The Push Text to an External TCP Socket Output Connector can be used to push event data, adapted and formatted as delimited text, to an endpoint address using a TCP socket connection. The delimiter between attribute values is often a comma, so the type of data adapted by this output connector is sometimes referred to as comma separated values text. ArcGIS GeoEvent Server can use any normal ASCII character as a delimiter to separate data attribute values.
Usage notes
- This output connector pairs the Text Outbound Adapter with the TCP Outbound Transport.
- The connector is frequently used to push simulated event data records to GeoEvent Logger.
- By default, the connector opens a TCP socket on port 5575, however any available server port can be used.
- Multiple Push Text to an External TCP Socket outputs can be configured sharing the same port. However, it is recommended different feeds of event data use their own output connectors and ports.
- A Message Separator is required. This single character specifies the end of an event record. A newline (\n) is a common end-of-record delimiter.
- An Attribute Separator is required. This single character separates one attribute value from another. A comma (,) is a common attribute delimiter.
Parameters
| Parameter | Description |
|---|---|
| Name | A descriptive name for the output connector used for reference in GeoEvent Manager. |
Host (Client Mode) | The host address GeoEvent Server will establish a TCP socket connection to. The default is localhost, but any accessible hostname or IP address can be specified. |
Server Port | The server port to use when establishing the TCP socket connection. GeoEvent Server must be able to discover and connect over this port. The default is port 5575, but any available server port can be specified. |
Connection Timeout (Client Mode) | Specifies the amount of time, in seconds, GeoEvent Server will attempt to make a TCP socket connection to the remote server as a client. If a TCP socket connection cannot be established in the specified amount of time, the output connector will report an error. |
Message Separator | A single literal character which indicates the end of an event data record. Unicode values may be used to specify a character delimiter. The character should not be enclosed in quotes. A newline (\n) is a common end-of-record delimiter. The default is a newline (/n). The outbound message will contain event data records separated by a newline. |
Attribute Separator | A single literal character used to separate one attribute value from another in a message. Unicode values may be used to specify a character delimiter. The character should not be enclosed in quotes. A comma (,) is a common attribute delimiter The default is a comma (,). The outbound message will be comma separated text. |
Output Date Format | Specifies the format of date/time values written to the file. The available output date formats are ISO 8601 Format or a Custom Format. The default is ISO 8601 Format.
|
Custom Date Format (Conditional) | The custom format for date/time values written to the file. The custom date format should be constructed using the Java SimpleDateFormat class convention. For more information, see the SimpleDateFormat. This property is shown when Output Date Format is set to Custom Format and is hidden when set to ISO 8601 Format. |
Language for Number Formatting | The locale identifier (ID) used for locale-sensitive behavior when formatting numbers from data values. The default is the locale of the machine GeoEvent Server is installed on. For more information, see Java Supported Locales. |