Overview
Web Dashboard service (WD) is a Kaa platform component intended for data visualization and analytics. It provides a user interface for interactions with other services. This service provides the visual interface to setup the user solutions, configure and monitor data, operate the devices as well as configure the Kaa platform services.
Interfaces
WD supports a number of interfaces to perform its functional role. The key supported interfaces are summarized in the following diagram. Additional supported interfaces can be found on the widgets’ pages.
For inter-service communication, Kaa services mainly use REST APIs and messaging protocols that run over NATS messaging system.
Tekton integration
WD is integrated with the Kaa Tekton for centralized solution configuration management. It receives configuration update messages from Tekton over 17/SCMP and uses Tekton REST API to retrieve solution configs.
Also, WD updates other platform services configuration through the Tekton REST API.
See the deployment section for Tekton integration configuration.
Components
The main component of the user interface is a dashboard. Dashboard is a page where WD widgets may be placed. You can configure and customize both the dashboard and the widgets. See Configuration.
A widget is a component of an interface that enables a user to perform some actions or access key data.
The WD provides built-in widgets.
Below you can find the list of those default widgets separated by categories:
EP management
Endpoint management functionality of WD is implemented through communication with the Endpoint Register service—this allows the user to view, add, update and delete data for a single endpoint.
| Widget name | Description | View |
|---|---|---|
| EP Label | Displays custom image containing labels that represent EP-related data. | Image |
| EP List | Displays detailed information about all endpoints within the application. | Table |
| EP Metadata | Allows viewing and managing data from a single endpoint. | Table |
EP Time Series
WD can receive both real-time and historical time series data. For this purpose, WD communicates with EP Time Series service, or a compatible implementation thereof, by using the [EPTS API][EPTS API].
| Widget name | Description | View |
|---|---|---|
| EP Label | Displays custom image containing labels that represent EP-related data. | Image |
| Gauge | Displays the last data point from the time series of a single endpoint. | Gauge |
| Map | Displays endpoint current location and the locations history for multiple endpoints. | Map |
| Multi Series Chart | Displays data from multiple time series sources and EPs. | Graph |
| Time Series Table | Displays real-time telemetry data from a single endpoint. | Table |
Endpoint filter management
| Widget name | Description | View |
|---|---|---|
| EP Filter Details | Displays current filter status. | Form |
| EP Filter List | Displays all filters in the application and their details. | Table |
Over-the-air software updates
Over-the-air software updates functionality of WD is implemented through communication with the Over-the-air Orchestrator service. A user can add and view software definitions.
| Widget name | Description | View |
|---|---|---|
| Software list | View and create software updates and their details. | Table |
| Software version details | Displays details of certain software version in the application with update ability. | Form |
Configuration management
Configuration management is essential for controlling the device behavior, managing data processing parameters, edge analytics, feature flagging, and other functions. For this purpose, WD communicates with Endpoint Configuration Repository service.
| Widget name | Description | View |
|---|---|---|
| EP Configuration | Allows viewing and editing configurations of EPs or EP groups. | JSON, Form |
Credentials management
You can use credential management APIs to provision, suspend, or revoke access. This functionality is implemented through communication with the Credential Management service.
| Widget name | Description | View |
|---|---|---|
| EP Token Status | Displays EP current token status. | Form |
Command execution
Command execution is the feature that allows delivering messages with the arbitrary payload to connected devices, execute commands, and receive near-real-time responses. WD communicates with Remote Command Invocation service.
| Widget name | Description | View |
|---|---|---|
| Control | Displays current state and execute commands on a single endpoint. | Button |
Generic
| Widget name | Description | View |
|---|---|---|
| Raw HTML | Displays custom HTML fragment. | HTML |
Theme customization
WD theme can be customized to match your brand style guide. More information here.
