ConsistencyCheck

Performs data consistency check in Identity Store

ConsistencyCheck runs the role service agent against the Identity Store to detect data quality problems such as broken links, referential integrity violations, or entries that contradict configured consistency rules. The results are written to the ConsistencyCheck out output channel and logged. The reportformat parameter controls the output format (default HTML).

Run this workflow on a schedule or on demand when you suspect data quality issues, for example after a large import or after a connectivity configuration change.

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

ConsistencyCheck

Category

Identity Store

Technology

Tcl-based scheduled workflow

LDAP object class

dxmWorkflow

Workflow type

-

Connected system / controller type

-

Configuration wizard

LDAP-LDAP

Active in the factory data

not set

Factory data version

7.0

Factory data path

Workflows/Default/Identity Store/ConsistencyCheck

Prerequisites

  • The ServiceAgent must be deployed and configured in the C++-based Server.

  • The Default input channel and the ConsistencyCheck out output channel must be configured.

Workflow and Activities

Step Activity Description Agent Runs after

1

ConsistencyCheck

Consistency check via role service agent

ServiceAgent

start activity

Jobs and Agents

Activity Job Agent Operation Input channel Output channel

ConsistencyCheck

ConsistencyCheck

ServiceAgent

Full Import

Default

ConsistencyCheck out

Configuration Parameters

Table 1. Parameters of job ConsistencyCheck
Parameter Default value

delta_mode

full

delta_on

0

ldaptrace

FALSE

ldaptracefile

ldapTrace.*.log

ldaptracelines

0

reportformat

HTML

request

checkConsistency

trace

1

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 a single activity, ConsistencyCheck, which runs the ServiceAgent job with the Default input channel and the ConsistencyCheck out output channel. The request parameter is checkConsistency, which instructs the service agent to perform a consistency check rather than a full import. The reportformat parameter controls whether the results are written as HTML or in another supported format.

Operation

  1. You start the workflow manually from the Identity Manager, attach it to a schedule, or trigger it as part of the CombinedMaintenance workflow.

  2. The C++-based Server starts the ConsistencyCheck activity and launches the ServiceAgent job.

  3. The agent connects to the Identity Store, reads entries from the Default input channel, and checks each entry for consistency rule violations, broken links and referential integrity problems.

  4. The results are written to the ConsistencyCheck out output channel; an optional LDAP trace file is produced when ldaptrace is TRUE.

  5. The report is formatted according to reportformat (default HTML) and is available for review in the Identity Manager or the file system.