EventBased Email Notification Handling

Calls Email Consistency Rules when subscriber entry changes and an error message is present.

EventBased Email Notification Handling is the event-driven mail consistency workflow for connected systems of type SvcEmailAccount. You use it when a changed subscriber entry with an error message should trigger mail consistency handling immediately.

The sample evaluates mail rules below consistencyrulesroot within the domain cn=My-Company. With tscluster set to *, you can use the same pattern across mail target systems.

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

EventBased Email Notification Handling

Prerequisites

You need SvcEmailAccount entries that can trigger change events for the workflow.
You need mail consistency rules below cn=Mail,cn=Consistency,cn=Default,cn=Rules,cn=Policies,cn=My-Company.
The Java-based Server (IdS-J) must be able to access the domain cn=My-Company, which the workflow uses through domain and tsresource.

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 arbitrary object.	-

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

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

error

Message

errorPort

ErrorNotifyMailConnector

not set

Configuration Parameters

Table 1. Workflow parameters of `EventBased Email Notification Handling`
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=Mail,cn=Consistency,cn=Default,cn=Rules,cn=Policies,cn=My-Company
`domain`	cn=My-Company
`resourcefamily`	Event_Maintenance
`retrylimit`	3
`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 join activity is a server-side resolutionActivity that processes a change event for an arbitrary object. It has no external workflow ports; instead, it uses consistencyrulesroot, domain, and sortattribute to decide how the affected mail entry is handled.

If the event cannot be processed after three retries with a 30-minute wait, the workflow routes the request to error, which sends the error notification through Message.

Operation

A change event on a subscriber entry with an error message creates a request for EventBased Email Notification Handling.
The Java-based Server (IdS-J) routes the request to join.
join processes the affected object in the domain cn=My-Company and evaluates the rules below consistencyrulesroot, ordered by sortattribute.
When rule processing succeeds, the workflow returns the result to DirX Identity so follow-up mail handling can continue.
Requests that fail permanently are handed to error, which reports them by e-mail.

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