Web UI 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.
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:
Endpoint management
Endpoint management functionality of WD is implemented through communication with the endpoint management rest api—this allows the user to view, add, update and delete data for a single endpoint.
| Widget name | Description | View |
|---|---|---|
| Endpoint label | Displays custom image containing labels that represent EP-related data. | Image |
| Endpoint list | Displays detailed information about all endpoints within the application. | Table |
| Endpoint metadata | Allows viewing and managing data from a single endpoint. | Table |
Endpoint time series
WD can receive both real-time and historical time series data. For this purpose, WD communicates with time series rest api, or a compatible implementation thereof, by using the time series rest api.
| Widget name | Description | View |
|---|---|---|
| Endpoint 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 |
|---|---|---|
| Endpoint filter details | Displays current filter status. | Form |
| Endpoint 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 updates rest api. 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 rest api.
| Widget name | Description | View |
|---|---|---|
| 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 endpoint management rest api.
| Widget name | Description | View |
|---|---|---|
| Endpoint Token Status | Displays EP current token status. | Form |
| Basic client credentials | View, add and modify users credentials. | Form |
| x509 credentials | View, add and modify users credentials. | 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 commands rest api.
| Widget name | Description | View |
|---|---|---|
| Command execution | Displays current state and execute commands on a single endpoint. | Button |
Generic
| Widget name | Description | View |
|---|---|---|
| Raw HTML | Displays custom HTML fragment. | HTML |
| Dashboard controls | Set dashboard context which may be used by the dashboard widgets. | |
| Endpoint orientation | Displays device orientation in space | 3D |
| Luminance | Displays light level | Image |
Theme customization
WD theme can be customized to match your brand style guide. More information here.
