Import Users from external LDAP

Sample workflow to import users from a separate LDAP user branch

Import Users from external LDAP is a source workflow that reads user entries from the connected directory UserLDAP and writes them into the Identity Store. The TS port represents the external LDAP source, while the IdentityDomain port represents the DirX Identity destination.

The workflow parameters tscluster and tsresource are both set to External. They declare that this connected system represents an external LDAP source, not a target system that DirX Identity provisions to. The workflow works on the users channel and is the counterpart to the full import workflow for the same source.

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

Import Users from external LDAP

Category

Source Realtime / Import To Identity

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

LDAP

Configuration wizard

LDAP-LDAP

Active in the factory data

TRUE

Factory data version

8.9

Factory data path

Workflows/Default/Source Realtime/Import To Identity/Import Users from external LDAP

Prerequisites

  • You need a connected directory UserLDAP that the LdapConnector can reach with the bind profile LDAPadmin.

  • You need the connected directory Identity Store for the IdentityDomain port, with the bind profile Domain_Admin.

  • The TS port uses the CryptFilter, so the source side must be configured for the expected encrypted attribute handling.

  • The Java-based Server that runs the workflow must be able to reach both LDAP directories and the JMS and mail infrastructure that the event, notify and error ports use.

Workflow and Activities

Activity Type Component description Description Ports

error

error

provisioningActivity

Error Activity

Message

join

ProvisionTS

provisioningActivity

Join activity for the provision-to-LDAP 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

UserLDAP

LDAPadmin

FALSE

Channels

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

users

Channel for users

OneToOne

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

users

Channel for Corporate Directory users

OneToOne

SearchAttributes

Filters

Port Filter Description Sequence

TS

CryptFilter

decryption

1

Configuration Parameters

Table 3. Workflow parameters of Import Users from external LDAP
Parameter Default value

timeout

P0Y0M4DT0H0M0S

tscluster

External

tsresource

External
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

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 performs the import. Its TS port reads users from UserLDAP, and its IdentityDomain port writes the corresponding users into the Identity Store. The event port receives the JMS requests that start the workflow, the notify port sends the configured mail notifications, and the CryptFilter on the TS port decrypts protected source values before the LdapConnector handles them.

A request that fails is retried up to three times (retrylimit) with 30 minutes between attempts (waitbeforeretry). If it still fails, the error activity takes it over and reports it through the Message port; the workflow parameter timeout gives a request four days before it is discarded.

Operation

  1. A change for the users channel reaches the workflow through the event port.

  2. The Java-based Server passes the resulting request to the join activity.

  3. The TS port reads the affected user from UserLDAP.

  4. The IdentityDomain port creates or updates the corresponding user in the Identity Store.

  5. The notify port sends the configured notifications, and the event port publishes the resulting workflow event.

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

The workflow is delivered active (dxmActive is TRUE). After you configure the connected directory and the related infrastructure, you can use it directly.