Export Users to CSV

Sample workflow to export users to an LDIF file

Export Users to CSV is a source workflow that writes user data from the Identity Store to the connected directory CSVfile. Here the IdentityDomain port is the source, and the TS port represents the file-based destination.

Use this workflow when you want to create or refresh a CSV representation of users from DirX Identity. The workflow works on the users channel and uses the same ProvisionTS engine as other real-time workflows, but the functional direction is export from the Identity Store to the file.

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

Export Users to CSV

Category

Source Realtime / CSVfile

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

not applicable

Configuration wizard

LDAP-File

Active in the factory data

FALSE

Factory data version

8.0

Factory data path

Workflows/Default/Source Realtime/CSVfile/Export Users to CSV

Prerequisites

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

  • You need a connected directory CSVfile that is configured for the CsvConnector and points to the CSV destination that you want to write.

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

  • The Java-based Server that runs the workflow must be able to reach the Identity Store, the CSV destination, 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 Export Users to LDIF 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

CsvConnector

CSVfile

-

FALSE

Channels

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

users

Channel for users

not set

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

users

Channel for users

not set

not set

Filters

Port Filter Description Sequence

TS

CryptFilter

decryption

1

Configuration Parameters

Table 3. Workflow parameters of Export Users to CSV
Parameter Default value

timeout

P0Y0M4DT0H0M0S
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

dxmPassword

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 export. Its IdentityDomain port reads users from the Identity Store, and its TS port writes the corresponding users to CSVfile. 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 values before the CsvConnector writes them to the file.

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 IdentityDomain port reads the affected user from the Identity Store.

  4. The TS port writes or updates the corresponding record in CSVfile.

  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 inactive (dxmActive is FALSE). Copy it into your own scenario, connect the copy to your connected directory and activate the copy.