EventBasedLocationProcessing

Sample workflow for handling a change event for a location.

EventBasedLocationProcessing reacts to change events published for location entries (ctxLocation) in the Identity Store. When a location entry is added, modified or deleted, the Java-based Server passes the event to the join activity, which applies the consistency rules from consistencyrulesroot to the affected location. Changes to the address attributes postalAddress, street, l, postalCode and st — listed in the include parameter — are propagated to all users and entries that reference the location.

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

EventBasedLocationProcessing

Category

Identity Store

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

ctxLocation

Configuration wizard

LDAP-LDAP

Active in the factory data

FALSE

Factory data version

8.0

Factory data path

Workflows/Default/Identity Store/EventBasedLocationProcessing

Prerequisites

  • The Identity Store domain event policy must be configured to publish events for ctxLocation entries.

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

  • Copy the workflow into your scenario, configure the parameters, 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 organization unit.

-

Ports

Activity Port Component description Connector Connected directory Bind profile SSL

error

Message

errorPort

ErrorNotifyMailConnector

-

-

not set

Configuration Parameters

Table 1. Workflow parameters of EventBasedLocationProcessing
Parameter Default value

timeout

P0Y0M4DT0H0M0S

tscluster

*

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

consistencyrulesroot

cn=domain_name,cn=Rules,cn=Policies,cn=domain_name

domain

cn=My-Company

include

postalAddress,street,l,postalCode,st

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 location entry and propagate address attribute changes (postalAddress, street, l, postalCode, st) to related entries. 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 a location entry in the Identity Store and the event policy publishes a ctxLocation 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 location entry.

  4. Changes to the address attributes listed in include (postalAddress, street, l, postalCode, st) are propagated to users and other entries that reference the location.

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

  6. The workflow is delivered inactive (dxmActive is FALSE). Copy it into your own scenario and activate the copy.