2.2.5.12 KPI Object
The KPI object represents a key performance indicator (KPI) object. It is a child of a Measure object.
The KPI object has the following properties.
Name |
Type |
Description |
---|---|---|
ID |
unsignedLong |
A reference to the object. |
MeasureID |
unsignedLong |
An ID-based reference to a Measure object. |
Description |
string |
The description of the object. |
TargetDescription |
string |
The description of the target value of the KPI. |
TargetExpression |
string |
An expression that evaluates to a number and indicates the goal for the KPI. |
TargetFormatString |
string |
The format string to be used when presenting the target value for the KPI. |
StatusGraphic |
string |
A string that identifies the recommended graphic to represent the status of the KPI.<64> |
StatusDescription |
string |
A description of the Status value for the KPI. |
StatusExpression |
string |
An expression that is used to calculate the status of the KPI. |
TrendGraphic |
string |
A string that identifies the graphic to show for the trend of the KPI.<65> |
TrendDescription |
string |
A description of the trend value of the KPI. |
TrendExpression |
string |
An expression representing the trend of the KPI. |
ModifiedTime |
dateTime |
The time that the object was last modified. |