Analytics Builder 10.13.0 | Using Analytics Builder for Cumulocity IoT | Block Reference | Calculation | KPI
 
KPI
apama.analyticskit.blocks.cumulocity.KPI
Compares a value against either a KPI (Key Performance Indicator) or the data point of a device.
This block uses data from the KPI input port or from the device which contains data points. It extracts the units, label, and the red and yellow ranges. The output indicates whether the value is within the red or yellow range specified by the KPI or data point.
The KPI input can provide properties, typically from a KPI-managed object, which include the red and yellow ranges, the unit and the label. If the device contains a data point for the specified fragment and series, then the values from the data point override those from the KPI.
Parameters
Name
Description
Type
Notes
Source Device or Device Group
The device or device group which contains a data point. If specified, then this device (typically the same device as the measurement source) is checked to see if it contains a data point for the specified fragment and series. If it contains a data point, the red and yellow range values from the source object are used in place of the KPI values. The model editor uses the current device or asset name. This is mapped internally to the inventory identifier.
string
Optional
Data Point Fragment and Series
This parameter must be specified if the Source Device or Device Group parameter is specified. It specifies a data point from the source object. This is typically the same as the fragment and series of the measurement source.
The data point fragment and series must be specified as fragment.series.
string
Optional
Upper end of yellow range exclusive
If set, the upper end of the yellow range is treated as being exclusive.
boolean
Default: false
Upper end of red range exclusive
If set, the upper end of the red range is treated as being exclusive.
boolean
Default: false
Input Port Details
Name
Description
Type
Value
Numeric value to compare with the defined ranges.
float
KPI
Object containing the c8y_Kpi property.
pulse
Output Port Details
Name
Description
Type
Red
Is set to true when the value is in the red range (if a red range is defined).
boolean
Yellow
Is set to true when the value is in the yellow range (if a yellow range is defined).
boolean
Unit
The unit name from the data point.
string
Label
The label name from the data point.
string