# SimulationMetricDefinitionType (Complex Type)

### Namespace: http://midpoint.evolveum.com/xml/ns/public/common/common-3

Explicit definition of a metric.

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
identifier | property string | [0,1] | Identifier of the metric.
description | property string | [0,1] | Free-form textual description of the object.
documentation | property string | [0,1] | Technical documentation for a particular object or construct.
display | container DisplayType | [0,1] | Display style of the metric.
displayOrder | property int | [0,1] | An order in which this metric should be displayed relative to other metrics within the same context.
enabledByDefault | property boolean | [0,1] | Is this metric enabled by default?
computation | container SimulationMetricComputationType | [0,1] | How is the metric value computed for individual "processed objects"? May be missing when this metric is computed from a different (source) object-level metric.
aggregation | container SimulationMetricAggregationType | [0,1] | How are the metric values aggregated? May be missing when automatic aggregation (i.

- ### Items

  - #### identifier

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Identifier of the metric.

  - #### description

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Free-form textual description of the object. It is supposed to describe the object or a construct that it is attached to.

    This information may be presented to midPoint users, even to ordinary end users. For example role description may be presented to users when they are selecting roles to request. Therefore the description should be written in a language that the users can understand.

    Description is assumed to be a plan, non-formatted text. Amount of white space is considered insignificant. E.g. leading and trailing white space may be skipped, multiple spaces can be collapsed to one and so on.

  - #### documentation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Technical documentation for a particular object or construct.

    The purpose of this element is to document system configuration and behavior. The documentation will not be presented to end users. In fact, it will probably not be presented at all in midPoint user interface. This documentation element is supposed to be a part of the technical documentation of midPoint deployment. The tools than generate deployment configuration will look for these elements and combine them to compiled documentation document.

    AsciiDoc formatting is assumed for this element. Any leading or trailing whitespace is skipped. Indentation equivalent to he indentation of the first non-blank line of text is also skipped.

  - #### display

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display style of the metric.

  - #### displayOrder

    Flags: RAM,runtime

    Multiplicity: [0,1]

    An order in which this metric should be displayed relative to other metrics within the same context.

  - #### enabledByDefault

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Is this metric enabled by default?

  - #### computation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    How is the metric value computed for individual "processed objects"? May be missing when this metric is computed from a different (source) object-level metric.

  - #### aggregation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    How are the metric values aggregated? May be missing when automatic aggregation (i.e. plain summation) is employed.