Operations
Dashboard SDK and custom dashboards
Ship the operational views your team actually needs: custom React dashboard packages with the Dashboard SDK, or self-authored panels from SRQL without writing a package.
Build browser dashboards as signed packages with the React Dashboard SDK, or assemble SRQL-driven views in the product UI—ServiceRadar owns the host, data frames, theme, and navigation.
Two paths to the same operational surface
Not every view needs a custom codebase. Self-authored dashboards let operators build panels in the ServiceRadar UI from SRQL source queries and guided visualizations. The Dashboard SDK is for when you need bespoke rendering, maps, or workflows that ship from your own repository as a verified browser module.
- Self-authored: create dashboards in-product from SRQL sources and compatible panel types
- SDK packages: React modules built with @carverauto/serviceradar-dashboard-sdk
- Same host shell for navigation, theme, and data—whether built-in or custom
- Choose SDK only when built-in panels cannot express the view
Customer packages, platform host
Dashboard packages are not compiled into ServiceRadar. You ship a signed renderer artifact and manifest from your repo; ServiceRadar imports, verifies, and renders them. The platform owns SRQL execution, frame transport, Mapbox and deck.gl injection, and the stable host interfaces the SDK targets.
- Publish from a customer repository—not a fork of the core UI
- Signed packages with verification before browsers load renderer code
- Idempotent republish when the renderer digest matches; reject silent swaps of the same version
- CLI tooling for init, build, local harness, validate, and publish
SRQL-first data for every panel
Dashboards are driven by ServiceRadar Query Language . Packages and self-authored views use the same query surface and should treat the live SRQL catalog as the source of field and entity metadata—not a frozen field map copied into the package.
- Query inventory, services, telemetry, and security datasets with SRQL
- Use GET /api/srql/catalog for authoring completions and schema alignment
- Frame helpers in the SDK for rows, filters, indexing, and map layers
- Multiple clear source queries beat one opaque mega-query
Maps, frames, and the React surface
The SDK is React-first. It exposes hooks for dashboard query state, frame rows, filter state, indexed rows, and Mapbox/deck.gl map composition so custom dashboards can build geospatial and high-density operational views without reinventing the host data path.
- Composable map and layer patterns for site and topology views
- Arrow IPC and SRQL primitives for efficient frame handling
- Optional WASM render-model path for advanced packages
- Local development harness before you publish to an instance
Where operators and builders go next
Operators assemble day-to-day views with self-authored dashboards in the product. Builders use the developer portal and npm package for package authoring. Product docs point at both paths so deployment teams and dashboard authors do not share one overloaded runbook.
- Developer portal is the canonical SDK reference and hook guide
- docs.serviceradar.cloud covers self-authored dashboards and SRQL
- RBAC and ownership apply to dashboards you build and share
- Pair with discovery, NetFlow, and security solutions for real data behind the panels
FAQs
When should we use the Dashboard SDK instead of self-authored dashboards?
Use self-authored dashboards when SRQL plus built-in panel types are enough. Use the Dashboard SDK when you need custom React UI, specialized maps, or workflows that must ship as a versioned package from your own repository.
Do custom dashboards run our code inside ServiceRadar core?
No. You publish a verified browser module. ServiceRadar hosts the shell, SRQL data frames, and shared libraries; your package renders inside that contract.
Where is the full SDK reference?
Installation, React hooks, map patterns, harness, and publishing live on the Dashboard SDK developer portal .
How do self-authored dashboards work?
Operators add SRQL source queries, pick compatible outputs, and lay out panels in the UI. See the Self-authored dashboards docs .