hop-user-manual/modules/ROOT/pages/plugins/transforms/ldapinput.adoc

////
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
////
:documentationPath: /plugins/transforms/
:language: en_US
:page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/plugins/transforms/ldapinput/src/main/doc/ldapinput.adoc
= LDAP Input

== Description

The LDAP Input transform allows you to read information like users, roles and other data from an LDAP server. The following sections describe the available options for the LDAP input transform.


== General Tab

[width="90%", options="header"]
|===
|Option|Description
|Transform name|Name of the transform; this name has to be unique in a single pipeline.
|Host|Host can be the IP address of the LDAP directory server or its DNS name.
|Port|Port number of LDAP directory server.
|Use authentication|To enable LDAP authentication
|Username|The username to be passed during authentication.
|Password|The password to be passed during authentication.
|Use certificate|To enable the use of a certificate.
|Trust store path|
|Trust store password|
|Trust all certificates|
|Test connection|Tests the configured connection to the LDAP server.
|===

== Search Tab

[width="90%", options="header"]
|===
|Option|Description
|Dynamic search base|Enables the search base field.
|Search base fieldname|The field containing the base LDAP node.
|Search base|Base LDAP node to search the LDAP contents.
|Dynamic filter string|Enables the filter string field.
|Filter string fieldname|The field containing the filter string.
|Filter String|LDAP filter to search the customized contents, in the current stage only "single filter format" is supported like. 
 Example: mail=*
|===

== Advanced Tab

[width="90%", options="header"]
|===
|Option|Description
|Include rownum in output?|Adds a row number to the output.
|Rownum fieldname|The field containing the row number.
|Limit|Limit the number of results returned.
|Time limit|Limit the amount of time given to return results.
|Multi valued field separator.|
|Set paging|
|Page size|
|Search scope|Object scope, One level scope, Subtree scope
|===

== Fields Tab

[width="90%", options="header"]
|===
|Option|Description
|Name|The name of the imported field. Note: If you renamed a field in the Select & Alter tab, the name here must match the renamed value.
|Attribute|
|Fetch as|String, Binary
|Is sorted Key?| Y/N
|Type|The data type for this field.
|Format|The format mask (number type or date format)
|Length|The field length.
|Precision|The precision option depends on the field type, but only Number is supported; it returns the number of floating point digits.
|Currency|Symbol used to represent currencies
|Decimal|A decimal point; this is either a dot or a comma
|Group|A method of separating units of thousands in numbers of four digits or larger. This is either a dot or a comma.
|Trim type|Where to trim the field, left, right, both, none
|Repeat|If LDAP returns no value for an attribute, use the value from the previous row
|Get fields|Gets the result fields
|===