Cisco UCM / Business Edition (AKA Call Manager) version 5.0 - 8.6

Configuring your Cisco UCM

Creating Cisco Application User for AXL sync

To enable TIM Plus to query the Cisco DB, you will need to create an Application User within your Cisco UCM. Please follow the steps below to proceed with the setup:

1. Connect to your UCM node, select Cisco Unified CM Administration from the Navigation drop-down list and click Go.
2. Log in to the system, select User Management from the main menu, and click Application User.
3. Click Add New and 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) 

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 on Standard TabSync User and click on the Add Selected tab.
6. Click Save to apply the settings.

Setting up FTP / SFTP on 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 into Cisco UCM Administration, and from the left-hand side menu, click on the System button and selectService Parameters.
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 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 were never connected or which lasted 1 second).
6. Click on the Save button.
7. Click on the Navigation drop-down list from the top right-hand side corner, and select Cisco Unified Serviceability.
8. You may be prompted to log in 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 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 configured above.
• Directory Path: Enter the forward slash key: /.
• 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. If it fails, you should check the FTP or SFTP details, configured above.

Configuring TIM Plus

Configuring Cisco AXL sync

Below you will find steps on how to configure the Directory Sync from Cisco UCM:

1. Browse to TIM Plus as normal and login with your credentials.
2. Click on the Directory tab.
3. Click on the site configured during the setup wizard and click Properties or create a new site and click Properties.
4. Within the Site Properties window, select the Sync tab.
5. Click on the Synchronise with the following device tick box.
   
   
6. In the Host field, enter the IP address of the UCM Publisher node.
7. In the Username field, enter the username for your Application User created above (e.g. TIM_AXL) 
8. Click on the Set button and enter the password for your Application User created above (e.g. C1sco). ClickOK.
9. Finally, click on the Save button to apply the settings.

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

Configuring the FTP connection

Below you will find steps on how to configure your TIM Plus to receive data from UCM:

1. Browse to TIM Plus as normal and login with your credentials.
2. Click on the Directory tab.
3. Click on the site configured during the setup wizard and click Properties or create a new site and click Properties.

1. Within the Site Properties window, select Cisco UCM 5+ from the PBX model drop-down list.
2. In the Connection method field select Receive FTP tranfers from PBX from the drop-down list.
3. In the Username field enter in the username of your choice e.g. Cisco.
4. In the Password field enter in the password of your choice e.g. C1sco.
5. To enable data backup, click on the Options tab.

1. Click on the Save a backup of any data received from this PBX tick box.
2. Finally, click on the Save button.

These instructions should assist in configuring your Cisco UCM / Business Edition to work with TIM Plus. If you are not familiar with PBX configuration, please contact your system maintainer.

The tasks required to be done are as follows. They are all analysed in details further down this page.

1. Download TIM Plus and complete the setup wizard
2. Create Cisco Application User for AXL sync
3. Configure TIM Plus to receive data from your UCM
4. Configure Cisco AXL sync
5. Set up FTP / SFTP on Cisco UCM to transfer CDRs to TIM Plus

1.  Downloading TIM Plus and completing the setup wizard

1. Visit Tri-Line's Portal and download the TIM Plus installation package, as shown below:

2. Run the installation package and on Stage 5 complete the following details:

• Site name: Enter a description for the site
• PBX model: Select Cisco UCM 5+
• Method: Select Receive FTP transfers from PBX. To use SFTP protocol, just click on the tick box
• Username: Enter a username for FTP/SFTP transfers e.g. TIM
• Password: Enter a password for the FTP account e.g. Ciscoftp

2.  Creating Cisco Application User for AXL sync

Create an Application User on Cisco UCM, enabling TIM Plus to query the Cisco DB. Just follow the steps 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.  Configuring TIM Plus to receive data from UCM

Below you will find steps on how to configure your TIM Plus to receive data from UCM:

1. Browse to TIM Plus as normal and login with your credentials.
2. Click on the Directory tab.
3. Click on the site configured during the setup wizard and click Properties or create a new site and click Properties.

4. Within the Site Properties window, select Cisco UCM 5+ from the PBX model drop-down list.
5. In the Connection method field select Receive FTP tranfers from PBX from the drop-down list.
6. In the Username field enter in the username of your choice e.g. Cisco.
7. In the Password field enter in the password of your choice e.g. C1sco.
8. To enable data backup, click on the Options tab.

9. Click on the Save a backup of any data received from this PBX tick box.
10. Finally, click on the Save button.

4.  Configuring Cisco AXL sync

Below you will find steps on how to configure the Directory Sync from Cisco UCM:

1. Browse to TIM Plus as normal and login with your credentials.
2. Click on the Directory tab.
3. Click on the site configured during the setup wizard and click Properties or create a new site and click Properties.
4. Within the Site Properties window, select the Sync tab.
5. Click on the Synchronise with the following device tick box.

6. In the Host field enter in the IP address of the UCM 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 on the Set button 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 Plus will now connect to the PBX and sync the directory objects.

5.  Setting up FTP / SFTP on Cisco UCM to transfer CDRs to TIM Plus

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. 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 Plus.
• User Name: as configured within phase 3. Configuring TIM Plus to receive data from UCM e.g. Cisco.
• Password: as configured within phase 3. Configuring TIM Plus 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.