# CompositeSubCorrelatorType (Complex Type)

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

Supertype: CompositeCorrelatorType
Composition-enabled composite correlator.

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
name | property string | [0,1] | Name of the correlator.
displayName | property string | [0,1] |
description | property string | [0,1] |
documentation | property string | [0,1] |
confidence | container CorrelationConfidenceDefinitionType | [0,1] | Defines how this correlator - if matching - increases the overall confidence of its results.
enabled | property boolean | [0,1] | A way how to disable a correlator (either temporarily, or e.
super | container SuperCorrelatorReferenceType | [0,1] | Reference to the "super-correlator", serving as a template for this correlator.
scaling | container CompositeCorrelatorScalingDefinitionType | [0,1] | Scaling to be applied to the results of this correlator.
extension | container ExtensionType | [0,1] | Correlators not defined in the static schema.
none | container NoOpCorrelatorType | [0,-1] | "No-op" correlation that always returns "certainly no owner" result.
items | container ItemsSubCorrelatorType | [0,-1] | Correlation using a list of matching items.
filter | container FilterSubCorrelatorType | [0,-1] | Correlation using a query filter.
expression | container ExpressionSubCorrelatorType | [0,-1] | Correlation using a custom expression.
idMatch | container IdMatchSubCorrelatorType | [0,-1] | Correlation using ID Match service.
composite | container CompositeSubCorrelatorType | [0,-1] | Correlation using multiple correlators.
use | property CorrelationUseType | [0,1] | Determines when the correlation should be used.
composition | container CorrelatorCompositionDefinitionType | [0,1] | The role of this correlator in the overall composition.

- ### Items

  - #### name

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 10

    Name of the correlator. Should be unique in the given context (object type definition, resource, or system-wide).

  - #### displayName

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 20

  - #### description

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 30

  - #### documentation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 40

  - #### confidence

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 70

    Defines how this correlator - if matching - increases the overall confidence of its results.

  - #### enabled

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 90

    A way how to disable a correlator (either temporarily, or e.g. for sub-types).

  - #### super

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 100

    Reference to the "super-correlator", serving as a template for this correlator.

  - #### scaling

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 70

    Scaling to be applied to the results of this correlator.

  - #### extension

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Correlators not defined in the static schema. (E.g. dummy correlator used for testing, or custom correlators.)

  - #### none

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Display order:

    "No-op" correlation that always returns "certainly no owner" result.

  - #### items

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Display order:

    Correlation using a list of matching items.

  - #### filter

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Display order:

    Correlation using a query filter.

  - #### expression

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Display order:

    Correlation using a custom expression.

  - #### idMatch

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Display order:

    Correlation using ID Match service. See https://spaces.at.internet2.edu/display/cifer/SOR-Registry+Strawman+ID+Match+API.

  - #### composite

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Display order:

    Correlation using multiple correlators.

  - #### use

    Flags: RAM,runtime,AVals:2

    Multiplicity: [0,1]

    Display order:

    Determines when the correlation should be used. If not specified, synchronization is assumed. Note: For synchronization, only one correlator makes sense, but for username recovery, many correlators might be defined.

  - #### composition

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 50

    The role of this correlator in the overall composition. Technically, this is a part of the parent (composite) correlator definition.