|
|
|
|
|
|
InputSettings
The input settings (or input channel settings) are used by the MonTel Server - ServerSv to configure input information. Typically this is via a serial port. However it may be by a file (polled or triggered), TAPI interface or an SQL data base. Items in this section should not be altered if the system was previously working.
This section was introduced in 2.12.0 and replaces the less general SerialPortSettings Section.
InputChannelName
Used by: ServerSV.
Max length: 5 characters
Version 2.12.0 onwards.
Example:
InputChannelName= COM1, COM2, TAPI
This setting is a short name that should reflect the TypeOfInput and perhaps the DeviceOrFileName. This name is used as a key when more than one input channel is specified (see InputChannelNamesList).
Generally the name used should reflect the input device name or a facsimile there of. For example 'COM2' from DeviceOrFileName if TypeOfInput = 0, or for greater values 'FILE1', 'TAPI1' or 'SQL1' or 'POLL1' in increasing order of TypeOfInput.
The short name should be 5 or fewer characters to display correctly in the ServerSv console output and in MtAdmin.
PABXDriverName
Used by: ServerSv.exe
Max length: 14 characters
Example:
PABXDriverName = "CISCOCM4"
Up to version 2.11.32 this was the name of the PABX driver used by the SERVER (16 bit DOS) module, and included the ".drv" extension.
Version 2.12.0 onwards
Moved to [Inputsettings] section from the [SerialPortSettings] section.
From version 2.12 this is the base file name only of the PABX Driver and would only be changed when updating a PABX system. Since the DOS version is no longer included as part of 2.12 (and is not compatible) this setting now replaces PABXDriverNameCN. The extension, that is ".drl" part of the file name is not included. So all that is included is the base name, for example "NEC7400" or "CICOCM4".
SecondsBeforeNoInputReset
Used by: Server.
Server Version 1.3.188 onwards
Example:
SecondsBeforeNoInputReset = 3600
By default this value is blank. If set to a value greater than 0, the MonTel server will wait for the specified number of seconds after the last keyboard input, or character received from the serial port before resetting the serial port and performing a hard ware hang-up to clear the line. This option is really experimental, and should only be used if suggested by MonTel support personnel.
2.12.0 Onwards:
Moved to the [InputSettings] section from the [MonTelServer] section.
TypeOfInput
Used by: Server.
Version 2.9.67 onwards
Range: 0 - 4.
Example:
TypeOfInput = 0
Usually this value should be left at its default of 0. On some newer PABX systems (typically VO/IP) the SMDR output is to a text file.
When TypeOfInput is 1, The MonTel Server will read from a file, where the file path and name is specified in the SerialPort field. The MonTel Server will save an "index" file which records the name of the file and the file length, so that if the server if existed it can pick up processing at the correct point, and also check if the file is new.
TypeOfInput = 2 is for a TAPI interface.
TypeOfInput = 3 is for a ODBC interface, though none are in use currently.
Version 2.11.4 onwards
TypeOfInput = 4 is a polled input that works in the same way as type 1 did.
TypeOfInput now waits until the operating system reports changes in the folder,which will cut down the amount of file I/O and system resources being used.
Version 2.12.0 onwards
Moved to [Inputsettings] section from the [SerialPortSettings] section.
DeviceOrFileName
Used by: Server.
2.12.0 onwards
Example:
DeviceOrFileName = COM1
This setting identifies the input device, whether it be File, Serial port or some other settings for the MonTel Server. If is is a serial port (that is when TypeOfInput is 0) then the name is the serial port number of the device name if open as a file, typically this would be COM1 or COM2.
When TypeOfInput is 1 or 4, SerialPort is used for the path and file name to the input data file. The name can be further modified by the AppendDate and DateFormat settings.
When TypeOfInput is 2 (TAPI) this value is not used.
AppendDate and DateFormat settings allow you to add extra character to what appears in DeviceOrFileName and not just the date and time, so it would be quite acceptable to have the path in DeviceOrFileName, with AppendDate =1 and the date format holding the file name and extension.
This setting replaces SerialPort in the [SerialPortSettings] section.
DeviceOrFileName must be specified in full. That is single digits such as 1 will no longer be read as COM1 as was the case with SerialPort.
AppendDate
Used by: Server.
Version 2.9.67 onwards
Range: 0 - 1.
Example:
AppendDate = 0
If this value is set to 1 then a date value (and other values) is appended to the file name and path (in the SerialPort setting). This value is ignored is TypeOfInput = 0. The date value is found in the DateFormat setting.
2.12.0 Onwards:
Moved to the [InputSettings] section from the [SerialPortSettings] section.
DateFormat
Used by: Server.
Version 2.9.67 onwards
Max length: 80 characters
Example:
DateFormat = "_%y-%m-%d"
When Appenddate is set to 1, the string generated by the values above is appended to the file name. The format can be any string values up to 80 characters in length and can include the following special formatted characters:
%% |
Character % |
|
%a |
Abbreviated weekday name |
|
%A |
Full weekday name |
|
%b |
Abbreviated month name |
|
%B |
Full month name |
|
%c |
Date and time |
|
%d |
Two-digit day of month (01 - 31) |
|
%H |
Two-digit hour (00 - 23) |
|
%I |
Two-digit hour (01 - 12) |
|
%j |
Three-digit day of year (001 - 366) |
|
%m |
Two-digit month as a decimal number (1 - 12) |
|
%M |
Two-digit minute (00 - 59) |
|
%p |
AM or PM |
|
%S |
Two-digit second (00 - 59) |
|
%U |
Two-digit week number where Sunday is the first day of the week (00 - 53) |
|
%w |
Weekday where 0 is Sunday (0 - 6) |
|
%W |
Two-digit week number where Monday is the first day of week the week (00 - 53) |
|
%x |
Date |
|
%X |
Time |
|
%y |
Two-digit year without century (00 to 99) |
|
%Y |
Year with century |
2.12.0 Onwards:
Moved to the [InputSettings] section from the [SerialPortSettings] section.
BaudRate
Used by: Server.
Example:
BaudRate = 9600
Serial port settings for the MonTel Server. Can be 110, 150, 300 ,600, 1200, 2400, 4800, 9600 or higher depending on the serial port. (Remember that this is likely to be on an old and slower DOS machine).
Version 2.10.10 until version 2.12.27
This value is also used When TypeOfInput is 4 (polled file). When set to a value between 1 and 299 inclusive if becomes a value in seconds for the number of seconds between checking the length that a SMDR data file has changed length (indicating more input is available). This reduces network load by not checking the length of the file during each cycle of the processing loop, which might happen many (perhaps hundreds or thousands of) times a second, to more than once in the delay period specified. If the value is 300 or greater, it is assumed to be a left over baud rate, and the delay period is set to 0, meaning that this value is ignored.
Note: System wait file input (TypeOfInput is 1) tests any change in both file lens of date-time in the specified folder, but relies on meta information propagated by the network and operating system.
2.12.28 onwards
Removed the polled file value. See CheckFileLenFrequency.
2.12.0 Onwards:
Moved to the [InputSettings] section from the [SerialPortSettings] section.
StopBits
Used by: Server.
Example:
StopBits = 1
Serial port settings for the MonTel Server. Can be 1 or 2.
2.12.0 Onwards:
Moved to the [InputSettings] section from the [SerialPortSettings] section.
DataBits
Used by: Server.
Example:
DataBits = 8
Serial port settings for the MonTel Server. Either 7 or 8.
~Version 2.9.69 onwards
This value is also used When TypeOfInput is 1. When TypeOfInput=1 the MonTel Server checks to see if the date/time stamp of the file specified in the SerialPort field has changed so it can process incoming data. In some situations the network operating system does not pass on the file date time stamp correctly (this has been observed as a problem only over network drives), and so MonTel thinks that the file length has stayed the same when it has in fact increased. To get around this problem (at the expense of more network traffic) if (and only if) DataBits = 1 the Server will check to see if the length of the file has changed. For another option to reduce network load see: BaudRate.
2.12.0 Onwards:
Moved to the [InputSettings] section from the [SerialPortSettings] section.
Parity
Used by: Server.
Example:
Parity = None
Serial port settings for the MonTel Server. Odd, None, Even (and now Mark and Space).
2.12.0 Onwards:
Moved to the [InputSettings] section from the [SerialPortSettings] section.
Handshake
Used by: Server.
Example:
Handshake = None
Serial port settings for the MonTel Server. Note that these settings will override a default value in the PABX Driver.
Allowed values are DEFAULT (to user the drivers settings), NOHANDSHAKE, XONXOFF, XONXOFFCTS (sort of belts AND braces), RTSCTS, HARDWARE, DTRDSR, TRANPARENTXONXOFF.
Generally the default is HARDWARE. Use NONE or XONXOFF for three wire cables. Use XONXOFFDTR for multiwire cables when you are not sure if the PABX also uses XONXOFF.
XONXOFF, XONXOFFDTRTIMED and XONXOFFTIMED cn be used with SecondsTillAutoResendXon below.
2.12.0 Onwards:
Moved to the [InputSettings] section from the [SerialPortSettings] section.
SendStartChar
Used by: Server.
Example:
SendStartChar =0
Some serial connection won't start with out receiving some data (even XONXOFF). Should be 0, but some times 1 so send some data to the pabx. Note that some systems will fail to work if this is set on.
2.12.0 Onwards:
Moved to the [InputSettings] section from the [SerialPortSettings] section.
CheckFileLenAsWellAsDateTime
Topic creation date: 2010-06-02
Used by: ServerSv.
Version 2.12.28 onwards
Value: 0 or 1
Example:
CheckFileLenAsWellAsDateTime = 1
When TypeOfInput is 4 it is polled file based. By default, polled file based input only checks that file date has changed, before checking the length to see if there are new records. When CheckFileLenAsWellAsDateTime = 1 then the file size if checked as well, even if the date-time appears not to have changed. This may add some network as the file is polled continuously. To reduce this see CheckFileLenFrequency.
The default is 0 (or only check that the write date-time of the file has changed).
CheckFileLenFrequency
Topic creation date: 2010-06-02
Used by: ServerSv.
Version 2.12.28 onwards
Value: 0 - 3600
Example:
CheckFileLenFrequency = 10
Used when TypeOfInput is 4 it is polled file based. Only valid when CheckFileLenAsWellAsDateTime = 1.
To reduce network traffic when CheckFileLenFrequency is greater than 0 (and less than 3600) , then this becomes a value in seconds for the number of seconds between checking the length that a SMDR data file has changed length (indicating more input is available). When set to zero and CheckFileLenAsWellAsDateTime = 1 then the file is polled continuously, which might happen many (perhaps hundreds or thousands of) times a second.
OpenFileAndSeekToEndFrequency
Topic creation date: 2010-06-02
Used by: ServerSv.
Version 2.12.28 onwards
Value: 0 - 3600 (0 is off)
Example:
OpenFileAndSeekToEndFrequency = 0
This setting has been introduced to fix a problem that may only exist in Windows XP Service Pack 2, running on networks with newer file servers. XP should be upgraded to Service Pack 3. The problem manifests itself, by not updating the file meta information, specifically the date or the file length over a network, that file based input (TypeOfInput = 1 or 4) needs to be able to tell if there is a new call record.
When the value of OpenFileAndSeekToEndFrequency is greater than 1 (and implicitly less than 3600 for future versions), the MonTel server will open the file specified DeviceOrFileName in at the specified frequency in seconds. The minimum of once a second will only create minimal network traffic, as all that happens, is that the file is opened, a seek to the end of file performed and the file is immediately closed. A value or 5 seconds would give the best performance in terms of user expectations and minimal network load.
Do not use this setting with out contacting support@netwiz.com.au in case there are better remedies available.
StartString
Used by: Server.
Example:
StartString = ""
For the PABX's that require a logon. The value is a string of characters to be sent to the serial port by the server to log onto a PABX. MonTel will proceed after a short count down if it does find recognisable strings. MonTel will "look for" sub strings enclosed in a <> pair, and send characters out side of the <>.
2.12.0 Onwards:
Moved to the [InputSettings] section from the [SerialPortSettings] section.
SecondsTillAutoResendXon
Used by: ServerSv.
Example:
SecondsBeforeNoInputReset= 0
This setting is only relevant if the input channel is a COM port using some form of XON-XOFF handshaking. When set it will send a XON Character every number of seconds specified to keep data flowing in case the PABX has mistakenly thought it has received am XOFF. The default is 0. A setting of zero, will not send an Xon. SecondsTillAutoResendXon=10 will send an Xon every 10 seconds. A message will be displayed if the Com Port was disabled at the time the it was auto re-enabled by MonTel Server. The COM Port status line status line displays if the Com port is enabled. On the Console version of ServerSv press 's' to disable the com port, and SPACE or ENTER to enabled it.
2.12.0 Onwards:
Moved to the [InputSettings] section from the [SerialPortSettings] section.
