Configuration Reference Home
OpenDS - Distribution Workflow Element

Distribution Workflow Element

The Distribution Workflow Element is used to partition a DIT into subsets of entries.

Parent Component

The Distribution Workflow Element component inherits from the Workflow Element

Relations From this Component

The following components have a direct COMPOSITION relation FROM Distribution Workflow Elements :

The following components have a direct AGGREGATION relation FROM Distribution Workflow Elements :




This page describes the Distribution Workflow Element:


Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ base-dn ↓ force-modify-dn
↓ enabled ↓ java-class
↓ global-index-catalog
↓ workflow-element-id

Basic Properties

base-dn

Description
Identifies the portion of the DIT targeted by the distribution. The base DN of the subtree to partition is specified by this base-dn attribute.
Default Value
None
Allowed Values
A valid DN.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
Yes

enabled

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

global-index-catalog

Description
The global index used by the distribution workflow element.
Default Value
None
Allowed Values
The DN of any Extension. The referenced global index catalog must be enabled.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

workflow-element-id

Description
Provides a name that identifies the associated Workflow Element . The name must be unique among all Workflow Elements in the server.
Default Value
None
Allowed Values
A String
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
Yes


Advanced Properties

force-modify-dn

Description
This flag determines if a modify DN is always accepted or not. Considering the following distribution: partition1=[1..1000[ and partition2=[1000..2000[. And considering the DIT where user entries are stored in [ou=people,dc=example,dc=com]. When a modify DN is targeting the entry uid=1,ou=people,dc=example,dc=com: modifying the RDN uid=1 to uid=2 is always accepted because the new entry stays in partition1. Modifying the RDN uid=1 to uid=1200 is not accepted because the new entry would need to be moved to the partition2, and moving entries from one partition to another is not supported. If the flag forceModifyDN is set to true then the request is accepted anyway but the new entry stays in partition1. Note that when the force modify DN flag is set to true then the distribution should be configured with a global index catalog because when entries are "moved" the distribution algorithm might not be able to locate them properly.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

java-class

Description
Specifies the fully-qualified name of the Java class that provides the Distribution Workflow Element implementation.
Default Value
com.sun.dps.server.workflowelement.distribution.DistributionWorkflowElement
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


LDAP Mapping

Each configuration property can be mapped to a specific LDAP attribute under the "cn=config" entry. The mappings that follow are provided for information only. In general, you should avoid changing the server configuration by manipulating the LDAP attributes directly.

Base DN
cn=Workflow elements,cn=config
objectclass name
ds-cfg-distribution-workflow-element
objectclass superior
ds-cfg-workflow-element

Property
LDAP attribute
base-dn
ds-cfg-distribution-base-dn
enabled
ds-cfg-enabled
force-modify-dn
ds-cfg-distribution-force-modify-dn
global-index-catalog
ds-cfg-global-index-catalog
java-class
ds-cfg-java-class
workflow-element-id
ds-cfg-workflow-element-id