Restore_ADS_Realtime

Sample workflow to restore an Active Directory domain

A restore workflow writes the state that DirX Identity holds for a target system back into the connected system. Use it after the connected system has lost data, for example after a restore from a backup that is older than the last provisioning run: the workflow re-creates the accounts, groups and memberships that DirX Identity knows about, so that the connected system matches the Identity Store again.

The workflow reads from the target system subtree of the Identity Store and writes to the connected system; it does not change the Identity Store.

Restore_ADS_Realtime restores objects in a connected system of type ADS from the state that DirX Identity keeps in the Identity Store. You use it when accounts, groups, memberships or password values in the connected directory need to be brought back into line with the target system subtree.

The workflow uses the same ADS-specific provisioning channels as the real-time provisioning workflow, including setPassword on the TS port. This lets you restore ordinary object data and password data through one activity chain.

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

Restore_ADS_Realtime

Category

Target Realtime / ADS

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

ADS

Configuration wizard

wf-Provisioning-Restore.xml

Active in the factory data

FALSE

Factory data version

8.0

Factory data path

Workflows/Default/Target Realtime/ADS/Restore_ADS_Realtime

Prerequisites

  • You configure a connected directory of type ADS that uses the AdsConnector and the bind profile ADSadmin.

  • You make the Identity Store available through the bind profile Domain_Admin and the ADS connected directory available through the TS port of the Java-based Server.

  • You keep the relevant ADS target system subtree in the Identity Store, so the workflow can read the restore source over accounts, groups and members.

Workflow and Activities

Activity Type Component description Description Ports

error

error

provisioningActivity

Error Activity

Message

join

ProvisionTS

provisioningActivity

Join activity for the provision-to-ADS 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

AdsConnector

ADS

ADSadmin

FALSE

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 account - group memberships

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 account - group memberships

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 Restore_ADS_Realtime
Parameter Default value

timeout

P0Y0M4DT0H0M0S
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

dxmPassword
Table 6. Parameters of activity join
Parameter Default value

resourcefamily

ADS

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

unicodePwd

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 the restore source from IdentityDomain and writes the corresponding state to TS. It carries accounts, groups and memberships over the channels of the same name, and it uses setPassword when a restore request includes password data. The CryptFilter decrypts unicodePwd before the AdsConnector processes it.

If processing fails, join retries the request three times and waits 30 minutes between attempts. If the request still fails, the workflow hands it to error, which sends the error notification through Message. The workflow-level timeout keeps the request for up to four days.

Operation

  1. You start a restore request for the affected object in the ADS target system subtree of the Identity Store.

  2. You let the Java-based Server route the request to join.

  3. You let IdentityDomain read the expected state over accounts, groups or members.

  4. You let TS recreate or update the object in the connected directory and use setPassword when the restore request contains password data.

  5. You let the workflow write the result back to the Identity Store, publish the event through event and send the configured notification through notify.

  6. If the request still fails after the configured retries, you let error report the failure through Message.

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.