Ident_GoogleApps_Realtime

Sample workflow to provision a Google Apps directory from a DirX Identity target system.

A provisioning workflow transfers the account, group and membership changes that DirX Identity has calculated for a target system into the connected system, and acknowledges the result back into the Identity Store. It is the workflow that executes what privilege resolution has decided: when a user gains or loses a privilege, the resolution writes the resulting account or membership change into the target system subtree of the Identity Store, and this workflow applies that change to the connected system.

The workflow processes single requests as they arrive, so it reflects changes with little delay. Use the corresponding validation workflow to detect changes that were made in the connected system outside of DirX Identity.

Ident_GoogleApps_Realtime is the provisioning workflow for connected systems of type Google Apps. You use it to keep a Google Apps directory aligned with the target system objects that DirX Identity groups under tsresource google-domain and tscluster google-cluster.

The workflow keeps the common provisioning scope of accounts, groups, and members on both sides, while the target side also exposes setPassword. That makes it the base real-time workflow for Google Apps account, group, and membership changes.

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

Ident_GoogleApps_Realtime

Category

Target Realtime / Google Apps

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

Google Apps

Configuration wizard

wf-Provisioning-Synchronize.xml

Active in the factory data

FALSE

Factory data version

8.4

Factory data path

Workflows/Default/Target Realtime/Google Apps/Ident_GoogleApps_Realtime

Prerequisites

  • Create a connected directory of type Google Apps with the bind profile AppsAdmin.

  • Link that connected directory to a target system of type Google Apps in the Identity Store.

  • Make sure the Java-based Server can reach the Identity Store through Domain_Admin, the connected directory through GoogleAppsConnector, and the messaging system used by event.

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

GoogleAppsConnector

Google Apps

AppsAdmin

not set

Channels

Table 1. Channels of port IdentityDomain (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
Table 2. Channels of port TS (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

Filters

Port Filter Description Sequence

TS

CryptFilter

decryption

1

Configuration Parameters

Table 3. Workflow parameters of Ident_GoogleApps_Realtime
Parameter Default value

timeout

P0Y0M4DT0H0M0S

tscluster

google-cluster

tsresource

google-domain
Table 4. Parameters of activity error
Parameter Default value

resourcefamily

Mail

retrylimit

3

timeout

P0Y0M1DT0H0M0S

waitbeforeretry

P0Y0M0DT2H0M0S
Table 5. Parameters of port Message (activity error)
Parameter Default value

decrypt.attribute

TSA_OSILA_PIN
Table 6. Parameters of activity join
Parameter Default value

resourcefamily

Google_Apps

retrylimit

3

timeout

P0Y0M1DT0H0M0S

waitbeforeretry

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

appid

event

decrypt.attribute

userPassword

tgtisjmsclient

false
Table 8. Parameters of port IdentityDomain (activity join)
Parameter Default value

decrypt.attribute

userPassword
Table 9. Parameters of port notify (activity join)
Parameter Default value

decrypt.attribute

userPassword
Table 10. Parameters of port TS (activity join)
Parameter Default value

decrypt.attribute

password

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 receives provisioning work on event, reads the DirX Identity side on IdentityDomain, and sends the resulting add, modify, or delete work to TS. It keeps accounts, groups, and members in scope, so it can process both primary objects and their memberships in one activity.

notify handles the normal notification path. If provisioning fails, the workflow switches to error and sends the failure message through Message.

Operation

  1. A provisioning event reaches join through event.

  2. join reads the required objects and memberships from IdentityDomain.

  3. CryptFilter decrypts the target-side password value on TS, and GoogleAppsConnector writes the change to the connected directory.

  4. The workflow sends the normal notification through notify.

  5. If the target request fails, the workflow routes the error to error and sends the failure information through Message.

The workflow is delivered inactive (dxmActive is FALSE). Copy it into your own scenario before you enable it.