Restore_Notes_Realtime

Sample workflow to restore a IBM Notes database

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_Notes_Realtime is the restore workflow for connected systems of type Notes. You use it to rebuild a Notes database from the state that DirX Identity stores for the corresponding target system. The workflow reaches Notes through the C++-based Server identified by idscconnector and idscdn.

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_Notes_Realtime

Category

Target Realtime / Notes

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

Notes

Configuration wizard

wf-Provisioning-Restore.xml

Active in the factory data

FALSE

Factory data version

8.0

Factory data path

Workflows/Default/Target Realtime/Notes/Restore_Notes_Realtime

Prerequisites

  • A connected directory of type Notes that uses Spmlv1SoapConnector2IDSC, with the bind profile kellner20-vm set to a Notes connection that IdS-C can use.

  • A target system of type Notes in the Identity Store whose subtree contains the state that you want to restore into the Notes environment.

  • The C++-based Server referenced by idscconnector and idscdn must be configured and reachable from the Java-based Server.

  • The Java-based Server must be able to reach the Identity Store and IdS-C, and IdS-C must be able to reach Notes.

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

Spmlv1SoapConnector2IDSC

Notes

kellner20-vm

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 normal groups in Notes Target System

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 in Notes System

OneToOne

SearchAttributes

members

Channel for group members in Notes System

not set

not set

setPassword

Channel for setting a password

not set

not set

Filters

Port Filter Description Sequence

TS

CryptFilter

decryption

1

Configuration Parameters

Table 3. Workflow parameters of Restore_Notes_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

Notes

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

idscconnector

dxmC=test,cn=main,dxmC=C Servers,dxmC=Metahub Synchronization Services,dxmC=Configuration,dxmC=DirXmetahub

idscdn

cn=main,dxmC=C Servers,dxmC=Metahub Synchronization Services,dxmC=Configuration,dxmC=DirXmetahub
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,HTTPPassword

ssltoidsc

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 performs the restore. Its IdentityDomain port reads the Notes accounts, groups, and memberships that you want to rebuild, and its TS port sends that state through IdS-C to recreate it in Notes. CryptFilter decrypts protected password values before the request is handed to the Notes side.

A request that fails is retried up to 3 times (retrylimit) with 30 minutes between the attempts (waitbeforeretry). If it still fails, the error activity takes it over and sends a notification through the Message port; the workflow parameter timeout gives a request 4 days before it is discarded.

Operation

  1. You start a restore request for the affected Notes objects from the target system subtree in the Identity Store.

  2. The Java-based Server passes the request to the join activity of this workflow.

  3. The IdentityDomain port reads the stored Notes state from the Identity Store over the matching channel.

  4. The TS port sends that state through the configured IdS-C connection and recreates it in Notes.

  5. The result is written back into the Identity Store so that the request state reflects what happened in Notes.

  6. The event port publishes the change as a JMS event for applications that listen to provisioning events; the notify port sends the configured e-mail notifications.

  7. Requests that fail permanently are handed to the error activity, 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.