Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

Summary_list
Task1Adding an input
Task2Configuring an input
Task3Input types
Task4Deleting an input

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

Adding an input

To add a new data input, click on the

Buttonmacro
LabelAdd new
button from either the
Referencemacro
LabelSummary
or the
Referencemacro
LabelInputs
screen, as shown below:

...

A new window will open, allowing you to name the data input. Enter a name and click Click on the

Buttonmacro
LabelAdd
button to add the input to the system, as shown below:

Screenshotmacro
Borderfalse
Shadowfalse
URL/download/attachments/12588757/add_input_2.png

The data input-configuration screen will be displayed. To For information on how to configure these settings, refer to the Configuring an input section below.

Screenshotmacro
Borderfalse
Shadowfalse
URL/download/attachments/12588757/add_input_3.png

...

Screenshotmacro
Borderfalse
Shadowfalse
URL/download/attachments/12588757/config_input_2.png

Name

Selection_macroValueTestSelectionThe settings displayed in this window will be described below:

Name

The

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

Type

Selection_macro
ValueSerial port
SelectionType

The

Referencemacro
LabelType
field allows you to specify the connection method by which you want to use to collect the data should be collected from the phone system. The following connection methods are supported in NetPBX:

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
Borderfalse
URL/download/attachments/12588757/input_listener.png

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:

  • Keywordmacro
    Label{remoteip}
    - the IP address of the remote party
  • Keywordmacro
    Label{remoteport}
    - 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

...

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

Screenshotmacro
Borderfalse
URL/download/attachments/12588757/input_serial.png

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 request to Send
  • xonxoff - X-On/X-Off
  • rtsxonxoff - either RTS or X-On/X-Off is used
Buffer sizeThe size of the data buffer 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

...

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
Borderfalse
URL/download/attachments/12588757/input_client_socket.png

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
Username The username required by the data source, if applicable
PasswordAn optional password which is sent upon successful connection
IP script The script file used by NetPBX to check for new data

Trickle frequency

 Trickle data 

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

Referencemacro
LabelTrickle frequency
option allows you to configure the amount of inactivity that must occur (in miliseconds) before a trickle back is performed.

Trickle dataA 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.

Screenshotmacro
Borderfalse
URL/download/attachments/12588757/input_pipe_server.png

...

This method registers a connection with the 

Referencemacro
LabelNortel CDRClient.dll
library and receives data-callbacks whenever the PBX produces data.

Screenshotmacro
Borderfalse
URL/download/attachments/12588757/input_BCM_SSH.png

FieldDescription
Host
The IP address or hostname of the BCM PBX
Username
The username required to access PBX the CDR events
PasswordThe password required to access PBX 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. Any new nodes are extracted and presented into a new XML document.  An To specify which nodes to monitor, an XPath query is used; to specify identify which nodes to monitor.  A are new, a unique element is required to track which nodes are new.   Default properties are designed to workwith the "work with the ticketcollector.xml" file produces by an  ReferencemacroLabelAlcatel OmniPCX Enterprise PBX.

Screenshotmacro
Borderfalse
URL/download/attachments/12588757/input_XML_file.png

{app} variable can be used to specify the program data location of the running service
FieldDescription
Location
The full filename of the XML file to be monitored. The 
Keywordmacro
Label
X-Path query
The XPath query to use when testing for new nodes
Checksum nodeThe unique node/(element) to use 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.
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: 

Screenshotmacro
Borderfalse
URL/download/attachments/12588757/input_file_reader.png

FieldDescription
Location
The path of the folder where the file is located

BCM DCOM

Screenshotmacro
Borderfalse
URL/download/attachments/12588757/input_BCM_DCOM.png

...

Screenshotmacro
Borderfalse
Shadowfalse
URL/download/attachments/12588757/delete_input.png