An Input is the system object that connects to a data source, such as PBXs, routers and other telecom signalling equipment, in order to collect the call logging data.
Adding an input
To add a data input, click on the button from either the Summary or the Inputs screen, as shown below:
A new window will open, allowing you to name the input. Click on the button to add the input to the system, as shown below:
The input-configuration screen will be displayed. For information on how to configure these settings, refer to the Configuring an input section below.
Configuring an input
To configure a data input, select it from the All inputs 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:
The settings displayed in this window will be described below:
Name
The Name field allows you to view or edit the name of the selected input. To rename, overtype the current entry.
Type
The Type field allows you to specify the connection method you want to use to collect the data from the phone system. The following connection methods are supported in NetPBX:
Input types
Listener
This method creates a socket and binds it to a specific port, accepting any data received on the connection without challenge.
| Field | Description |
|---|---|
Connection message | An optional greeting message which is sent to any connecting socket. This message can include one or more of the following variables:
|
| Port | The port that the listener should bind to |
| Address family | The address family of the socket |
| Socket type | The type of data flow the socket expects |
| Protocol type | The type of protocol the listener will use |
Serial port
This method allows the connection of a serial (RS-232) device.
| Field | Description |
|---|---|
| Port name | The name of the serial port device, e.g. COM 1, COM 2 |
| Baud rate | The serial port's speed |
Parity | The parity check regime
|
| Data bits | The number of data bits, between 5 and 8 |
Handshake | The type of handshake the serial port requires:
|
| Buffer size | The size of the data buffer of the serial port |
| Buffer threshold | The size that the buffer must first reach before being empty |
| Stop bits | The number of stop bits used |
Client socket
This method creates a TCP socket and connects to a remote host.
| Field | Description |
|---|---|
| Address | The IP address or hostname to which the socket should connect |
| Address family | The address family of the socket |
| Port | The port that the listener should bind to |
| Username | The username required by the data source, if applicable |
| Password | An optional password which is sent upon successful connection |
| IP script | The script file used by NetPBX to check for new data |
Trickle frequency | This option allows you reset the connection between NetPBX and remote host, in case of inactivity. When the system becomes inactive, NetPBX sends a string of data back to the remote host in order to test the connection. Sending the trickle back data will emit a detectable error in case a disconnection has occurred and, thus, will cause the connection to reset. The Trickle frequency option allows you to configure the amount of inactivity that must occur (in miliseconds) before a trickle back is performed. |
| Trickle data | A string containing the data to be sent back |
Pipe server
This method opens a global named pipe and accepts any data that is sent to it.
| Field | Description |
|---|---|
| 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 Nortel CDRClient.dll library and receives data-callbacks whenever the PBX produces data.
| Field | Description |
|---|---|
| Host | The IP address or hostname of the BCM PBX |
| Username | The username required to access the CDR events |
| Password | The password required to access the CDR events |
| App ID | The unique ID number given to each source of data. |
XML file
This method monitors an XML file for new nodes. To specify which nodes to monitor, an XPath query is used; to identify which nodes are new, a unique element is required. Default properties are designed to work with the ticketcollector.xml file produces by an Alcatel OmniPCX Enterprise PBX.
| Field | Description |
|---|---|
| Location | The full filename of the XML file to be monitored. The {app} 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 node | The unique node(element) to be used 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 | The time interval the system is checking for a new node. |
| Delay | A value, in milliseconds, that specifies the artificial delay that is waited when a change in the source XML file is discovered. |
File reader
This method opens a connection to an actual file.
| Field | Description |
|---|---|
| Location | The path of the folder where the file is located |
BCM DCOM
| Field | Description |
|---|---|
| Host | The IP address or hostname of the BCM PBX |
Deleting an input
To delete a data input, select it from the All inputs 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 system, as shown below:
