To add a WebSocket data connection, use the WebSocket data connection type when you connect a source service to a target service in a data flow.
The following table describes the properties that you need to configure for the WebSocket data connection type:
Entity Name
Name of the data connection. Maximum length is 32 characters.
Description
Description of the data connection. Maximum length is 256 characters.
Messaging mode
Mode in which the source service distributes data to the target service.
You can choose one of the following messaging modes:
Acknowledgment. The target service sends an acknowledgment to source service after it writes data to the target.
Streaming. The data connection uses streaming to distribute data.
Default is Acknowledgment mode.
Connection Type
The type of connection that the data connection uses.
You can select one of the following connection types:
WebSocket
WebSocket Secure
KeyStore Path
The directory that contains the keystore file. Specify the absolute path to the file.
Specify this path if you select the
WebSocket Secure
connection type.
KeyStore Password
Password for the keystore file.
You must specify this property if you select the
WebSocket Secure
connection type.
Select a secure parameter if you have already created it. To specify a key and value, click
Click to add secure parameters
.
TrustStore Path
Path and file name of the truststore file.
Specify this path if you select the
WebSocket Secure
connection type.
TrustStore Password
Password for the truststore file.
You must specify this property if you select the
WebSocket Secure
connection type.
Select a secure parameter if you have already created it. To specify a key and value, click
Click to add secure parameters
.
Port
Port on which the target service listens for incoming connections.
Status Check Path
Path to which an HTTP GET request is sent to verify if the server is running.
Load Balancer IP
IP address of the external load balancer.
WS Advanced Configuration
The advanced configuration that the data connection uses. You can configure the following options:
event_flush_frequency
. The amount of time in milliseconds after which events are flushed from the source service to the target service. Default is 100.
maximum_events_batched
. The maximum number of events that are sent in a batch from the source service to the target service. Default is 1000.
The data is sent to the source service when either the event flush frequency or the maximum events batched event occurs.
maximum_client_buffer
. The buffer size in bytes allocated to the source service. if this buffer is full, source service will not accept more data from the source, to send to the target service. Default is 33554432.
acknowledgment_flush_frequency
. The frequency in milliseconds at which the target service sends acknowledgments to the source service after receiving data. Default is 500.
maximum_send_attempts
. The maximum number of times, including the first time, that the source service tries to send data to the target service. Default is 5.
acknowledgment_idle_time
. The amount of time in milliseconds that the source service waits for an acknowledgment from the target service before it tries to resend data. Default is 10000.
connection_idle_time
. The amount of time in milliseconds that the source service waits before it tries to reconnect to the target service. Default is 10000.
maximum_connection_attempts
. The maximum number of times the source service tries to connect to the target service. Default is 3.