KPI
The KPI entity allows you to provide the various KPIs of a process.
You can use one of the attributes from the table below to request the KPI details from an SAP Business Suite system.
You can use the KpiDefinitionName, ThresholdExceeded, and Status attributes as filters in the following cases only:
When you use the KpiDefinitionName, ThresholdExceeded, or Status attribute in conjunction with the ProcessFamilyID attribute
When you access the KPI entity by navigating from another entity
Attribute |
Description |
Filter Operators |
Example |
KpiID |
ID used to uniquely identify a KPI |
EQ |
$Filter = KpiID EQ ‘3AB2994F314C375FE10000000A428CC9~C2~000’ |
ProcessFamilyID |
ID used to uniquely identify a process family |
EQ |
$Filter = ProcessFamilyID EQ 'SALES ORDER PROCESS' |
KpiDefinitionName |
Name of a KPI definition |
SubStringOf, StartsWith, EndsWith |
$Filter = (ProcessFamilyID EQ 'PGW_INTEGRATION_TEST_O2C' and EndsWith(KpiDefinitionName,'Issue')) |
ThresholdExceeded |
Indicates whether a defined threshold has exceeded |
EQ |
$Filter = ThresholdExceeded EQ ‘x’ |
KpiDefinitionShortDescription |
Additional information of a KPI definition |
SubStringOf, StartsWith, EndsWith |
$Filter=(ProcessFamilyID EQ 'PGW_INTEGRATION_TEST_O2C' and EndsWith(KPIDefinitionShortDescription,'Issue')) |
KpiType |
KPI type; possible values are count, duration, and classification |
Not applicable |
Not applicable |
Status |
Status of a KPI; possible values are In process and Finished |
Not applicable |
Not applicable |
Value |
Value of a KPI. For example, if there is a KPI defined that sales order must be approved in 3 days, and if 2 days have already elapsed and the sales order is not approved, then the value is 1. |
Not applicable |
Not applicable |
Unit |
Unit of a KPI. For example, if there is a KPI defined that sales order must be approved in 3 days, and if 2 days have already elapsed and the sales order is not approved, then the unit is day. |
Not applicable |
Not applicable |
ThresholdExceededTimestamp |
Timestamp at which the defined threshold has exceeded |
Not applicable |
Not applicable |
ThresholdValue |
Threshold value of a KPI. For example, if there is a KPI defined that sales order must be approved in 3 days, then the value is 3. |
Not applicable |
Not applicable |
ThresholdUnit |
Threshold value of a KPI. For example, if there is a KPI defined that sales order must be approved in 3 days, then the unit is day. |
Not applicable |
Not applicable |
BusinessObjectReference |
Business object instance created for a process step |
Not applicable |
Not applicable |
ProcessID |
ID used to uniquely identify a process in a system |
Not applicable |
Not applicable |
ProcessStepDefinitionID |
ID used to uniquely identify a process step definition in a system |
Not applicable |
Not applicable |
KpiDefinitionID |
ID used to uniquely identify a KPI definition across process definitions |
Not applicable |
Not applicable |
From the KPI entity, you can navigate to other related entities (see below) and retrieve the required details:
KPIDefinition
Process
ProcessStep