Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Snap type:

Read


Description:

This Snap performs a search operation on the LDAP server.

  • Expected upstream SnapsFile Reader followed by CSV Parser. 
  • Expected downstream Snaps: [None].
  • Expected inputThe Distinguished name of the unit to be searched, the scope of the search, and the filter to be applied to obtain the search results.
  • Expected outputThe entries satisfying the search criteria in the given unit.


Prerequisites:

[None]


Support and limitations:Works in Ultra Task Pipelines.
Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to connect to an LDAP server. See LDAP Account for information on setting up this type of account.


Views:


InputThis Snap has at most one input view, which contains the distinguished name of the unit to be searched, scope level and filter to be applied.
OutputThis Snap has at most one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.


Settings

Label


Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Distinguished name



Required. The distinguished name of the entry to be modified.

Examplecn=syed,ou=People,dc=Snaplogic,dc=com

Default value: [None]


Pass through

Select to include the entire input data in the Snap's output. The Snap includes this data within the $original field in the output. 

Default value: Not selected

Search scope


Required. The depth of the search. The options available include:

  • OBJECT (within the unit)
  • ONELEVEL (within the unit and its immediate children)
  • SUBTREE (within the unit and all its descendants)

Default value: OBJECT


Filter


Required. The pattern to refine the search results.  Must be enclosed in parenthesis.

Example(cn=s*)

Attributes

This field filters the attributes that will be output by the Snap. Click + to add the attributes to filter. If you do not add any attributes, the result displays all the attributes by default.

Example: givenName

Default value: None

Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute

Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read

Example of a Search result without any attributes:

Example of a Search result with givenName and Company as the attributes:

Note
titleUsing the pass-through functionality

In certain scenarios, the Snap may be unable to process the entire input due to limitations imposed by the endpoint's API. In such cases, we recommend that you select the Pass through checkbox to ensure that the unprocessed input is not lost. You can process the remaining input data using more of the same Snap in the Pipeline. Alternatively, you can also write the original data into a separate file using a combination of the Mapper Snap and the File Writer Snap. 


 

Excerpt Include
LDAP Snap Pack
LDAP Snap Pack
nopaneltrue