KPI card

The KPI card portlet presents key performance indicators in a compact format, showing essential metrics with numerical values and visual indicators for quick assessment.

General

General data is required for all portlets, see General.

Advanced settings

• Initialize Load: Set to true if the KPI card should load when the page is accessed. If set to false, it will load only when receiving a listening command.

Events

To set up an event, see Events.

Data

To set up a data source, see Data.

Data source columns

In the data source column, you can change column names and set their types. Click Manage to access a grid view of the configuration.

Presentation

• Description: A description of the value.

• Value: The value to be displayed as the primary information in the portlet.

• Unit: The unit of the value.

• Bottom Left Corner: The information is displayed in the bottom left corner of the portlet. Configurable with the following widget types:

  • Data Field: The input value will be displayed as is (e.g. if the input is "Area: Central," that is what will be shown).

  • Trend: Displayed as an arrow indicating the trend direction based on the input value. The input must be an integer between -2 and 2, where -2 is an arrow pointing down, and 2 is an arrow pointing up.

• Bottom Right Corner: Configured the same way as the Bottom Left Corner, but the information is displayed on the right.

Background color rules

The KPI card's background color can be changed from its default color. Additionally, one or more color rules can be applied, such as changing the background color to indicate if a value is below or above a certain threshold. A color rule will always take priority over the default color and override it if its condition is met.

To add a new rule:

1. Click Add.

2. Select a color.

3. Enter the condition field, operator, and value.

4. Preview the result or save.

Style

To configure style, see Style.