Ident_SharePoint_Realtime_Clustered

Sample workflow to provision a cluster of SharePoint sites from the corresponding DirX Identity target systems either scheduled or triggered by an event.

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_SharePoint_Realtime_Clustered is the provisioning workflow for connected systems of type SharePoint. It keeps SharePoint groups and group memberships aligned across every site in the cluster named by tscluster; because tsresource is *, one workflow instance can address all sites in that cluster.

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_SharePoint_Realtime_Clustered

Category

Target Realtime / SharePoint

Technology

Java-based real-time workflow

LDAP object class

dxmIDMWorkflowDefinition

Workflow type

ProvisionTS

Connected system / controller type

SharePoint

Configuration wizard

LDAP-SharePoint

Active in the factory data

FALSE

Factory data version

8.0

Factory data path

Workflows/Default/Target Realtime/SharePoint/Ident_SharePoint_Realtime_Clustered

Prerequisites

  • A connected directory of type SharePoint that points to the SharePoint environment and grants the SharePointConnector permission to maintain site groups and memberships across the cluster.

  • Target systems of type SharePoint in the Identity Store that are linked to that connected directory, with the site structure already represented in the target system subtree.

  • The Java-based Server that runs the workflow must be able to reach both the SharePoint environment and the Identity Store; the Identity Store is accessed through the bind profile Domain_Admin.

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

SharePointConnector

SharePoint

-

not set

Channels

Table 1. Channels of port IdentityDomain (activity join)
Channel Description Reference type Delta type

groups

Channel for groups

not set

SearchAttributes

members

Channel for members

not set

not set
Table 2. Channels of port TS (activity join)
Channel Description Reference type Delta type

groups

Channel for groups

not set

not set

members

Channel for members

not set

not set

Filters

Port Filter Description Sequence

TS

CryptFilter

decryption

1

Configuration Parameters

Table 3. Workflow parameters of Ident_SharePoint_Realtime_Clustered
Parameter Default value

timeout

P0Y0M4DT0H0M0S

tscluster

SHPCluster

tsresource

*
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

LDAP

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

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 does the provisioning work. Its IdentityDomain port reads the requested state from the Identity Store over the groups and members channels, and its TS port writes that state into the SharePoint sites over the channels of the same name. The workflow therefore focuses on site groups and their memberships rather than on user account creation. The CryptFilter on the TS port decrypts protected attributes before the connector sends them.

A request that fails is retried up to three 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 four days before it is discarded.

Operation

  1. Privilege resolution writes a group or membership change into the relevant SharePoint target system subtree in the Identity Store and marks it for provisioning.

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

  3. The IdentityDomain port reads the affected site group or membership entry from the Identity Store.

  4. The TS port applies the change to the correct SharePoint site in the cluster addressed by SHPCluster; because tsresource is *, the site is selected from the target system object rather than from a fixed resource name.

  5. The result is written back into the Identity Store so that the state of the target system entry reflects what happened on the site.

  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.