The Receive Text from a TCP Socket Input Connector can be used to adapt event data, formatted as delimited text, received via a TCP socket connection. The delimiter between attribute values is often a comma, so this type of data is sometimes referred to as comma separated values. ArcGIS GeoEvent Server can use any normal ASCII character as a delimiter to separate data attribute values.
![Delimited text being sent using GeoEvent Simulator Delimited text being sent using GeoEvent Simulator](GUID-68CE411C-E245-46F5-A320-33C54D0F625B-web.png)
Usage notes
- Use this connector to receive delimited text from any TCP client able to see your server machine and connect to the specified TCP socket.
- This input connector pairs the Text Inbound Adapter and the TCP Inbound Transport.
- The connector is frequently used to receive simulated event data records from GeoEvent Simulator.
- By default, the connector opens a TCP socket on port 5565, however any available server port can be used.
- Multiple Receive Text from a TCP Socket inputs can be configured, but each must specify a unique port.
- Multiple TCP client applications can connect and send data to a single configured input simultaneously.
- 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.
- GeoEvent Simulator will interpret the end-of-file as an implicit event separator when the simulation file is loaded into memory. It is not necessary to end a simulation file with an empty line to force the inclusion of a message separator. Other TCP clients may behave differently.
- The first attribute of a received delimited data string may be used to specify the name of a GeoEvent Definition. This is useful when datagrams with different attribute data types or numbers of data attributes are expected to be received; the data itself can help specify which GeoEvent Definition the adaptor should use to interpret the received data values. Use the Incoming Data Contains GeoEvent Definition to leverage this capability. Typically, all data records received on a given socket will have the same schema, however, so this property should be set to No (its default).
Parameters
Parameter | Description |
---|---|
Name | A descriptive name for the input connector used for reference in GeoEvent Manager. |
Default Spatial Reference | The well-known ID (WKID) of a spatial reference to be used when a geometry is constructed from attribute field values whose coordinates are not latitude and longitude values for an assumed WGS84 geographic coordinate system, or geometry strings are received that do not include a spatial reference. A well-known text (WKT) value or the name of an attribute field containing the WKID or WKT may also be specified. |
Server Port | The server port to use when establishing the TCP socket. TCP clients must be able to discover and connect to this port. The default is port 5565, but any available server port can be used. |
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. |
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 |
Expected Date Format | The pattern used to match expected string representations of date/time values and convert them to Java Date values. The pattern's format follows the Java SimpleDateFormat class convention. This parameter has no default value. While GeoEvent Server prefers date/time values to be expressed in the ISO 8601 standard, several string representations of date/time values commonly recognized as date values can be converted to Java Date values without specifying an Expected Date Format pattern. These include:
If the date/time values received are expressed using a convention other than one of the five shown above, you will have to specify an Expected Date Format so GeoEvent Server knows how the date/time values should be adapted. |
Incoming Data Contains GeoEvent Definition | Specifies whether the first attribute value of each delimited line of text should be used as the name of a GeoEvent Definition. For more information, see the usage notes above.
|
Create Unrecognized Event Definitions (Conditional) | Specifies whether a new GeoEvent Definition should be created when one with the specified name does not exist. When a delimited text file includes event records from different types of sensors, the first attribute value is used to specify the type of event and this attribute value is used as the GeoEvent Definition name.
Parameter is shown when Incoming Data Contains GeoEvent Definition is set to Yes and is hidden when set to No. |
Create GeoEvent Definition (Conditional) | Specifies whether a new or existing GeoEvent Definition should be used for the inbound event data. A GeoEvent Definition is required for GeoEvent Server to understand the inbound event data attribute fields and data types.
Parameter is shown when Incoming Data Contains GeoEvent Definition is set to No and is hidden when set to Yes. |
GeoEvent Definition Name (New) (Conditional) | The name assigned to a new GeoEvent Definition. If a GeoEvent Definition with the specified name already exists, the existing GeoEvent Definition will be used. The first data record received will be used to determine the expected schema of subsequent data records, a new GeoEvent Definition will be created based on that first data record's schema. Parameter is shown when Create GeoEvent Definition is set to Yes and is hidden when set to No. |
GeoEvent Definition Name (Existing) (Conditional) | The name of an existing GeoEvent Definition to use when adapting received data to create event data for processing by a GeoEvent Service. Parameter is shown when Create GeoEvent Definition is set to No and is hidden when set to Yes. |
Construct Geometry from Fields | Specifies whether the input connector should construct a point geometry using coordinate values received as attributes. The default is No.
|
X Geometry Field (Conditional) | The attribute field in the inbound event data containing the X coordinate part (for example horizontal or longitude) of a point location. Parameter is shown when Construct Geometry from Fields is set to Yes and is hidden when set to No. |
Y Geometry Field (Conditional) | The attribute field in the inbound event data containing the Y coordinate part (for example vertical or latitude) of a point location. Parameter is shown when Construct Geometry from Fields is set to Yes and is hidden when set to No. |
Z Geometry Field (Conditional) | The name of the field in the inbound event data containing the Z coordinate part (for example depth or altitude) of a point location. If left blank, the Z value will be omitted and a 2D point geometry will be constructed. Parameter is shown when Construct Geometry from Fields is set to Yes and is hidden when set to No. |
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. |