The Workflow is a list of processing steps (Work Flow Elements) that are applied to data as it is retrieved from the Directory Server.
The following components have a direct AGGREGATION relation FROM Workflows :
The following components have a direct AGGREGATION relation TO Workflows :
A description of each property follows.
Basic Properties: | Advanced Properties: |
---|---|
↓ access-control-group | ↓ criticality |
↓ base-dn | |
↓ enabled | |
↓ virtual-aci-mode | |
↓ workflow-element |
Description | Specifies the access control group used by the Workflow. The access control group used by Workflow manages acis for naming context corresponding to this Workflow. Note that one or more Workflows may share the same access control group. |
---|---|
Default Value | The globally available default access control group will be used. |
Allowed Values | The DN of any Access Control Group. |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | Specifies the base DN of the data targeted by the Workflow . |
---|---|
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 whether the Workflow is enabled for use in the server. If a Workflow 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 whether the Workflow uses the virtual acis. If this property is set to true, the Workflow will use the virtual acis, i.e., the acis that are managed independent of the associated ldap entry. If it is set to false, the local acis, if any, are used wherever applicable. |
---|---|
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 root Workflow Element in the Workflow . |
---|---|
Default Value | None |
Allowed Values | The DN of any Workflow Element. The referenced workflow element must be enabled. |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | The criticality determines the behavior to adopt when one of the workflow elements belonging to a workflow returns an UNAVAILABLE result code during the execution of a search operation. This parameter is meaningful only for search requests. If the execution of a search operation on a workflow returns an UNAVAILABLE result code, the behavior is based on the criticality parameter: - TRUE: the workflow is critical, the search operation is stopped and an UNAVAILABLE result code is returned to the client. - PARTIAL: the workflow is partially critical, the search operation continues with other workflows involved in the search. The entries which are retrieved from healthy workflows are returned to the client. A result code of ADMIN_LIMIT_EXCEEDED is returned to the client, which indicates that the entries returned may be incomplete because one or more workflows failed to return entries. - FALSE: the workflow is not critical, the search operation continues with other workflows involved in the search. The entries which are retrieved from healthy workflows are returned to the client. No special result code is returned to the client. |
---|---|
Default Value | true |
Allowed Values | false - The workflow is not critical. partial - The workflow is partially critical. true - The workflow is critical. |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |