The Push JSON to an External WebSocket output connector can be used to push event data, adapted and formatted as generic JSON, to an external server’s WebSocket. This output connector runs as a client and must be able establish a connection with an external server’s WebSocket gateway to push JSON data to.
Usage notes
Keep the following in mind when using the Push JSON to an External WebSocket output connector:
- This output connector adapts event data as generic JSON as opposed to feature JSON or GeoJSON.
- This output connector pairs the Generic JSON outbound adapter with the WebSocket outbound transport.
- This output connector runs as a client and establishes a connection to an external server’s WebSocket.
- The WebSocket (ws) and WebSocket Secure (wss) protocols are supported by this connector.
Parameters
The following are the parameters for the Push JSON to an External WebSocket output connector:
| Parameter | Description |
|---|---|
Name | A descriptive name for the output connector used for reference in GeoEvent Manager. |
Remote Server WebSocket URI (Client Mode) | The WebSocket URI GeoEvent Server will push data to. The default is a placeholder URI specified as ws://localhost:80/ws. Update this parameter to reflect the URI of the external server’s WebSocket. |
Formatted JSON | Specifies whether the generic JSON will be formatted (prettified). Also known as PJSON. The default for this parameter is No.
|
Idle Time to Disconnect | The interval (in seconds) after which the WebSocket connection will close if there is no traffic. The default is 600 seconds, which means after 10 minutes (600 seconds) of no traffic the WebSocket connection will close. |