View Source

<p>These instructions should assist in configuring your Cisco UCME / UC500 to 
work with TIM Enterprise. If you are not familiar with PBX 
configuration, please contact your system maintainer.</p>

<div class="panelMacro"><table class="tipMacro"><colgroup><col width="24"><col></colgroup><tbody><tr><td valign="top"><img width="16" height="16" border="0" align="absmiddle" alt="" src="/images/icons/emoticons/check.png"></td><td><b>There are two ways to connect to the Cisco UCME / UC500:</b><br><ol><li><a href="#radius">RADIUS</a> (RADIUS events are recommended by Cisco)</li><li><a href="#syslog">SysLog</a> (Requires SysLog server, not all CDR data received from router)</li></ol></td></tr></tbody></table></div>

<h2><a name="ftp">Cisco UCME / UC500 RADIUS configuration</a></h2>

<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
			</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>IP method</b></td>
			<td class="confluenceTd">The Cisco UCME will need to be configured to send the CDR out using FTP accounting method. The Call Detail Records are sent out via FTP over the network.
			</td>
		</tr>
	</tbody>
</table>

<h4>Configuring your SMDR</h4>

<h6>Download and configure interface file <span class="keyword" style="color: #477FBD;">3CX.zip</span></h6>

<ol class="split start">
	<li>Visit <a href="https://gateway.tri-line.com/">Tri-Line's Portal</a> and download the template file, as shown below:</li>
	<img id="border" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/3cx_1.png" alt="3CX" />
	<li> Extract the <span class="keyword">3CX.zip</span> file to <span class="keyword">C:\Program Files\Tri-Line\TIM Enterprise\config</span> folder. Zip file should contain 
		<span class="keyword">CDRTemplate-Socket.xml</span>, <span class="keyword">3CX.TDT</span> and <span class="keyword">3CX.TDS</span>.</li>
</ol>

<h6>Copy <span class="keyword" style="color: #477FBD;">CDRTemplate-Socket.xml</span> to 3CX server</h6>

<ol class="split">
	<li>Copy <span class="keyword">CDRTemplate-Socket.xml</span> to the 3CX server into <span class="keyword">C:\Documents and Settings\All Users\Application Data\3CX\Data\CDRTemplates</span>.</li>
	<li>Edit <span class="keyword">CDRTemplate-Socket.xml</span> with the IP address of the machine running TIM Enterprise.</li>
	<li>Login to your 3CX server and select <span class="keyword">Settings ? Advanced</span> from the menu.</li>
	<li> Select <span class="button" id="list">CDR output</span> from the <span class="reference">Advanced Settings</span> screen.</li>
	<li>Enable the tick box for <span class="keyword">Output CDR to Socket (Active - Initiates connection)</span> and click <span class="button" id="list">Apply</span>.</li>
	<li> Under 3CX Phone System, click <span class="button" id="list">Service Status</span> and within the <span class="reference">Service Name</span> section select 
		<span class="button" id="list">3CX PhoneSystem Call History</span>.</li>
	<li>Click <span class="button" id="list">Restart</span> to load the new XML file.</li>

</ol>

<h4>Configuring TIM Enterprise</h4>

<p>Below you will find steps on how to configure TIM Enterprise to listen for SMDR data from your Cisco UCME:</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 UCME'.</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 UCME</span> from the PBX model list.</li>
	<img src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucme_1.png" alt="Cisco UCME" />
	<li>In the <span class="button" id="list">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 your username.</li>
	<li>In the <span class="reference">Password</span> field enter in your password.</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_ucme_2.png" alt="Cisco UCME" />
</ol> 

<h4>Configuring the FTP connection</h4>

<p>You will need to configure your Cisco UCME router to transmit the CDR data using the FTP accounting method.</p>

<p>This method will transmit CDR data files in .CSV format to the FTP server configured within the routers IOS configuration.</p>

<p>The machine that TIM Enterprise is installed on will receive the <span class="keyword">.CSV</span> files via FTP and process the data.</p>

<p>The steps required are as follows:</p> 

<ol>
	<li> Login to Cisco router, and type <span class="keyword">enable</span> followed by the <span class="button" id="list">Enter</span> key. (Enter your password if prompted). This will allow you to enter enabled mode 
	and can be confirmed by the command prompt changing to display <span class="keyword">router name #</span>.</li>
	<li>Type <span class="keyword">conf</span> to enter configuration mode. This will be confirmed as a successfully entered because the command line will change to <span class="keyword">router name (config)#</span>.</li>
	<li>Type <span class="keyword">gw-accounting file</span> followed by <span class="button" id="list">Enter</span>.</li>
	<li>Type <span class="keyword">primary ftp server name / username bob password mypass</span>  followed by <span class="button" id="list">Enter</span>.</li>
	<p id="list"><span class="keyword">Server name</span> = The DNS name of the server with TIM Enterprise installed or its <span class="keyword">IP address/</span> = root of FTP server location.</p>
	<p id="list"><span class="keyword">Bob</span> = FTP username configured within TIM Enterprise.</p>
	<p id="list"><span class="keyword">My pass</span> = The FTP password configured within TIM Enterprise.</p>
	<li>Type <span class="keyword">maximum retry-count 3</span> followed by <span class="button" id="list">Enter</span>.</li>
	<li>Type <span class="keyword">maximum buffer-size 25</span> followed by <span class="button" id="list">Enter</span>.</li>
	<li>Type <span class="keyword">maximum fileclose-timer 60</span> followed by <span class="button" id="list">Enter</span>.</li>
	<li>Type <span class="keyword">maximum cdrflush-timer 1</span> followed by <span class="button" id="list">Enter</span>.</li>
	<li>Type <span class="keyword">cdr format detailed</span> followed by <span class="button" id="list">Enter</span>.</li>
	<li>Type <span class="keyword">end</span> followed by <span class="button" id="list">Enter</span>.</li>
	<li>Type <span class="keyword">wr</span> followed by <span class="button" id="list">Enter</span> to save the settings on the routers memory.</li>
	<li>You may now choose any filename, however the extension of the file is unique and should correspond with the <span class="reference">sitecode</span> associated to the Site that has been created in the 
	<span class="button" id="list">Directory</span> tab in TIM Enterprise. To find the 'Unique ID', please follow the following steps:</li>	
	<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>Hover the mouse currsor over the Site that you want to log data for. A tooltip will appear that will have the name of the site and in brackets it will show 'Uinque ID :X', X being a numerical value. 
		The numerical value is the actual 'Unique ID' and this is what the file extension should be set to. For example, if you see Unique ID 41392, then your Unique ID is 41392 and you shouls set the extension of 
		the file that is being written to be TIM Enterprise 'Spool' to '41392' e.g. data.1</li>
		<img src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucme_3.png" alt="Cisco UCME" />
	</ol>
</ol>

<h2><a name="syslog">Cisco UCME SysLog configuration</a></h2>

<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">IP
			</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>IP method</b></td>
			<td class="confluenceTd">The Cisco UCME will need to be configured to send the CDR out using the SysLog accounting method. The Call Detail Records are sent out via UDP over the network.
			</td>
		</tr>
	</tbody>
</table>

<p>You will need to configure your Cisco UCME to send the CDR data out using the SysLog accounting method. This method will broadcast messages via UDP. The machine that TIM Enterprise is installed on will need to have a 
SysLog server installed which can output the information it receives from the Cisco UCME to a file and destination which can be specified to our needs. Kiwi SysLog is a popular SysLog server that has been used 
for implementation with TIM Enterprise successfully.</p>

<h4>Configuring TIM Enterprise</h4>

<p>Below you will find steps on how to configure TIM Enterprise to listen for SMDR data from your Cisco UCME:</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 UCME'.</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 UCME</span> from the PBX model list.</li>
	<img src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucme_4.png" alt="Cisco UCME" />
	<li>In the <span class="button" id="list">Connection</span> tab select <span class="keyword">No connection required</span> from the <span class="reference">Connection method</span> list.</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_ucme_5.png" alt="Cisco UCME" />
	<li>When the connection method is set to <span class="keyword">No connection required</span> this indicates that the SMDR/CDR information is going to be written directly to the TIM Enterprise 
	<span class="reference">Spool</span> folder. The application which writes the file will need to be setup so it writes to file to the following location: <span class="keyword">\program files\tri-line\tim plus\spool\</span>.</li>
	<li>You may now choose any filename, however the extension of the file is unique and should correspond with the <span class="reference">sitecode</span> associated to the Site that has been created in the 
	<span class="button" id="list">Directory</span> tab in TIM Enterprise. To find the 'Unique ID', please follow the following steps:</li>	
	<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>Hover the mouse currsor over the Site that you want to log data for. A tooltip will appear that will have the name of the site and in brackets it will show 'Uinque ID :X', X being a numerical value. 
		The numerical value is the actual 'Unique ID' and this is what the file extension should be set to. For example, if you see Unique ID 41392, then your Unique ID is 41392 and you shouls set the extension of 
		the file that is being written to be TIM Enterprise 'Spool' to '41392' e.g. data.1</li>
		<img src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucme_3.png" alt="Cisco UCME" />
	</ol>
</ol> 

<h4>Configuring the SysLog connection</h4>

<p>You will need to configure your Cisco UCME router to transmit the CDR data using the SysLog accounting method.</p>

<p>This method will transmit CDR data files as events to the syslog server configured within the routers IOS configuration.</p>

<p>The machine that is running the syslog server will receive the events and write them to a file, TIM Enterprise will then process the files.</p>

<p>The steps required are as follows:</p> 

<ol>
	<li> Login to Cisco router, and type <span class="keyword">enable</span> followed by the <span class="button" id="list">Enter</span> key. (Enter your password if prompted). This will allow you to enter enabled mode 
	and can be confirmed by the command prompt changing to display <span class="keyword">router name #</span>.</li>
	<li>Type <span class="keyword">conf</span> to enter configuration mode. This will be confirmed as a successfully entered because the command line will change to <span class="keyword">router name (config)#</span>.</li>
	<li>Type <span class="keyword">wr</span> followed by <span class="button" id="list">Enter</span> to save the settings on the routers memory.</li>
	<li>Download and install Kiwi syslog from <a href="http://www.kiwisyslog.com">http://www.kiwisyslog.com</a>.</li>
	<li>Configure Kiwi to save received data to the spool folder of TIM Enterprise. Click  <span class="button" id="list">File</span> and then <span class="button" id="list">Setup</span>.</li>
	<li>Followed by clicking on <span class="button" id="list">Log to file</span>.</li>
	<li>Within the Path and file name of the log file area, change the path to <span class="keyword">c:\ProgramFiles\Tri-Line\TIM Enterprise\Spool\.X</span> where X is the Site Code number configured within TIM Enterprise. 
	(Pleas see Configuring TIM Enterprise above).</li>
	<img src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucme_6.png" alt="Cisco UCME" />
	<li>Click <span class="button" id="list">Apply</span> followed by <span class="button" id="list">OK</span>.</li>
</ol>