<a id="Overview"></a>

Overview

To configure a PBX, locate the object in the Directory, click on it and select Properties from the drop-down list, as shown below:

A new window will open, allowing you to configure the properties of your PBX object, as shown below:

<a id="General"></a>

General

This tab allows you configure the general properties of your PBX object, which are described in the table below:

Field

Description

Name

The name by which you want your PBX to be identified. Usually, the make or model name of your PBX is used.

Unique ID

The unique ID of the site object.

Time zome

Broadcast CDRs from this PBX

Keep a local backup of data

Tick this box to backup your call logging data and enter the location of the folder you want to store these files.

The default path is {app}\backup\backup-{year}-{month}-{day}.{uiv} and can contain dynamic variables, as detailed below:

Item	Description
app	The full installation path of TIM Enterprise
year	The year the data was captured in yyyy format
month	The month the data was captured in mm format
day	The day of the month when data was captured in dd format
uiv	The unique ID representing each site in the Directory

Data format

Each telephone system outputs its call logging data in a different format. Select your PBX model from the list provided to ensure your calls are logging correctly.

<a id="Connection"></a>

Connection

This tab allows you to configure the connection parameters of your telephone system. The properties presented in the section will vary, depending on the connection method used by your telephone system to provide call logging data. Each type of connection is described below:

Receive FTP transfers from PBX

Field	Description
Username	The username of the FTP account on your telephone system.
Password	The password of the FTP account on your telephone system.

Establish TCP connection to this PBX

Field	Description
Host	The IP address of the telephone system.
Port	The port number that your telephone system listens on.
Username	The username required to log in to your telephone system, if applicable.
Password	The password required to log in to your telephone system, if applicable.
IP script	The script file that TIM Enterprise uses when checking for new data.

Listen for connection to this PBX

Field	Description
Host	Specify the IP address of your PBX to only allow data to be sent from that address. You may leave this field blank to accept data from any IP address.
Port	The port number that TIM Enterprise should listen on for call logging data.

System DSN connection

Field	Description
DSN name	The name of the system DSN connection to use when connecting to your telephone system's database.
Frequency	The frequency, in seconds, of the checks that TIM Enterprise makes when connecting to the database to determine if new data is available.
DB Script	The database script that TIM Enterprise uses when checking for new data.

RADIUS connection

Field	Description
Client IP	The IP address of your telephone system responsible for sending RADIUS packets.
Secret	The secret key used in RADIUS authentication between TIM Enterprise and your telephone system.

Syslog connection

Field	Description
Client IP	The IP address of your telephone system responsible for sending SysLog events to TIM Enterprise.

For detailed information about connecting to all makes/models of PBX, refer to the Connecting to your PBX section.

Connection options

Option	Description
Binary data	Select this option if your telephone system sends call records in a non-textual format.
Timestamp data	TIM Enterprise can timestamp call records from your telephone system as they are received, if they do not already include dates and times.
Delay processing by	Enable this option and enter a time delay, in milliseconds, if call records are sent from your telephone system over a slow connection. This helps to prevent data loss when call records are processed before they are fully received.

<a id="Inactivity"></a>

Inactivity

This tab allows you to set up an inactivity timer, which can notify you by e-mail when TIM Enterprise has not received data from your telephone system for a given amount of time.

Enable inactivity timer

Select this option to enable inactivity monitoring for the site you are configuring. Enter the amount of time, in minutes, that must pass with no call activity, before an e-mail is sent. Next, enter the e-mail address that will receive inactivity alerts for this site.

Reset connection on inactivity

TIM Enterprise can reset the network connection to your telephone system when an inactivity alert is sent, in order to cause the telephone system to restart its connection.

Exclude days and hours from inactivity monitoring

Tick the box alongside the days and hours when it is legitimate that no call activity takes place, such as at night or at weekends, so as not to receive unnecessary e-mail notifications for those periods.

<a id="Options"></a>

Options

This option when enabled restricts users/groups within the site so if anyone takes out a user from the PBX level and places it outside in a group (which they shouldn't), it will create the extension again and place it back into the "Discovered Users" folder. This option by default will be off and will only be used by us if we think it's necessary for the client in question.

<p>To edit a PBX, simply left-click on it and select <span class="button">Properties</span> from the pop-up menu, as shown below:</p>

<img class="screenshot" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx_properties_1.png" alt="PBX properties" />

<h2>General properties</h2>

<p>In the <span class="button">General</span> tab, type in the name of your PBX, select the data format required and enable the local backup.</p>

<p>The setting will vary depending on the PBX being connected. The examples
below show the general setting for a and Cisco UCM and Avaya IP Office.</p>

<h5>Cisco UCM properties</h5>

<p>Please select <span class="keyword">Cisco UCM 5+</span> from the PBX model list and enable the local backup.</p>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucm_4.png" alt="Cisco UCM" />

<h5>Avaya IP Office properties</h5>

<p>Please select <span class="keyword">Avaya IP Office 6+</span> from the PBX model list and enable the local backup.</p>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/avaya_ip_office_5.png" alt="PBX properties" />

<h2>Connection</h2>

<p>Click on the <span class="button">Connection</span> tab and select the <span class="reference">Connection method</span> to be used. Please note that the connection method will vary from PBX to PBX. The default boxes in the <span class="reference">Connection details</span> section will change to suit the connection method selected and will only allow you to enter details relevant to that connection method.</p>

<h5>Cisco UCM properties</h5>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/cisco_ucm_5.png" alt="PBX properties" />

<p>Follow these steps to set the connection properties for your PBX:</p>

<ol>
	<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>
</ol>

<h5>Avaya IP Office properties</h5>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/pbx/avaya_ip_office_6.png" alt="PBX properties" />

<p>Follow these steps to set the connection properties for your PBX:</p>

<ol>
	<li>In the <span class="button no_margin">Connection</span> tab select <span class="keyword">Listen for connection from PBX</span> from the <span class="reference">Connection method</span> list.</li>
	<li>In the <span class="reference">Port</span> field enter in <span class="keyword">9000</span>.</li>
	<li>Finally, click on the <span class="button no_margin">Save</span> button.</li>
</ol>

<h2>Inactivity</h2>

<p>TIM Enterprise can alert you when your phone system has become <b>inactive</b>, meaning it hasn't provided any call record data for a time, possibly indicating a fault.</p>

<h4>Trigger</h4>

<p>To set up an inactivity alert, tick the box inside the <span class="reference">Trigger</span> 
section, choose the amount of time that there must be inactivity from 
your phone system for it to be considered inactive, then specify an 
email address to send an inactivity warning alert to.</p>

<p>Inactivity from your telephone system can be caused by a network failure
 between your phone system and the machine running the TIM Enterprise 
software.  In some cases, resetting the connection can force the phone 
system to reconnect.  If you want TIM Enterprise to reset the connection
 when inactivity is detected, tick the box alongside that option.</p>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/avaya_ip_office_inactivity.png" alt="PBX Inactivity" />

<h4>Exclusions</h4>

<p>Inactivity might not always be as a result of a fault.  Your 
organisation's normal work patterns might mean that the phone system is 
naturally inactive between certain hours or on certain days (e.g. at 
weekends). In this case, it is prudent to exclude those periods when 
inactivity may naturally occur, so that an alarm isn't sent 
unnecessarily during those times.  Tick the boxes alongside the days and
 hours that you expect your phone system to naturally be inactive.</p>

<h2>Options</h2>

<p>This option when enabled restricts users/groups within the site so if anyone takes out a user from the PBX level and places it outside in a group (which they shouldn't), it will create the extension again and place it back into the "Discovered Users" folder. This option by default will be off and will only be used by us if we think it's necessary for the client in 
question.</p>

<p>The example below shows the options for an Avaya IP Office.</p>

<img class="screenshot border" src="http://www.tri-line.com/common/img/documentation/tim_enterprise/avaya_ip_office_options.png" alt="PBX properties" />