ModifyDN Entry

Use the ModifyDN Entry activity to modify the distinguished name of an entry.

General

In the General tab, you can establish a connection to an LDAP server, and specify whether to validate the entry before modifying it.

The following table lists the configurations in the General tab of the ModifyDN 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.

Validate Object Yes When you select this option, the plug-in checks whether the configured object class matches the objectClass attribute:
  • If the configured object class matches the objectClass attribute, the modification succeeds.
    Note: When the configured object class is a composite object class and you select the Handle Any Subset of Configured Object Classes option, the modification also succeeds if the objectClass attribute is a subset object class of the configured object class.
  • If the configured object class does not match the objectClass attribute, the modification fails.

The configured object class refers to the object class that you select from the Advanced tab or the object class specified in the Input tab. The object class specified in the Input tab can overwrite the object class specified in the Advanced tab.

The objectClass attribute is one attribute of the specified object class.

Description

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

Advanced

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

The following table lists the configurations in the Advanced tab of the ModifyDN 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 modify the DN for:
  • 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 the object classes of the entry that you want to modify.
Handle Any Subset of Configured Object Classes Yes Select this option to modify distinguished name of 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 for which you want to modify the distinguished name.

The following table lists the input elements in the Input tab of the ModifyDN Entry activity:

Input Item Data Type Description
DN String (Required) Enter the distinguished name (DN) of the entry that you want to modify.
NewDN String (Required) Enter the new distinguished name (DN) of the entry.
ObjectClass String Enter the object class of the entry that you want to modify. 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".

Output

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

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

Fault

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

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