WebSocket Channel

The WebSocket Channel external action receives messages and delivers them over TCP to WebSocket-supported clients that are connected to the FME Server WebSocket Server or another target URL. Supported clients include:

  • FME Desktop workspaces configured with WebSocketReceiver transformers.
  • HTML5-based web browsers, such as:
    • Internet Explorer 10+
    • Firefox 11+
    • Chrome 16+
    • Safari 6+
    • Opera 12.10+

The WebSocket Channel external action has two output ports. The success port () can send a message if the WebSocket channel is notified successfully. The failure port (x) can send a message if the notification fails.

Note: When Retry settings are configured, the failure port renders with a Retry Configured (⟳) icon.

Client Requirements

To receive data from the external action, clients must send the following preamble:

{

"ws_op" : "open",

"ws_stream_ids" : ["<stream_id1>", "<stream_id2>", "<stream_id3>", ...]

}

For more information, see WebSocket Server Messaging Protocol.

WebSocket Communication Channels

The WebSocket Server is located on the FME Server Core. By default, FME Server uses the following channels for WebSocket communication:

  • Port: 7078
  • URI: ws://<hostname>:7078/websocket

To configure the WebSocket server for SSL communication, see Configuring for HTTPS.

Parameters

Output Keys

Retry

See Also