Cisco UCM / Business Edition (Call Manager) Versions 5 - 15

These instructions help you configure your Avaya BCM phone system up to v3.x to Cisco UCM version 5 - 15 to work with TIM Plus. Contact your system maintainer if you are not familiar with the configuration of your PBX.

Pbxsummary

RequiredTask4	Configure TIM Plus to receive FTPSet up FTP/SFTP in Cisco UCM
Supportfiles1	Cisco UCM 5+.TDT
Supportfiles2	Cisco UCM 5+.TDS
Connection	FTP transfer
RequiredTask1	Create Cisco Application User for AXL sync
RequiredTask2	Set up FTP/SFTP in Cisco UCMConfigure Cisco AXL sync
RequiredTask3	Configure Cisco AXL sync TIM Plus to receive data by FTP

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

Configuring your Cisco UCM

...

Create Cisco Application User for AXL sync

To enable TIM Plus to query the Cisco DBdatabase, you will need to create an

Referencemacro

Label	Application User

within

on your Cisco UCM. Please follow Follow the steps below to proceed with the setupcomplete this task:

...

Connect to the web management interface of your UCM node , and select Cisco Unified CM Administration from the Navigation drop
Referencemacro
Label Navigation
drop-down list and click Go.
Log in to the system , select and click User Management from the main menu, and click . Select Application User from the drop-down list.
Click Add New
and enter in the following details
to create a new user:
User ID:

Enter a username (e.g

TIM_AXL

)

Password:

Enter a password (e.g

C1sco

)

C1sco
Confirm Password:

Repeat the password (e.g

C1sco

)

C1sco
Screenshotmacro
Border false
Shadow false
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.
Scroll down to the Permissions Information section and click Add to User Group.
In the new window, enter Standard Tab and then click Find. Tick on the Standard TabSync User box, and then click on the Add Selected tab.
Click Save to apply the settings.

HTML
<a id="Set up FTP/SFTP in Cisco UCM"></a>

...

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.

Log into Cisco UCM Administration, and from the left-hand side menu, click on the System button and selectService Parameters.
Select your UCM node from the Server drop-down list.
Select Cisco Call Manager from the Service drop-down list.
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.
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).
Click on the Save button.
Click on the Navigation drop-down list from the top right-hand side corner, and select Cisco Unified Serviceability.
You may be prompted to log in with a user account with administrative permissions. If so, login with such an account.
Select Tools then click CDR Management.
Click 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 configured above.
Directory Path: Enter the forward-slash key: /.
Remove the tick from Resend on Failure.

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.

Screenshotmacro
Border false
Shadow false
URL /download/attachments/4817082/cisco_ucm_9.png
Click Save to apply the settings.

HTML
<a id="Configure theCisco AXL sync in TIM Plus"></a>

Configuring Cisco AXL sync

Below you will find steps on how Follow the steps below to configure TIM Plus to sync synchronise with the directory of your Cisco UCM Directory:

Browse to TIM Plus as normal and login with your credentials.
Click on the Directory tab.
Click on Choose the site configured during the setup wizard you want to configure and click Properties.
Within In the Site Properties window, select the Sync tab.
Click on Tick the Synchronise with the following device tick box. box, and enter your UCM details, as shown below:
Screenshotmacro
Border false
URL http://docs.tri-line.com:8090/download/attachments/4817082/cisco_ucm_5.png
In the Host field, enter the IP address of the UCM Publisher node.
In the Username field, enter the username

for your

of the Cisco Application User

(

you configured in the previous section, e.g. TIM_AXL

)

.
Click on the Set button and enter the password for your Cisco of the Cisco Application User (you configured in the previous section, e.g. C1sco). Click, then click OK.
Finally, click Click on the Save button to apply the settings.

TIM Plus will now connect to the phone system and sync the directory objectsyour Cisco UCM and synchronise with its directory.

HTML
<a id="Configure TIM Plus to receive data by FTP"></a>

Configuring

...

TIM Plus to receive data by FTP

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

Browse to TIM Plus as normal and login with your credentials.
Click on the Directory tab.
Select Choose the site configured during the setup wizard you want to configure and click Properties.
Screenshotmacro
Border false
URL http://docs.tri-line.com:8090/download/attachments/4817082/cisco_ucm_3.png
Within In the Site Properties window, select Cisco UCM 5+ from the PBX model drop-down list.
In the Connection method field, select Receive FTP tranfers transfers from PBX from the drop-down list.
In the Username field, enter the username created in the Cisco UCM for your FTP connection (a user name for FTP/SFTP transfers, e.g. TIM)
In the Password field, enter the password created in the Cisco UCM for your FTP connection (a password for the FTP account, e.g. Ciscoftp)
Click on the Save button to apply the changes.

HTML

<hr/>

<p>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.</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 Plus via FTP or SFTP.
			</td>
		</tr>
	</tbody>
</table>


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

<ol>
	<li><a href="#1">Download TIM Plus and complete the setup wizard</a></li>
	<li><a href="#2">Create Cisco Application User for AXL sync</a></li>
	<li><a href="#3">Configure TIM Plus to receive data from your UCM</a></li>
	<li><a href="#4">Configure Cisco AXL sync</a></li>
	<li><a href="#5">Set up FTP / SFTP on Cisco UCM to transfer CDRs to TIM Plus</a></li>
</ol>

<h4><a name="1" style="text-decoration: none; color: #36375A;">1.&nbsp; Downloading TIM Plus and completing the setup wizard</a></h4>

<ol>
	<li>Visit <a href="https://gateway.tri-line.com/">Tri-Line's Portal</a> and download the TIM Plus installation package, as shown below:</li>
	<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_plus/pbx/gateway_2.png" alt="Gateway" />
	<li>Run the installation package and on <b>Stage 5</b> complete the following details:</li>
	<ul>
		<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_plus/pbx/installation_1.png" alt="Installation" />
		<li><b>Site name:</b> Enter a description for the site</li>
		<li><b>PBX model:</b> Select <span class="keyword">Cisco UCM 5+</span></li>
		<li><b>Method:</b> Select <span class="keyword">Receive FTP transfers from PBX</span>. To use SFTP protocol, just click on the tick box</li>
		<li><b>Username:</b> Enter a username for FTP/SFTP transfers e.g. <span class="keyword">TIM</span></li>
		<li><b>Password:</b> Enter a password for the FTP account e.g. <span class="keyword">Ciscoftp</span></li>
	</ul>
</ol>

<h4><a name="2" style="text-decoration: none; color: #36375A;">2.&nbsp; Creating Cisco Application User for AXL sync</a></h4>

<p>Create an Application User on Cisco UCM, enabling TIM Plus to query the Cisco DB. Just follow the steps 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: #36375A;">3.&nbsp; Configuring TIM Plus to receive data from UCM</a></h4>

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

<ol>
	<li>Browse to TIM Plus as normal and login with your credentials.</li>
	<li>Click on the <span class="button no_margin">Directory</span> tab.</li>
	<li>Click on the site configured during the setup wizard and click <span class="button no_margin">Properties</span> or create a new site and click <span class="button no_margin">Properties</span>.</li>
	<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_plus/pbx/cisco_ucm_3.png" alt="Cisco UCM" />
	<li>Within the <span class="reference">Site Properties</span> window, select <span class="keyword">Cisco UCM 5+</span> from the <span class="reference">PBX model</span> drop-down list.</li>
	<li>In the <span class="reference">Connection method</span> field select <span class="keyword">Receive FTP tranfers from PBX</span> from the drop-down 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>To enable data backup, click on the <span class="button no_margin">Options</span> tab.</li>
	<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_plus/pbx/cisco_ucm_4.png" alt="Cisco UCM" />
	<li>Click on the <span class="keyword">Save a backup of any data received from this PBX</span> tick box.</li>
	<li>Finally, click on the <span class="button no_margin">Save</span> button.</li>
</ol> 

<h4><a name="4" style="text-decoration: none; color: #36375A;">4.&nbsp; Configuring Cisco AXL sync</a></h4>

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

<ol>
	<li>Browse to TIM Plus as normal and login with your credentials.</li>
	<li>Click on the <span class="button no_margin">Directory</span> tab.</li>
	<li>Click on the site configured during the setup wizard and click <span class="button no_margin">Properties</span> or create a new site and click <span class="button no_margin">Properties</span>.</li>
	<li>Within the <span class="reference">Site Properties</span> window, select the <span class="button no_margin">Sync</span> tab.</li>
	<li>Click on the <span class="keyword">Synchronise with the following device</span> tick box.</li>
	<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_plus/pbx/cisco_ucm_5.png" alt="Cisco UCM" />
	<li>In the <span class="reference">Host</span> field enter in the IP address of the UCM 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>
	<li>Click on the <span class="button no_margin">Set</span> button 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>
	<li>Finally, click on the <span class="button no_margin">Save</span> button.</li>
</ol> 

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

<h4><a name="5" style="text-decoration: none; color: #36375A;">5.&nbsp; Setting up FTP / SFTP on Cisco UCM to transfer CDRs to TIM Plus</a></h4>

<p>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.</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 Plus.</li>
		<li><b>User Name: </b>as configured within phase <a href="#3">3. Configuring TIM Plus 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 Plus 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><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 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.

Log in to
Referencemacro
Label Cisco UCM Administration
and from the left-hand menu click on the System tab and select Service Parameters.
Choose your UCM node from the Server drop-down list.
Select Cisco Call Manager from the Service drop-down list.
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
Border false
Shadow false
URL /download/attachments/4817082/cisco_ucm_11.png
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.
Click on the Save button.
Click on the Navigation drop-down list from the top right-hand corner, and select
Keywordmacro
Label Cisco Unified Serviceability
. You may need to log in with a user account that has administrative permissions.
Select Tools, then click on the CDR Management tab.
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 the user name for FTP/SFTP transfers you set up in TIM Plus, e.g. TIM
Password: Enter the password for the FTP account you set up in TIM Plus, 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
Border false
Shadow false
URL /download/attachments/4817082/cisco_ucm_6.png
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.