Integrate KX Dashboards with KX Insights SDK

This page describes the requirements for integrating KX Dashboards with KX Insights SDK.

Info

Integration with KX Insights SDK is supported only from KX Insights SDK version 1.15 onwards.

Integration of KX Dashboards with KX Insights SDK provides the following benefits:

Real-time data access: Integration with the kdb Insights Database allows KX Dashboards to query both real-time streaming and historical data through the same interface.
Advanced query capabilities: Leverage qSQL or custom q functions via the KX Insights SDK APIs, allowing complex analytics directly from KX Dashboards.
Simplified development workflows: Define queries, pipelines, and data sources using the KX Insights SDK, then link them directly to dashboard widgets without additional configuration.
Managed deployments and versioning: Integration with the KX Insights SDK allows dashboards to be packaged and deployed as part of a complete KX Insights SDK.
Enhanced visual interactivity: KX Insights SDK integration enables live updates, streaming data visualizations, and event-driven interactions between dashboards and the backend data services.

How to Integrate

To enable KX Dashboards integration with your KX Insights SDK deployment, the following requirements must be met:

Deploy KX Dashboards.
Deploy KX Insights SDK: at a minimum the Database must be deployed. Refer to Deploying Database for details.
Configure CORS policy: The KX Insights SDK CORS policy defines which external origins are permitted to access resources on the Service Gateway. To enable KX Dashboards access, you must configure KXI_SG_CORS_ORIGINS in your KX Insights SDK deployment with the host and port where KX Dashboards is running.
Connect dashboard components with KX Insights SDK: the Data Source for components in your dashboards must be configured to connect to KX Insights SDK. Refer to Connection Management for details.