Before you can begin to take advantage of the many tools that Variphy has to offer, a few settings must first be configured within your CUCM.
ENABLE CALL DETAIL RECORD SERVICE PARAMETERS
Login to Cisco UCM Administration and select Service Parameters from the System menu.
For each Server, for which the Cisco CallManager Service is Active, select the Cisco CallManager service.
Set the value for CDR Enabled Flag to True and CDR Log Calls with Zero Duration Flag to True.
Set the value for Call Diagnostics Enabled to Enabled Only When CDR Enabled Flag is True. For CUCM versions 8.0 and later, we also recommend setting the set value for Show Line Group Member DN in finalCalledPartyNumber CDR Field and Show Line Group Member Non-Masked DN in finalCalledPartyNumber CDR Field to True.
If your organization uses Forced Authorization Codes, the Display FAC in CDR flag must also be enabled in order for the FAC codes to be written to the CDR. This is an ‘advanced‘ service parameter for the ‘Cisco CallManager‘ Service that is only visible in CUCM Administration via Service Parameters, then clicking the ‘Advanced‘ button to expose the additional fields.
The Display FAC in CDR field is then listed under the ‘Clusterwide Parameters (Device – General)’ section. Set to true for all CallManager/call-processing servers (those with the ‘Cisco CallManager’ service Active)
When finished click Save and repeat this process for each of the CUCM Servers.
CREATE USER GROUP AND APPLICATION USER
Variphy uses an Application User account to access CUCM for reporting purposes, and for using the phone control feature.
Create Access Control Group (Formerly User Group) in CUCM
Login to Unified CM Administration and under User Management, select User Group (or User Settings > Access Control Group in Call Manager 9.x and above)
Select Add New to create a new User Group
Enter a name for this User Group, such as VariphyGroup and click Save
Assign Required Roles to Variphy Group
Once the group is saved, click on Assign Role to Access Control Group in the Related Links drop-down menu:
Click on Assign Role:
Perform a blank search for roles and add the following from the list:
- Standard AXL API Access
- Standard CCM Admin Users
- Standard SERVICEABILITY Read Only (ensure the role for the “Cisco Call Manager Serviceability” application is selected AND NOT that of the “Cisco Dialed Number Analyzer”)
- Standard CTI Allow Control of All Devices
- Standard CTI Allow Control of Phones supporting Connected Xfer and conf
- Standard CTI Allow Control of Phones supporting Rollover Mode
- Standard CTI Enabled
Save changes to the User/Access Control Group when finished.
Create Application User
To create a new Application User, select Application User from the User Management menu
Go Back to User Management > Application user
Add Application User variphyadmin (if a Variphy account does not exist from a previous installation) or an applicable name per any naming conventions/policies. The standard password we recommend is V@riphy!!, but please make a note of the password if using a different one.
Add the variphyadmin account to the VariphyGroup. Upon saving, the 7 required roles should be associated with the account through group membership.
Add Phones to Controlled Devices
Under the Device Information section of the variphyadmin account, all phones that you want to access via our remote phone control feature will need to be added to the Controlled Devices field. Please note that Insight cannot control softphones, only physical Cisco IP phones with SEP device names.
You can add individual phones you wish to control, or add all SEP phones. To add phones, click on the Find More Phones button, search for Device Name Begins with SEP, and change the Rows Per Page setting from 50 to 250. Then check the Select All checkbox for that page and click on Add Selected. This will add all phones on the page into controlled devices. If you have multiple pages worth of phones, you will need to go back and repeat this process for each additional page.
CONFIGURE BILLING APPLICATION SERVER
*** NOTE: This step requires your Variphy server to be deployed and online. ***
In Cisco Unified Serviceability, select CDR Management from the Tools menu.
The resulting screen will show any existing Billing Application Servers configured for CDR Management.
Click the Add New button to create a new Billing Application Server.
Enter the following settings for the new Billing Application Server:
Host Name / IP Address: Enter the hostname / IP address for the machine running the (S)FTP Server as routable from the Cisco UCM Publisher. If using Variphy OVA use IP address specified during OVA deployment.
User Name: Enter the FTP user login along with the corresponding password.
Note: If using Variphy OVA use Username: variphyadmin | Password: V@riphy!!
Protocol: Select corresponding delivery protocol.
Note: If using Variphy OVA select SFTP.
Directory Path: Enter a single forward slash (“/”) to denote the root path. This will use the Home Folder designated for the account specified in your (S)FTP server.
Note: If using Variphy OVA use /opt/variphy/data/cluster#/cdr/ adjust cluster# accordingly (e.g. cluster1, cluster2, cluster3, etc)
Click the Add button to validate the settings and add the Billing Server.
Once successful, the newly added Billing Server will be displayed.