Join Participants are other WorkFlow elements that are participating in Join process.
The Join WorkflowElement can have one primary participant and one or more secondary participants, each of which is a WorkFlow Element of any type like LDAP Proxy WorkflowElement, RDBMS WorkflowElement, LocalBackend WorkflowElement, Distribution WorkflowElement, LoadBalancing WorkflowElement or even another Join WorkflowElement.
The following components have a direct AGGREGATION relation FROM Join Participants :
The following components have a direct COMPOSITION relation TO Join Participants :
A description of each property follows.
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ enabled-operation | None |
| ↓ join-condition | |
| ↓ join-policy | |
| ↓ joiner-type | |
| ↓ non-retrievable-attribute | |
| ↓ non-storable-attribute | |
| ↓ participant-attribute | |
| ↓ participant-bind-priority | |
| ↓ participant-criticality | |
| ↓ participant-dn | |
| ↓ participants-join-rule | |
| ↓ participating-workflow-element | |
| ↓ primary-participant | |
| ↓ retrievable-attribute | |
| ↓ storable-attribute |
| Description | This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not. |
|---|---|
| Default Value | search compare delete modify |
| Allowed Values | add - LDAP ADD Operation is enabled for this participant bind - LDAP BIND Operation is enabled for this participant compare - LDAP COMPARE Operation is enabled for this participant delete - LDAP DELETE Operation is enabled for this participant modify - LDAP MODIFY Operation is enabled for this participant modifydn - LDAP MODIFYDN Operation is enabled for this participant search - LDAP SEARCH Operation is enabled for this participant |
| Multi-valued | Yes |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Only the entries satisfying the join condition are considered for join in this participant where the condition is defined. It is of the LDAPFilter syntax. |
|---|---|
| Default Value | By default, no join condition is defined. That is all entries satisfying the original search filter are considered for join. |
| Allowed Values | A String |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | The Join policy configuration for this Join WorkflowElement, which decides what entries are returned from Search Operation. This is analogous to Database join. It can be one of the following: 1) standard-join 2) left-outer-join 3) full-outer-join |
|---|---|
| Default Value | standard-join |
| Allowed Values | full-outer-join - Returns all the entries in the Primary participant after joining with corresponding entries in Secondary participant (Standard Join); returns entries from the Secondary participant that satisfy the join condition and which have a corresponding match in Primary participant (Left Outer Join); and returns entries from the Secondary participant that satisfy the search filter but do not have a matching entry in Primary participant. This is the equivalent to Left Outer Join + Right Outer Join in database terminology. left-outer-join - Returns all the entries in the Primary participant after joining with corresponding entries in Secondary participant ()Standard Join), and returns entries from the Secondary participants that satisfy the join condition and which have a corresponding match in Primary participant. This is the equivalent to Left Outer Join in database terminology. standard-join - Returns all entries that satisfy the search filter in the Primary participant after joining the corresponding entries in Secondary participants. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | The Joiner Type used to join two participants defined in this participant configuration. It can be one of the following. 1. OneToOne 2. OneToMany 3. ManyToOne 4. Shadow |
|---|---|
| Default Value | one-to-one |
| Allowed Values | many-to-one - Many-To-One one-to-many - One-To-Many one-to-one - One-To-One shadow - Shadow Join |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Defines the list of non-retrievable attributes for this participant |
|---|---|
| Default Value | By default, the non-retrievable list is empty, which means that all attributes are retrievable. |
| Allowed Values | A String |
| Multi-valued | Yes |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Defines the list of non-storable attributes for this participant. This overrides the storable list. |
|---|---|
| Default Value | By default, the non-storable list is empty, which means that all attributes are storable. |
| Allowed Values | A String |
| Multi-valued | Yes |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Defines the list of attributes, that when present in search filter, can be handled by this participant. |
|---|---|
| Default Value | By default, the participant attribute list is empty, which means that participant is not responsible for handling any attributes that are present in search filter. When it is empty for all the paritipcants, then all search attributes are considered to be in primary participant. |
| Allowed Values | The name of an attribute type defined in the server schema. |
| Multi-valued | Yes |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Determines the priority of this participant when serving bind requests, if BIND is specified as enabled operation in this participant. It can take any values greater than or equal to zero. The priority decreases as the number increases - Lower the number, higher the priority; 0 being the highest priority. |
|---|---|
| Default Value | 0 |
| 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 | When a search operation done against a participant fails due to a communication error, Join WorkflowElement reacts based on the Criticality setting. It can be set to one of the following values - true, false, partial. Criticality is honored only for Search operations. |
|---|---|
| Default Value | true |
| Allowed Values | false - This setting instructs Join WorkflowElement that the failure to perform an operation in the participant is not critical to the overall result. If a non-critical participant incurs an operations error, than the result is simply omitted from the overall LDAP search results and Join WorkflowElement returns partial results from any other participant and does not indicate any error. partial - Setting the participant criticality to Partial means the application can notify its own users that partial results were obtained. When an error occurs, Join WorkflowElement returns an Admin Limit Exceeded error. While this is not the expected error, the intention of this setting is to cause client application logic to indicate that not all results are shown. true - The default setting, which indicates that if the participant fails to return a result, for example, due to an operations error or remote host failure, Join WorkflowElement causes the overall search operation to fail and returns a DSA Unavailable error to the client regardless of whether data was found in any other adapter or not. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | The real DN that is exposed by the participating workflow element |
|---|---|
| Default Value | None |
| Allowed Values | A valid DN. |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | The join rule defined between two participants, that is used to join entries between them. It is of the LDAPFilter syntax containing multiple components mixed with AND/OR/NOT, with each component of the form [ParticipantName].[attributeName]=[ParticipantName].[attributeName], where the [ParticipantName] and [attributeName] are substitued with actual values. |
|---|---|
| Default Value | |
| Allowed Values | A String |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
participating-workflow-element
| Description | Name of the Participating WorkFlow Element Name of the participant for the Join WorkflowElement. It must always refer to any of the existing workflow only. |
|---|---|
| Default Value | None |
| Allowed Values | The DN of any Workflow Element. |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Indicates that this participant is the primary participant. |
|---|---|
| Default Value | false |
| Allowed Values | true false |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Defines the list of retrievable attributes for this participant |
|---|---|
| Default Value | By default, the retrievable list is empty, which means that all attributes are retrievable. |
| Allowed Values | A String |
| Multi-valued | Yes |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Defines the list of storable attributes for this participant |
|---|---|
| Default Value | By default, the storable list is empty, which means that all attributes are storable. |
| Allowed Values | A String |
| Multi-valued | Yes |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |