This widget shows a current measurement value in realtime and a chart based on measurement values as datapoints.
⚠️ This project is no longer under development. Please use Cumulocity KPI Trend Widget Plugin for Application Builder >=2.x.x and Cumulocity >=1016.x.x⚠️
- Supports measurements from a single device
- Allows color customization for KPI and the trend chart.
- Allows to configure threshold values and do color customization.
- Allows to upload custom image to represent the KPI.
- Supports different chart types.
- Download the latest
kpitrend-widget-{version}.zip
file from the Releases section. - Make sure you have Runtime Widget Loader installed on your Cockpit or App Builder app.
- Open a dashboard.
- Click
more...
. - Select
Install Widget
and follow the instructions.
- Clone the repository on your local machine using
git clone https://github.com/SoftwareAG/cumulocity-kpi-trend-widget.git
. - Run
npm install
to install the module dependencies. - Run
c8ycli build
to build the cockpit application. - Run
c8ycli deploy
and follow the instructions to deploy the cockpit application on your tenant. This will include the widget also.
- Make sure you have successfully installed or deployed the widget.
- Click on
Add widget
. - Choose
KPI Trend
widget. Title
is the title of widget. Provide a relevant name. You may choose to hide this. Go toAppearance
tab and chooseHidden
underWidget header style
.- Select the
device
. KPI title
is the name of the KPI you want to show. Example: Temperature, Humidity.Upload KPI icon
allows you to upload relevant icon. Icon should be a image format like .png, jpg, etc.Measurement
allows you to choose the Fragment and Series combined. It automatically gets populated based on the device selected.KPI color
is the custom color you may want to specify. Clicking this field opens a color picker to help you selecting a color.KPI unit
is a unit value you to specify. Providing this value override the value received with measurement. Leave blank if you don't want to override. Examples: km, m, kg, etc.KPI aggregation enabled
is to calculate and show the percentage tend text statement or not.KPI aggregation interval
is an interval to choose the measurements from to calculate the KPI.KPI threshold enabled
and its related fields allows you to configure threshold values. KPI will change its color on reaching the threshold values. Threshold values are inclusive.Chart enabled
is to show or hide chart in the widget.Chart type
is the type of the chart you want to see. There are 2 options line and bar.Chart position
decides where to chart in the widget with respect to the KPI.Chart height
is the height of the chart you want to configure in pixels.Chart color
is the color of the chart you want to see. Clicking this field opens a color picker.Chart aggregation type
is whether you want to retrieve the measurement to be plotted on the chart based on the interval or the custom number.- Click
Save
to add the widget on the dashboard. - In case you see unexpected results on the widget, refer to browser console to see if there are error logs.
- Clone the repository on local machine using
git clone https://github.com/SoftwareAG/cumulocity-kpi-trend-widget.git
. - Run
npm install
to download the module dependencies. - Install c8ycli
npm install -g @c8y/cli
if not already. - Run
c8ycli server -u https://your_tenant_url
to start the server. - Go to
http://localhost:9000/apps/cockpit/
in the browser to view and test your changes. - (Optional) push the changes back to this repository.
- Finish the development and testing on your local machine.
- Run
gulp
to start the build process. Runnpm install -g gulp
to install gulp if not already. - Use
widget.zip
file in thedist
folder as a distribution.
These tools are 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.
For more information you can Ask a Question in the TECHcommunity Forums.
You can find additional information in the Software AG TECHcommunity.