Key Performance Indicators
Introduction
Product 360 provides a framework for key performance indicator (KPI) value calculation, also for any customer specified KPI contribution.
Calculation of the KPI values in Product 360
Calculation schedule
Product 360 provides two ways to calculate KPI values for which the corresponding KPI should be contributed with an own KPI value calculator:
Calculate KPI values (scheduled): A system server job is running periodically to schedule the execution of all contributed KPI value calculators. The values of each contributed KPI are calculated for the time interval which is based on the corresponding KPI extension attribute daysToBeBacktracked and the current time as referenceTime. For details please visit the chapter "Scheduling KPI implementation" of the Customizing guide.
Calculate KPI values (manual): Call the REST API to schedule another server job which calculates the KPI values for the desired contributed KPIs. The values of each desired KPI are calculated for the time interval which is based on the desired daysToBeBacktracked and the desired referenceTime. For details please visit the chapter "Schedule calculation of Key Performance Indicator(KPI) values" of the Customizing guide.
Please visit also the further chapters for detailed information about topics like contribution of an own KPI, the KPI REST API, the standard contributed KPI, etc..
Calculation process
Determine interval for KPI value calculation
For each KPI value calculation it should be determined which time interval is considered in the first place. It will be calculated with the corresponding value of referenceTime and daysToBeBacktracked.
referenceTime specifies the end time of the interval. For the system job "Calculate KPI values (scheduled)" it is always the current time.
daysToBeBacktracked specifies a value for the days to be backtracked ending at the date of the referenceTime value.
As it is a defined interval it consists of two parameters: startTime which is included, while endTime is excluded. This means interval = [startTime, endTime).
Calculate the KPI value for the necessary time
The determined interval is then separated to a continuous time unit (days) series. For each day it is checked whether the corresponding calculation is already executed or not. Already executed means that KPI values of a specific KPI are already calculated for the complete day interval. These days are considered finished and calculators are not called again for that day. This way repeated result calculation for the same period of time is prevented.
The following example indicates the above mentioned calculation process:
Initially schedule calculation for the referenceTime "1980 10.01. 20:00:00" and daysToBeBacktracked is 1 day. Then the following KPI calculation result is persisted.
KPI data
startTime
endTime
is day completed?
inserted
1980 09.30. 00:00:00
1980 10.01. 00:00:00
YES
inserted
1980 10.01. 00:00:00
1980 10.01. 20:00:00
NO
Then schedule calculation for the referenceTime "1980 10.02. 22:10:00" and daysToBeBacktracked is 2 day. Then the following KPI calculation result is persisted.
KPI data
startTime
endTime
is day completed?
updated
1980 10.01. 00:00:00
1980 10.02. 00:00:00
YES
inserted
1980 10.02. 00:00:00
1980 10.02. 22:10:00
NO
Recalculate KPI values
Product 360 provides also the possibility to enforce the recalculation of a KPI value for a desired time interval which will also be persisted again. For this purpose the user should call the REST API to remove all persisted values and execution data for the corresponding KPIs and time intervals.
For the details please visit the chapter "Remove persisted results of Key Performance Indicator (KPI) calculations" of the Customizing guide.
Further reading
KPI Service Management API
A Management API has been added to the Service API. Please have a look at the chapter "KPI Service Management API" of the Customizing guide.
Standard KPI 'Average Time Spent in Workflow States'
Please have a look at the chapter "Standard KPI 'Average Time Spent in Workflow States'" to learn more about how to configure and use this standard KPI.
KPI Performance Indicator customization
Product 360 provides a framework for the calculation of custom KPIs. Please have a look at the chapter "Key Performance Indicator customization" of the Customizing guide.