TCP/IP Collection Agent(3.1)
- Jenni Wallin
The TCP/IP collection agent allows data to be collected and inserted into a workflow, using the standard TCP/IP protocol. Several connections at a time are permitted. It is also possible to send responses back to the source in the form of a bytearray, or when there are several connections as a UDR containing a response field. All response handling is done through APL commands.
The TCP/IP collection agent supports IPv4 and IPv6 environments.
Configuration
The TCP/IP collection agent consists of two tabs: TCP/IP and Decoder.
TCP/IP Tab
| Setting | Description |
|---|---|
Host | Enter the IP address or hostname that you want the collection agent to bind to. If this field is left empty, the agent binds to all IP addresses available on the system. Note! This can be dynamically updated. For further information about updating agent configurations while the workflow is running, see Dynamic Update in /wiki/spaces/MD/pages/3221849. |
Port | Enter the port number from which the data is to be received. Ensure that the port is not used by other applications. Note! The port can also be dynamically updated while the agent is running. Double-click the agent in the Workflow Editor in monitor mode and modify it. To trigger the agent to use the new port, save the workflow. For further information about updating agent configurations while the workflow is running, see Dynamic Update in /wiki/spaces/MD/pages/3221849. |
Allow Multiple Connections | If you select this check box, several TCP/IP connections are permitted simultaneously. If left empty, only one connection at a time is permitted. |
Number of Connections Allowed | If the check box Allow Multiple Connections is selected, enter the maximum number of simultaneous connections required, as a number between 2 and 65000. |
Send Response | If you select this check box, the agent can send a response back to the source. If the check box Allow Multiple Connections is selected, the agent expects a UDR extended with the default TCPIPUDR as a reply. If the Decoder tab is configured so that it produces UDRs that are TCPIPUDR subtypes, then these UDR types are also accepted as input, and the response field must be completed before sending them back to the agent. If the check box Allow Multiple Connections is left empty, the agent also accepts a bytearray. Note! The TCP/IP agent must be connected to an agent using APL code since responses are created with APL commands. |
| Send TCPIPStateUDR | If you select this check box, you can track the connection state of the client. When this option is selected the collection agent sends a udr indicating the status of the client connection each time it changes state. See TCPIPStateUDR in TCPIP Related UDR Types - Collection Agent(3.1). Note! It is not detected if a client is powered down or if its network cable has been removed. |
Note!
If Allow Multiple Connections and Send Response are selected, UDRs are expected as reply back to the collector from the APL agent. Extend the internal format to contain the built-in TCPIP format.
Decoder Tab
For information on how to configure the Decoder tab, see Decoder(3.1).
The configuration is the same in the TCP IP collection agent, except that there is no On Error option for the collection agent.
Extra System Properties
This section describes the extra system properties that you can use to configure the TCP IP Collection Agent.
| Setting | Description |
|---|---|
mz.tcpip.logginginterval_ms | This property allows you to limit the number of exceptions from the TCP Collection Agent to one exception per specified interval (in milliseconds). Only change the property if support has expressly recommended it. It is normally not recommend to set this property. |
Input/Output Data
The agent produces UDRs in accordance with the Decoder tab. If Send Response is enabled, the agent consumes bytearray types for single connections and TCPIPUDR for multiple connections.
This section contains the following subsection: