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

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

Configuring your Cisco UCM

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.

  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.
<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.
  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 Enterprise.
    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.
<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 the synched files should be created and add a new Directory Sync object. Enter a name for the object and click on the 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.
<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. Choose the PBX object you want to configure and click Properties.
  3. A new window will open. In the General tab, select Cisco UCM 5+ from the Data format list and tick the Keep a local backup of data box, as shown below:
  4. In the Connection tab, select Receive FTP transfers from PBX from the Connection method list.
  5. In the Username field, enter the username you created when setting up your Cisco UCM for FTP/SFTP transfers, e.g. TIM .
  6. In the Password field, enter the password you chose when setting up your Cisco UCM for FTP/SFTP transfers, e.g. Ciscoftp .
  7. Click on the Save button to apply the changes.

 

 

 

 

<p>Follow these instructions to configure your Cisco UCM / CUBE to work with TIM Enterprise:</p>

<table class="confluenceTable">
	<tbody>
		<tr>
			<th class="confluenceTh" width=158>Connection information</th>
			<th class="confluenceTh">Description</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Connection type</b></td>
			<td class="confluenceTd">FTP or SFTP</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Connection method</b></td>
			<td class="confluenceTd">The Cisco UCM will send the CDR data to TIM Enterprise via FTP or SFTP</td>
		</tr>
	</tbody>
</table>


<p>Tasks required:</p>

<ol>
	<li><a href="#1">Download and configure interface file <span class="keyword" style="color: #006DAF;">UCM.zip</span></a></li>
	<li><a href="#2">Create an Application User on your UCM for AXL synchronisation</a></li>
	<li><a href="#3">Configure TIM Enterprise to receive data from your UCM</a></li>
	<li><a href="#4">Create a synchronisation object in TIM Enterprise</a></li>
	<li><a href="#5">Setup FTP/SFTP on the UCM to transfer CDRs to TIM Enterprise</a></li>
</ol>

<h4><a name="1" style="text-decoration: none; color: #477FBD;">1.&nbsp; Download and configure interface file <span class="keyword" style="color: #477FBD;">UCM.zip</span></a></h4>

<ol>
	<li>Log in to the <a href="https://gateway.tri-line.com/">Tri-Line Gateway</a> to download the specific interface file that enables TIM Enterprise to communicate with your UCM, as shown below:</li>
	<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/gateway_2.png" alt="Gateway" />
	<li>Extract the <span class="keyword">Cisco UCM.zip</span> file to the <span class="keyword">C:\Program Files\Tri-Line\TIM Enterprise\config\</span> folder.  The ZIP file contains two files: <span class="keyword">Cisco UCM.TDT</span> and <span class="keyword">Cisco UCM.TDS</span>.</li>
</ol>

<h4><a name="2" style="text-decoration: none; color: #477FBD;">2.&nbsp; Create an Application User on your UCM for AXL synchronisation</a></h4>

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

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

<h4><a name="3" style="text-decoration: none; color: #477FBD;">3.&nbsp; Configure TIM Enterprise to receive data from your UCM</a></h4>

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

<ol>
	<li>Browse to TIM Enterprise and login with your credentials.</li>
	<li>Click on the <span class="button no_margin">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 <span class="keyword">Cisco UCM</span>.</li>
	<li>Left-click on it and select <span class="button no_margin">Properties</span>.</li>
	<li>From the <span class="button no_margin">General</span> settings tab select <span class="keyword">Cisco UCM 5+</span> from the PBX model list and enable the local backup.</li>
	<img class="screenshot border" 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 no_margin">Connection</span> tab select <span class="keyword">Receive FTP transfers from PBX</span> from the <span class="reference">Connection method</span> list.</li>
	<li>In the <span class="reference">Username</span> field enter in the username of your choice e.g. <span class="keyword">Cisco</span>.</li>
	<li>In the <span class="reference">Password</span> field enter in the password of your choice e.g. <span class="keyword">C1sco</span>.</li>
	<li>Finally, click on the <span class="button no_margin">Save</span> button.</li>
	<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucm_5.png" alt="Cisco UCM" />
</ol> 

<h4><a name="4" style="text-decoration: none; color: #477FBD;">4.&nbsp; Create a synchronisation object in TIM Enterprise</a></h4>

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

<ol>
	<li>Browse to TIM Enterprise as normal and login with your credentials.</li>
	<li>Click on the <span class="button no_margin">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. <span class="keyword">Cisco AXL</span>.</li>
	<img class="screenshot border" 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 no_margin">Properties</span>.</li>
	<li>In the <span class="reference">Directory type</span> drop-down list select <span class="keyword">Cisco UCM</span>.</li>
	<li>In the <span class="reference">Host name</span> field enter in the IP address or Hostname of Publisher node.</li>
	<li>In the <span class="reference">Username</span> field enter in the username configured in phase <a href="#2">2. Creating Cisco Application User for AXL sync</a>, e.g. <span class="keyword">TIM_AXL</span>.</li>
	<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucm_6.png" alt="Cisco UCM" />
	<li>Click <span class="button no_margin">Set password</span> and enter the password configured in phase <a href="#2">2. Creating Cisco Application User for AXL sync</a>, e.g. <span class="keyword">C1sco</span>, 
	followed by clicking <span class="button no_margin">OK</span>.</li>
	<img class="screenshot border" 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 no_margin">Save</span> button.</li>
</ol> 

<p>TIM Enterprise will now connect to the PBX and sync the directory objects.</p>

<h4><a name="5" style="text-decoration: none; color: #477FBD;">5.&nbsp; Setup FTP/SFTP on the UCM to transfer CDRs to TIM Enterprise</a></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 <span class="button no_margin">System</span>, <span class="button no_margin">Service Parameters</span> which is located on the left hand side of the screen.</li>
	<li>Select your UCM node from the <span class="reference">Server</span> drop down list.</li>
	<li>Select <span class="keyword">Cisco Call Manager</span> from the <span class="reference">Service</span> drop down list.</li>
	<li>In the <span class="reference">System</span> section, change the <span class="reference">CDR Enabled Flag</span> to <span class="keyword">True</span>, enable this parameter on all servers in the cluster that you want to log calls for.</li>
	<li>Change the <span class="reference">CDR Log Calls with Zero Duration Flag</span> to <span class="keyword">True</span>(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 <span class="button no_margin">Save</span> button.</li>
	<li>Click on the <span class="reference">Navigation</span> drop-down list in the top right hand corner and select <span class="reference">Cisco Unified Serviceability</span>.</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 <span class="button no_margin">Tools</span> then click <span class="button no_margin">CDR Management</span>.</li>
	<li>Click <span class="button no_margin">Add New</span> button. You will now see the <span class="reference"">Billing Application Server Parameters</span> 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 phase <a href="#3">3. Configuring TIM Enterprise to receive data from UCM</a> e.g. <span class="keyword">Cisco</span>.</li>
		<li><b>Password: </b>as configured within phase <a href="#3">3. Configuring TIM Enterprise to receive data from UCM</a> e.g. <span class="keyword">C1sco</span>.</li>
		<li><b>Protocol: </b>Select FTP or SFTP as configured above.</li>
		<li><b>Directory Path: </b>Enter <span class="keyword">/</span>.</li>
		<li>Remove the tick from <span class="reference">Resend on Failure</span>.</li>
	</ul>
	<li>Now click on the <span class="button no_margin">Add</span> 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 should check the FTP or SFTP details, configured above.</li>
</ol>

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

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.