The KPI aggregator widget allows you to quickly configure and visualize queries againt the inventory API, and count or aggregate single result fragments, on client side (in the browser).
The widget can be configured to query inventory managed objects, based on the filter query langugage, enhanced with context sensitive query parameters.
For visualization, three display modes are avilable: a "bar chart" – or rather a listing with the percentual value represented as background-color –, a pie chart and a table – listing all queried assets.
To be able to control the potential pandoras box of queries, options to limit the number of results per request, the number of parallel requests and requests per page are configurable, as well as an option to only run the query on demand.
Currently, five display modes are available. Functional, both aggregation and counting views share identical configurations and provide two visualisation flavours: 📊 bar and 🍰 pie chart.
Display aggregated values: bar chart (left) and pie chart (right).
Display counted values: bar chart with percent values (left) and pie chart (right).
Display mode table: each queried device is listed.
Highlighted request meta information: Paging (top) and duration of query (bottom).
Paging detail information in tooltip
The drop down menu provides access to actions, such as refreshing the data.
It is possible to user "context sensitive" parameters within your query. This means that parts of your query can be replaced by values from the managed object of your dashboard context, for example: if you would want to display a list of devices from the same owner – that hosts the dashboard – you can use the query owner eq "[owner]". [owner] will then be replaced by the devices types, so that the actual request would read owner eq "your.email@host.net".
Ht econtext sensitive parameter can also address fragments of objects, such as [c8y_Hardware.model] or [c8y_Availability.status]. Please note that it is currently not possible to traverse arrays this way.
- Count all devices by type
- Query:
has(c8y_IsDevice) - Display Mode:
Bar Chart: Count Entries - KPI Fragment:
type - Group by:
type - Sort:
by Value - Order:
Descending Show Meta InfoandRun on Loadchecked
- Query:
- Aggregate critical alarms by device type
- Query:
has(c8y_IsDevice) - Display Mode:
Pie Chart: Aggregate Entries - KPI Fragment:
c8y_ActiveAlarmsStatus.major - Group by:
type - Label:
type - Sort:
by Value - Order:
Descending Show PercentandRun on Loadchecked
- Query:
- node v 16.x
- npm v 9.x
- Angular v 14.x
- WebSDK v 1018.0.x
Change the target tenant and application you want to run this plugin on in the package.json.
c8ycli server -u https://{{your-tenant}}.cumulocity.com/ --shell {{cockpit}}Keep in mind that this plugin needs to have an app (e.g. cockpit) running with at least the same version as this plugin. if your tenant contains an older version, use the c8ycli to create a cockpit clone running with at least version 1016.0.59! Upload this clone to the target tenant (e.g. cockpit-1016) and reference this name in the --shell command.
The widget plugin can be locally tested via the start script:
npm startIn the Module Federation terminology, widget plugin is called remote and the cockpit is called shell. Modules provided by this widget will be loaded by the cockpit application at the runtime. This plugin provides a basic custom widget that can be accessed through the Add widget menu.
Note that the
--shellflag creates a proxy to the cockpit application and providesKpiAggregatorWidgetPluginModuleas anremotevia URL options.
Also deploying needs no special handling and can be simply done via npm run deploy. As soon as the application has exports it will be uploaded as a plugin.
Dive into a wealth of Cumulocity IoT tutorials and articles in the TECHcommunity Knowledge Base.
Stuck or just curious? Ask the Cumulocity IoT experts directly on our Software AG TECHcommunity Forums.
See Cumulocity IoT in action with a Free Trial.
Your input drives our innovation. If you find a bug, please create an issue in the repository. If you’d like to share your ideas or feedback, please post them in our Tech Forums.
- Cumulocity IoT Web Development Tutorial - Part 1: Start your journey
- How to install a Microfrontend Plugin on a tenant and use it in an app?
- The power of micro frontends – How to dynamically extend Cumulocity IoT Frontends
This widget is provided as-is and without warranty or support. They do not constitute part of the Software AG product suite. Users are free to use, fork and modify them, subject to the license agreement. While Software AG welcomes contributions, we cannot guarantee to include every contribution in the master project.