LDIF

Use the LDIF activity to export entries that are fetched by the Search Entry and LDAP Entry Listener activities to an LDAP Data Interchange Format (LDIF) file, or import entries data from either an LDIF file or a string to an LDAP server.

General

In the General tab, you can establish a connection to an LDAP server, and specify to import entries or export entries.

The following table lists the configurations in the General tab of the LDIF activity:

Field Module Property? Visual Diff?Description
NameNo YesThe name to be displayed as the label for the activity in the process.
LDAP ConnectionYes YesClick 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.

File NameYes YesClick to select the file that imports entries from or exports entries to.
Import LDIF to ServerYes YesBy default, the LDIF activity exports the searched or monitored entries to an LDIF file.

If you select this option, the LDIF activity imports entries from a selected LDIF file to the connected LDAP server.

Description

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

Advanced

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

The following tab lists the configurations in the Advanced tab of the LDIF activity:

Field Module Property? Visual Diff?Description
Base DNYes YesDisplays the distinguished name of the selected base entry.

Click Browse DIT to select the base DN 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 FromNo Yes Select a method to specify the object class of the entry:

  • 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 EntryNo 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 ClassesNo NoClick 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.
ObjectclassesNo YesDisplays the object classes of the entry that you want to export.

Input

In the Input tab, you can review the information related to the entry that you want to export. The entry information is mapped from the Search Entry activity or the LDAP Entry Listener activity.

The following tab lists the input elements in the Input tab of the LDIF activity:

Input Item Data Type Description
isImportContentString Boolean Set this to true if you want to import string data in the ldif format through the LdifFile input field. The default value is false.
Note: If the value is set to true, then preference is given to LDIFFile field data.
Note: Note: This value should be set to true for deployment on a TIBCO Cloud Integration platform as file import is not supported.
LdifFile String Set the ldif file path in this field. If isImportContentString is set to true, then string ldif data is expected for this field.
Note: In case this field is blank, the content in the File Name input field from the General tab is used as fall-back. This file name will be considered for import or export of string data in Ldif format.
OpCode Boolean Displays the change type of the searched or monitored entry.
DN String Displays the distinguished name (DN) of the searched or monitored entry.
NewDN String Displays the new distinguished name (DN) of the searched or monitored entry.
Note: This element is displayed only when the distinguished name of the searched or monitored entry is changed.
Object Class String Displays the object class of the searched or monitored entry. Expand the object class to view the attributes.

Fault

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

The following table lists error schema elements in the Fault tab of the LDIF activity:

Error Schema Element Data Type Description
msgCode String Displays the error code.
msg String Displays the error message.