Creating WebSocket Input Data Source

The WebSocket connector is very similar to the Stream 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. In the New Data Source page, select Input > WebSocket in the Connector drop-down list.
  2. Enter the connection details:
    Property Description

    Path

    The path to which the WebSocket server will respond to.

    Proxy Server URI

    The HTTP Proxy setting that will allow the WebSocket connector to reach the endpoint.

    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.

     

  3. Select the Message Type.
  4. Select either the period (.) or comma (,) as the Decimal Separator.

    NOTE: Prepend 'default:' for the elements falling under default namespace.

  5. 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.
  6. You can also opt to load or save a copy of the column definition.
  7. You can also opt to 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.

    JsonPath/Text Column Index/XPath

    The JsonPath/Text 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.

    Filter

    Defined parameters that can be used as filter.

    Enabled

    Determines whether the message field should be processed.
     

    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 .

  8. Define the Real-time Settings.
  9. Click  . The new data source is added in the Data Sources list.

 

 

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

Intellectual Property Rights Notice | Technical Support