Search LDAP Entry Activity

Search activity is used to search entries in LDAP Server that matches the values that are specified in the search criteria.

You can specify or configure the following search criteria in the configuration panel or input data that is sent with the outbound request.
  1. Search Scope:
    The Scope is the starting point of an LDAP search and the depth from the base DN to which the search should occur. There are three options (values) that can be assigned to the SCOPE parameter:
    1. Only Object: This value is used to indicate searching only the entry at the base DN, resulting in only that entry being returned (keeping in mind that it also has to meet the search filter criteria.)
    2. Immediate Child: This value is used to indicate searching all entries one level under the base DN - but not including the base DN and not including any entries under that one level under the base DN.
    3. Complete Sub tree: This value is used to indicate searching of all entries at all levels under and including the specified base DN.
  2. Search filter: Search filters select the entries to be returned for a search operation. They are most commonly used with the LDAP search command-line utility and you can place multiple search filters.

Using the Search Entry activity

  1. Right-click Orchestration in the Project pane and click New Orchestration to create or open an orchestration. The orchestration pane is displayed.
  2. Select the Activities tab and expand the LDAP folder.
  3. Drag Search Entry activity from the LDAP folder onto the orchestration. The graphical representation of the orchestration, including the checklist is displayed.
  4. The Checklist pane lists the tasks (Summary, Pick Endpoint, Configure, Map inputs, Map outputs) that you must complete to configure the outbound activity.
    1. Click on Pick Endpoint to select a LDAP endpoint.
      Note: For instructions on creating or editing a LDAP endpoint, see Creating or Editing Endpoint for LDAP connector.
    2. Click Configure from the Checklist. The Configure pane is displayed.
      1. Click Browse button to select an Base Dn from the Browse DIT pane. The Browse DIT panel displays all the entries from the selected LDAP server.
        Note: If you have configured the Base-Dn property in the endpoint panel then Browse LDAP Entry displays children of Base-Dn alone or else it displays all the entries from the root of the LDAP directory.
      2. Click Browse button to select an Object class(es) from the Browse LDAP Object Class pane. The Browse LDAP Object Class displays all the Object Classes on the selected endpoint.
    3. Select the scope of Search.
    4. Input the LDAP filter to search and filter the result.

Specifying the map inputs for search entry activity

Click Map Input from the Checklist pane. The input parameters for the specific LDAP activity are displayed under the To Activity pane.

Table 1. Map Input Optional Parameter
Parameter Name Descrtiption
baseDn Starting point of LDAP search
RDN Relative DN
Search Scope The Scope is the starting point of an LDAP search and the depth from the base DN to which the search should occur
Search Filter Search filters select the entries to be returned for a search operation.
Note: Value provided in map will take highest priority.

Specifying the map outputs search entry activity

Click Map output from the Checklist pane. The output parameters for the LDAP Search entry activity are displayed under the From Activity pane. Some of the common output parameters are defined in the following table:
Table 2. Retrieve Activity common output parameters
Parameter Name Description
baseDn The container Dn under which entry represented by RDN is created.
RDN Relative Distinguished Names(RDN). RDN of an object is the part of the name that is an attribute of the object itself (the part of the object name that identifies this object as unique from its siblings at its current level in the naming hierarchy)
objectClasses Lists all object classes of the search entry
entryAttributes Field contains structured content containing all attributes of the object classes selected in configure panel.
additionalAttributes additionalAttributes field contains additional set attributes of the entry which cannot be represented by selected object classes (entryAttributes). Means, if the entry contains an attribute or set of attributes which are not in the entryAttribute field then those attribute(s) will be added to additionalAttributes. The field additionalAttributes is a complex type field which can contain attribute name, its type and values. (The value field is an array in turn to support multiple value for an attribute)



Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


https://www.ibm.com/support/knowledgecenter/en/SS3LC4_7.5.3/com.ibm.wci.doc/LDAP_connector_search_entry.html