The Union Workflow Element is used to aggregate several DITs into a virtual unified DIT.
The Union Workflow Element component inherits from the Workflow Element
The following components have a direct COMPOSITION relation FROM Union Workflow Elements :
A description of each property follows.
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ auto-tune-search-option | ↓ java-class |
| ↓ base-dn | |
| ↓ bind-option | |
| ↓ cache-size | |
| ↓ enabled | |
| ↓ search-first-match | |
| ↓ suppress-entry-duplicates |
| Description | A subtrees search with the filter e.g. !(uid=user.1) is likely to target a entry if search-first-match property is set to true however it should target several entries e.g. uid=user.2 and uid=user.3 as these could be valid results for this condition. To enable union workflow element to return several entries which are meeting the condition even if search-first-match is set to true, set this property to true. It has two options of false and true. True enables the union workflow element to target several entries based on the search filter even if search-first-success property is set to true. False doesn't allow union work flow element to target several entries based on the search filter in case of search-first-success property is set to true. |
|---|---|
| Default Value | false |
| Allowed Values | true false |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | The base DN of the virtual unified DIT. A virtual unified DIT is an aggregation of one or more partitons. |
|---|---|
| Default Value | None |
| Allowed Values | A valid DN. |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | Yes |
| Description | Indicates if a bind request should fall through the list of all configured partitions until it reaches first success or fail if multiple users have the same DN from different configured partitions. It has two options BindFirstSuccess and BindQuickFail. Set this option as BindQuickFail if bind has to fail in case multiple users have the same DN from different configured partitions. By default it takes BindFirstSuccess which allows bind to fall through the list of all configured partitions until it reaches first success. |
|---|---|
| Default Value | bind-first-success |
| Allowed Values | bind-first-success - Allows the bind to fall through the list of all configured eligible partitions until it reaches a first success. bind-quick-fail - Cause the bind to immediately throw an error if multiple users from different partitions have the same DN that is used as a bindDN. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | The maximum number of entries that can be stored in the cache used to filter out entry duplicates. When the entry duplicates filtering is active, the UnionWorkflowElement stores the returned entry DNs in a cache. A cache is specific to a search operation, and when the cache is full, the search operation is aborted. By default, the cache can handle 10 000 DNs. When the cache size is set to 0 or is negative, then no limit is enforced. |
|---|---|
| Default Value | 10000 |
| Allowed Values | An integer value. Lower value is 0. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Indicates whether the Workflow Element is enabled for use in the server. If a Workflow Element is not enabled, then its contents are not accessible when processing operations. |
|---|---|
| Default Value | None |
| Allowed Values | true false |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Indicates if a subtree search should stop the processing once an entry is found. A subtree search with the filter (uid=user.1) is likely to target a single entry. However, in some deployment, there can be several entries with uid=user.1 in the various data sources. To prevent the union workflow element from returning more than one entry with UId-user.1, set this property to true. |
|---|---|
| Default Value | true |
| Allowed Values | true false |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Indicate whether the Union Workflow Element should try to suppress the entry duplicates. The union distribution merges several physical DITs into a single virtual DIT. The merge process may bring into the virtual DIT several entries with the same DN. When the merge process is likely to bring duplicate entries into the virtual DIT, it is recommended to set this flag to true so that the Union Workflow Element filters out the entrie duplicates. By default, the filtering of entrie duplicates is not active because the filtering process is memory consuming. Note that the filtering process uses an entry cache, and by default the cache is sized to handle 10 000 entries per operation. You may change this default value through the entry-duplicates-cache-size parameter. |
|---|---|
| Default Value | false |
| Allowed Values | true false |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Specifies the fully-qualified name of the Java class that provides the Union Workflow Element implementation. |
|---|---|
| Default Value | org.opends.server.workflowelement.union.UnionWorkflowElement |
| Allowed Values | A java class that implements or extends the class(es) : org.opends.server.workflowelement.WorkflowElement |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | Yes |
| Read-only | No |