Using the KPI Widget

The KPI widget displays important metrics or performance indicators in a concise and visually appealing format. It displays any single value requested from the model, for instance a sum or a count of data items.

KPI widget

The widget settings can be edited using a dedicated configurator.

KPI widget Configurator

The upper tabs allow configuring the:

  • Custom Controller in charge of customizing the widget behavior, set to None by default.

  • Scenario Comparison option to Automatically enable the Scenario comparison mode for the widget.

  • Filters that should only apply to the widget, in addition to any filters set at a more global level, such as the Filter widget. For more details, please refer to Section Using the Filter Widget.

The main tabs allow configuring the:

  • General properties of the widget, such as the:

    • Title, or label, to display under the value,

    • Description of the widget if need be,

    • Icon of the widget if need be, displayed on the right of the value,

    • Navigation target which forwards users, upon click, to a specific View or Dashboard,

  • Data to use in the widget, such as the:

    • Datasource of the widget, which can be set to a Custom Query,

    • Type, which refers to the table, in the scenario data set, from which to retrieve the KPI value to display,

    • Field, which refers to the column, in the specified table, from which to retrieve the KPI value to display,

    • Value that the KPI widget should display depending on the selected Type, either:

      • Average, i.e. the mean average of the elements in the column Field,

      • Count, i.e. the total number of elements in the column Field,

      • Distinct, i.e. the number of distinct values across the column Field,

      • Max, i.e.the largest-value element in the column Field,

      • Min, i.e.the smallest-value element in the column Field,

      • Sum, i.e.the arithmetic total of all values in the column Field, or

      • Value, which displays the options Filter Field and Filter Value to indicate another value from a different column in the table Type selected above to display the corresponding value from the aforementioned column Field, and the

    • Show Progress option — when a numerical Type is selected — that displays a circle or a bar — if an Icon is configured — showing the progression of the value. It is based on a Value Kind, set to Percent by default, which can also be set to Custom to reflect a numerical Max Value.

  • Formatting of the widget, such as the:

    • Value Format, which can be set to:

      • Date, using the format 10/3/2023, Oct. 3, 2023, October 3, 2023, or Thursday, October, 2023.

      • Time, using the format 3:50 PM, 3:50:55 PM, or 3:50:55 PM GMT+2.

      • Duration, using the format 8760:00:00 (hh:mm:ss), 525600 (Minutes), 8760 (Hours), 365 (Days), 52 (Weeks), 12 (Months), or 1 (Years).

      • Number, using the format 123,412%, 1,231 (Rounded value), 1,234.1, 1,234.12, 1,234.123, 1.234123e+3 (Scientific), 1.234e+3 (Scientific), 1.234K (thousands), 1K (thousands, rounded), 0.001M (millions), or 0M (millions, rounded).

      • Currency, using the format $ 1,234 (Rounded value), € 1,234 (Rounded value), 1,234 (Rounded value), $ 1,234.12 (Decimals), € 1,234.12 (Decimals) or 1,234.12 (Decimals).

      • Custom, which prompts the user to choose a formatter and a format, either ICU (Default), using the ICU message format, or Luxon (Date & Time), using the Luxon message format.

    • Colors of the widget, using the dropdown palettes to set the background and text colors,

    • Conditional Formatting, using the button + ADD ANOTHER RULE that displays Custom style options to Apply style when the value Is null, Is not null, Is equal to, Is not equal to, Greater than, Greater than or equal to, Lower than, Lower than or equal to, Is between or Is not between a certain value.

  • Comparison configuration, with parameters such as the:

    • Comparison Value Kind option to reflect a comparison delta between scenarios in Comparison Mode, which is set to Percent by default, but can be expressed as a Raw value,

    • Comparison Colors for the widget background and text when there is a delta in values in Comparison Mode, as well as the

    • Comparison Conditional Formatting, which lists the preexisting rules Value is greater than 0 and Value is lower than 0 that can be moved, removed or completed with other rules using the button + ADD ANOTHER RULE that displays Custom style options to Apply style when the value Is null, Is not null, Is equal to, Is not equal to, Greater than, Greater than or equal to, Lower than, Lower than or equal to, Is between or Is not between a certain value.