<a id="Adding an input"></a>

Adding an input

To add a new data input, click on the button from either the or the screen, as shown below:

A new window will open, allowing you to name the data input. Enter a name and click on the button, as shown below:

The data input configuration screen will be displayed. To configure these settings, refer to the Configuring an input section.

<a id="Configuring an input"></a>

Configuring an input

To configure a data input, select it from the list, as shown below:

A new window will open on the right-hand side panel, allowing you to configure the settings of your data input:

Name

The field allows you to view or edit the name of the current data input. To rename, overtype the current entry.

Type

The field allows you to specify the connection method by which the data should be collected from the phone system. The following methods are supported:

<a id="Input types"></a>

Input types

Listener

This method creates a socket and binds it to a specific port, accepting any data received on the connection without challenge.

FieldDescription

Connection message

An optional greeting message which is sent to any connecting socket.  This message can include one or more of the following variables:

  • - the IP address of the remote party
  • - the remote party's source port
PortThe port that the listener should bind to
Address familyThe address family of the socket
Socket typeThe type of data flow the socket expects
Protocol typeThe type of protocol the listener will use

Serial port

This method allows the connection of a serial (RS-232) device.

FieldDescription
Port nameThe name of the serial port device, e.g. COM 1, COM 2
Baud rate
The serial port's speed

Parity

The parity check regime

  • none - no parity checking is performed
  • odd  - odd bits parity checking is performed
  • even - even bits parity checking is performed
Data bitsThe number of data bits, between 5 and 8

Handshake

The type of handshake the serial port requires:

  • none - no handshake required
  • rts - Request to Send
  • xonxoff - X-On/X-Off
  • rtsxonxoff - either RTS or X-On/X-Off is used
Buffer sizeThe size of the serial port's data buffer
Buffer thresholdThe size that the buffer must first reach before being empty
Stop bitsThe number of stop bits used

Client socket

This method creates a TCP socket and connects to a remote host.  When the connection is established, optionally, a password can be sent. Thereafter, any data received is accepted.

FieldDescription
AddressThe IP address or hostname to which the socket should connect
Address familyThe address family of the socket
PortThe port that the listener should bind to
UsernameAn optional username which is sent upon successful connection.
Password

An optional password which is sent upon successful connection.

IP script 
Trickle frequency 
Trickle data 

Pipe server

This method opens a global named pipe and accepts any data that is sent to it.

FieldDescription
Pipe name
The name of the pipe that is created
Buffer size
The size of the buffer, in bytes, that is allocated to the pipe.

BCM SSH

This method registers a connection with the  library and receives data-callbacks whenever the PBX produces data.

FieldDescription
Host
The IP address or hostname of the BCM PBX
Username
The username required to access PBX CDR events
PasswordThe password required to access PBX CDR events
App ID 

XML file

This method monitors an XML file for new nodes.  Any new nodes are extracted and presented into a new XML document.  An XPath query is used to specify which nodes to monitor.  A unique element is required to track which nodes are new.  Default properties are designed to workwith the "ticketcollector.xml" file produces by an  PBX.

FieldDescription
Location
The full filename of the XML file to be monitored. The  variable can be used to specify the program data location of the running service
X-Path query
The XPath query to use when testing for new nodes
Checksum nodeThe unique node/element to use to track which nodes have been added since the last check
Outer element

The name of the outer XML element to be used to contain any new nodes when the new XML document is created for output.

Check interval 
DelayA value, in milliseconds, that specifies the artificial delay that is waited when a change in the source XML file is discovered.  If the file were to be accessed immediately upon a change, i.e. without such a delay, the operating system would most likely not allow access to the file so soon, causing a sharing violation.

File reader

This method opens a connection to an actual file. Type the file path in the Location field, as shown below:

BCM DCOM

FieldDescription
HostThe IP address or hostname of the BCM PBX.
<a id="Deleting an input"></a>

Deleting an input

To delete a data input, select it from the list, as shown below:

A new window will open on the right-hand side panel. Click on the  button to remove the input from the list, as shown below: