Subscribe to an External WebSocket for JSON—ArcGIS GeoEvent Server Help

The Subscribe to an External WebSocket for JSON input connector can be used to receive and adapt event data, formatted as generic JSON, broadcast from an external server’s WebSocket. This input connector runs as a client and must be able to subscribe to a WebSocket hosted by a server. If you are looking for an input connector that runs as a server and allows client applications to subscribe and send data to the input, consider using Receive JSON on a WebSocket.

Usage notes

Keep the following in mind when working with the Subscribe to an External WebSocket for JSON input connector:

Use this input connector to receive data, formatted as generic JSON, through a WebSocket hosted by an external server.
This input connector runs as a client and subscribes to a server’s hosted WebSocket to receive data broadcast by the server.
This input connector pairs the Generic JSON inbound adapter with the WebSocket inbound transport.
The adapter interprets generic JSON as opposed to feature JSON or GeoJSON. Note that GeoJSON and feature JSON are both variants of generic JSON; different GeoEvent Server adapters are used to process those specific formats.
The adapter will handle both single JSON records and JSON records organized in an array.
A generic JSON record does not have to contain data that represents a geometry.
The adapter supports the ability to construct a point geometry from x, y, and z attribute values.
Both the WebSocket (ws) and WebSocket Secure (wss) protocols are supported by this connector.
Clients who want to send data to the WebSocket endpoint should use ws://<machine_name>.<domain>:6180/path.
Clients who want to send data to the WebSocket Secure (wss) endpoint should use wss://<machine_name>.<domain>:6143/path.
This input connector includes a Learning Mode parameter, which can be used to allow the input connector to modify a GeoEvent Definition it has constructed. The purpose of this property is to temporarily accept that event data received will have a variable schema or data structure. The input connector will use a sample of received data records to learn more about the variable data structure and append new, previously unobserved, attribute fields to an existing GeoEvent Definition.
Allowing a GeoEvent Definition to be changed on the fly can negatively impact the design of real-time analysis in a GeoEvent Service. As a best practice, it is recommended that if schema variance is expected in your inbound event data that you use the learning mode for as brief a period of time as possible to produce a GeoEvent Definition that supports all expected variants of your inbound data. The learning mode can then be turned off and the autogenerated GeoEvent Definition will be copied and tailored for production deployment.
A stream service uses a GeoEvent Server hosted WebSocket to broadcast feature JSON representations of processed event records. Feature JSON can be interpreted using this connector. For more information, see the Esri Community blog How To: Subscribe to a GeoEvent Server Stream Service.

Parameters

The following are the parameters for the Subscribe to an External WebSocket for JSON input connector:


Parameter	Description
Name	A descriptive name for the input connector used for reference in GeoEvent Manager.
Remote Server WebSocket URI (Client Mode)	The complete URL endpoint including a protocol, hostname or IP address, port, and path. The default is localhost. Update this parameter to reflect the URI of a server’s hosted WebSocket.
Create GeoEvent Definition	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. Yes—A new GeoEvent Definition will be created based on the schema of the first event record received. No—A new GeoEvent Definition will not be created. Select an existing GeoEvent Definition that matches the schema of the inbound event data.
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. The 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. The parameter is shown when Create GeoEvent Definition is set to No and is hidden when set to Yes.
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.
JSON Object Name	The name of a JSON element that can be used as the root node of a substructure within the received JSON data. When JSON Object Name is used to specify a JSON element by name, the adapter will search for substructures whose object name matches the specified element name. Only data within the identified substructure will be considered. When left blank, which is the default, the uppermost JSON object is used as the root of the entire JSON structure.
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. 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 the following: "2019-12-31T23:59:59"—The ISO 8601 standard format 1577836799000—Java Date (epoch long integer; UTC) "Tue Dec 31 23:59:59 -0000 2019"—A common web services string format "12/31/2019 11:59:59 PM"—Common format used in the United States (12-hour clock) "12/31/2019 23:59:59"—Common format used in the United States (24-hour clock) 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 pattern so GeoEvent Server knows how the date/time values should be adapted.
Construct Geometry from Fields	Specifies whether the input connector should construct a point geometry using coordinate values received as attributes. The default is No. Yes—Values from specified event attribute fields will be used to construct a point geometry. No—A point geometry will not be constructed. It is assumed an attribute field contains a value that can be interpreted as a geometry or the event record is nonspatial (does not have a geometry).
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. The 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. The 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. The parameter is shown when Construct Geometry from Fields is set to Yes and is hidden when set to No.
Learning Mode	Specifies whether Learning Mode is active or disabled. When Learning Mode is set to Yes, the inbound adapter will append new fields to a GeoEvent Definition it has created and is maintaining. Yes—Learning mode will be enabled. The GeoEvent Definition will be updated with new fields from event records sharing different schemas. No—Learning mode will not be enabled. The GeoEvent Definition will not be modified. Learning Mode can be useful when you need to allow the input connector to modify a GeoEvent Definition it has constructed. The purpose of this parameter is to temporarily accept that event data received will have a variable schema or data structure. The input connector will use a sample of received data records to learn more about the variable data structure and append new, previously unobserved, attribute fields to an existing GeoEvent Definition. Allowing a GeoEvent Definition to be changed on-the-fly can adversely impact the design of real-time analytics in a GeoEvent Service. If schema variance is expected in your inbound event data, it is recommended that you use Learning Mode for as brief a period of time as possible to produce a GeoEvent Definition that supports all expected variants of your inbound data. Learning mode can then be turned off and the automatically generated GeoEvent Definition copied and tailored for production deployment.

Feedback on this topic?