WebSocket Client

The WebSocket Client target writes data to a WebSocket endpoint. Use the target to send data to a WebSocket resource URL. For information about supported versions, see Supported systems and versions.

The WebSocket Client target opens a connection to the WebSocket endpoint for each batch of data that it writes. The target sends each record to the WebSocket resource URL. When the batch is fully written, the target closes the connection and then opens another connection for the next batch of data.

When you configure the WebSocket Client target, you define the resource URL and headers to use for the requests. You can also configure SSL/TLS properties, including default transport protocols and cipher suites.

Data formats

The WebSocket Client target writes data to WebSocket endpoints based on the data format that you select.

The WebSocket Client target processes data formats as follows:

Binary
The stage writes binary data to a single field in the record.
JSON
The target writes records as JSON data. You can use one of the following formats:
  • Array - Each file includes a single array. In the array, each element is a JSON representation of each record.
  • Multiple objects - Each file includes multiple JSON objects. Each object is a JSON representation of a record.
SDC Record
The target writes records in the SDC Record data format.
Text
The target writes data from a single text field to the target system. When you configure the stage, you select the field to use.
You can configure the characters to use as record separators. By default, the target uses a UNIX-style line ending (\n) to separate records.
When a record does not contain the selected text field, the target can report the missing field as an error or to ignore the missing field. By default, the target reports an error.
When configured to ignore a missing text field, the target can discard the record or write the record separator characters to create an empty line for the record. By default, the target discards the record.

Configuring a WebSocket Client target

About this task

Configure a WebSocket Client target to write data to a WebSocket endpoint.

Procedure

  1. In the Properties panel, on the General tab, configure the following properties:
    General Property Description
    Name Stage name.
    Description Optional description.
    Required Fields Fields that must include data for the record to be passed into the stage.
    Tip: You might include fields that the stage uses.

    Records that do not include all required fields are processed based on the error handling configured for the flow.
    Preconditions Conditions that must evaluate to TRUE to allow a record to enter the stage for processing. Click Add to create additional preconditions.

    Records that do not meet all preconditions are processed based on the error handling configured for the stage.
    On Record Error Error record handling for the stage:
    • Discard - Discards the record.
    • Send to Error - Sends the record to the flow for error handling.
    • Stop Flow - Stops the flow.
  2. On the WebSocket tab, configure the following properties:
    WebSocket Property Description
    Resource URL WebSocket resource URL. Enter in the following format:
    <ws | wss>://<hostname>:<listening_port>

    Use wss for secure WebSocket connections over HTTPS.

    For example:
    ws://localhost:8080
    Headers Headers to include in the request. Using simple or bulk edit mode, click the Add icon to add additional headers.
    Maximum Request Time Maximum number of seconds to wait for a request to complete.
  3. To use SSL/TLS, on the TLS tab, configure the following properties:
    TLS Property Description
    Use TLS Enables the use of TLS.
    Use Remote Truststore Enables loading the contents of the truststore from a remote credential store or from values entered in the stage properties. For more information, see Remote keystore and truststore.
    Trusted Certificates Each PEM certificate used in the remote truststore. Enter a credential function that returns the certificate or enter the contents of the certificate.

    Using simple or bulk edit mode, click the Add icon to add additional certificates.
    Truststore File

    Path to the local truststore file. Enter an absolute path to the file or enter the following expression to define the file stored in the Data Collector resources directory:

    ${runtime:resourcesDirPath()}/truststore.jks

    By default, no truststore is used.

    Truststore Type
    Type of truststore to use. Use one of the following types:
    • Java Keystore File (JKS)
    • PKCS #12 (p12 file)

    Default is Java Keystore File (JKS).

    Truststore Password

    Password to the truststore file. A password is optional, but recommended.

    Tip: To secure sensitive information such as passwords, you can use runtime resources or credential stores.
    Truststore Trust Algorithm

    Algorithm to manage the truststore.

    Default is SunX509.
    Use Default Protocols Uses the default TLSv1.2 transport layer security (TLS) protocol. To use a different protocol, clear this option.
    Transport Protocols TLS protocols to use. To use a protocol other than the default TLSv1.2, click the Add icon and enter the protocol name. You can use simple or bulk edit mode to add protocols.
    Note: Older protocols are not as secure as TLSv1.2.
    Use Default Cipher Suites Uses a default cipher suite for the SSL/TLS handshake. To use a different cipher suite, clear this option.
    Cipher Suites Cipher suites to use. To use a cipher suite that is not a part of the default set, click the Add icon and enter the name of the cipher suite. You can use simple or bulk edit mode to add cipher suites.

    Enter the Java Secure Socket Extension (JSSE) name for the additional cipher suites that you want to use.

  4. On the Data Format tab, configure the following property:
    Data Format Property Description
    Data Format Data format for messages. Use one of the following properties:
  5. For binary data, on the Data Format tab, configure the following property:
    Binary Property Description
    Binary Field Path Field that contains the binary data.
  6. For JSON data, on the Data Format tab, configure the following properties:
    JSON Property Description
    JSON Content Method to write JSON data:
    • JSON Array of Objects - Each file includes a single array. In the array, each element is a JSON representation of each record.
    • Multiple JSON Objects - Each file includes multiple JSON objects. Each object is a JSON representation of a record.
    Charset Character set to use to write data.
  7. For text data, on the Data Format tab, configure the following properties:
    Text Property Description
    Text Field Path Field that contains the text data to be written. All data must be incorporated into the specified field.
    Record Separator Characters to use to separate records. Use any valid Java string literal. For example, when you write to Windows, you might use \r\n to separate records.

    By default, the target uses \n.
    On Missing Field When a record does not include the text field, determines whether the target reports the missing field as an error or ignores the missing field.
    Insert Record Separator if No Text When configured to ignore a missing text field, inserts the configured record separator string to create an empty line.

    When not selected, discards records without the text field.
    Charset Character set to use to write data.