Create KPI#

KPI.Create

KPI.CreateTemplate

KPI.CreateFromTemplate

Overview#

This operation is used to create a KPI, i.e. to define a generic mechanism to store KPI data to be later displayed in reports and Widgets. A template can also be created using a similar procedure and there is also the possibility of using a template to create the new object as well. This selection can be done in the main entity menu.

Setup#

No specific setup is required other than to meet the precondition of the transaction.

Preconditions#

• The combination of KPI name and EntityType must be unique.
• If the SourceType is Dynamic:
  • The EntityType must be defined.
  • At least one KPI Dimension must be defined.
• All defaults must respect the Parameter definition datatype and boundaries - note that values can only be specified for numeric parameters.
• The following properties can only be defined in the following KPITypes and only if the parameter is numeric - must be null in other cases:
  • DefaultCloseToTargetMinimumValue - for KPIs of type Maximum and Deviation only.
  • DefaultCloseToTargetMaximumValue - for KPIs of type Minimum and Deviation only.
  • DefaultInTargetMinimumValue - for KPIs of type Maximum and Deviation only.
  • DefaultInTargetMaximumValue - for KPIs of type Minimum and Deviation only.

Sequence of Steps#

Step 1: Details#

1. Provide a name for the KPI.
2. Optionally, provide a description for the KPI.
3. Select the Type of KPI. The list of possible values is taken from the lookup table KPIType.
4. Define the KPI's Source type - Static or Dynamic. If the Source Type is Static, the Parameter must be numeric and if the Source Type is Dynamic, it can be of any type.
5. Select the Entity Type.
6. Select the Parameter of KPI scope.
7. Select a KPI Type from the following options:
   • Maximum
   • Minimum
   • Deviation
8. Select the Frequency:
   • Daily
   • Weekly
   • Monthly
   • Yearly
9. Optionally, define an owner role.
10. Select Create to complete the operation.