Update Entry

Use the Update Entry activity to update an existing entry. If the entry does not exist, the plug-in can add it to the connected LDAP server.

General

In the General tab, you can establish a connection to an LDAP server, and specify whether to add the entry when the entry that you want to update does not exist.

The following table lists the configurations in the General tab of the Update Entry activity:
Field Module Property? Description
Name No The name to be displayed as the label for the activity in the process.
LDAP Connection Yes

Click to select an LDAP Connection shared resource. The LDAP Connection shared resource creates a connection between the plug-in and an LDAP server.

If no matching LDAP Connection shared resources are found, click Create Shared Resource to create one. For more details, see Creating an LDAP Connection.

Allow Create If Entry Does Not Exist Yes Select this option to add the entry when the entry that you want to update does not exist.

Description

In the Description tab, you can enter a short description for the Update Entry activity.

Advanced

In the Advanced tab, you can specify the object class of the entry that you want to update. The specified object class is displayed in the Input tab.

The following table lists the configurations in the Advanced tab of the Update Entry activity:
Field Module Property? Description
Base DN Yes Displays the distinguished name of the selected base entry.

Click Browse DIT to select a base entry from the Directory Information Tree (DIT).

The Select Base DN dialog is displayed when clicking Browse DIT. In the Select Base DN dialog, move the slider to specify the maximum number of entries to be displayed in the DIT. The maximum number is 10000.

Select Object Classes From No Select a method to specify the object class of the entry that you want to update:
  • Sample Entry: if you select this option, the object class is retrieved from a sample entry.
  • LDAP Schema: if you select this option, the object class is selected from the LDAP schema.
Sample Entry No Click Browse DIT to select a sample entry. The object class defined for the selected entry is automatically populated in the Objectclasses field.
Note: This option is available only when you select Sample Entry in the Select Object Classes From field.
LDAP Schema Classes No Click Browse Schema to select one or more object classes. The selected object classes are automatically populated in the Objectclasses field.
Note: This option is available only when you select LDAP Schema in the Select Object Classes From field.
Objectclasses No Displays object classes of the entry that you want to update.
Handle Any Subset of Configured Object Classes Yes Select this option to update entries that match any subset of the specified object classes.
Note: This option is available only when you select a composite object class.

Input

In the Input tab, you can specify the entry that you want to update, and the modification that you want to make.

The following table lists the input elements in the Input tab of the Update Entry activity:
Input Item Data Type Description
DN String (Required) Enter the distinguished name (DN) of the entry that you want to update.
ModifyType String Specify the type of modification that you want to make:
  • Enter MA or ma to add a new attribute for the entry that you want to update.
  • Enter MR or mr to replace the attributes of the entry that you want to update.
  • Enter MD or md to delete the attributes of the entry that you want to update.
Note: If you do not enter a value, the plug-in uses the MR/mr type.
ObjectClass String Enter object class of the entry that you want to update. The entered object class replaces the object class that you have specified in the Advanced tab.

Object classes are separated by periods (.), for example, "person.container".

Object Class Complex Expand the object class and enter a value for the corresponding attribute.

Output

In the Output tab, you can find the update result.

The following table lists the output elements in the Output tab of the Update Entry activity:
Output Item Data Type Description
Result Boolean A value of true indicates the update succeeds, whereas a value of false indicates the update fails.

Fault

In the Fault tab, you can find the error code and error message of the Update Entry activity. See Error Codes for a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Update Entry activity:
Error Schema Element Data Type Description
msgCode String Displays the error code.
msg String Displays the error message.