Metrics Engine Documentation Index
Configuration Reference Home

Aggregate Search Reference Criteria

Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.

Aggregate Search Reference Criteria provide search reference criteria which contain Boolean combinations of other search reference criteria objects.

↓Parent Component
↓Relations To this Component
↓Properties
↓dsconfig Usage

Parent Component

The Aggregate Search Reference Criteria component inherits from the Search Reference Criteria

Relations from This Component

The following components have a direct aggregation relation from Aggregate Search Reference Criteria:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ all-included-search-reference-criteria
↓ any-included-search-reference-criteria
↓ not-all-included-search-reference-criteria
↓ none-included-search-reference-criteria

Basic Properties

description

Description
A description for this Search Reference Criteria
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

all-included-search-reference-criteria

Description
Specifies a search reference criteria object that must match the associated search result reference in order to match the aggregate search reference criteria. If one or more all-included search reference criteria objects are provided, then a search result reference must match all of them in order to match the aggregate search reference criteria.
Default Value
None
Allowed Values
The DN of any Search Reference Criteria.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

any-included-search-reference-criteria

Description
Specifies a search reference criteria object that may match the associated search result reference in order to match the aggregate search reference criteria. If one or more any-included search reference criteria objects are provided, then a search result reference must match at least one of them in order to match the aggregate search reference criteria.
Default Value
None
Allowed Values
The DN of any Search Reference Criteria.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

not-all-included-search-reference-criteria

Description
Specifies a search reference criteria object that should not match the associated search result reference in order to match the aggregate search reference criteria. If one or more not-all-included search reference criteria objects are provided, then a search result reference must not match all of them (that is, it may match zero or more of them, but it must not match all of them) in order to match the aggregate search reference criteria.
Default Value
None
Allowed Values
The DN of any Search Reference Criteria.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

none-included-search-reference-criteria

Description
Specifies a search reference criteria object that must not match the associated search result reference in order to match the aggregate search reference criteria. If one or more none-included search reference criteria objects are provided, then a search result reference must not match any of them in order to match the aggregate search reference criteria.
Default Value
None
Allowed Values
The DN of any Search Reference Criteria.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Search Reference Criteria:

dsconfig list-search-reference-criteria
     [--property {propertyName}] ...

To view the configuration for an existing Search Reference Criteria:

dsconfig get-search-reference-criteria-prop
     --criteria-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Search Reference Criteria:

dsconfig set-search-reference-criteria-prop
     --criteria-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Aggregate Search Reference Criteria:

dsconfig create-search-reference-criteria
     --criteria-name {name}
     --type aggregate
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Search Reference Criteria:

dsconfig delete-search-reference-criteria
     --criteria-name {name}