Joint Backup

Workflow to perform a joint backup of the Java-based repositories, and LDAP databases

Joint Backup creates a consistent backup of both the Java-based repositories and the LDAP databases in a single operation. Administrators use it to take a coordinated snapshot before making configuration changes or before a system upgrade, so that both data stores can be restored to a consistent state if needed.

The perform activity type is Server, which means the Java-based Server carries out the backup internally without opening a connector port to an external system.

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

Joint Backup

Prerequisites

The Java-based Server must be running and must have write access to the backup storage location.
The domain parameter of the perform activity must point to the correct company DN (cn=My-Company by default).

Workflow and Activities

Activity Type Component description Description Ports

Activity	Type	Component description	Description	Ports
`error`	`error`	`provisioningActivity`	Error Activity	`Message`
`perform`	`Server`	`provisioningActivity`	Activity for performing the joint backup	-

error

provisioningActivity

Error Activity

Message

perform

Server

provisioningActivity

Activity for performing the joint backup

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 `Joint Backup`
Parameter	Default value
`timeout`	P0Y0M0DT1H0M0S
`tscluster`	localhost
`tsresource`	cn=My-Company

Table 2. Parameters of activity `error`
Parameter	Default value
`resourcefamily`	LDAP
`retrylimit`	0
`timeout`	P0Y0M0DT0H5M0S
`waitbeforeretry`	P0Y0M0DT0H0M0S

Table 3. Parameters of port `Message` (activity `error`)
Parameter	Default value
`decrypt.attribute`	dxmPassword

Table 4. Parameters of activity `perform`
Parameter	Default value
`domain`	cn=My-Company
`resourcefamily`	workflowengine
`retrylimit`	0
`timeout`	P0Y0M0DT0H30M0S
`waitbeforeretry`	P0Y0M0DT0H0M0S

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 perform activity uses the provisioningActivity component with the Server type to carry out the backup operation directly within the Java-based Server. It has no external connector ports: all work is done internally. The domain parameter scopes the backup to the company DN, and resourcefamily (workflowengine) identifies the engine that handles the request.

Because retrylimit is 0, a failure is not retried: the request is passed immediately to the error activity, which sends a notification via the Message port.

Operation

A backup request is submitted to the Joint Backup workflow, typically by a schedule or a manual trigger through the Identity Manager.
The perform activity instructs the Java-based Server to create a coordinated backup of both the Java-based repositories and the LDAP databases for the domain cn=My-Company.
The backup operation completes within the timeout configured for the perform activity (30 minutes by default).
If the backup fails, the request is passed immediately to the error activity (retrylimit is 0), which reports the failure by e-mail through the Message port.

The workflow is delivered inactive (dxmActive is FALSE). Copy it into your own scenario, verify the domain parameter, and activate the copy.