| Summary_list |
|---|
| Task5 | Settings |
|---|
| Task1 | Overview |
|---|
| Task2 | Summary |
|---|
| Task3 | Inputs |
|---|
| Task4 | Outputs |
|---|
|
| HTML |
|---|
<a id="Overview"></a> |
Overview
To configure a controller, select it from the
list, as shown below:
| Screenshotmacro |
|---|
| Border | false |
|---|
| Shadow | false |
|---|
| URL | /download/attachments/12588544/config_controller.png |
|---|
|
The
screen will appear, allowing you to configure the inputs and outputs of the selected controller:
Summary
The
section allows you to add, view or edit the data inputs and outputs of the selected controller. From this section you can navigate to the full list of inputs/outputs, but also to the settings of a specific input or output, by clicking on the relevant link:
| Screenshotmacro |
|---|
| Border | false |
|---|
| Shadow | false |
|---|
| URL | /download/attachments/12588544/config_controller_1.png |
|---|
|
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/12588544/config_controller_2.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/12588544/config_controller_3.png |
|---|
|
The new input will be added to the
list, as shown below:
| Screenshotmacro |
|---|
| Border | false |
|---|
| Shadow | false |
|---|
| URL | /download/attachments/12588544/add_input.png |
|---|
|
To configure a data input, select it from the
list, as shown below:
| Screenshotmacro |
|---|
| Border | false |
|---|
| Shadow | false |
|---|
| URL | /download/attachments/12588544/config_input_1.png |
|---|
|
A new window will open on the right-hand side panel, allowing you to configure the settings of your data output:
| Screenshotmacro |
|---|
| Border | false |
|---|
| Shadow | false |
|---|
| URL | /download/attachments/12588544/config_input_2.png |
|---|
|
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:
- Listener
- Serial port
- Client socket
- Pipe server
- BCM SSH
- XML file
- File reader
- BCM DCOM
Listener
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/12588544/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 |
Serial port
This method allows the connection of a serial (RS-232) device.
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588544/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 |
| 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 |
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.
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588544/input_client_socket.png |
|---|
|
| Field | Description |
|---|
| Address | The IP address or hostnameto 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 | |
Pipe server
This method opens a global named pipe and accepts any data that is sent to it.
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588544/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. |
BCM SSH
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/12588544/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 | |
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
| Referencemacro |
|---|
| Label | Alcatel OmniPCX Enterprise |
|---|
|
PBX.
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588544/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. |
File reader
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588544/input_file_reader.png |
|---|
|
BCM DCOM
| Screenshotmacro |
|---|
| Border | false |
|---|
| URL | /download/attachments/12588544/input_BCM_DCOM.png |
|---|
|
Outputs
| HTML |
|---|
<a id="Settings"></a> |
Settings