Operation Property

Specifies the operation the component will perform.

Data Type

Enumeration

Possible Values

Add (0)
Delete (1)
Modify (2)
Search (3)
Change Password (4)
Authenticate (5)
Move To DN (6)

Default Value

0

Remarks

This property controls the action of the connector. Possible values are:

• Add
• Authenticate
• ChangePassword
• Delete
• Modify
• Search

Details on each operation are below.

Add

Adds an entry specified by DN to the directory server using the type and value attributes defined in the message. The message must adhere to the schema defined in "LDAPAdd.xsd" that is located in the "schemas" folder of the installation. Note that instead of including the Value attribute in the message, Base64 encoded data may be included in the LDAPAttribute element text. To add attributes to an existing entry use the Modify operation instead.

To get started, set the message payload to an XML-formatted LDAPAdd message before it arrives at the LDAP Send Connector. For example, add a Set Payload Transformer and set the value to the following message:

<LDAPAdd><LDAPAttribute Type="objectClass" Value="top" /><LDAPAttribute Value="person"/><LDAPAttribute Value="organizationalPerson" /></LDAPAdd>

Then add a LDAP Send Connector behind the Set Payload Transformer and configure the connection settings. Set the Operation to Add and that's it. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Authenticate

Binds with the user specified by BindDN. This is only used to validate the user can bind successfully to the LDAP server. No other action is performed.

Add the LDAP Send Connector to your flow and configure the connection settings. This operation does not require a message which adheres to a schema. Simply configure the connection settings and set the Operation to Authenticate. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

ChangePassword

Changes the password for the user specified by DN with the value specified in NewPassword.

Add the LDAP Send Connector to your flow and configure the connection settings. This operation does not require a message which adheres to a schema. Simply configure the connection settings and set the Operation to ChangePassword. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Delete

Deletes the entry specified by DN.

Add the LDAP Send Connector to your flow and configure the connection settings. This operation does not require a message which adheres to a schema. Simply configure the connection settings and set the Operation to Delete. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Modify

Modifies an existing entry specified by DN. The message must adhere to the schema defined in "LDAPModify.xsd" that is located in the "schemas" folder of the installation. Note that instead of including the Value attribute in the message, Base64 encoded data may be included in the LDAPAttribute element text.

To get started, set the message payload to an XML-formatted LDAPModify message before it arrives at the LDAP Send Connector. For example, add a Set Payload Transformer and set the value to the following message:

<LDAPModify><LDAPAttribute Type="telephoneNumber" Value="phoneNumber1" ModifyOperation="add"/></LDAPModify>

Then add a LDAP Send Connector behind the Set Payload Transformer and configure the connection settings. Set the Operation to Modify and that's it. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Search

Performs a search using the criteria specified in the message. The message must adhere to the schema defined in "LDAPSearch.xsd" that is located in the "schemas" folder of the installation. The response message will adhere to the schema defined in "LDAPSearchResult" and provide the search results.

To get started, set the message payload to an XML-formatted LDAPSearch message before it arrives at the LDAP Send Connector. For example, add a Set Payload Transformer and set the value to the following message:

<LDAPSearch SearchFilter="sAMAccountName=bob"></LDAPSearch>

Then add a LDAP Send Connector behind the Set Payload Transformer and configure the connection settings. Set the Operation to Search and that's it. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.