Configuration file options

<p>This document sets out the settings available to the user within the
software's main configuration file  MAIN.CFG.
 These settings are normally set to the optimum settings, but in
certain installations may need tweaking.  If
you are in any doubt about these settings, do not alter them without
proper guidance.</p>

<table class="confluenceTable">
	<tbody>
		<tr>
			<th class="confluenceTh">Setting</th>
			<th class="confluenceTh">Description</th>
			<th class="confluenceTh" width=100>Default value</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>PBXTemplate</b></td>
			<td class="confluenceTd">Sets the default PBX Template that the system uses when no other routing
takes precedence.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Features</b></td>
			<td class="confluenceTd">A number associated with your registration code enabling certain system
functions.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>VendorImagePath</b></td>
			<td class="confluenceTd">For branding purposes only.  Sets the path to the image that will be
displayed in the top-left corner of the main screen.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>VendorAppTitle</b></td>
			<td class="confluenceTd">For branding purposes only.  Set the application's title as registered
with the operating system.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>VendorScreenTitle</b></td>
			<td class="confluenceTd">For branding purposes only. Sets the main screen's title.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>WebRealmTitle</b></td>
			<td class="confluenceTd">Sets the realm name for anyone accessing the system via its web interface.  Only effective when an HTTP authentication pair (username and
password) is set.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>WebEnabled</b></td>
			<td class="confluenceTd">Determines whether users on the network are able to access system functions via a web browser.</td>
			<td class="confluenceTd"><span class="keyword">true</span> or <span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>HTTPAuthPair</b></td>
			<td class="confluenceTd">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).</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>WWWKeepTempReports</b></td>
			<td class="confluenceTd">Sets whether or not the system discards immediately any temporary files that are created to produce reports, etc.</td>
			<td class="confluenceTd"><span class="keyword">true</span> or <span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>WWWServerIP</b></td>
			<td class="confluenceTd">Sets the IP address or hostname of the local PC.  This is used for
creating cyclical links (in emails and live reports) back to the internal web server.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>WWWServerPort</b></td>
			<td class="confluenceTd">Sets the TCP Port that the internal web server uses.</td>
			<td class="confluenceTd"><span class="keyword">80</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>WWWBind</b></td>
			<td class="confluenceTd">Bind the WWW socket to the IP address and Port as specified in the <span class="keyword">WWWServerIP</span> and <span class="keyword">WWWServerPort</span> settings.  This may be desirable in the case of a computer with multiple IP addresses.</td>
			<td class="confluenceTd"><span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>MultiTask</b></td>
			<td class="confluenceTd">Determines whether a user can access other system functions whilst data is being processed, or whether they must wait until it has finished.</td>
			<td class="confluenceTd"><span class="keyword">true</span> or <span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>CurrencySymbol</b></td>
			<td class="confluenceTd">Sets the currency symbol used throughout the system, including web reports.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>DefaultTariffTable</b></td>
			<td class="confluenceTd">Sets the default tariff table to use when routing doesn't command that another be used.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>MinimumDialledDigits</b></td>
			<td class="confluenceTd">Sets the minimum number of dialled digits an outgoing call record must possess in order not to be discarded as invalid.</td>
			<td class="confluenceTd"><span class="keyword">3</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>FileScout</b></td>
			<td class="confluenceTd">Sets whether the file spooler is active or not.</td>
			<td class="confluenceTd"><span class="keyword">true</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>TCPIPScout</b></td>
			<td class="confluenceTd">Sets whether the system responds to data packets sent over the TCP/IP network, as an alternative to a file, as used in multiple site applications.</td>
			<td class="confluenceTd"><span class="keyword">true</span> or <span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>SerialScout</b></td>
			<td class="confluenceTd">Sets whether the system responds to data packets received via the local PC's serial port.</td>
			<td class="confluenceTd"><span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>DirectWMScout</b></td>
			<td class="confluenceTd">This settings determines whether or not the system responds to Microsoft Windows low-level window notification as a method for sending data.</td>
			<td class="confluenceTd"><span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>TCPServerIP</b></td>
			<td class="confluenceTd">Sets the IP address or host name of the TCP/IP remote PBX data socket.</td>
			<td class="confluenceTd"><span class="keyword">localhost</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>TCPDataPort</b></td>
			<td class="confluenceTd">The TCP Port that the TCPIP data scout uses to receive data packets via.  (Only effective when <span class="keyword">TCPIPScout</span> is set to <span class="keyword">true</span>).</td>
			<td class="confluenceTd"><span class="keyword">23</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>TCPBind</b></td>
			<td class="confluenceTd">Determines whether the TCP/IP remote PBX data socket is bound to the IP address/name and port as specified in the <span class="keyword">TCPServerIP</span> and <span class="keyword">TCPDataPort</span> settings.  In some installations, where a computer has multiple IP addresses, it may be desirable to bind the socket to a specific one, and in this case <span class="keyword">TCPBind</span> would be set to <span class="keyword">true</span>.</td>
			<td class="confluenceTd"><span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>ShowExtensionNamesInLiveView</b></td>
			<td class="confluenceTd">Determines whether an extension's associated name is displayed in place of the basic number on the <span class="reference">Call View</span> screen.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>LiveStats</b></td>
			<td class="confluenceTd">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.</td>
			<td class="confluenceTd"><span class="keyword">true</span> or <span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>StatsFor</b></td>
			<td class="confluenceTd">Sets a particular extension group to monitor, for the <span class="reference">Live Statistics</span> function (if enabled). Partial entries are acceptable, eg. Admini*  would keep statistics for all groups beginning Admini.  The default (<span class="keyword">*</span>) indicates that statistics should be collated for all extensions.</td>
			<td class="confluenceTd"><span class="keyword">*</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>AlwaysPromptUpdate</b></td>
			<td class="confluenceTd">Sets whether or not the system always prompts the user to update their previous call records when a change has been made to the extensions or trunks configuration.</td>
			<td class="confluenceTd"><span class="keyword">true</span> or <span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>AlwaysPromptNewItems</b></td>
			<td class="confluenceTd">Sets whether or not the system always prompts the user to save newly-discovered items such as extensions and trunks, before making changes to their extensions or trunks configuration.</td>
			<td class="confluenceTd"><span class="keyword">true</span> or <span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>TempFileExpiry</b></td>
			<td class="confluenceTd">Sets the life of a temporary file.  The units are days and may be expressed in fractions of days, eg. (1/24 = 0.041 is approximate to 1 hour).  Please note that setting this option to <span class="keyword">0</span> instructs the software to remove temporary files immediately after use.</td>
			<td class="confluenceTd"><span class="keyword">0</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>OverflowFile</b></td>
			<td class="confluenceTd">Sets the path to the file that will store overflowed data received via the other methods of data delivery.  This would not normally be used but is provided in case of emergency.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>OverflowTimeout</b></td>
			<td class="confluenceTd">Sets the length of time in seconds that the system will wait when trying to process any data arriving in its <span class="keyword">\spool</span> sub-folder.  Some applications providing the data may not release the filehandle very quickly causing a sharing violation.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>EmailSRLinkOnly</b></td>
			<td class="confluenceTd">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.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>SMTPHost</b></td>
			<td class="confluenceTd">Sets the SMTP host name or IP address for sending mail via SMTP.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>SMTPPort</b></td>
			<td class="confluenceTd">Sets the SMTP TCP Port that the SMTP mail server is listening on.</td>
			<td class="confluenceTd"><span class="keyword">25</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>SMTPServerName</b></td>
			<td class="confluenceTd">Sets the server name under which the system masquerades when negotiating a connection with the SMTP mail server.  Some SMTP hosts will only communicate with designated named servers.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>SMTPMailFrom</b></td>
			<td class="confluenceTd">Sets the return e-mail address to be used when sending e-mail items.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>MAPIProfile</b></td>
			<td class="confluenceTd">Sets the profile name to be used when the system sends e-mail using MAPI transport, instead of SMTP.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>MAPIPassword</b></td>
			<td class="confluenceTd">Sets the password for the MAPI profile being used, when sending e-mail using the MAPI transport method.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>BillTaxRate%</b></td>
			<td class="confluenceTd">Sets the sales tax (without the % mark) that is applied to Billing Reports only.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Report#Extra</b></td>
			<td class="confluenceTd">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 (1 - 8).</td>
			<td class="confluenceTd"><span class="keyword"># = 1 to 8</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>AutoRestartHour</b></td>
			<td class="confluenceTd">Sets the hour of the day (0-23) that the system will automatically restart itself, giving time to purge temporary files and compact the calls database (if enabled).</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>RestartDelay</b></td>
			<td class="confluenceTd">Specifies the number of seconds to wait, following a request, before the system restarts.  Increasing this setting allows more time for tasks such as closing the database.</td>
			<td class="confluenceTd"><span class="keyword">5</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>OverrideMarkup</b></td>
			<td class="confluenceTd">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 %, but don't include the <span class="keyword">%</span> symbol is NOT required.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>OverrideSurcharge</b></td>
			<td class="confluenceTd">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 should NOT be included.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>TechInfo#</b></td>
			<td class="confluenceTd">Sets the text in the <span class="reference">Help|About</span> box for branding purposes.  For example, you could put your technical support contact number(s) here.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>SaveUnknownItems</b></td>
			<td class="confluenceTd">Sets whether or not the system saves newly-discovered items (extension and trunk numbers) into the 'New Extensions' or 'New Trunks' folders.

<p>If set to <span class="keyword">false</span>, the system prompts the user whether they would like to do this when entering the Extension or Trunk set-up screens.</p></td>
			<td class="confluenceTd"><span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>ShowHighlights</b></td>
			<td class="confluenceTd">Sets whether the call highlighting feature on the <span class="reference">Call View</span> screen is enabled or not.</td>
			<td class="confluenceTd"><span class="keyword">true</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>HighlightColour</b></td>
			<td class="confluenceTd">Specifies the colour to be used when highlighting qualifying calls.</td>
			<td class="confluenceTd"><span class="keyword">ffc0c0</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>UseLocationTable</b></td>
			<td class="confluenceTd">Instructs the system to change the destination of custom dialled numbers as defined in the <span class="keyword">LOCATIONS.CFG</span> file.</td>
			<td class="confluenceTd"><span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>KeepLiveViewData</b></td>
			<td class="confluenceTd">Determines whether or not the information displayed in the <span class="reference">Call View</span> screen persists between application sessions.  If this is set to <span class="keyword">false</span>, any restart of the system will clear the <span class="reference">Call View</span> screen.</td>
			<td class="confluenceTd"><span class="keyword">true</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>AAEvery</b></td>
			<td class="confluenceTd">Sets the number of days between each Automatic Archive, where calls over this period are automatically removed from the database and saved into the <span class="keyword">\backup</span> folder under a unique name.  Setting this to <span class="keyword">0</span> disables the function.</td>
			<td class="confluenceTd"><span class="keyword">0</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>IATTrigger</b></td>
			<td class="confluenceTd">Specifies the time in minutes, after which, if no activity has been logged, an alarm is produced as part of the Inactivity Timer feature.</td>
			<td class="confluenceTd"><span class="keyword">60</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>IATExcludeDays</b></td>
			<td class="confluenceTd">Specify the days (in the abbreviated form of <span class="keyword">ddd</span>) 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' here in order to exclude Saturdays and Sundays.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>IATExcludeHours</b></td>
			<td class="confluenceTd">Specify the hours (in the form <span class="keyword">hh</span>), 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.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>IATAudible</b></td>
			<td class="confluenceTd">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, rather than waiting for an e-mail, etc.</td>
			<td class="confluenceTd"><span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>LogChanges</b></td>
			<td class="confluenceTd">Specifies the filename to be used to store noteworthy information about system activity.  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 <span class="keyword">\config</span> folder and so should not include a path.</td>
			<td class="confluenceTd"><span class="keyword">history.log</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>DCSearchDigits</b></td>
			<td class="confluenceTd">Specifies the number of digits (starting from the leftmost) from which to start matching any dialled number in all tariff tables.  For example, 01614199999 would start searching with '016141' using the default setting.</td>
			<td class="confluenceTd"><span class="keyword">6</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>HighlightDuration</b></td>
			<td class="confluenceTd">Specifies the duration of a call over which it will be highlighted, assuming call highlighting is enabled.</td>
			<td class="confluenceTd"><span class="keyword">1800</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>HighlightCost</b></td>
			<td class="confluenceTd">Specifies the cost of a call over which it will be highlighted, assuming call highlighting is enabled.</td>
			<td class="confluenceTd"><span class="keyword">5.00</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>HighlightNumber</b></td>
			<td class="confluenceTd">Specifies the (partial) dialled number of a call which, if matched, will cause it to be highlighted, assuming call highlighting is enabled.  Please note that simply leaving this option blank (and not removing it), will cause all non-outgoing calls to be highlighted, since their dialled digits will be blank, and indeed match.</td>
			<td class="confluenceTd"><span class="keyword">NONE</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>HighlightExtn</b></td>
			<td class="confluenceTd">Specifies a particular (partial) extension number to highlight, if a call is made from or to that extension/those extensions.</td>
			<td class="confluenceTd"><span class="keyword">nothing</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>HighlightExtnGroup</b></td>
			<td class="confluenceTd">Specifies a particular (partial) extension group to highlight, if a call is made from or to an extension within that group/those groups.</td>
			<td class="confluenceTd"><span class="keyword">nothing</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>PieColour#</b></td>
			<td class="confluenceTd">Specifies the colour to paint each segment in any pie charts.  The value should be specified in the HTML-HexRGB style (eg. ff00ff).  In the case of the Call Geography report, the <span class="keyword">#</span> specifies the slice of the pie chart corresponding to it's associated dialled number, eg. PieColour7 = ffffff would colour the slice corresponding to mobile numbers to white.  This is because 7 is the prefix to mobile numbers, eg. (0)7771234567.</td>
			<td class="confluenceTd"><span class="keyword">#</span> is a number</td>
		</tr>
	</tbody>
</table>