# FilterSubCorrelatorType (Complex Type)

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

Supertype: FilterCorrelatorType
TODO

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.
ownerFilter | property ConditionalSearchFilterType | [0,-1] | The filter that should return a list of candidate focus entries that may be owners of a particular shadow.
confirmation | property ExpressionType | [0,1] | Confirmation expression.
useConfirmationForSingleCandidate | property boolean | [0,1] | Should be the confirmation expression used also when there is only a single candidate found by the filter? (The default is true.
composition | container CorrelatorCompositionDefinitionType | [0,1] | The role of this correlator in the overall composition.

- ### Items

  - #### name

    Flags: RAM,runtime

    Multiplicity: [0,1]

    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]

  - #### description

    Flags: RAM,runtime

    Multiplicity: [0,1]

  - #### documentation

    Flags: RAM,runtime

    Multiplicity: [0,1]

  - #### confidence

    Flags: RAM,runtime

    Multiplicity: [0,1]

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

  - #### enabled

    Flags: RAM,runtime

    Multiplicity: [0,1]

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

  - #### super

    Flags: RAM,runtime

    Multiplicity: [0,1]

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

  - #### ownerFilter

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    The filter that should return a list of candidate focus entries that may be owners of a particular shadow.

    The filter in this case is conditional, i.e. there can be specified an expression that denotes a necessary condition for the filter to be applied.

    Beware that the list of filters is unordered, so individual filters can be executed in arbitrary order. If you want to prescribe specific order, please use multiple filter correlators.

  - #### confirmation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Confirmation expression. The arguments are an account and a candidate owner (user). The confirmation expressions should return true if the user should be owner of the account. It should return false if the user cannot be owner of the account. The evaluation of the confirmation expression may be relatively inefficient, as it will only be run for candidate entries returned by correlation expression. TODO review this The expression variables should be set as follows: $user - the candidate user object (one of the results of correlation expression) $account - the changed account object

  - #### useConfirmationForSingleCandidate

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Should be the confirmation expression used also when there is only a single candidate found by the filter? (The default is true. This is consistent with midPoint 4.3+ behavior. Before midPoint 4.3, the default was false.)

  - #### composition

    Flags: RAM,runtime

    Multiplicity: [0,1]

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