Validate_ShareFile_Realtime

Sample workflow to validate a Citrix ShareFile connected system against a DirX Identity target system.

A validation workflow compares the content of the connected system with the state that DirX Identity holds for the corresponding target system. It runs in one of two modes, controlled by the mode parameter of the workflow:

  • InitialLoad - exports all accounts and groups and their relationships from the connected system and imports them into the target system subtree of the Identity Store in replace mode. Use this mode when you take a target system into operation.

  • Validation - detects deviations between the state known in DirX Identity and the state in the connected system, for example accounts or groups that were created or deleted outside of DirX Identity, and writes a message about each deviation into the "to do" field (dxrToDo) of the affected target system object.

Both modes update the dxrTSState attribute and the group member attributes of the affected target system objects.

Validate_ShareFile_Realtime validates a connected system of type Citrix ShareFile against the state that DirX Identity keeps in the Identity Store. You use it when you want to check whether accounts, groups and members in the connected directory still match the ShareFile target system subtree.

The workflow uses the same CitrixShareFileConnector path as ordinary provisioning, so validation and any resulting corrective update use the same channels and connector settings. The factory data keeps dxminitialload at FALSE, so the sample is prepared for validation of an existing target system subtree.

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

Validate_ShareFile_Realtime

Category

Target Realtime / Citrix ShareFile

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

Citrix ShareFile

Configuration wizard

wf-Provisioning-Validate.xml

Active in the factory data

FALSE

Factory data version

8.3

Factory data path

Workflows/Default/Target Realtime/Citrix ShareFile/Validate_ShareFile_Realtime

Prerequisites

  • You configure a connected directory of type Citrix ShareFile that uses CitrixShareFileConnector and the bind profile Admin.

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

  • You keep the relevant target system subtree in the Identity Store, so the workflow can read the expected state 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-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

CitrixShareFileConnector

Citrix ShareFile

Admin

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

Filters

Port Filter Description Sequence

TS

CryptFilter

decryption

1

Configuration Parameters

Table 3. Workflow parameters of Validate_ShareFile_Realtime
Parameter Default value

dxminitialload

FALSE

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

Citrix_ShareFile

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

userPassword,dxmPassword

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 expected state from IdentityDomain and validates it against the connected directory through TS. It uses the accounts, groups and members channels on both ports. The CryptFilter decrypts userPassword,dxmPassword before CitrixShareFileConnector receives the request.

If processing fails, join retries the request three times and waits 30 minutes between attempts. If the request still fails, the workflow passes 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 validation request for the affected object in the Citrix ShareFile 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 validate the target-side state and apply the corresponding change when the connected directory does not match.

  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.