Live Refresh

This option will help the user to refresh the Report with latest data based on the saved WebSocket configuration.

The Live Refresh feature enables users to refresh a Report or specific Views with the latest data using a configured WebSocket connection. When a defined event occurs, the WebSocket channel triggers an automatic refresh, ensuring that the report always displays real-time information.

This is especially useful for monitoring live dashboards, real-time KPIs, or event-driven analytics without manual intervention.

How Live Refresh Works

  1. A WebSocket channel is established when a WebSocket-enabled report is opened.

  2. The configuration requires:

    • WebSocket IP

    • Message trigger

  3. When the WebSocket receives the configured message, the associated Report or Views are refreshed automatically.

  4. Users can choose to refresh all Views or only selected Views.

Steps to Configure Live Refresh

  1. Navigate to the Report’s final screen containing multiple Views.

  2. Click the Live Refresh icon.

  3. The WebSocket panel opens.

  4. Enable WebSocket functionality.

  5. Enter the WebSocket IP.

  6. Insert a message trigger that will initiate a refresh when received.

  7. Choose one of the following:

    • Refresh All – Refresh all Views in the Report.

    • Selected Views – Choose Views manually:

      • Use Check All to select all Views.

      • Or use individual checkboxes to select specific Views.

  8. Click the Apply icon to save the configuration.

Monitoring Refresh Events

  • Each WebSocket trigger can be tracked in the Developer Tools console.

  • The count of WebSocket triggers is displayed for verification.

Notes:

  • The WebSocket IP for Live Refresh is generated using the WebSocket Producer component available in the Data Pipeline module of the platform.

  • When the event trigger occurs, Views are refreshed with updated data based on the configured WebSocket message.

Best Practices

  • Use Refresh All for high-level monitoring dashboards where all Views need real-time updates.

  • Use Selected Views when only specific KPIs or charts need refreshing to reduce system load.

  • Keep WebSocket messages clear and unique to avoid unintended refresh triggers.

  • Test configurations using the Developer Tools console before deploying for business use.

PreviousShared ViewNextExport

Last updated