Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Pbxsummary
RequiredTask4Set up FTP/SFTP in Cisco UCM
Supportfiles1Cisco UCM 5+.TDT
Supportfiles2Cisco UCM 5+.TDS
ConnectionFTP transfer
RequiredTask1Create Cisco Application User for AXL sync
RequiredTask2Configure Cisco AXL sync
RequiredTask3Configure TIM Enterprise to receive data by FTP

HTML
<a id = "Create Cisco Application User for AXL sync</h4>

<p>Create an Application User on Cisco UCM, enabling TIM Enterprise to query the Cisco DB. Just follow the steps shown below:</p>

<ol>
	<li>Connect to your UCM node, Select Cisco Unified CM Administration from the Navigation drop down list on the right and click Go.</li>
	<li>Login to the system, select User Management from the menu and click Application User.</li>
	<li>Click Add New from the menu.</li>
	<li>Enter in the following details:</li>
	<ul>
		<li><b>User ID:</b> TIM_AXL</li>
		<li><b>Password:</b> C1sco</li>
		<li><b>Confirm Password:</b> C1sco</li>
	</ul>
	<li>Scroll down to the Permissions Information section, click Add to User Group.</li>
	<li>In the new window, enter Standard Tab then click Find. Select Standard TabSync User and click Add Selected, followed by Save.</li>
</ol>

<h4>3.&nbsp; Configuring TIM Enterprise to receive data from UCME</h4>

<p>Below you will find steps on how to configure TIM Enterprise to listen for SMDR data from your Cisco UCM:</p>

<ol>
	<li>Browse to TIM Enterprise as normal and login with your credentials.</li>
	<li>Click on the <span class="button" id="list">Directory</span> tab.</li>
	<li>Go the the point in the Directory where you need to add the PBX Object and add a PBX with the name 'Cisco UCM'.</li>
	<li>Left-click on it and select <span class="button" id="list">Properties</span>.</li>
	<li>From the <span class="button" id="list">General</span> settings tab select <span class="keyword">Cisco UCM 5+</span> from the PBX model list and enable the local backup.</li>
	<img src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucm_4.png" alt="Cisco UCM" />
	<li>In the <span class="button" id="list">Connection</span> tab select <span class="keyword">RADIUS connection</span> from the <span class="reference">Connection method</span> list.</li>
	<li>In the <span class="reference">Client IP</span> field enter in the IP address or Hostname of your Cisco router.</li>
	<li>In the <span class="reference">Secret key</span> field enter in the passphrase used for RADIUS events e.g. 'C1sco'.</li>
	<li>Finally, click on the <span class="button" id="list">Save</span> button.</li>
	<img src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucm_5.png" alt="Cisco UCM" />
</ol> 

<h4>4.&nbsp; Configuring Directory Sync</h4>

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

<ol>
	<li>Browse to TIM Enterprise as normal and login with your credentials.</li>
	<li>Click on the <span class="button" id="list">Directory</span> tab.</li>
	<li>Go to the point in the Directory where you need to synchronise and add a new <span class="reference">Directory Sync</span> object with an appropriate description e.g. 'Cisco AXL'.</li>
	<img src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucme_6.png" alt="Cisco UCM" />
	<li>Left-click on it and select <span class="button" id="list">Properties</span>.</li>
	<li>In the <span class="reference">Directory type</span> drop-down list select <span class="keyword">Cisco UCME</span>.</li>
	<li>In the <span class="reference">Host name</span> field enter in the IP address or Hostname of your Cisco router.</li>
	<li>In the <span class="reference">Username</span> field enter in the username of your choice.</li>
	<img src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucm_6.png" alt="Cisco UCM" />
	<li>Click <span class="button" id="list">Set password</span> and enter the password used to login to the Cisco UCM, followed by clicking <span class="button" id="list">OK</span>.</li>
	<img src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucm_7.png" alt="Cisco UCM" />
	<li>Finally, click on the <span class="button" id="list">Save</span> button.</li>
</ol> 

<h4>5.&nbsp; Setting up FTP / SFTP on Cisco UCM to transfer CDRs to TIM Enterprise</h4>

<p>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.</p>

<ol>
	<li>Login to Cisco UCM Administration and choose System, Service Parameters which is located on the left hand side of the screen.</li>
	<li>Select your UCM node from the Server drop down list.</li>
	<li>Select Cisco Call Manager from the Service drop down list.</li>
	<li>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.</li>
	<li>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.</li>
	<li>Click on the Save button.</li>
	<li>Click on the Navigation drop-down list in the top right hand corner and select Cisco Serviceability.</li>
	<li>You may be prompted to login with a user account with Administrative permissions, if so, login with such an account.</li>
	<li>Select Tools then click CDR Management.</li>
	<li>Click Add New button. You will now see the Billing Application Server Parameters window.</li>
	<li>Enter the following parameters:</li>
	<ul>
		<li><b>Host Name/IP Address: </b>The IP address or hostname of the machine running TIM Enterprise.</li>
		<li><b>User Name: </b>as configured within Step 12 e.g. C1sco.</li>
		<li><b>Password: </b>as configured within Step 12 e.g. C1sco.</li>
		<li><b>Protocol: </b>Select FTP or SFTP as configured within Step 12.</li>
		<li><b>Directory Path: </b>Enter /</li>
		<li><b>Remove the tick from Resend on Failure</b></li>
	</ul>
	<li>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.</li>
	<li> if it fails you will see the following error message and you should check the FTP or SFTP details.</li>
</ol>

<p>You have now completed the configuration.</p>
Note

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.

sync"></a>

Create Cisco Application User for AXL sync

To enable TIM Enterprise 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.
    Click Add New to create a new user:

    User ID:  TIM_AXL 

    Password: C1sco 

    Confirm Password: C1sco

    Screenshotmacro
    Borderfalse
    Shadowfalse
    URL/download/attachments/4817082/cisco_ucm_1.png

    Warning

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

  3. Scroll down to the Permissions Information section and click Add to User Group.
  4. 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.
    Screenshotmacro
    Borderfalse
    Shadowfalse
    URL/download/attachments/4817082/cisco_ucm_9.png
  5. Click Save to apply the settings.
HTML
<a id="Configure Cisco AXL sync"></a>

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 to synch the UCM files and add a new Directory Sync object. Enter a name for the object and click on the
    Buttonmacro
    LabelAdd
    button, as shown below:
    Screenshotmacro
    Borderfalse
    URL/download/attachments/3670084/cisco_ucme_6.png
  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 Host port field, enter the port number of the UCM Publisher node.
  7. In the Username field, enter the username of the Cisco Application User you configured in the previous section, e.g. TIM_AXL.
    Screenshotmacro
    Borderfalse
    URL/download/attachments/3670084/cisco_ucm_6.png

  8. Click Set password and enter the password configured in the previous section, e.g. C1sco.
    Screenshotmacro
    Borderfalse
    URL/download/attachments/3670084/cisco_ucm_7.png
  9. Click on the Save button to apply the changes.
HTML
<a id="Configure TIM Enterprise to receive data by FTP"></a>

Configuring TIM Enterprise to receive data by FTP

Follow the steps below to configure TIM Enterprise to receive data from your Cisco UCM:

  1. Click on the Directory tab.
  2. Locate the PBX object you want to configure in the Directory, right-click on it and select Properties.
  3. A new window will open, displaying the general properties of your PBX object. Select Cisco UCM 5+ from the Data format list and tick the 
    Keywordmacro
    LabelKeep a local backup of data
    box, as shown below:
    Screenshotmacro
    Borderfalse
    URL/download/attachments/3670084/cisco_ucm_4.png
  4. Click on the Connection tab and select Receive FTP transfers from PBX from the Connection method list.
  5. In the Username field, enter a username for FTP/SFTP transfers, e.g. TIM .
  6. In the Password field, enter a password for FTP/SFTP transfers, e.g. Ciscoftp .
  7. Click on the Save button to apply the changes.
    Screenshotmacro
    Borderfalse
    URL/download/attachments/3670084/cisco_ucm_5.png
HTML
<a id="Set up FTP/SFTP in Cisco UCM"></a>

Set up FTP/SFTP in Cisco UCM

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. 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.
    Screenshotmacro
    Borderfalse
    Shadowfalse
    URL/download/attachments/3670084/cisco_ucm_11.png
  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 ServiceabilityYou 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 Enterprise.
    User Name:  Enter the user name for FTP/SFTP transfers you set up in TIM Enterprise (e.g. TIM) 
    Password: Enter the password for the FTP account you set up in TIM Enterprise (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.
    Screenshotmacro
    Borderfalse
    Shadowfalse
    URL/download/attachments/4817082/cisco_ucm_6.png
  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.