How Do I Create and Customize a KPI View?

Example of a KPI View
Example of a KPI View

The KPI View allows to visualize a defined attribute of your graph elements aggregated as a number. For instance, you can visualize the average, minimum, maximum or sum value of an attribute of a data set.
In order to create and customize a KPI View, just follow these steps:

  1. To create a KPI view, open your graph file (.slg) and the Open View Dialog will pop up. Select KPI as view type on the left-hand side of the Open View Dialog.In the View Settings, you can precise information for your view, as the title, subtitle, the unit, and the tooltip.
    KPI View dialog window
    KPI View dialog window

    Moreover, you have to define the dataset (the node/edge – class for which the KPI should be calculated), the measure (the node’s/edge’s attribute) and the function (average, minimum, maximum, sum, variance, standard deviation of the measure for the dataset or the count of elements in the dataset).

    If you want to compare this value with another one, tick the Compare To box. Again, pick the dataset, measure, and function of the value with which you would like to compare your initial value.
    Also chose if you would like the difference appear as a percentage, or as a number.
    What will appear is your KPI, and under it, the difference between your KPI and your chosen comparative value, and finally the comparative value (see picture below).

    After clicking on OK, the view is created.

    KPI View - Delta KPI with info
    KPI View with comparison


  2. To customize a KPI view, click on the graph window and proceed to set/change the properties in the Properties Pad.
    KPI View Properties Pad
    KPI View Properties Pad

    The table at the end of this article summarizes all adjustable properties and their role.

  3. As soon as you are happy with your customized view, you can save the settings by extracting a view template (see figure below). You can then reuse this template for any graph file built with the same metamodel. You find your saved view templates under “My View Templates” in the Open View Dialog.
  4. Extract a View Template and Save It for Reuse. You find it under My View Templates in the Open View Dialog

    Extract a View Template and Save It for Reuse

Available Properties for KPI View:

Graph ElementsProperty NameDescription
CanvasUnitSets the unit (in brackets) behind the KPI
CanvasSubtitleSets the subtitle (second line) of the KPI View
CanvasTitleSets the title (first line) of the KPI View
CanvasTooltipSets text which will be shown when hovering over the Graph window
CanvasBackground ColorDefines the color of the background
CanvasValue Upper RangeDefines the upper range limit of the KPI for the color indicator
CanvasValue Lower RangeDefines the lower range limit of the KPI for the color indicator
CanvasColor Indicator EnabledDefines whether the color indicator is enabled or not
CanvasLower Color IndicatorDefines the color for the color indicator in case the KPI is smaller then the "Value Lower Range" property.
CanvasMedium Color IndicatorDefines the color for the color indicator in case the KPI is bigger then the "Value Lower Range" property and smaller then the "Value Upper Range" property.
CanvasUpper Color indicatorDefines the color for the color indicator in case the KPI is bigger then the "Value Upper Range" property.
Node, EdgeFunctionDefines which function is used to calculate the KPI (average, minimum, etc.)
Node, EdgeTooltipDefines the text which is showed while hovering over the element with the mouse

Was this article helpful?

Related Articles