KpiDefinition

The KpiDefinition entity allows you to use KPI definition details of a process definition.

Attributes and Filters

You can use the attributes from the following table to request the KPI definition details from an SAP Business Suite system.

Note

You can use the Name, ShortDescription, and KpiType attributes in the following cases only:

When you use the Name, ShortDescription, or KpiType attribute in conjunction with the ProcessFamilyID attribute
When you access the KpiDefinition entity by navigating from another entity

Attribute	Description	Filters Operators	Example
KpiDefinitionID	ID used to uniquely identify a KPI definition across process definitions	EQ	`$Filter = KPIDefinitionID EQ ‘BP_BRF_TESTING~001~KP1‘`
Name	Name of a KPI. It is a display name only and you cannot use it to uniquely identify a KPI definition	SubStringOf	`$Filter = SUBSTRINGOF(‘SALES’, Name)`
		StartsWith	`$Filter = STARTSWITH(Name, ‘SALES’)`
		EndsWith	`$Filter = ENDSWITH(Name, ‘ORDER’)`
ProcessFamilyID	ID used to uniquely identify a process family	EQ	`$Filter = ProcessFamilyID eq 'BP_BRF_TESTING'`
ShortDescription	Additional information of a KPI definition	SubStringOf	`$Filter = SUBSTRINGOF(‘SALES’, ShortDescription)`
		StartsWith	`$Filter = STARTSWITH(ShortDescription, ‘Sales’)`
		EndsWith	`$Filter = ENDSWITH(ShortDescription, ‘Order’)`
KpiType	KPI type; possible values are `count`, `duration`, and `classification`.	Not applicable	Not applicable
ThresholdDefined	Indicates whether a threshold is defined as KPI or not	Not applicable	Not applicable
ProcessDefinitionID	ID used to uniquely identify a process step definition in a system	Not applicable	Not applicable

Navigation

From the KPIDefinition entity, you can navigate to other related entities (see below) and retrieve the required details: