Single KPI

This page describes how to configure the Single KPI widget. The general description of this widget can be found here: Single KPI Widget Documentation.

This widget is intended for use in Dashboard applications and Report applications.

This widget supports the following datasources :

• Point Datasource

• Availability Statistics

Configuration

General Tab

This tab is composed of two sections:

• App Linked Data Sources: Displays all usable data in the widget.
  

• Output configuration: The output configuration allows to choose which points the widget will show.
  

App Linked Data Sources

For details on Linked app datasource see Widget Configurations.

Output Configuration

The output configuration allows to choose which point the widget will display as a KPI.

Only one point can be selected. It is mandatory, as it is the main information displayed.

• Click on the   button 

• Enter the following information:

  • Data: Select the data point to display as a KPI

  • Type: Aggregated or Realtime

  • Unit: If necessary, choose the unit that will be displayed; by default, the unit of the point is used. The button allows to enter a custom unit. Note: this does not convert from one unit to another; the displayed value remains unchanged.

  • Value Decimals: number of digits to show after the decimal point

Optionally, a reference point can also be entered, which will be displayed as a comparison value, juxtaposed with the KPI point, in the form “KPI/KPI_REFERENCE”.

• Enable the “Use Reference Point” switch. A KPI_REFERENCE line is added:
   

• Configure the reference KPI point, in the same way as the KPI point.

Multistating Tab

This tab allows to optionally enable conditional formatting of the KPI.

Initially, multistate conditions are disabled:

Use the Multistate conditions switch to enable/disable conditional formatting.
At any time, Multistate conditions can be disabled and re-enabled (the previous configuration is retained).

When enabled, at least 2 conditions are present:

• Define each desired condition by entering:

  • Limit (required): the threshold below or above which (depending on the operator) the condition applies. Note: One operator <= is created initially, then the operator is automatically assigned to > for any additional conditions. This implicitly defines ranges of values ​​over which conditions apply.

  • Text Color (optional): if enabled, choose a text color (using a color picker) that will be applied to the displayed value

  • Background Color (optional): if enabled, choose a background color (using a color picker) that will be applied to the displayed value

  • Text (optional): enter a static text that will replace the value

• The button adds a new condition (to be defined).

• The button allows to remove a condition definition.

Example:
For this hypothetical configuration:

• for a value < 1000, the KPI widget will display:
  

• for a value between 1001 et 1500:
  

• for a value above 1500:
  

Advanced Tab

This tab offers optional formatting possibilities:

• Common:

  • Description: A description or title that will be displayed before the KPI value.

• Description style: applies specific formatting for the KPI description text

  • Text Size: a number specifying the size of the text

  • Text Align: aligns the text, either left, center or right

  • Use custom text color: use the color picker to choose the color of the text. Only applies if multistating is not enabled or does not set a specific text color.

• Unit style: applies specific formatting for the KPI unit

  • Text Size: a number specifying the size of the text

  • Use custom text color: use the color picker to choose the color of the text. Only applies if multistating is not enabled or does not set a specific text color.

• Images:

  • Icon: choose either an icon or an image that will be displayed next to the KPI value

    • icon: enter the icon code in the Class field. See the reference of usable icons

    • image: use the  button to choose an image. Click on the Clear link will remove it.

  • Background Image: choose an image that will be displayed in the background of the KPI value. Click on the Clear link will remove the selected image.

• Value style: applies specific formatting for the KPI value

  • Text Size: a number specifying the size of the text

  • Text Align: aligns the text, either left, center or right

  • Use custom text color: use the color picker to choose the color of the text. Only applies if multistating is not enabled or does not set a specific text color.

• Icon style: applies specific formatting to the selected icon (does not apply to an image)

  • Text Size: a number specifying the size of the icon

  • Use custom text color: use the color picker to choose the color of the icon. Only applies if multistating is not enabled or does not set a specific text color.

Example KPI display for this hypothetical configuration, with Multistating disabled: