# PolicyRuleType (Complex Type)

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

These rules specify compliance and governance constraints. E.g. role exclusion (SoD), number of assignees, approvals, remediation, etc. This is the form suitable for use in assignments/inducements.

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
name | property string | [0,1] | Name of the rule.
description | property string | [0,1] | Free-form description of the rule (comment).
documentation | property string | [0,1] | Technical documentation for a particular object or construct.
policyConstraints | container PolicyConstraintsType | [1,1] | Constraints to be applied to selected objects.
markRef | reference ObjectReferenceType | [0,-1] | Mark(s) that are the result when this policy rule is triggered.
policySituation | property anyURI | [0,1] | Policy situation that is the result when this policy rule is triggered.
policyThreshold | container PolicyThresholdType | [0,1] | Policy threshold specification.
policyActions | container PolicyActionsType | [0,1] | Action(s) that has to be taken as a reaction to this rule being triggered.
evaluationTarget | property PolicyRuleEvaluationTargetType | [0,1] | Whether this rule has to be applied on an object or an assignment.

- ### Items

  - #### name

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Name of the rule. It is used to record processing of the rule in the log files and for similar diagnostic reasons.

  - #### description

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Free-form description of the rule (comment).

  - #### documentation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    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.

  - #### policyConstraints

    Flags: RAM,runtime

    Multiplicity: [1,1]

    Display order:

    Constraints to be applied to selected objects.

  - #### markRef

    Flags: RAM

    Multiplicity: [0,-1]

    Display order:

    Mark(s) that are the result when this policy rule is triggered. These may be implicit if the policy rule is defined as part of mark definition.

  - #### policySituation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Policy situation that is the result when this policy rule is triggered. If the situation is not explicitly stated then default situation will be selected instead. The situation is determined by the constraint that triggered the rule. Will be eventually replaced by markRef.

  - #### policyThreshold

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Policy threshold specification. It determines thresholds settings such as count after which the action is being executed, refresh interval for counter, ...

  - #### policyActions

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Action(s) that has to be taken as a reaction to this rule being triggered.

  - #### evaluationTarget

    Flags: RAM,runtime,AVals:3

    Multiplicity: [0,1]

    Display order:

    Whether this rule has to be applied on an object or an assignment. Normally this is determined by looking at policy constraints. But this setting can be used to override that.