Definition of standard measures

A measure is defined in the client-specific XML configuration file with the KeyindicatorConfiguration.dtd document type definition by the following element:

...

<kidef name="..." attrname="..." type="..."

calculated="..." distribution="..."

standarddeviation="..." retrievertype="..."

kigroup="..." sharedfunctionki="..."

functionspanki="..." colname="..."

importmode="OPTIONAL">

<description language="..." name="...">

Description text...

</description>

</kidef>

...

XML attribute

Description

name

Internal name of the measure. Referenced in the useki XML tag in the process tree definition.

type

Measure type
PROCESS: Process measure
FUNCTION (obsolete): Function measure
OT_FUNC: Function measure
OT_ORG: Organizational measure
RELATION: Relation measure

location
(optional)

Only for type="RELATION"

Valid values: SOURCE (attribute placement on source reference object of relation)
TARGET (attribute placement on target reference object of relation)
THIS (default value: attribute is placed at the relation itself)

description

Language-specific description of a group, optionally with tooltip (#PCDATA section in the description element). The description must be specified in at least the default language.

attrname

Name of the attribute on which the measure is based. This can be an existing attribute value (calculated=FALSE) or an attribute value to be calculated (calculated=TRUE).

calculated

TRUE: The value of the referenced attribute is calculated using the calculation rule specified by calcattr.
FALSE: The value of the referenced attribute is not calculated.

distribution

TRUE: The measure can be used as a dimension.
FALSE: The measure cannot be used as a dimension.

standarddeviation
(optional)

TRUE: The standard deviation can be calculated for the measure. The standard deviation can be calculated for all measures except Number of processes and Number of functions.
The default value is TRUE.

sharedfunctionki
(optional)

TRUE: The measure is treated as a shared function measure for calculating measures. The measure for a shared function is only calculated once and applies to all instances of the shared function.
Default value is FALSE.

functionspanki
(optional)

TRUE: The measure is a function span measure (e.g., cycle span).
If the function occurs multiple times within a process instance, the measure value calculated applies only once per instance.
Default value is FALSE.

retrievertype
(optional)

Type of measure retriever used. Defines how the set of measure values for the process instances involved in a particular analysis is aggregated.
Default value: KEYINDICATOR.

KEYINDICATOR:
Calculates the average value (e.g., cycle time). Numerical types except LONG are all permitted as data types.

NUM_KEYINDICATOR:
Aggregates numerical measures (e.g., number of processes, number of functions) by adding the values. All numerical data types are valid.

FREQ_KEYINDICATOR:
Aggregates frequencies (e.g., process frequency, function frequency). The values are added and then divided by the time span resulting from the selected step width of the dimension and the set time filter.

FACTORY_KEYINDICATOR:
Aggregates measures by calculating the average using the factory calendar. FACTORY_TIMESPAN is the only permissible data type.

dimreferring

Type of dimension reference
LOOSE: Loose
STRICT: Strict
Default value: LOOSE

kigroup
(optional)

Measure group

importmode
(optional)

Output of error messages when calculating measure values.
OPTIONAL: Calculation errors are not output.
MANDATORY: Calculation errors are output
Default value: OPTIONAL

Only one of the sharedfunctionki and functionspanki attributes may have the value TRUE. If one of the two attributes has the value TRUE, the type measure type must have the value FUNCTION (function measure).

The FACTORY_KEYINDICATOR measure retriever type is no longer used from PPM 3.x, but is still supported for compatibility reasons. When the configuration is imported, it is replaced by the KEYINDICATOR retriever type.