How to configure the cisco_ucm probe for Call Data Report (CDR) monitoring

Document ID : KB000072804
Last Modified Date : 08/03/2018
Show Technical Document Details
How do users configure the cisco_ucm probe for Call Data Report (CDR) monitoring?
UIM 8.x versions
cisco_ucm version 1.90 

cisco_ucm (Cisco Unified Communications Manager Monitoring) 

The cisco_ucm probe supports the following Cisco Unified products:
-        Cisco Unified Communications Manager (Call Manager) 6.x to 11.x
-        Cisco Unity Connection 7.x to 10.x
-        Cisco Unified Presence 7.x to 10.x
-        Cisco Contact Center Express 8.x 

The probe requires at least the following permissions for the Cisco UCM user account: 
-        Standard AXL API Access
-        Standard CCM Admin Users
-        Standard SERVICABILITY Read Only
The probe has the following installation considerations:
-        Install the Cisco Unified Communication Manager (UCM) Monitoring probe on the same system as the FTP server.
-        Specify valid user credentials with administrative privileges to the Cisco UCM server.
The following services are required by the probe:
-        Cisco AXL Web Service: This service is required only for Cisco Unified Communication Manager version 6.x to 8.x.
-        SOAP Real-Time Service APIs
-        SOAP Performance Monitoring APIs
-        Cisco SOAP CDRonDemand Service (required for Call Data Reports) – Call Data Reports are supported on Windows Robots only
-        CAR Web Service (also required for CDRs)
Time Zone Offset
Enter the Time Zone Offset in seconds between the Probe and the Cisco ucm server. By default, CUCM server generates cdr files on based on UTC time zone so we calculate offset according to difference between UTC time and time on the machine where the cisco_ucm probe is installed.
For example, if UTC time is 20:20:33 and the machine where the cisco_ucm probe is installed has a time of 3:20 PM. (15:20:00) then the difference is 5 hrs. Hence the CUCM server is ahead of the probe machine by 5 hrs. Hence the Time Zone Offset should be set to -5 in the probe configuration to compensate. 

FTP settings
The cisco_ucm probe uses File Transfer Protocol (FTP) to retrieve CDR files and generate the CDR Analysis Report. You can configure the FTP settings through the probe.
While configuring a CAR profile in cisco_ucm, you are instructing the UCM to push CDR/CMR files to an ftp server and the cisco_ucm probe will pick up these files from the ftp server and analyze them - so provide the FTP details in the probe config, instructing both the ftp client (on the UCM) and the probe where the CMR/CDR files should be located.
Note: The ftp server should be on the same system as the system running the cisco_ucm probe. For example, if the ftp users home directory is C:\ìnetpub\wwwroot\user, and the remotedir is configured to "/", the actual path have to be configured to C:\ìnetpub\wwwroot\user 

ftp_remotedir = /
ftp_actual_path = C:\ìnetpub\wwwroot\user 

Setup Instructions

Step 1 – Setup Probe
1)     Setup a new CDR profile
2)    Choose the version of Call Manager along with entering the IP and credentials used to access the Cisco Unified Serviceability page. These credentials are usually the same as the administration page.
3)    Once configured you will now need to configure the SFTP details. The IP is the IP of the data collector. The username, password, and FTP actual path is stored within whatever SFTP service you have installed. Remote Directory should always be “/” or if you want to you can create a directory for the cdr files to be stored.
4)    One key setting is the Time Zone Offset which needs to line up with the Call Manager UTC time which is shown in step 2. For example, if the UTC time on the CM is 14:00 and the data collector is 10:00, the time offset should be -4:00 because the data collector is 4 hours behind the CM.

User-added image

Step 2 – Check the time offset for Call Manager 

1)      Logon to the Call Manager through SSH/Telnet

2)     Run the command “utils ntp status”. This will give you the UTC time. This will be used to configure the time offset in the cisco_ucm probe.

User-added image



Both Cisco SOAP – CDRonDemand service as well as the Cisco CAR Web Service need to be activated in order for the probe to access the AXIS API. If you cannot

access the webpage below, the service is probably deactivated.

User-added image

User-added image

Additional Information:
Check the release notes and Known Issues
Example Call Data Report:
This particular client doesn’t have many calls but essentially after every poll these CDR calls update so there isn’t historical data. The only thing historical about it is it keeps the last call in every poll cycle so it will at least show one call each time. Note that the probe can insert data into the database as well.

User-added image