tLDAPInput

Property type

• Either Built-in or Repository .

• 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.

Click this icon to open a database connection wizard and store the database connection parameters you set in the component Basic settings view.

For more information about setting up and storing database connection parameters, see Centralizing database metadata.

Use an existing connection

Select this check box and in the Component List drop-down list, select the desired connection component to reuse the connection details you already defined.

Note that when a Job contains the parent Job and the child Job, Component List presents only the connection components in the same Job level.

Host

LDAP Directory server IP address.

Port

Listening port number of server.

Base DN

Path to the user's authorized 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, enter the password in double quotes in the pop-up dialog box, 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. When you create a Spark Job, avoid the reserved word line when naming the fields.

  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.

  This component offers the advantage of the dynamic schema feature. This allows you to retrieve unknown columns from source files or to copy batches of columns from a source without mapping each column individually. For further information about dynamic schemas, see Dynamic schema.

  This dynamic schema feature is designed for the purpose of retrieving unknown columns of a table and is recommended to be used for this purpose only; it is not recommended for the use of creating tables.

  Information noteWarning:

  Only three data types are supported here: String, byte[], and List. tMap can be used for data type conversion if needed.

• Built-in: The schema is created and stored locally for this component only. For more information about a component schema in its Basic settings tab, see Basic settings tab.

• Repository: The schema already exists and is stored in the Repository, hence can be reused. For more information about a component schema in its Basic settings tab, see Basic settings tab.

Select the Binary check box for the columns you want to be binary-encoded.

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 more information about variables, see Using contexts and variables.

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.