GenericEventBasedProcessing

Sample workflow for generic handling of a change event. Calls consistency rules and the userhook.

GenericEventBasedProcessing is a template that you copy and adapt when you need to react to change events for an object type that does not have its own dedicated workflow. Set the connected system type (<type>) and the tsresource parameter in your copy to match the object type and domain subtree you want to cover. The join activity applies the consistency rules from consistencyrulesroot and invokes the configured user hook for the changed entry.

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

GenericEventBasedProcessing

Category

Identity Store

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

<type>

Configuration wizard

LDAP-LDAP

Active in the factory data

FALSE

Factory data version

8.0

Factory data path

Workflows/Default/Identity Store/GenericEventBasedProcessing

Prerequisites

  • The Identity Store domain event policy must be configured to publish events for the object type you want to handle.

  • The consistency rules referenced by consistencyrulesroot must exist in the Identity Store.

  • Replace the placeholder connected system type (<type>) in your copy with the actual object type, configure tscluster, tsresource and consistencyrulesroot, and activate the copy in the Java-based Server.

Workflow and Activities

Activity Type Component description Description Ports

error

error

provisioningActivity

Error Activity

Message

join

Server

resolutionActivity

Activity for processing a change event for an arbitrary object.

-

Ports

Activity Port Component description Connector Connected directory Bind profile SSL

error

Message

errorPort

ErrorNotifyMailConnector

-

-

not set

Configuration Parameters

Table 1. Workflow parameters of GenericEventBasedProcessing
Parameter Default value

timeout

P0Y0M4DT0H0M0S

tscluster

<server-name>

tsresource

cn=My-Company

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

domain

cn=My-Company

resourcefamily

Event_Maintenance

retrylimit

3

sortascending

TRUE

sortattribute

cn

timeout

P0Y0M1DT0H0M0S

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 consistency rules from consistencyrulesroot to the changed entry and invoke the configured user hook. The connected system type is a placeholder (<type>) that you replace with the actual object type in your copy. Failed requests are retried up to retrylimit (3) times; persistent failures are passed to the error activity for e-mail notification through the Message port.

Operation

  1. A client creates, modifies or deletes an entry of the configured object type in the Identity Store and the event policy publishes the corresponding change event.

  2. The Java-based Server matches the event against tscluster and tsresource and passes the request to the join activity.

  3. The activity applies the consistency rules from consistencyrulesroot to the changed entry and invokes the configured user hook if one is present.

  4. Failed requests are retried up to three times; requests that still fail are handed to the error activity for e-mail notification.

  5. The workflow is delivered inactive (dxmActive is FALSE) and with a placeholder controller type. Copy it into your own scenario, replace the controller type, configure the parameters, and activate the copy.