Configuration file options

e.g. 419-258-252-800

Features

A number associated with your registration code enabling certain system functions

• 255: full
• 511: enable voice recording
• 0: demo mode

Expiry

The software expiry date in dd/mm/yyyy format

WebEnabled

Determines whether users on the network are able to access system functions via a web browser

MultiUser

If set to False, the system does not ask for passwords during web and report access. If set to True, the system will be using the information contained in the access.cfg configuration file

WWWKeepTempReports

Sets whether or not the system immediately discards any temporary files that are created to produce reports

WWWServerIP

Integrated web server IP address. Used when generating reports and for the web interface. This is used for creating cyclical links (in emails and live reports) back to the internal web server

WWWServerPort

Integrated web server port number. If default port is used, this does not need to be specified when entering web server IP

WWWBind

Setting this option to True causes the above IP address and port to become bound and is typically used with a computer that has two or more active network cards

IPPBXEnabled

If set to True, enables IP-PBX Connection Parameters

False

IPPBXIP

PBX IP address used by IP-PBX Connection Parameters

192.168.0.1

IPPBXPort

IPPBX port number used by IP-PBX Connection Parameters

4001 

IPPBXUsername

IPPBX username for logging into the PBX

IPPBXPassword

IPPBX password for logging into the PBX

IPScript

IPPBX script used for logging into the PBX

maximiser.ips

TCPIPScout

If set to True, enables Telnet server and allows the system to respond to data packets sent over the TCP/IP network

False

TCPDataPort

Telnet server port number used by the Telnet server; it is effective only when TCPIPScout option is set to True

23

TCPServerIP

Sets the IP address or host name of the TCP/IP remote PBX data socket

127.0.0.1

TCPBind

Determines whether the TCP/IP remote PBX data socket is bound to the IP address/name and port as specified in the TCPServerIP and TCPDataPort settings. In some installations, where a computer has multiple IP addresses, it may be desirable to bind the socket to a specific one

False

LCVGridLines

If set to True, enables grid lines in call view

False

BarColour

Change colour of bar graph generator

000080

BarBackColour

Change colour of bar graph generator

ffffff 

HighlightColour

Specifies the colour for highlighting qualifying calls

ffb0b0

MultiTask

Determines whether a user can access other system functions whilst data is being processed, or whether they must wait until it has finished

True

CurrencySymbol

Sets the currency symbol used throughout the system, including web reports

£

PBXTemplate

The default PBX template used by the application within the Setup|PBX tab

internal.tdt

DefaultTariffTable

The default tariff table used by the system when routing doesn't specify another one to be used

BT

MinimumDialledDigits

Minimum dialled digits defined in Setup|PBX tab

3

DCSearchDigits

Dial code search complexity in Setup|PBX tab

Specifies the number of digits (starting from the leftmost) from which to start matching any dialled number in all tariff tables; e.g. 01614199999 would start searching with 016141 using the default settings

The name and location of the call data discard file

\bad.pbx

If set to False, the call logger stops spooling call data and puts a start button on the bottom left of the main window.

File scout can be stopped by moving the mouse over the status text whilst pressing the SHIFT key on the keyboard. When successfully stopped, the Start button will appear at the bottom-left of the main screen. This feature will only be invoked if the system is not currently engaged with another operation, e.g. processing calls.

FileScout can also be deactivated by holding down the SHIFT key whilst starting application, when the user will be presented with the Controlled Startup dialog window dispalying the following two options:

• Select another template file
• Do nothing extra

True

SerialScout

Sets whether the system responds to data packets received via the local serial port of the PC

False 

DirectWMScout

Turns on TIM’s ability to receive call data via Windows Handle Messaging, which allows applications to send data to eachother without the need to employ networking or shared disk writing/reading. NetPBX is the only other application allowed to send data to TIM in this way.

False 

ShowExtensionNamesInLiveView

If set to True, it will show the extension name in Call view screen rather than the extension number and can be configured from the Setup|PBX tab.

True

SaveUnknownItems

Sets whether or not the system saves newly-discovered items (extension and trunk numbers) into the New Extensions or New Trunksfolders.

If set to False, the system prompts the user to choose whether they would like to do this when entering the Extension or Trunk set-up screens.

True

LogChanges

Stores any significant system changes. If this is missing, it defaults to confighistory.log. This information is useful in determining the sequence of events that lead to an error, for example. The file containing this information is always stored within the \config folder and so should not include a path.

Significant system changes include:

• • Tariff band and dialcode changes, additions and deletions
  • Extension and trunk configuration changes, including additions, renames and deletions
  • Database clearouts
  • Database extension name and trunk name updates
  • Temporary file deletions (manual requests only)
  • Configuration file opens and saves

history.log

Sets the path to the file that will store overflowed data received via the other methods of data delivery. This is not normally used, but is provided in case of emergency.

\timoverflow.pbx

OverflowTimeout

Sets the length of time (seconds) that the system will wait when trying to process any data arriving in its spool folder. Some applications providing the data may not release the file handle very quickly causing a sharing violation.

10

Enables or disables the built-in live statistics as used in call centre applications and which are accessible via the web interface in the form of SSI variables. Can also be set on the Setup|System tab.

True

AlwaysPromptUpdate

Sets whether or not the system prompts the user to update their previous call records when a change has been applied to the extensions or trunks configuration.

True

AlwaysPromptNewItems

Sets whether or not the system prompts the user to save newly-discovered items, such as extensions or trunks, before making changes to the configuration of their extensions or trunks.

True

TempFileExpiry

Sets the life of a temporary file. The units are days and may be expressed in fractions of days, e.g. 1/24 = 0.041 is approximate to 1 hour.

Setting this option to 0 instructs the software to remove temporary files immediately after use.

14

ShowHighlights

Enables highlighting of call records in call view that meet a specific criteria.

True

HighlightDuration

When ShowHighlights = True, any call record greater than a specified duration (seconds) will be highlighted in the Call view screen.

1800

HighlightCost

When ShowHighlights = True, any call record greater than a specified cost will be highlighted in the Call view screen.

5.00

HighlightNumber

Specifies the (partial) dialled number of a call which, if matched, it will be highlighted - assuming call highlighting is enabled.

If the option is enabled and it is left blank, it will cause all non-outgoing calls to be highlighted, since no number has been dialled.

Allows multiple values to be comma-separated, based on a dialled number.

09*

UseLocationTable

Instructs the system to change the destination of custom dialled numbers as defined in the locations.cfg file. This option enables the use of the Locations tab within Tools|Setup

Currently does not work with CLI numbers.

True

InternationalPrefix

Allows the international dialling prefix to be customised, from the default value.

00

ShowOnlyExtnNames

If set to True, all reports will display only the associated name of an extension, without the extension number. This was requested as a security feature, so that users could not easily determine a DDI number, in order to circumvent non-geographic numbers (NGNs).

True

ShowOnlyAccNames

When enabled, shows only account names instead of account numbers, if account numbers are specified.

GlobalHighlights

The globally, use these criteria: option within the Tools|System tab highlights any call record in the Call view screen that meets any one of the following criteria:

HighlightDuration =

HighlightCost =

HighlightNumber =

True

TrunkNumberModifier

Allows the user to amend both the extension number and/or trunk number, as taken from the raw call data.

By specifying a value for either of these CFOs, the amount specified will be added to the number as received in the data from the telephone system.

For example, if  TrunkNumberModifier is set to 1000000, a trunk number originally given as 12 from the PBX, would become 1000012.

These options can help when you need to move extension or trunk numbers out of a certain range. The modified trunk and extension values will be stored in the database with the modified trunk number. However, the backup.pbx or local backup files will preserve the original trunk number values as outputted from the telephone system, thus allowing the user to amend the entire trunk range in the future.

0

See TrunkNumberModifier for an explanation.

This option is not included by default in the main.cfg file.

AEI

0

False 

SWFL

e.g. 1719 

ShowDiagnostics

Indicates whether or not the main screen shows socket diagnostic information at the top-left corner. It is set on/off by ticking Diagnostics menu in the View menu.

False 

IncrementalSpool

When set to True, this option does not delete files in the \spool and appends new call records to the end of the file.

This option is used by AvayaIPOffice and VoiSpeed telephone systems.

True

SpoolFolder

When this option is present, the system looks for the spool files in the specified location, rather than the default location \tim\spool

If the SpoolFolder option is set to blank, the default path becomes the standard path, rather than the root folder, as a security precaution.

This option is used by all VoiSpeed setups and some AvayaIPOffice setups, such as when the Delta Server is running on a different computer than TIM Professional. Typically, a folder containing the SMDR file is shared as a drive letter visible to the call logger.

\Program Files\Avaya\IP Office\SMDR\SMDR_Output\

SpoolFiles

When this option is present, the system processes only the named file as a spool file. Wild cards can be used.

SMDR.CSV

prependCLIZero

If set to True , the system will automatically prepend a '0' (zero) to the CLI on incoming calls.

To disable this features, set the option to False.

TDT Options must appear in the [Options] section of a TDT file.

LastIncrementalCDR

This option is used in conjunction with IncrementalSpool = True and contains a copy of the last call record that the system processed in the \spool folder. This prevents the call logger from reprocessing the entire spool file each time it checks the for new call data.

""

SMTPHost

Sets the SMTP host name or IP address as defined within the Setup|Network tab.

mail.yourcompany.com

SMTPPort

SMTP port number that the email server is listening on, as defined in Setup|Network tab.

25

SMTPServerName

Sets the server name under which the system masquerades when negotiating a connection with the SMTP mail server. Some SMTP hosts will communicate only with designated named servers. This option can also be set within the Setup|Network tab as server greeting name.

Call-logger.yourcompany.com

SMTPMailFrom

Reply-To address when sending emails as defined within the Setup|Network tab.

you@yourcompany.com

EmailSRLinkOnly

Instructs the system to send only a link back to a pre-manufactured file holding the information for a report. It is sent in place of the actual report data where some e-mail systems cannot correctly handle embedded images and other data.

True

RADCheck

For future use to allow auto-updating of TIM software

False

RADHost

For future use to allow auto-updating of TIM software

 setup.tim-professional.com

RADUsername

For future use to allow auto-updating of TIM software

RADPassword

For future use to allow auto-updating of TIM software

CGDivisor

Used by the Call Geography Report, when ChargeBands do not exist, can be used to classify calls.

ChargeBand 

BillTaxRate%

Sets the sales tax (without the % mark) that is applied to billing reports only.

 17.50  

Report#Extra

A string to be prepended to the URL of a report before it is submitted to the report engine. It is used to override certain report settings or apply settings that are commonly used and the user does not want to repeatedly select.  A setting is provided for each Report ID (# can be replaced with the report's ID).

Two new parameters are added to the Billing Report so that a Call Geography summary is shown on the bill, and a further one to remove call itemisation. The parameters are:

showcallprofile = true or false

hidedetails = true or false

The parameters can be appended to the Report2Extra option in the main.cfg file, as shown below:

CustomiseReport1

Enables or disables the use of Report1Headers, Report1Fields and Report1ColWidths

False  

Report1Headers

Specifies the column headers if  All Extension Groups option is selected.

Date & Time,Extension,DialldNumber,CLI,Destination,Trunk,Trunk Name,Time To Answer,Duration,Cost  

Report1Fields

Specifies the column headers if a particular extension is selected after drilling down to this level.

5DateTime,Extension,DialledNumber,CLI,Destination,Trunk,TrunkName,Response,Duration,Cost0  

Report1ColWidths

Specifies the widths of the columns above.

 16,10,10,10,10,10,10,8,8,8 

AAEvery

Sets the number of days between each Automatic Archive, where calls over this period are automatically removed from the database and saved into the \backup folder under a unique name. If this is set to 0 the function is disabled.

LastAADate

1000

AutoRestartHour

Sets the hour of the day (0-23) the system will automatically restart itself, giving time to purge temporary files and compact the calls database, if enabled.

Default value of A means that the system will never auto restart

A

LastRestartID

e.g. 37091

AlertDisk1

Urgent/Critical Alerts log file name and path as defined in Setup|System tab.

\alert1.log

AlertDisk2

Warning Alerts log file name and path as defined in Setup|System tab.

\alert2.log

AlertDisk3

Information Alerts log file name and path as defined in Setup|System tab.

\alert3.log

AlertEmail1

Email address(es) to send Urgent/Critical Alerts notification to.

AlertEmail2

Email address(es) to send warning Alerts notification to.

AlertEmail3

Email address(es) to send information Alerts notification to.

IATTrigger

Specifies the time (in minutes) after which, if no activity has been logged, an alarm is produced as part of the Inactivity Timer feature.

0

IATExcludeDays

Specifies the days (in the abbreviated form of ddd) which do not qualify for the Inactivity Timer, separated by spaces. For example, an organisation whose telephone system may reasonably be inactive over weekends, may specify Sat Sun in order to exclude Saturdays and Sundays.

Sat Sun

IATExcludeHours

Specifies the hours, separated by spaces, during which the Inactivity Timer will not be activated if no data is logged. For example, an organisation whose telephone system is usually inactive outside the hours of 8am and 6pm might include 00 01 02 03 04 05 06 07 19 20 21 22 23 here in order to exclude these hours.

00 01 02 03 04 05 06 07 18 19 20 21 22 23

IATAudible

Specifies that in the event of an alert (as part of the Inactivity Timer feature), in addition to notifying the system administration by e-mail or logging to a file, the PC’s internal bell is also sounded every second. This could be used to ensure that an administrator who is nearby the PC is notified of the inactivity as soon as it occurs.

False

DefaultSTDCode

Default local area code as defined in Setup|Tariffs.

020

AARemoveCalls

It is used to determine whether or not calls are deleted from the database when backed up, using the Automatic Archive feature; it can take a True or False value.

ComplicateCallReference

Prefixes the call reference element v, identifying similar legs of calls with the ddmmyyyy from the call record. This ensures that the complexity of each call reference is made more unique, since when call references reset, it is unlikely they do so on the same day.

True

ConciseGraphs

It specifies the Y-axis in the Trunk Busy report scales, according to the total number of trunks configured in the software or the total number of trunks in the set of data being reported on.

True

EXEName

Specifies the executable file, mainly used in conjunction with the auto restart function ( check the AutoRestartHour option), if the .exe file is different from the standard tim.exe.

tim.exee

FileScoutInterval

Sets the interval at which the system scans for call data files in its \spool folder. Fractions can be expressed as well, e.g. 1.5 seconds.

1

ForceUserFolders

Allows separate HTML content to be forced upon a particular web user. It determines whether or not the web server draws its content from the current user's home folder, which is defined as the username within the \data folder ,e.g. \data\jbloggs

Normal rules about the default document being INDEX.HTML appl.

False

HighlightExtn

It specifies a particular (partial) extension number to be highlighted when a call from or to that extension(s) is made.

HighlightExtnGroup

Specifies a particular (partial) extension group to highlight, if a call is made from or to an extension within that group.

KeepLiveViewData

Determines whether or not the information displayed in the Call View screen persists between application sessions. If this is set to False, any restart of the system will clear the Call View.

Trues

LookupUserNamesFirst

This option instructs the system to look at an extension's label in order to determine its extension number, contrary to the default setting, which is to lookup up a number to determine the label/name. This CFO is immediately configurable in the Update Old Extensions dialog box, by using the tick box Lookup usernames first. Once set this value persists across all sessions, until disabled.

LoopTCP

False

MAPIPassword

Sets the password for the MAPI profile being used, when sending e-mail using the MAPI transport method.

MAPIProfile

Sets the profile name to be used when the system sends e-mail using MAPI transport, instead of SMTP.

MaxDBSize

Changes the default database size from 2000000000. Commas can be used to separate the zeros, but will be ignored. Used in conjunction with ShowDBMeter

[2000000000]

NDSHost

Implemented Nettel integration into TIM where each call that is processed is sent to Nettel whereupon a decision is made by that server as to whether or not to update its own extension status. This is in addition to TIM's own extension status facility. By having this option enabled, call processing is drastically slowed down, because for each call that is processed, a connection is made to a remote server.

NDSPort

8

NewStationUsersGroup

Defines the name of the extension group to which any phantom extensions are added in case station usernames are used instead of extension numbers.

Station Users

OverrideMarkup

Used to override any mark-up that is selected when producing a Billing Report. Even if the user sets their own mark-up, this setting will take precedence. Specify as a percentage without entering the % symbol, as it is not required.

The value used is 100 + markup value. For example, if the mark-up required is 32%, the command used would be:

OverrideMarkup = 132

Using values less than 100 will result in a mark-down of call charges.

OverrideSurcharge

Used to override any surcharge that is selected when producing a Billing Report.  Even if the user sets their own surcharge amount, this setting will take precedence. The currency symbol id not required to be included.

For example, if a surcharge of 65p is required the command would be:

OverrideSurcharge = 0.65

PieColour

Specifies the colour to paint each segment in any pie charts.  The value should be specified in the HTML-HexRGB style, e.g. ff00ff. For the Call Geography report, the # specifies the slice of the pie chart corresponding to its associated dialled number. For example, PieColour7 = ffffff would colour the slice corresponding to mobile numbers to white.

RawBackupFile

See SaveRawBackup above.

\RAWBACKUP.PBX

RestartDelay

Specifies the length of time (seconds) the system has to wait, following a request, before it restarts. Increasing this setting allows more time for tasks such as closing the database.

5

RPCSecurity

Used in conjunction with the Nortel CDRServer connection object, in order to connect to Nortel BCM PBXs. The installation package includes CDRServer.exe and attempts to register it. If the initial registration fails, TIM will automatically try to initialise the component itself before using it.

RPCSecurity = 1 is used in order to implement COM security, which is necessary for proper functioning on most systems. Further, connection to the BCM is achieved by the IPScript, using the command:

oleconnect CDRServer.CDRObj,xxx, where xxx is the IP address or LAN hostname of the BCM unit.

Alternatively, %ip can be used to substitute the IP address of LAN hostname supplied in the application's network set-up screen. The port, username and password fields are not required for connection to the BCM - it requires that the currently logged on user has sufficient privileges to access it via the LAN.

1

SaveRawBackup

It allows you to store an exact copy of the data sent from the PBX.

False

ShowDBMeter

When enabled, displays a database size meter on the main screen with the percentage full in numbers to the right of the icon, in the status bar. The icon will fill with red, as a percentage of the max database size. Default database size is 2Gb. When disabled, shows a database icon with a green tick on top.

See also the MaxDBSize option.

False

ShowExtnNamesOnly

StartStationUserExtn

Sets the beginning of the range at which the system starts to find a spare extension against which to allocate a Station User.

9000

StatsFor

Sets a particular extension group to monitor for the Live Statistics function, if enabled.  Partial entries are acceptable, e.g. Admini* would keep statistics for all groups whose name begins with Admini. The default value indicates that statistics should be collated for all extensions.

*

StripDigits

Strip initial n digits from the dialled number.

0

TCPTimeout

Specifies in seconds, how long the system waits for inactivity on the TCP socket when a remote site sends data to the host; the value cannot exceed 60.

5

TimeStampData

When enabled, a timestamp is added to each CDR that is received over an IP-PBX connection. This happens before the local backup is performed, so that old data preserves their dates and times. The default behaviour for this feature is disabled, in order to maintain backward compatibility.

False

TrackHeaderXXX

If the MultipleHeaders within a TDT file is set to True, this will store the headers in the main.cfg file as TrackHeaderXXX, where XXX is the filename extension associated with the site sending the data. This is to overcome the previous restriction that only one PBX - in a multiple site configuration - could have used the TrackHeader feature in its TDT. This way, each header for any PBX that requires it, is stored separately.

HTTPAuthPair

A base64-encoded string containing the username and password needed to access the system's web functions. This is no longer used; it was superseded by the Users & Passwords function in R157.

ControlPattern

Allows lower strength license checking. Possible values are 1, 2 or 3 and relate to the bit-wise settings, as follows:

It is important to only use these features in case of copy protection issues, such as when the user remotely logs on to the machine running the application, through a Terminal Services-type session, which alters volume information.

ControlDrive

C:\

DefaultLocalBand

User can localise a particular tariff table to a specific band;

Local

False