Session

This LDAP tool generates a Session ID which is used other LDAP tools to send commands to the LDAP Server. See Introduction to LDAP tools for more information on using this tool.

Inputs

HostName

The name of the server hosting the LDAP DS (Directory Server). This value is not required if the host server is on the local network. You may specify the name of the server or that server's IP address.

SearchBase

The OU (Organization Unit) of the DS tree you want to search. For example, in the following DN (Distinguished Name) uid=DoeJ,ou=mail users,ou=people,o=xyxy.com, the OU is mail users.

Login Id

The login ID generated with the Login tool in a step preceding this one in the handler.

Host Port

This optional field specifies the port through which to connect to the LDAP server. The default is 0.

Timeout

This optional field is the number of seconds to wait before timing out (Failure exit). The default is 3 seconds.

SizeLimit

A limit to the number of times that can be returned with any queries made during this session. Queries return lists, and this setting limits the size of those lists for all queries in this session.

Outputs

V3Compliant

True of the LDAP server is LDAP version 3 compliant. False if the LDAP server is not LDAP version 3 compliant.

Session Id

The unique identifier for this session. This session ID is used by other LDAP tools.

Error Code

The code associated with a processing error.

Error Message

A string description describing the error that occurred.

Error Native

A string description of an error that occurred in the LDAPLib module that connects this CIC server to your LDAP Server.

Exit Paths

Success

This step takes the Success of the operation completed successfully.

Note: If unused connections are in the cache (see Introduction to LDAP Tools for information on the connection cache), then it is possible for this tool to take the Success exit path even if the LDAP server is not currently available. In this scenario, the next tool that attempts to perform an action using the cached session will fail.

Failure

This tool takes the Failure exit path if an error occurred. Examine the output error text to determine the problem.