WebSocket Connection

Access the steps to develop a data connection based on the WebSocket Connection.

Use a WebSocket Connection to stream live data into the Designer and bind it to charting components.

Create a new WebSocket connection

  1. Click the Data Connectors icon.

  2. Click the Create New Connection icon next to the WebSocket connector. Result: A new connection gets created under the WebSocket connector type.

  3. Click the new connection to view the configuration panel on the right.

Configure the connection

Fill in the following fields exactly as shown:

  • Name: Provide a name for the connection.

  • URL: Enter a URL link (e.g., wss://<host>/path or ws://<host>/path).

  • guid: Provide the guid.

  • Ingestion ID: Provide the ingestion ID.

  • Ingestion Secret: Provide the ingestion secret key.

  • Load at Start: Enable this option to get up-to-date data / pull the updated data from the data source before loading it into charts.

Associate the connection to a charting component

  1. Open the Designer canvas for your dashboard.

  2. From the Component Library, drag a charting component onto the canvas.

  3. Right-click the component and select Dataset (or Dataset property).

  4. Choose your WebSocket connection from the list.

  5. Map the incoming fields to the component’s bindings (dimensions/measures).

  6. Click Preview to validate; Save when satisfied.

Tip: For streaming feeds, confirm the incoming message schema matches the chart’s expected fields. Use calculated fields or scripts if you need to reshape messages.

Best practices

  • Prefer secure endpoints: Use wss:// whenever possible.

  • Key hygiene: Keep Ingestion Secret private; rotate it per your organization’s policy.

  • Reconnect logic (if supported): Ensure the source can resume or resend missed messages after temporary network drops.

  • Lightweight payloads: Send only the fields your visuals need to reduce latency.

  • Initialize state: With Load at Start enabled, ensure the server can provide the current state (snapshot) before streaming deltas.

Troubleshooting

  • No data arriving: Verify the URL, guid, Ingestion ID, and Ingestion Secret are correct, and the server accepts your client.

  • Handshake/SSL errors: Use wss:// with a valid certificate; check firewall/proxy rules.

  • Schema mismatch: Confirm the message keys match the field names bound in the component.

  • Intermittent drops: Check server keep-alive/heartbeat settings and network stability; consider retry/backoff on the source.

PreviousData Sheet EnhancementsNextMerged Connection