Metrics Engine Documentation Index
Configuration Reference Home

Aggregate Search Entry 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 Entry Criteria provide search entry criteria which contain Boolean combinations of other search entry criteria objects.

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

Parent Component

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

Relations from This Component

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

Properties

The properties supported by this managed object are as follows:


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

Basic Properties

description

Description
A description for this Search Entry 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-entry-criteria

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

any-included-search-entry-criteria

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

not-all-included-search-entry-criteria

Description
Specifies a search entry criteria object that should not match the associated search result entry in order to match the aggregate search entry criteria. If one or more not-all-included search entry criteria objects are provided, then a search result entry 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 entry criteria.
Default Value
None
Allowed Values
The DN of any Search Entry Criteria.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

none-included-search-entry-criteria

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


dsconfig Usage

To list the configured Search Entry Criteria:

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

To view the configuration for an existing Search Entry Criteria:

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

To update the configuration for an existing Search Entry Criteria:

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

To create a new Aggregate Search Entry Criteria:

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

To delete an existing Search Entry Criteria:

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