Open topic with navigation

TIBCO Flogo® Connector for WebSockets 1.0.1

# Websocket Subscriber Trigger

Websocket Subscriber trigger is a WebSocket client, which subscribes to WebSocket server to read messages. You can map the received content and connection as a flow input for further processing.

## Trigger Settings

Field | Required | Description
--- | --- | ---
URI | Yes | URI of the WebSocket server. URI must be in the following format: wss:// for secure connections or ws:// for insecure connections. This field can also be set by using an application property.
Allow Insecure Connection | Yes | The Allow Insecure Connection field is available if `wss://` is present in the URI field. Set this field to True to use the self-signed development mode certificates for connecting to the server.
Server CA | Yes | Selects the certificate authority file used to sign the server's certificate for secure connections. This field is available if the Allow Insecure Connection field is set to False.
AutoReconnectAttempts | Yes | Specifies the number of attempts that the Websocket Subscriber trigger should make to reconnect to the WebSocket server. Default: 15 Note: No retry attempt is performed if the WebSocket server closes the connection by sending status code 1000 (normal closure).
AutoReconnectMaxDelay | Yes | Specifies the maximum time (in seconds) you want the Websocket Subscriber trigger to wait between attempts to reconnect to the WebSocket server. Default: 30
Query Params | No | HTTP request query parameters for the trigger. To add the query parameters, click the Add row button and press Enter to save your changes. parameterName: Name of the query parameter. Type: The data type of the query parameter. Supported types are string, number, or boolean. Value: Value of the query parameter Note: You can add multiple values separated by a comma for query parameters or header parameters. Do not add space after comma. Example: 1,2 True,False
Request Headers | No | HTTP request header parameters. To add the header parameters, click the Add row button and press Enter to save your changes. parameterName: Name of the header parameter. type: The data type of the header parameter. Supported types are string, number, or boolean. value: Value of the header parameter
Message Format | Yes | Selects one of the following formats of the message body: String: String message. JSON: If JSON is selected, a text editor is provided to accept a JSON document.
Schema for JSON value | Yes | The JSON schema for the WebSocket message payload. The Schema for JSON value field is only available when the Message Format field is JSON. This is a free form text editor that accepts any valid JSON document. You can also specify an app-level schema by using the Use app level schema option.

Note: Subscriber trigger keeps reading on the connection until the connection is closed by the server or there is any connection error.

## Map to Flow Inputs

This tab allows you to map the trigger output to flow input. You can map the received data to flow input by using the content field. Data received from each reading, triggers a new flow. You can map the received connection to the flow input by using the wsconnection field. You can map the wsconnection field as an input to an activity that takes WebSocket connection as an input. Example: Websocket Write Data activity.

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO Flogo® Connector for WebSockets

Copyright © 2024. Cloud Software Group, Inc. All Rights Reserved.