# ItemCorrelationType (Complex Type)

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

Supertype: CorrelationItemDefinitionType
TODO

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
name | property string | [0,1] | Name by which this definition is referenced.
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.
path | property ItemPathType | [0,1] | Short alternative to source/target definitions.
source | property CorrelationItemSourceDefinitionType | [0,1] | TODO
target | property CorrelationItemTargetDefinitionType | [0,-1] | TODO
ref | property string | [0,1] | Points to a shared item definition in "items" part of "definitions".

- ### Items

  - #### name

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Name by which this definition is referenced. If not present, the last segment of the source is used to derive the name.

  - #### 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.

  - #### path

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Short alternative to source/target definitions. If present, default source and target with this path are created. Should not be used along with source and/or target definitions.

  - #### source

    Flags: RAM,runtime

    Multiplicity: [0,1]

    TODO

  - #### target

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    TODO

  - #### ref

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Points to a shared item definition in "items" part of "definitions".