tLDAPAttributesInput – Docs for ESB 5.x

Component family

Databases/LDAP

Function

tLDAPAttributesInput analyses
each object found via the LDAP query and lists a collection of
attributes associated with the object.

Purpose

tLDAPAttributesInput executes an
LDAP query based on the given filter and corresponding to the schema
definition. Then it passes on the field list to the next component
via a Main row link.

Basic settings

Property type

Either Built-in or
Repository.

Since version 5.6, both the Built-In mode and the Repository mode are
available in any of the Talend solutions.

Built-in: No property data stored
centrally.

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.

Host

LDAP Directory server IP address.

Port

Listening port number of server.

Base DN

Path to user’s authorised tree leaf.

Protocol

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.

Authentication User and
Password

Select the Authentication check
box if LDAP login is required. 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.

Filter

Type in the filter as expected by the LDAP directory db.

Multi valued field separator

Type in the value separator in multi-value fields.

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
aliases

Never: Never dereferences
aliases.

Searching:Dereferences aliases only
after name resolution.

Finding: Dereferences aliases only
during name resolution

Referral handling

Select the option on the list:

Ignore: does not handle request
redirections

Follow:does handle request
redirections

Limit

Fill in a limit number of records to be read If needed.

Time Limit

Fill in a timeout period for the directory. access

Paging

Specify the number of entries returned at a time by the LDAP
server.

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 > Rejects link.

Schema and Edit
Schema

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.

Since version 5.6, both the Built-In mode and the Repository mode are
available in any of the Talend solutions.

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

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

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

The pre-defined schema lists:

– objectclass: list of object classes

– mandatoryattributes: list of mandatory
attributes to these classes

– optionalattributes: list of optional
attributes to these classes

– objectattributes: list of attributes that
are essential for the analysed object.

Advanced settings

Class Definition Root

Specify the root of the object class definition namespace.

tStatCatcher Statistics

Select this check box to gather the job processing metadata at a
job level as well as at each component level.

Global Variables

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

RESULT_NAME: the name of the current LDAP entry
satisfying the search filter. This is a flow variable, and it returns a string.

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 +
Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio
User Guide.

Usage

This component covers all possible LDAP queries.

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

Log4j

The activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User
Guide.

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.