SetPassword in Notes

Sets the password in a Notes connected system

A set-password workflow propagates a password from DirX Identity to the accounts of one connected system. It is triggered when a user or an administrator changes a password in the Identity Store, or when the password synchronization workflows distribute a password change. The workflow reads the password over the setPassword channel of the Identity Store port and writes it through the target system port; it does not synchronize any other account attribute.

Because a set-password workflow carries credentials, its ports decrypt the password attribute explicitly through the decrypt.attribute parameter, and failures are reported by a dedicated password notification connector instead of the regular notification connector.

SetPassword in Notes sets passwords in connected systems of type Notes. You use it when a password change stored in the Identity Store must be sent to Notes through the C++-based Server referenced by idscconnector and idscdn. The sample parameters identify the target system as tsresource resource in cluster 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

SetPassword in Notes

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-SetPassword.xml

Active in the factory data

FALSE

Factory data version

8.0

Factory data path

Workflows/Default/Target Realtime/Notes/SetPassword in Notes

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 to change passwords.

  • A target system of type Notes in the Identity Store that is linked to that connected directory and contains the accounts whose passwords you want to update.

  • 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; SSL to IdS-C is disabled in the factory data (ssltoidsc=FALSE).

Workflow and Activities

Activity Type Component description Description Ports

error

error

provisioningActivity

Error Activity

Message

SetPassword

ProvisionTS

provisioningActivity

setPassword activitity to update passwords in a Notes connected system

IdentityDomain, notify, ts

Ports

Activity Port Component description Connector Connected directory Bind profile SSL

error

Message

errorPort

ErrorNotifyMailConnector

-

-

not set

SetPassword

IdentityDomain

provisioningPort

LdapConnector

Identity Store

Domain_Admin

not set

SetPassword

notify

notificationPort

NotifyMailPwdConnector

-

-

not set

SetPassword

TS

provisioningPort

Spmlv1SoapConnector2IDSC

Notes

kellner20-vm

not set

Channels

Table 1. Channels of port IdentityDomain (activity SetPassword)
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 SetPassword)
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 SetPassword in Notes
Parameter Default value

timeout

P0Y0M4DT0H0M0S

tscluster

cluster

tsresource

resource
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 SetPassword
Parameter Default value

resourcefamily

Notes

retrylimit

3

timeout

P0Y0M1DT0H0M0S

waitbeforeretry

P0Y0M0DT0H30M0S
Table 7. Parameters of port IdentityDomain (activity SetPassword)
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 8. Parameters of port notify (activity SetPassword)
Parameter Default value

decrypt.attribute

userPassword
Table 9. Parameters of port TS (activity SetPassword)
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 SetPassword activity handles the password update. Its IdentityDomain port reads the affected account from the Identity Store, and its TS port sends the password change through IdS-C to Notes on the setPassword channel. CryptFilter decrypts Password and HTTPPassword 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. A password change request marks the affected Notes account in the resource target system subtree of cluster cluster in the Identity Store.

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

  3. The IdentityDomain port reads the affected entry from the Identity Store.

  4. The TS port sends the password update through the configured IdS-C connection and applies 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 notify port sends the configured password notification.

  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.