KPI | Urbi Pro | Urbi Documentation
Urbi Pro

KPI

A KPI widget allows you to display the following indicators on dashboard scenes:

  • Current value: a constant value or a value of a selected data attribute (e.g., average rating or the number of constructed buildings).
  • Target value.
  • Difference between the current and the target values.

Use the KPI widget to monitor KPIs and important metrics such as a sales plan progress, an average rating, or population change.

Case example: track progress in the number of constructed buildings:

KPI widget
  • You can display only a current value in the widget or enable the display of a target value and the difference between them.

  • As a current and a target values, you can use:

    • Constant values that are entered manually and do not depend on the layer data.

    • Data attribute values from the layer, which are updated automatically when the layer data changes. As attributes, you can use:

      • Numeric attributes: to count the number of values ​​in the sample or to count values of the attributes using aggregation functions: total, mean, minimum, maximum value, median, and percentile.
      • Text attributes, logical attributes, or number of objects: to count the number of values ​​in the sample.
  • The current and the target values can be of different types. For example, the target value can be a constant, and the current value can be obtained from data attributes. Also, attributes for the current and the target values can belong to different data layers.

  • You can select the function to calculate the difference between the current and the target values.

  • Changes in layer data are automatically reflected in the widget.

  • If the filtering by territories or data attributes is applied on a dashboard scene, only the values ​​that match the filters are displayed in the widget. For more information, see the Filtering data on a dashboard instruction.

Example of creating a KPI widget
  1. Go to the Dashboards tab.

  2. Open the required dashboard.

  3. Open a scene using the arrows Left arrow and Right arrow. If there is only one scene in the dashboard, it opens automatically when you open the dashboard.

  4. In the top menu of the dashboard, click Widgets icon.

  5. Select the KPI widget type.

  6. Specify the required parameters. In the Value block, select the current value to display in the widget:

    • From datasets: selecting an attribute from the dataset (the value in the widget is updated when the data changes):
      • Layer: data layer containing the required attribute.
      • Aggregation attribute: attribute used to aggregate data and calculate the value.
      • Aggregation type: function used to calculate the attribute value.
    • Set manually: entering the constant value manually.
  7. Set the remaining widget parameters if necessary.

  8. Click Create.

The new widget is automatically added to the selected dashboard scene.

Note

When working with the uploaded data, make sure it contains at least one attribute to display a value in the widget.

Parameter
Description
Widget name Widget name.

Current value label:

Parameter
Description
Label Label text in the widget above the value. The maximum number of characters is 100.
Label color Color of the label above the value. You can select a color from the palette or specify it in HEX format.

Selecting a current value (From datasets tab):

Parameter
Description
Layer Data layer containing the required attribute.
Aggregation attribute Attribute, which value is aggregated and displayed in the widget:
  • Text attribute. You can select any attribute values ​​from the data sample. When you modify the sample, the available attribute values are also changed.
  • Numeric attribute.
  • Logical attribute. Available values are Yes and No/Unknown.
  • Number of objects.

When the data value changes, the value in the widget is also updated automatically.
Aggregation type Function used to calculate the attribute value.

For numeric attributes:
  • Sum: the sum of the values.
  • Mean: the mean value.
  • Min: the minimum value.
  • Max: the maximum value.
  • Median: the median value that is equal to or greater than 50% of the values ​​in the group.
  • 80th percentile: the value that is equal to or greater than 80% of the values ​​in the group.
  • 95th percentile: the value that is equal to or greater than 95% of the values ​​in the group.
  • 99th percentile: the value that is equal to or greater than 99% of the values ​​in the group.
  • Quantity: number of objects in the sample.

For text attributes, logical attributes, and number of objects:
  • Quantity: number of objects in the sample.
Value color Color of the current value in the widget. You can select a color from the palette or specify it in HEX format.

Entering a current value manually (Set manually tab):

Parameter
Description
Value Constant value that is not changed until you specify a new one when editing the widget. The maximum number of characters is 16.
Value color Color of the value in the widget. You can select a color from the palette or specify it in HEX format.

Target value label:

Parameter
Description
Label Label text in the widget above the value. The maximum number of characters is 100.
Label color Color of the label above the value. You can select a color from the palette or specify it in HEX format.

Selecting a target value (From datasets tab):

Parameter
Description
Layer Data layer containing the required attribute.
Aggregation attribute Attribute, which value is aggregated and displayed in the widget:
  • Text attribute. You can select any attribute values ​​from the data sample. When you modify the sample, the available attribute values are also changed.
  • Numeric attribute.
  • Logical attribute. Available values are Yes and No/Unknown.
  • Number of objects.

When the data value changes, the value in the widget is also updated automatically.
Aggregation type Function used to calculate the attribute value.

For numeric attributes:
  • Sum: the sum of the values.
  • Mean: the mean value.
  • Min: the minimum value.
  • Max: the maximum value.
  • Median: the median value that is equal to or greater than 50% of the values ​​in the group.
  • 80th percentile: the value that is equal to or greater than 80% of the values ​​in the group.
  • 95th percentile: the value that is equal to or greater than 95% of the values ​​in the group.
  • 99th percentile: the value that is equal to or greater than 99% of the values ​​in the group.
  • Quantity: number of objects in the sample.

For text attributes, logical attributes, and number of objects:
  • Quantity: number of objects in the sample.
Value color Color of the target value in the widget. You can select a color from the palette or specify it in HEX format.

Entering a target value manually (Set manually tab):

Parameter
Description
Value Constant value that is not changed until you specify a new one when editing the widget. The maximum number of characters is 16.
Value color Color of the value in the widget. You can select a color from the palette or specify it in HEX format.
Parameter
Description
Calculation method Function used to calculate the change in the current value relative to the target value:
  • Difference: shows the difference between the current and the target values, taking into account the sign. Example:
    • Current value: 70.
    • Target value: 100.
    • Calculation result: 70 - 100 = -30
  • Absolute difference: shows the difference between the current and the target values, ignoring the sign (difference modulus). Example:
    • Current value: 70.
    • Target value: 100.
    • Calculation result: |70 - 100| = 30
  • Percentage of the target value: shows as a percentage the ratio of the current value to the target value. Example:
    • Current value: 120.
    • Target value: 80.
    • Calculation result: (120 ÷ 80) ⋅ 100% = 150%
  • Percentage difference: shows as a percentage the ratio of the difference between the current and the target values to the target value. Example:
    • Current value: 120.
    • Target value: 80.
    • Calculation result: ((120 - 80) ÷ 80) ⋅ 100% = +50%
  • Ratio: shows as a coefficient how many times the current value is greater or less than the target value. Example:
    • Current value: 200.
    • Target value: 100.
    • Calculation result: 200 ÷ 100 = 2
  • Relative change: shows the ratio of the difference between the current and the target values to the target value. Example:
    • Current value: 120.
    • Target value: 80.
    • Calculation result: (120 — 80) ÷ 80 = +0,50
Indicator icons Selecting a color of the icons that show the change in the current value relative to the target value. You can select a color from the palette or specify it in HEX format.

Icon display rules:
  • Up arrow (▲) is displayed when the current value is greater than the target value. Examples: Difference > 0 or Percentage of the target value > 100%.
  • Down arrow (▼) is displayed when the current value is less than the target value. Examples: Difference < 0 or Percentage of the target value < 100%.
  • Icons are not displayed when the current value is equal to the target value. Examples: Difference = 0 or Percentage of the target value = 100%.
Icons are displayed for all calculation methods except the Absolute difference, since this metric has no direction.