Ident2CSVfile

Workflow for Export from LDAP to a CSV file

Ident2CSVfile exports data from the Identity Store to a CSV file. You use it when another system expects periodic file-based extracts from DirX Identity instead of reading the Identity Store directly.

The workflow runs as a single MetaCP job. It can work with delta-capable exports or with a full export, depending on how you run the scheduled job.

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

Ident2CSVfile

Category

Source Scheduled / CSVfile

Technology

Tcl-based scheduled workflow

LDAP object class

dxmWorkflow

Workflow type

-

Connected system / controller type

-

Configuration wizard

LDAP-File

Active in the factory data

not set

Factory data version

7.0

Factory data path

Workflows/Default/Source Scheduled/CSVfile/Ident2CSVfile

Prerequisites

  • The MetaCP agent is available for scheduled execution.

  • The channel Ident2CSVfile is configured for the Identity Store input and the CSV output of the job.

  • The target CSV location is writable from the system where MetaCP runs.

Workflow and Activities

Step Activity Description Agent Runs after

1

Ident2CSVfile_MetaCP

Export from LDAP to a CSV file

MetaCP

start activity

Jobs and Agents

Activity Job Agent Operation Input channel Output channel

Ident2CSVfile_MetaCP

Ident2CSVfile_MetaCP

MetaCP

Full Export

Ident2CSVfile

Ident2CSVfile

Configuration Parameters

Table 1. Parameters of job Ident2CSVfile_MetaCP
Parameter Default value

debug_trace

0

delta_mode

delta-or-full

delta_on

1

exact_action

FALSE

init_mode

REAL

max_trace_entries

10

notify_not_ok

0

statistics

TRUE

test_mapping_only

FALSE

trace_level

1

trace_recordcount

0

A Tcl-based workflow runs scheduled in the C++-based Server (IdS-C). Its activities run in the order defined by the dxmPredecessorActivity-DN chain, and each activity starts a job that runs one agent with one input and one output channel. Agents exchange their data through files or directly through the meta controller, so a typical workflow consists of an export activity that writes the data of the connected system and an import activity that maps and loads that data into the Identity Store.

You start these workflows manually from the Identity Manager or attach them to a schedule.

The workflow has one activity, Ident2CSVfile_MetaCP. This activity performs the complete export through channel Ident2CSVfile in one MetaCP job. Because no second activity follows, any error in this job ends the workflow run immediately.

Operation

  1. The scheduler starts job Ident2CSVfile_MetaCP in agent MetaCP.

  2. MetaCP reads the required data from the Identity Store through channel Ident2CSVfile and applies the configured mappings.

  3. Delta handling is enabled for this job, so you can use it for delta-oriented exports or run it as a full export when you need a complete file.

  4. MetaCP writes the export result to the configured CSV target. If the job fails, the workflow ends with that error.