Centralizing LDAP connection metadata

Talend Data Management Platform Studio User Guide

EnrichVersion
6.2
EnrichProdName
Talend Data Management Platform
task
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

If you often need to access an LDAP directory, you want to centralize your LDAP server connection in the Repository tree view for easy reuse.

You can create an LDAP connection either from an accessible LDAP directory, or by saving the LDAP settings defined in a Job.

To create an LDAP connection from an accessible LDAP directory, expand the Metadata node in the Repository tree view, right-click the LDAP tree node, and select Create LDAP schema from the contextual menu to open the [Create new LDAP schema] wizard.

To centralize an LDAP connection and its schema you have already defined in a Job, click the icon in the Basic settings view of the relevant component, with its Property Type set to Built-In, to open the [Create new LDAP schema] wizard.

Unlike the DB connection wizard, the LDAP wizard gathers both LDAP server connection and schema definition in a five-step procedure.

Defining the general properties

  1. Fill in the general information in the relevant fields to identify the LDAP connection to be created, including Name, Purpose and Description.

    The Name field is required, and the information you provide in the Description field will appear as a tooltip when you move your mouse pointer over the LDAP connection.

  2. If needed, set the version and status in the Version and Status fields respectively. You can also manage the version and status of a Repository item in the [Project Settings] dialog box. For more information, see Version management and Status management respectively.

  3. If needed, click the Select button next to the Path field to select a folder under the LDAP node to hold your newly created LDAP connection.

  4. Click Next to define your LDAP server connection details.

Defining the server connection

  1. Fill the connection details.

    Field

    Description

    Host

    LDAP Server host name or IP address

    Port

    Listening port to the LDAP directory

    Encryption method

    LDAP : no encryption is used

    LDAPS: secured LDAP

    TLS: certificate is used

  2. Then check your connection using Check Network Parameter to verify the connection and activate the Next button.

  3. Click Next to continue.

Configuring LDAP access parameters

  1. In this view, set the authentication and data access mode.

    Field

    Description

    Authentication method

    Simple authentication: requires Authentication Parameters field to be filled in

    Anonymous authentication: does not require authentication parameters

    Authentication Parameters

    Bind DN or User: login as expected by the LDAP authentication method

    Bind password: expected password

    Save password: remembers the login details.

    Get Base DN from Root DSE / Base DN

    Path to user's authorized tree leaf

    Fetch Base DNs button retrieves the DN automatically from Root.

    Alias Dereferencing

    Never allows to improve search performance if you are sure that no aliases 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

    Redirection of user request:

    Ignore: does not handle request redirections

    Follow:does handle request redirections

    Limit

    Limited number of records to be read

  2. Click Check authentication to verify your access rights.

  3. Click Fetch Base DNs to retrieve the DN and click the Next button to continue.

  4. If any third-party libraries required for setting up an LDAP connection are found missing, an external module installation wizard appears. Install the required libraries as guided by the wizard. For more information on installing third-party modules, see the Talend Installation Guide.

Defining the schema

  1. Select the attributes to be included in the schema structure.

    Add a filter if you want selected data only.

  2. Click Refresh Preview to display the selected column and a sample of the data.

  3. Click Next to continue.

Finalizing the end schema

The last step shows the LDAP schema generated and allows you to further customize the end schema.

  1. If needed, rename the metadata in the Name field (metadata, by default), add a Comment, and make further modifications, for example:

    • Redefine the columns by editing the relevant fields.

    • Add or delete a column using the and buttons.

    • Change the order of the columns using the and buttons.

    Make sure the data type in the Type column is correctly defined.

    For more information regarding Java data types, including date pattern, see Java API Specification.

    Below are the commonly used Talend data types:

    • Object: a generic Talend data type that allows processing data without regard to its content, for example, a data file not otherwise supported can be processed with a tFileInputRaw component by specifying that it has a data type of Object.

    • List: a space-separated list of primitive type elements in an XML Schema definition, defined using the xsd:list element.

    • Dynamic: a data type that can be set for a single column at the end of a schema to allow processing fields as VARCHAR(100) columns named either as 'Column<X>' or, if the input includes a header, from the column names appearing in the header. For more information, see Dynamic schema.

    • Document: a data type that allows processing an entire XML document without regarding to its content.

  2. If the LDAP directory which the schema is based on has changed, use the Guess button to generate again the schema. Note that if you customized the schema, your changes will not be retained after the Guess operation.

  3. Click Finish. The new schema is displayed under the relevant LDAP connection node in the Repository tree view.

Now you can drag and drop the file connection or any schema of it from the Repository tree view onto the design workspace as a new component or onto an existing component to reuse the metadata.

To modify an existing file connection, right-click it from the Repository tree view, and select Edit LDAP schema to open the file metadata setup wizard.

To add a new schema to an existing file connection, right-click the connection from the Repository tree view and select Retrieve Schema from the contextual menu.

To edit an existing file schema, right-click the schema from the Repository tree view and select Edit Schema from the contextual menu.