tLDAPAttributesInput Standard properties - 6.4

LDAP

author
Talend Documentation Team
EnrichVersion
6.4
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance > Third-party systems > Database components > LDAP components
Data Quality and Preparation > Third-party systems > Database components > LDAP components
Design and Development > Third-party systems > Database components > LDAP components
EnrichPlatform
Talend Studio

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

The Standard tLDAPAttributesInput component belongs to the Databases family.

The component in this framework is available in all Talend products.

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 (columns) 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.

Warning:

As this component is intended to list the attributes associated with a LDAP object, its schema is then pre-defined. You should retain these established columns, even though you may need to add some new columns. Hence you should use the Built-in mode.

 

Click Edit schema 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] window.

 

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

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

Usage rule

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