Ident_LDAP_Realtime

Sample workflow to provision an LDAP directory from a DirX Identity target system.

A provisioning workflow transfers the account, group and membership changes that DirX Identity has calculated for a target system into the connected system, and acknowledges the result back into the Identity Store. It is the workflow that executes what privilege resolution has decided: when a user gains or loses a privilege, the resolution writes the resulting account or membership change into the target system subtree of the Identity Store, and this workflow applies that change to the connected system.

The workflow processes single requests as they arrive, so it reflects changes with little delay. Use the corresponding validation workflow to detect changes that were made in the connected system outside of DirX Identity.

Ident_LDAP_Realtime is the provisioning workflow for connected systems of type LDAP. You use it to keep an LDAP directory aligned with the corresponding target system subtree in the Identity Store.

The workflow parameters tscluster and tsresource show the sample target-system context as My-Company and sample-ts. The workflow provisions accounts, groups, and members, and it can write password changes through setPassword.

The workflows in this reference are delivered as factory data and are loaded into the Connectivity configuration database during the initial configuration. They are samples: use the Identity Manager to copy a workflow into your own scenario and adapt the copy. Do not change the delivered objects, because a product update can replace them.

At a Glance

Name

Ident_LDAP_Realtime

Category

Target Realtime / LDAP

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

LDAP

Configuration wizard

wf-Provisioning-Synchronize.xml

Active in the factory data

FALSE

Factory data version

8.0

Factory data path

Workflows/Default/Target Realtime/LDAP/Ident_LDAP_Realtime

Prerequisites

  • You need a connected directory of type LDAP with bind profile Admin.

  • You need a target system of type LDAP in the Identity Store that represents the same directory content over accounts, groups, and members.

  • The Java-based Server (IdS-J) must reach the Identity Store through Domain_Admin and the LDAP connected directory through the TS port.

Workflow and Activities

Activity Type Component description Description Ports

error

error

provisioningActivity

Error Activity

Message

join

ProvisionTS

provisioningActivity

Join activity for the provision-to-TS workflow

event, IdentityDomain, notify, ts

Ports

Activity Port Component description Connector Connected directory Bind profile SSL

error

Message

errorPort

ErrorNotifyMailConnector

-

-

not set

join

event

notificationPort

JmsConnector

-

-

not set

join

IdentityDomain

provisioningPort

LdapConnector

Identity Store

Domain_Admin

not set

join

notify

notificationPort

NotifyMailConnector

-

-

not set

join

TS

provisioningPort

LdapConnector

LDAP

Admin

not set

Channels

Table 1. Channels of port IdentityDomain (activity join)
Channel Description Reference type Delta type

accounts

Channel for accounts

OneToOne

SearchAttributes

groups

Channel for groups

OneToOne

SearchAttributes

members

Channel for members

OneToOne

SearchAttributes
Table 2. Channels of port TS (activity join)
Channel Description Reference type Delta type

accounts

Channel for accounts

OneToOne

SearchAttributes

groups

Channel for groups

OneToOne

SearchAttributes

members

Channel for members

OneToOne

SearchAttributes

setPassword

Channel for setting a password

OneToOne

SearchAttributes

Filters

Port Filter Description Sequence

TS

CryptFilter

decryption

1

Configuration Parameters

Table 3. Workflow parameters of Ident_LDAP_Realtime
Parameter Default value

timeout

P0Y0M4DT0H0M0S

tscluster

My-Company

tsresource

sample-ts
Table 4. Parameters of activity error
Parameter Default value

resourcefamily

Mail

retrylimit

3

timeout

P0Y0M1DT0H0M0S

waitbeforeretry

P0Y0M0DT2H0M0S
Table 5. Parameters of port Message (activity error)
Parameter Default value

decrypt.attribute

dxmPassword
Table 6. Parameters of activity join
Parameter Default value

resourcefamily

LDAP

retrylimit

3

timeout

P0Y0M1DT0H0M0S

waitbeforeretry

P0Y0M0DT0H30M0S
Table 7. Parameters of port event (activity join)
Parameter Default value

appid

event

decrypt.attribute

userPassword

tgtisjmsclient

false
Table 8. Parameters of port IdentityDomain (activity join)
Parameter Default value

decrypt.attribute

userPassword
Table 9. Parameters of port notify (activity join)
Parameter Default value

decrypt.attribute

userPassword
Table 10. Parameters of port TS (activity join)
Parameter Default value

decrypt.attribute

userPassword

A Java-based real-time workflow runs as a permanently loaded configuration in the Java-based Server (IdS-J). It is triggered by a request or an event rather than by a schedule. Each workflow consists of activities; an activity opens one port per system it talks to, and each port uses a connector to reach that system.

Most provisioning workflows contain a join activity that performs the actual work and an error activity that receives requests which still fail after all retries and sends a notification about them. The retrylimit, waitbeforeretry and timeout parameters of an activity control how often and how long a failed request is retried before it is handed to the error activity.

The event port publishes change events over JMS, and the notify port sends e-mail notifications. Neither port is bound to a connected directory.

The join activity reads the requested state from the Identity Store over accounts, groups, and members and writes it to the LDAP connected directory through channels of the same name. The TS port also exposes setPassword, and CryptFilter decrypts protected values before the connector sends them to the directory.

The event port can publish JMS messages and the notify port can send workflow notifications. If processing still fails after three retries with a 30-minute wait, the workflow routes the request to error, which sends the error notification through Message.

Operation

  1. Privilege resolution writes an account, group or membership change into the LDAP target system subtree of the Identity Store.

  2. The Java-based Server (IdS-J) passes the resulting request to join.

  3. The IdentityDomain port reads the affected entry from the Identity Store over the matching channel.

  4. The TS port applies the change in the LDAP connected directory and uses setPassword when the request contains password data.

  5. DirX Identity records the provisioning result back in the target system entry state.

  6. The event port publishes the change as a JMS event and the notify port sends the configured e-mail notifications.

  7. Requests that fail permanently are handed to error, which reports them by e-mail.

The workflow is delivered inactive (dxmActive is FALSE). Copy it into your own scenario, connect the copy to your connected directory and activate the copy.