| Summary_list |
|---|
| Task1 | Adding an input |
|---|
| Task2 | Configuring an input |
|---|
| Task3 | Input types |
|---|
| Task4 | Deleting an input |
|---|
|
| HTML |
|---|
<a id="Adding an input"></a> |
To add a new data input, click on the
button from either the
or the
screen, as shown below:
| Screenshotmacro |
|---|
| Border | false |
|---|
| Shadow | false |
|---|
| URL | /download/attachments/12588757/add_input_1.png |
|---|
|
A new window will open, allowing you to name the data input. Enter a name and click on the
button, as shown below:
| Screenshotmacro |
|---|
| Border | false |
|---|
| Shadow | false |
|---|
| URL | /download/attachments/12588757/add_input_2.png |
|---|
|
The data input configuration screen will be displayed. To configure these settings, refer to the Configuring an input section.
| Screenshotmacro |
|---|
| Border | false |
|---|
| Shadow | false |
|---|
| URL | /download/attachments/12588757/add_input_3.png |
|---|
|
| HTML |
|---|
<a id="Configuring an input"></a> |
To configure a data input, select it from the
list, as shown below:
| Screenshotmacro |
|---|
| Border | false |
|---|
| Shadow | false |
|---|
| URL | /download/attachments/12588757/config_input_1.png |
|---|
|
A new window will open on the right-hand side panel, allowing you to configure the settings of your data input:
| Screenshotmacro |
|---|
| Border | false |
|---|
| Shadow | false |
|---|
| URL | /download/attachments/12588757/config_input_2.png |
|---|
|
The
field allows you to view or edit the name of the current data input. To rename, overtype the current entry.
| Selection_macro |
|---|
| Value | Serial port |
|---|
| Selection | 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:
| HTML |
|---|
<a id="Input types"></a> |
This method creates a socket and binds it to a specific port, accepting any data received on the connection without challenge.
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588757/input_listener.png |
|---|
|
| 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: - - the IP address of the remote party
- - the remote party's source port
|
| 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 |
This method allows the connection of a serial (RS-232) device.
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588757/input_serial.png |
|---|
|
| 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 - none - no parity checking is performed
- odd - odd bits parity checking is performed
- even - even bits parity checking is performed
|
| Data bits | The 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 size | The size of the serial port's data buffer |
| Buffer threshold | The size that the buffer must first reach before being empty |
| Stop bits | The number of stop bits used |
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.
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588757/input_client_socket.png |
|---|
|
| 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 | An optional username which is sent upon successful connection. |
| Password | An optional password which is sent upon successful connection. |
| IP script | |
| Trickle frequency | |
| Trickle data | |
This method opens a global named pipe and accepts any data that is sent to it.
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588757/input_pipe_server.png |
|---|
|
| 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. |
This method registers a connection with the
| Referencemacro |
|---|
| Label | Nortel CDRClient.dll |
|---|
|
library and receives data-callbacks whenever the PBX produces data.
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588757/input_BCM_SSH.png |
|---|
|
| Field | Description |
|---|
Host
| The IP address or hostname of the BCM PBX |
Username
| The username required to access PBX CDR events |
| Password | The password required to access PBX CDR events |
| App ID | |
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
| Referencemacro |
|---|
| Label | Alcatel OmniPCX Enterprise |
|---|
|
PBX.
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588757/input_XML_file.png |
|---|
|
| Field | Description |
|---|
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 node | The 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 | |
| Delay | A 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. |
This method opens a connection to an actual file. Type the file path in the Location field, as shown below:
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588757/input_file_reader.png |
|---|
|
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588757/input_BCM_DCOM.png |
|---|
|
| Field | Description |
|---|
| Host | The IP address or hostname of the BCM PBX. |
| HTML |
|---|
<a id="Deleting an input"></a> |
To delete a data input, select it from the
list, as shown below:
| Screenshotmacro |
|---|
| Border | false |
|---|
| Shadow | false |
|---|
| URL | /download/attachments/12588757/config_input_1.png |
|---|
|
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: