Connector for WebSocket

The WebSocket connector is very similar to the Streams Simulator connector, except that rather than looping through a file, it would either connect through web sockets, long polling, or repeatedly poll an external URL for new records to process.

 

  1. Enter the connection details:
    Property Description

    Path

    The path to which the WebSocket server will respond to.

    User Id

    The User ID that will be used to connect to the WebSocket server.

    Password

    The password that will be used to connect to the WebSocket server.

    Select the Show Characters checkbox to display the entered characters.

    Request Body

    For both the HTTP and ws:// POST requests sent to the WebSocket server.

    Timeout

    The length of time to wait for the server response (10 to 300). Default is 10.

     

  2. Select the Message Type.
  3. Click    to the fetch the schema based on the connection details. Consequently, the list of columns with the data type found from inspecting the first ‘n’ rows of the input data source is populated and the Save button is enabled. 

    This also populates the Id Column with the set of columns, of arbitrary type, that can be concatenated to form a unique row identifier.

  4. You can also opt to load or save a copy of the column definition.
  5. Click   to add columns to the WebSocket connection that represent sections of the message. Then enter or select:
    Property Description

    Name

    The column name of the source schema.

    Fix Tag/JsonPath/Column Index/XPath

    The Fix Tag/JsonPath/ Column Index/XPath of the source schema.

    Type

    The data type of the column. Can be a Text, Numeric, or Time

    Date Format

    The format when the data type is Time.

    Enabled

    Determines whether the message field should be processed.

    Filter

    Defined parameters that can be used as filter. Only available for JSON, Text, and XML message types.

    NOTE: To parse and format times with higher than millisecond precision, the format string needs to end with a period followed by sequence of upper case S. There can be no additional characters following them.

    For example: yyyy-MM-dd HH:mm:ss.SSSSSS

    To delete a column, check its  or all the column entries, check the topmost , then click .

  6. Date/Time values of output data and Date/Time inputs, where supported, is by default unchanged.

    You can opt to define the Show in Timezone and Source Timezone settings.

  7. For this section:

    Refer to Define Real-Time Settings for more information.

 

 

(c) 2013-2024 Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support