July 30, 2023

tLDAPRenameEntry – Docs for ESB 7.x


Renames ones or more entries in a specific LDAP directory.

tLDAPRenameEntry Standard properties

These properties are used to configure tLDAPRenameEntry running in the Standard Job framework.

The Standard
tLDAPRenameEntry component belongs to the Databases family.

The component in this framework is available in all Talend

Basic settings

Property type

Either Built-in or


Built-in: No property data stored


Repository: Select the repository
file in which the properties are stored. The fields that follow are
completed automatically using the data retrieved.

Use an existing connection

Select this check box and click the relevant tLDAPConnection component on the Component list to reuse the connection
details you already defined.


LDAP directory server IP address.


Number of the listening port of the server.

Base DN

Path to user’s authorized tree leaf.


Select the protocol type on the list.

LDAP: no encryption is used,

LDAPS: secured LDAP. When this
option is chosen, the Advanced CA
check box appears. Once selected, the advanced mode allows you to
specify the directory and the keystore password of the certificate
file for storing a specific CA. However, you can still deactivate
this certificate validation by selecting the Trust all certs check box.

TLS: certificate is used. When this
option is chosen, the Advanced CA
check box appears and is used the same way as that of the LDAPS type.

User and Password

Fill in user authentication information.

Note that the login must match the LDAP syntax requirement to be
valid. e.g.: “cn=Directory Manager”.

To enter the password, click the […] button next to the
password field, and then in the pop-up dialog box enter the password between double quotes
and click OK to save the settings.

Alias dereferencing

Select the option on the list. Never improves search performance if you are sure
that no alias is to be dereferenced. By default, Always is to be used:

Always: Always dereference

Never: Never dereferences

Searching: Dereferences aliases
only after name resolution,

Finding: Dereferences aliases only
during name resolution.

Referrals handling

Select the option on the list:

Ignore: does not handle request

Follow: does handle request

Previous DN and New

Select from the list the schema column that holds the old DN
(Previous DN) and the column
that holds the new DN (New DN).

Schema and Edit

A schema is a row description, it defines the number of fields to
be processed and passed on to the next component. The schema is
either Built-in or stored remotely
in the Repository.

Click Edit
to make changes to the schema. If the current schema is of the Repository type, three options are available:

  • View schema: choose this
    option to view the schema only.

  • Change to built-in property:
    choose this option to change the schema to Built-in for local changes.

  • Update repository connection:
    choose this option to change the schema stored in the repository and decide whether
    to propagate the changes to all the Jobs upon completion. If you just want to
    propagate the changes to the current Job, you can select No upon completion and choose this schema metadata
    again in the Repository Content


Built-in: The schema is created
and stored locally for this component only. Related topic: see

Talend Studio User


Repository: The schema already
exists and is stored in the Repository, hence can be reused. Related
topic: see
Talend Studio User

Die on error

This check box is selected by default. Clear the check box to skip
the row on error and complete the process for error-free rows. If
needed, you can retrieve the rows on error via a Row > Reject link.

Advanced settings

tStatCatcher Statistics

Select this check box to collect log data at the component

Global Variables

Global Variables

NB_LINE: the number of rows processed. This is an After
variable and it returns an integer.

ERROR_MESSAGE: the error message generated by the
component when an error occurs. This is an After variable and it returns a string. This
variable functions only if the Die on error check box is
cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable
functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl +
to access the variable list and choose the variable to use from it.

For further information about variables, see
Talend Studio

User Guide.


Usage rule

This component covers all possible LDAP queries. It is usually
used as a one-component subJob but you can use it with other
components as well.

Note: Press Ctrl + Space bar to
access the global variable list, including the GetResultName variable to retrieve automatically the
relevant DN Base.

Related scenarios

For use cases in relation with tLDAPRenameEntry, see
the following scenarios:

Document get from Talend https://help.talend.com
Thank you for watching.
Notify of
Inline Feedbacks
View all comments
Would love your thoughts, please comment.x