EventBasedAccountProcessing

Sample workflow for handling a change event for an account.

EventBasedAccountProcessing reacts to change events published for account entries (SvcTSAccount) in the Identity Store. When a client creates, modifies or deletes an account, the Java-based Server passes the event to the join activity, which applies the consistency rules from consistencyrulesroot and the validation rules from validationrulesroot to the affected account, and cascades any follow-on updates to related entries.

Deploying this workflow allows you to react to account changes in real time instead of waiting for a scheduled ConsistencyCheck run.

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

EventBasedAccountProcessing

Prerequisites

The Identity Store domain event policy must be configured to publish events for SvcTSAccount entries.
The consistency rules referenced by consistencyrulesroot and the validation rules referenced by validationrulesroot must exist in the Identity Store.
Copy the workflow into your scenario, set the tscluster and tsresource parameters to match your target system, and activate the copy in the Java-based Server.

Workflow and Activities

Activity Type Component description Description Ports

Activity	Type	Component description	Description	Ports
`error`	`error`	`provisioningActivity`	Error Activity	`Message`
`join`	`Server`	`resolutionActivity`	Activity for processing a change event for an account.	-

error

provisioningActivity

Error Activity

Message

join

Server

resolutionActivity

Activity for processing a change event for an account.

Ports

Activity Port Component description Connector Connected directory Bind profile SSL

Activity	Port	Component description	Connector	Connected directory	Bind profile	SSL
`error`	`Message`	`errorPort`	`ErrorNotifyMailConnector`	`Mail Server`	-	not set

error

Message

errorPort

ErrorNotifyMailConnector

Mail Server

not set

Configuration Parameters

Table 1. Workflow parameters of `EventBasedAccountProcessing`
Parameter	Default value
`timeout`	P0Y0M4DT0H0M0S
`tscluster`	*
`tsresource`	*

Table 2. Parameters of activity `error`
Parameter	Default value
`resourcefamily`	LDAP
`retrylimit`	3
`timeout`	P0Y0M1DT0H0M0S
`waitbeforeretry`	P0Y0M0DT2H0M0S

Table 3. Parameters of port `Message` (activity `error`)
Parameter	Default value
`decrypt.attribute`	dxmPassword

Table 4. Parameters of activity `join`
Parameter	Default value
`consistencyrulesroot`	cn=domain_name,cn=Rules,cn=Policies,cn=domain_name
`resourcefamily`	Event_Maintenance
`retrylimit`	3
`sortascending`	TRUE
`sortattribute`	cn
`timeout`	P0Y0M1DT0H0M0S
`validationrulesroot`	cn=domain_name,cn=Rules,cn=Policies,cn=domain_name
`waitbeforeretry`	P0Y0M0DT0H30M0S

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 workflow has two activities. The join activity uses the resolutionActivity component to apply the consistency rules from consistencyrulesroot and the validation rules from validationrulesroot to the affected account entry. Entries are sorted by sortattribute (cn) in ascending order before processing. Failed requests are retried up to retrylimit (3) times with waitbeforeretry (30 minutes) between attempts; persistent failures are passed to the error activity, which sends a notification by e-mail through the Message port.

Operation

A client creates, modifies or deletes an account entry in the Identity Store and the event policy publishes a SvcTSAccount change event.
The Java-based Server matches the event against the tscluster and tsresource parameters of this workflow and passes the request to the join activity.
The activity applies the consistency rules from consistencyrulesroot and the validation rules from validationrulesroot to the changed account.
Any follow-on actions determined by the rules — for example updating related user entries — are executed in the same request.
Failed requests are retried up to three times; requests that still fail are handed to the error activity for e-mail notification.
The workflow is delivered inactive (dxmActive is FALSE). Copy it into your own scenario, configure the tscluster, tsresource and rule roots, and activate the copy.