Cisco UCM / CUBE (Call Manager) versions 5.0 - 8.6

These instructions help you configure your Cisco UCM version 5.0 - 8.6 to work with TIM Plus. Contact your system maintainer if you are not familiar with the configuration of your PBX.

Connection Type

  TIM Enterprise receives FTP transfers from this PBX.

Support Files

  Cisco UCM 5+.TDT
  Cisco UCM 5+.TDS

Required Tasks

  Create Cisco Application User for AXL sync
  Set up FTP/SFTP in Cisco UCM
  Configure Cisco AXL sync
  Configure TIM Enterprise to receive data by FTP

Configuring your Cisco UCM

Create Cisco Application User for AXL sync

To enable TIM Plus to query the Cisco database, you need to create an Application User on your Cisco UCM. Follow the steps below to complete this task:

1. Connect to the web management interface of your UCM node and select Cisco Unified CM Administration from the Navigation drop-down list.
2. Log in to the system and click User Management from the main menu. Select Application User from the drop-down list.

3. Click Add New to create a new user:

   User ID:  TIM_AXL 

   Password:C1sco 

   Confirm Password:C1sco
   
   

   The credentials above are shown as an example. In the interests of security, you should choose your own values.

4. Scroll down to the Permissions Information section and click Add to User Group.
5. In the new window, enter Standard Tab and then click Find. Tick the Standard TabSync User box,  and then click on the Add Selected tab.
   
   
6. Click Save to apply the settings.

Set up FTP/SFTP in Cisco UCM

You will need to configure your Cisco UCM to send the CDR data to TIM Plus. Note that the UCM can be configured with cluster wide or server specific settings, depending on how the system maintainer has installed it. Please note that, by default, CDR records are turned off.

1. Log in to Cisco UCM Administration and from the left-hand menu click on the System tab and select Service Parameters.
2. Choose your UCM node from the Server drop-down list.
3. Select Cisco Call Manager from the Service drop-down list.
4. In the System section, change the CDR Enabled Flag to True. Enable this parameter on all servers within the cluster you want to log calls for.
5. Change the CDR Log Calls with Zero Duration Flag to True. This parameter enables or disables the logging of CDRs for calls which did not connect.
6. Click on the Save button.
7. Click on the Navigation drop-down list from the top right-hand corner, and select Cisco Unified Serviceability. You may need to log in with a user account that has administrative permissions.
8. Select Tools, then click on the CDR Management tab.
9. Click the Add New button. You will now see the Billing Application Server Parameters window. Enter the following parameters:
   
   Host Name / IP Address: The IP address or hostname of the machine running TIM Plus.
   User Name:  Enter a user name for FTP/SFTP transfers (e.g. TIM) 
   Password: Enter a password for the FTP account (e.g. Ciscoftp) 
   Protocol: Select FTP or SFTP as desired.
   Directory Path: Enter a forward-slash character to indicate root (/).
   Remove the tick from Resend on Failure.
   
   
10. Next, click on the Add button to complete the billing server configuration. The UCM node will check that the FTP/SFTP details are valid and will write a test file to the FTP/SFTP directory. If this fails, you should double-check the details you entered.

Configuring Cisco AXL sync

Follow the steps below to configure TIM Enterprise to synchronise with the directory of your Cisco UCM:

1. Click on the Directory tab.
2. Go to the Directory level where you want the synched files to be created and add a new Directory Sync object. Enter a name for the object and click on the Add button, as shown below:
   
   
3. Left-click on the newly-created object and select Properties.
4. In the Directory type drop-down list select Cisco UCM.
5. In the Host name field enter the IP address of the UCM Publisher node.
6. In the Username field, enter the username of the Cisco Application User you configured in the previous section, e.g. TIM_AXL.
   
   
   
7. Click Set password and enter the password configured in the previous section, e.g. C1sco.
   
   

1. Download and configure interface file UCM.zip
2. Create an Application User on your UCM for AXL synchronisation
3. Configure TIM Enterprise to receive data from your UCM
4. Create a synchronisation object in TIM Enterprise
5. Setup FTP/SFTP on the UCM to transfer CDRs to TIM Enterprise

1.  Download and configure interface file UCM.zip

1. Log in to the Tri-Line Gateway to download the specific interface file that enables TIM Enterprise to communicate with your UCM, as shown below:

2. Extract the Cisco UCM.zip file to the C:\Program Files\Tri-Line\TIM Enterprise\config\ folder. The ZIP file contains two files: Cisco UCM.TDT and Cisco UCM.TDS.

2.  Create an Application User on your UCM for AXL synchronisation

So that TIM Enterprise can automatically log in to your UCM and perform synchronisation commands, you need to create an Application User, as shown below:-

1. Connect to your UCM node, select Cisco Unified CM Administration from the Navigation drop down list on the right and click Go.
2. Login to the system, select User Management from the menu and click Application User.
3. Click Add New from the menu.
4. Enter in the following details:
• User ID: Enter a username e.g TIM_AXL
• Password: Enter a password e.g C1sco
• Confirm Password: Repeat the password e.g C1sco
5. Scroll down to the Permissions Information section and click Add to User Group.
6. In the new window, enter Standard Tab and then click Find. Tick on Standard TabSync User and click Add Selected, followed by Save.

3.  Configure TIM Enterprise to receive data from your UCM

Follow these steps to create a PBX object and configure the CDR transfer method in the TIM Enterprise Directory:

1. Browse to TIM Enterprise and login with your credentials.
2. Click on the Directory tab.
3. Go the the point in the Directory where you need to add the PBX Object and add a PBX with the name Cisco UCM.
4. Left-click on it and select Properties.
5. From the General settings tab select Cisco UCM 5+ from the PBX model list and enable the local backup.

6. In the Connection tab select Receive FTP transfers from PBX from the Connection method list.
7. In the Username field enter in the username of your choice e.g. Cisco.
8. In the Password field enter in the password of your choice e.g. C1sco.
9. Finally, click on the Save button.

4.  Create a synchronisation object in TIM Enterprise

Follow these steps to set up a synchronisation object in TIM Enterprise which will regularly check for name and extension changes on your UCM and replicate them in your TIM Enterprise directory:

1. Browse to TIM Enterprise as normal and login with your credentials.
2. Click on the Directory tab.
3. Go to the point in the Directory where you need to synchronise and add a new Directory Sync object with an appropriate description e.g. Cisco AXL.

4. Left-click on it and select Properties.
5. In the Directory type drop-down list select Cisco UCM.
6. In the Host name field enter in the IP address or Hostname of Publisher node.
7. In the Username field enter in the username configured in phase 2. Creating Cisco Application User for AXL sync, e.g. TIM_AXL.

8. Click Set password and enter the password configured in phase 2. Creating Cisco Application User for AXL sync, e.g. C1sco, followed by clicking OK.

9. Finally, click on the Save button.

TIM Enterprise will now connect to the PBX and sync the directory objects.

5.  Setup FTP/SFTP on the UCM to transfer CDRs to TIM Enterprise

You will need to configure your Cisco UCM to send the CDR data to TIM Enterprise. Note that the UCM can be configured with cluster wide or server specific settings depending on how the system maintainer has installed it. Please note that by default CDR records are turned off.

1. Login to Cisco UCM Administration and choose System, Service Parameters which is located on the left hand side of the screen.
2. Select your UCM node from the Server drop down list.
3. Select Cisco Call Manager from the Service drop down list.
4. In the System section, change the CDR Enabled Flag to True, enable this parameter on all servers in the cluster that you want to log calls for.
5. Change the CDR Log Calls with Zero Duration Flag to True(This parameter enables or disables the logging of CDRs for calls which were never connected or which lasted 1 second).
6. Click on the Save button.
7. Click on the Navigation drop-down list in the top right hand corner and select Cisco Unified Serviceability.
8. You may be prompted to login with a user account with Administrative permissions. If so, login with such an account.
9. Select Tools then click CDR Management.
10. Click Add New button. You will now see the Billing Application Server Parameters window.
11. Enter the following parameters:
• Host Name/IP Address: The IP address or hostname of the machine running TIM Enterprise.
• User Name: as configured within phase 3. Configuring TIM Enterprise to receive data from UCM e.g. Cisco.
• Password: as configured within phase 3. Configuring TIM Enterprise to receive data from UCM e.g. C1sco.
• Protocol: Select FTP or SFTP as configured above.
• Directory Path: Enter /.
• Remove the tick from Resend on Failure.
12. Now click on the Add button to complete the Billing Server configuration. The UCM node will check that the FTP/SFTP details are correct and will write a test file to the FTP/SFTP directory.
13. If it fails, you should check the FTP or SFTP details, configured above.

You have now completed the configuration.

NOTE: If you have more than one server in your cluster you must repeat Steps 1 to 5 for each node. This will enable the UCM nodes to start creating CDR records, which are stored on the Publisher Node.