Send Emails

Workflow to provision Email objects from DirX.

Send Emails is the mail delivery workflow for connected systems of type Mail. You use it to provision email objects from the Identity Store to the Mail Server connected directory.

Unlike account provisioning workflows, this sample works only with the emails channel between IdentityDomain and TS. The TS port uses MailConnector, while the workflow-level event and notify ports handle follow-up messaging.

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

Send Emails

Category

Target Realtime / MAIL

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

Mail

Configuration wizard

LDAP-File

Active in the factory data

FALSE

Factory data version

8.0

Factory data path

Workflows/Default/Target Realtime/MAIL/Send Emails

Prerequisites

  • You need a connected directory Mail Server of type Mail with bind profile Admin.

  • You need mail objects in the Identity Store that are exposed through the emails channel.

  • The Java-based Server (IdS-J) must reach the Identity Store through Domain_Admin and the Mail Server connected directory through the TS port.

Workflow and Activities

Activity Type Component description Description Ports

error

error

provisioningActivity

Error Activity

Message

join

ProvisionTS

provisioningActivity

Join activity for the provision-to-TS workflow

event, IdentityDomain, notify, ts

Ports

Activity Port Component description Connector Connected directory Bind profile SSL

error

Message

errorPort

ErrorNotifyMailConnector

-

-

not set

join

event

notificationPort

JmsConnector

-

-

not set

join

IdentityDomain

provisioningPort

LdapConnector

Identity Store

Domain_Admin

not set

join

notify

notificationPort

NotifyMailConnector

-

-

not set

join

TS

provisioningPort

MailConnector

Mail Server

Admin

not set

Channels

Table 1. Channels of port event (activity join)
Channel Description Reference type Delta type

accounts

Channel for accounts

OneToOne

SearchAttributes

groups

Channel for groups

OneToOne

SearchAttributes

members

Channel for members

OneToOne

SearchAttributes

setPassword

Channel for setting a password

OneToOne

SearchAttributes
Table 2. Channels of port IdentityDomain (activity join)
Channel Description Reference type Delta type

emails

Channel to accounts

OneToOne

ExpertFilter
Table 3. Channels of port TS (activity join)
Channel Description Reference type Delta type

emails

Channel to Email connector

OneToOne

SearchAttributes

Filters

Port Filter Description Sequence

TS

CryptFilter

decryption

1

Configuration Parameters

Table 4. Workflow parameters of Send Emails
Parameter Default value

timeout

P0Y0M4DT0H0M0S
Table 5. Parameters of activity error
Parameter Default value

resourcefamily

Mail

retrylimit

3

timeout

P0Y0M1DT0H0M0S

waitbeforeretry

P0Y0M0DT2H0M0S
Table 6. Parameters of activity join
Parameter Default value

resourcefamily

LDAP

retrylimit

3

timeout

P0Y0M1DT0H0M0S

waitbeforeretry

P0Y0M0DT0H30M0S
Table 7. Parameters of port event (activity join)
Parameter Default value

appid

event

jmsprovidertype

MQSERIES

tgtisjmsclient

false

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 reads emails from IdentityDomain and writes them to TS through MailConnector. CryptFilter runs on TS before the connector receives the request.

The event port can publish JMS messages for processed requests, and the notify port can send workflow notifications. If processing still fails after three retries with a 30-minute wait, the workflow routes the request to error, which sends the error notification through Message.

Operation

  1. DirX Identity creates a provisioning request for the affected emails objects.

  2. The Java-based Server (IdS-J) routes the request to join.

  3. The IdentityDomain port reads the affected emails entries from the Identity Store.

  4. The TS port passes the mail object to the Mail Server connected directory through MailConnector; CryptFilter runs before the connector handles the request.

  5. The event and notify ports handle the configured follow-up messages for the processed request.

  6. 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, connect the copy to your connected directory and activate the copy.