Documentation forOrion Platform

Configure KPI widgets for modern dashboards

This topic applies to all Orion Platform products.

KPI widgets display a big number representing a certain metric. You can use them on modern dashboards.

See the THWACK post on modern dashboards for an overview of the feature.

You can add multiple Key Performance Indicators (cells), select a background, and define whether the background should change when the metric exceeds a certain value

How to configure KPI widgets

  1. Configure widget title and other details

  2. Configure what should be displayed in the first box: Click Add new value.

    1. Specify the KPI name and background color
    2. Specify what metric to display in the KPI box
    3. If you want the KPI box to change color when the data exceeds a certain value, configure thresholds for the color change. When the metric reaches the Warning or Critical threshold value, the KPI box color changes accordingly.
  3. If you want more KPI boxes in the widget, repeat the previous step: Click Add new value and define the value.

    You might want to reorder the boxes or change the previous KPI box to better fit into the widget.

  4. Save Changes.

See Edit widgets for details on resizing widgets, changing widget position, or deleting widgets.

Step 1: Configure the widget title and other details (Presentation)

In the panel on the left, you can type a title and description for the widget. The default title is KPI Widget. You can keep default values for all boxes in this section.

  1. In Presentation, expand Title and description.

  2. Provide the title and subtitle.

  3. If you want to have a link with more details on the widget, provide it in the Widget link URL.

  4. You can also provide a description that might help others to reuse the widget.

Step 2: Specify metrics to be charted

Click Add new value and specify what the item should display.

  1. Specify the KPI name, unit, and background color
  2. Specify what metric to display in the KPI box: Review the SQL examples for KPI widgets and enter the SWQL manually.
  3. If you want the KPI box to change color when the data exceeds a certain value, configure thresholds for the color change.

Task a: Define the KPI name (obligatory), background color, and unit

In Description, provide a label for the metric to chart. Specify a background color and if necessary, provide an abbreviation for units.

Task b: Configure Data model

  1. Click Data model to specify what should be charted.

  2. Select Hand-edit a query and click Edit.

    See SWQL examples for KPI widgets.

  3. In the SWQL query editor, search for the entity you want to chart, and expand it. You will see a list of fields and linked entities.

  4. Click import SWQL to display a query that selects top 5 instances of the entity with the listed fields in the SWQL Query box.

  5. Adjust the query to return required results.

  6. Click Validate query to check for syntax errors.

  7. Click Show records to display what the query returns.

  8. When the query returns the requested items, click Save model.

    Now you can either add another KPI, define thresholds, or Save Changes to complete the widget configuration.

Task c: Configure Thresholds (optional)

By default, your widget uses colors specified for individual values. To make the widget change color when the specified KPI exceeds a value, define thresholds.

  1. In the Value box, expand Thresholds.

  2. Select Use custom thresholds.

  3. Specify the value for the Warning threshold. When the KPI exceeds this value, the KPI box color turns yellow.

  4. To keep the KPI box yellow until the KPI reaches the specified value, click the Warning and critical when below box

  5. Specify the value for the Critical threshold. When the KPI exceeds this value, the KPI box color turns red.

  6. To keep the KPI box red until the KPI reaches the specified value, click the Warning and critical when below box.

  7. Click Save Changes to complete the value configuration. You can add a new value, or complete the widget configuration.

Step 3: Add another KPI box

To add another box to the widget, click Add new value and repeat tasks in the previous step, and save changes.

See how to change the order of KPI boxes, change the look of KPI boxes, or delete KPI boxes.

Change the order of KPI boxes

If you defined multiple values and want to change their order on the widget, use the arrows on a KPI box to move it up or down.

Rename KPI boxes, change background or unit

  1. Click three dots > Edit widget.
  2. Expand description for the KPI to edit.
    • Type the new KPI name to the Label box.
    • Select the requested background color.
    • Type the requested unit.
  3. Click Save Changes.

Delete a KPI box

  1. Click three dots > Edit widget.
  2. Click the bin icon for the value to delete.
  3. Click Save Changes.