KPIs

1. Overview

The KPIs page enables creating and managing Key Performance Indicators and their associated alarm conditions.

2. KPI Types

Type Description

Device parameter KPI

Created automatically when monitoring is activated for a parameter. Cannot be deleted while monitoring is active.

Custom KPI

Created manually by the user. Can be deleted at any time.

A red triangle next to a KPI name indicates the graph is hidden on the Single Device page.

3. KPI Creation

Click Create custom to create a new custom KPI with the following options:

  • KPI name — User-defined name

  • Display KPI graph — Determines how the KPI graph is displayed on the Single Device graph page

  • Support string value — Determines the possibility of using KPI with string value data for device group filtering (see Group Filtering)

  • Description — User-defined KPI description

  • Units — User-defined measurement units (e.g., %, ms, Mbps)

  • Child KPI — List of all available monitored parameters or previously created custom KPIs (or both)

  • Thresholds — Optional input for each severity level (see Thresholds)

  • Formula — Value processing method (see Formula Types)

When Support string value is selected, Display KPI graph, Thresholds, Formula drop-down, Formula input field, and Formula operands become greyed out.

3.1. Child KPI

The Child KPI area provides an easy way to select any parameter from all monitored parameters or previously created custom KPIs or both. These selected parameters will be available in the Formula input field.

4. Formula Types

The Formula drop-down defines the mechanism for processing data received from the device:

4.1. Number

Allows arithmetic actions for integer data received during monitoring. Predefined buttons:

  • max — The biggest value

  • min — The smallest value

  • avg — An average value

  • sum — Sum of values

  • +, -, *, /, (, ) — Mathematical operators and brackets

  • Clear — Clears the content of the formula input field

The formula input field can be populated manually or by using predefined buttons and the KPI drop-down (or any combination). The KPI drop-down provides an easy way to insert any KPI selected as Child KPI into the formula input field. For each Child KPI, two types are available:

  • Initial KPI — Selected as the Child KPI, represents the current checkpoint

  • KPI with _prev postfix — Allows manipulating with the previous value in relation to the initial KPI checkpoint in the formula

If a correct formula is set, only three lines (MIN, AVG, MAX) will be displayed on the graph from the Device Groups page for the mentioned KPI. If more than one KPI is selected as Child KPI while there is no formula input, MIN, AVG, and MAX lines will be displayed per each KPI.

4.2. Regexp

Allows using regular expressions for advanced processing of string data received during monitoring.

Example

The following string values were received from the device during monitoring:

  • 15_value

  • 28_value

  • 17_value

To extract the number from each value as a graph checkpoint, select Regexp from the Formula drop-down and use the following regular expression:

[0-9]+

The resulting graph will display checkpoints with values 15, 28, and 17.

4.3. Script

Allows using script primitives for advanced processing of string data received during monitoring.

Example

The following string values were received from the device during monitoring:

  • {[10, 10]}

  • {[15, 10]}

  • {[1, 20]}

The resulting graph must consist of checkpoints calculated as an average of all numbers from each string data checkpoint. Select Script from the Formula drop-down and use the following script:

function parseValue(val) {
    var res = [], k = 0;
    val = val.substring(1, val.length - 1);
    var arr = val.split(',');
    for (var i = 0; i < arr.length; i++) {
        var v = 0.0;
        var s = arr[i].trim();
        if (s.indexOf('[') != -1) {
            s = s.substring(1, s.length);
            var u = 0;
            while (s.indexOf(']') == -1) {
                v += parseFloat(s.trim());
                s = arr[++i];
                u++;
            }
            s = s.substring(0, s.length - 1);
            v += parseFloat(s.trim());
            u++;
            v /= u;
        } else {
            v = parseFloat(s);
        }
        res[k++] = v;
    }
    return res;
}

The resulting graph will display checkpoints with values 10, 12.5, and 10.5 (averages of each pair).

5. Thresholds

Each KPI can have up to three threshold levels. To create an alarm condition, click the + button next to the relevant severity level title. A line with the condition rule properties will appear.

Level Color Description

Critical

Red

Highest severity alarm

Major

Yellow

Medium severity alarm

Minor

Green

Lowest severity alarm

You can create a complex condition as a set of rules.

All rules under the condition are tied with OR logic, so all conditions must be met at once to trigger the relevant alarm.

The Condition column on the KPIs page displays configured conditions highlighted with the corresponding severity color:

  • Red — Condition related to the Critical severity alarm type

  • Yellow — Condition related to the Major severity alarm type

  • Green — Condition related to the Minor severity alarm type

6. KPI Edit

Click the pencil icon to edit a KPI. The Child KPI option is not available for device parameter KPIs. For multi-instance parameters, a single KPI covers all instances with instance numbers replaced by the i character.

If a monitor has been activated on a parameter with a string value, the KPI will be automatically created with the Support string value checkbox selected.

If the Support string value checkbox is cleared and any group is being filtered by this KPI, a confirmation message will appear: "If you change the type of this KPI, all involved group filters will be deleted." If confirmed, the filter with the appropriate KPI will be removed from all relevant group views.

7. KPI Deletion

Custom KPIs can be deleted via the recycle bin icon with confirmation.

← Back | Main Page