To open the TCP/IP collection agent configuration, click Build → New Configuration. Select Workflow from the Configurations dialog. When prompted to Select workflow type, select Realtime. Click Add agent and select Tcp Ip from the Agent Selection dialog. Double-click the agent icon or right-click the icon and select Edit agent, to display the Agent Configuration dialog.
TCP/IP Tab
TCP/IP collection agent configuration dialog - TCP/IP tab
| Setting | Description |
|---|---|
Host | The IP address or hostname to which the TCP collector connects. If the host is connected the port must also be connected. If left empty, the TCP collector connects to all IP-addresses available in the system. Note! This setting can be dynamically updated. |
Port | The port number from which the data is received. Make sure 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. Save the workflow to trigger the agent to use the new port. For further information about updating agent configurations while a workflow is running, see Dynamic Update in L -1.2 Administration and Management. |
Allow Multiple Connections | Select this checkbox to allow several TCP/IP connections simultaneously. If cleared, only one connection is allowed. |
Number of Connections Allowed | If Allow Multiple Connections is selected, enter a number between 2 and 65000 to specify the number of allowed connections. |
Send Response | Select this checkbox to have the collector send a response back to the source. If Allow Multiple Connections is selected, the collector expects a UDR extended with the default TCPIPUDR as a reply. If the checkbox is cleared, it expects a bytearray. Note! Drag and drop in the opposite direction in the workflow to create a response route between the agents. The TCP/IP agent must be connected to an agent utilizing APL, since responses are created using APL commands.
For a description of the differences between single or multiple connections, see A TCP/IP Example. |
| Send TCPIPStateUDR | Select this checkbox to track the connection state of the client and have the collection agent send a UDR indicating the status of the client connection each time it changes state. See TCPIPStateUDR in TCP/IP Related UDR Types. Note! This information is not detected if a client is powered down or if its network cable is removed. |
Decoder Tab
TCP/IP collection agent configuration dialog - Decoder tab
| Setting | Description |
|---|---|
Decoder | Click Browse to select from a list of available decoders created in the Ultra Format Editor, as well as the default built-in decoders:
Different settings are available depending on the Decoder you select. |
| Full Decode | This option is only available when you have selected a decoder created in the Ultra Format Editor. Select this option to fully decode the UDR before it is sent out from the decoder agent. This action may have a negative impact on performance, since not all fields may be accessed in the workflow, making decoding of all fields in the UDR unnecessary. If it is important that all decoding errors are detected, you must select this option. If this checkbox is cleared (default), the amount of work needed for decoding is minimized using "lazy" decoding of field content. This means that the actual decoding work may be done later in the workflow, when the field values are accessed for the first time. Corrupt data (that is, data for which decoding fails) may not be detected during the decoding stage, but can cause a workflow to abort later in the process. |
| MZ Tagged Specific Settings | |
Tagged UDR Type | Click the Add button to select from a list of available internal UDR formats stored in the Ultra and Code servers to reprocess UDRs of an internal format and send them out. If the compressed format is used, the decoder automatically detects this. |
| JSON Specific Settings | |
UDR Type | Click Browse to select the UDR type you want the Decoder to send out. You can either select one of the predefined UDRs or the |
| Unmapped Fields | If you have selected DynamicJson as UDR Type, you can select the option data in this field in order to include payload. If you have selected another UDR type that contains an any, or a map field, you can select to put any unmapped fields into the field you select in this list. All fields of any or map type in the selected UDR type will be available. If set to (None), any unmapped fields will be lost. |
| Schema Path | Enter the path to the JSON schema you want to use in this field. |
| CSV Specific Settings | |
| UDR Type | Click Browse to select the UDR type you want the Decoder to send out. You can either select one of the predefined UDRs or the DynamicCsv UDR if the CSV format is not known. |
| Format | Select the CSV format you want to use; Unix, Mac, Windows, or Excel, or select to define your own customized format. If you select Custom, the following four settings will be enabled. |
| Delimiter | Enter the delimiter character(s) for the fields in the CSV. |
| Use Quote | Select this option if quotes are used in the CSV. |
| Quote | If Use Quote is selected, enter the type of quotes used in the CSV. |
| Line Break | Enter how line breaks are expressed in the CSV. |
| Setting | Description |
|---|---|
Decoder | List holding available decoders introduced via the Ultra Format Editor. The decoders are named according to the following syntax:
The option MZ Format Tagged UDRs indicate that the expected UDRs are stored in one of the built-in |
Tagged UDR Type | List of available internal UDR formats stored in the Ultra and Code servers. The formats are named according to the following syntax:
If the decoder is to reprocess UDRs of an internal format, the Decoder MZ format tagged UDRs has to be selected to enable this list. Once enabled, the internal format may be selected. |
Full Decode | If enabled, the UDR will be fully decoded before inserted into the workflow. This may have a negative impact on performance since all fields may not be accessed in the workflow, making decoding of all fields unnecessary. If disabled (default), the amount of work needed for decoding is minimized, using a "lazy" method decoding sub fields. This means the actual decoding work may not be done until later in the workflow, when the field values are accessed for the first time. Corrupt data (that is, data for which decoding fails) may not be detected during the decoding stage and could cause the UDR to be discarded at a later processing stage. |
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. |