How to Set Up and Configure LDAP Connector

All BA Insight connectors can be downloaded from the Upland Community under Knowledge > BA Insight > Product Downloads > Connectors. This connector is installed with the same generic steps as any BA Insight connector. You must satisfy the Prerequisites for your connector before installing. The configuration specifics are detailed below.

How to Configure the LDAP Connector

  1. In Connectivity Hub, click Connections > New Connection Connection defines the how Connectivity Hub connects to your Source System (which contains your documents, graphics, etc.,). Your Connection includes identifying elements such as: URL of the BA Insight web service connector you are using, (File Share connector, SharePoint Online connector, etc.), Authentication mode, User Accounts and Credentials, Database information (for database connectors) > Web Service Connection.
  2. Enter the web service URL for your connector.
  3.  In the Services field, choose one of the two services depending on your directory authentication settings:
    • Services
      • Authentication: Simple Bind:
        • The default LDAP authentication mechanism (using the LDAP BIND operation).
      • Authentication: Anonymous:
        • Used to access the LDAP server without specifying a username or password.
  4. Click Connect.

Common Connection Configuration Settings

Setting Description
LDAP Server

  • The DNS name of your LDAP directory server.

  • Example: example.contoso.com:<port>
Base DN list:

  • The list of Base DN to be crawled. One per line.

  • The connector only returns the immediate children of the Base DN. It does not recursively search sub-containers.

  • If you wish to crawl multiple levels of a hierarchy, you must specify the DN for each container

Example:
OU=contoso,DC=example,DC=com
CN=Users,DC=example2,DC=com
Search for descendants within specified base DNs:

  • Checked: the connector will return records matching the enumeration query in the base DN container but also any sub container.

  • Unchecked: the connector will only return records directly located in the base DN container
Properties to request per record to index

The first line must specify the property to use as the unique identifier for each record.

  • Supported data types for unique identifier: Guid, Sid, UUID, string.

The second line is a comma separated list of properties to return for each record.

Example:
objectSid

ou,url,distinguishedName,telephoneNumber,etc.

 
Enumeration query

LDAP query that returns a list of ids to be indexed.

Example: (&(objectCategory=person)(objectClass=user)(cn=*Marketing*))

This means: search for all entries that have:

  • objectCategory = person
    AND
  • objectClass = user
    AND
  • cn that contains the word 'Marketing'.

Simple Bind Connection Configuration Specifics

In addition to Anonymous connection configuration there are the following settings:

Setting Description
LDAP Account

  • A user with read access to the LDAP service

  • Example: CN=Administrator,Cn=Users,DC=example,DC=com
Password The password for the LDAP account.

Content Configuration Specifics

Because the LDAP Directory may contain any kind of attribute and LDAP implementations do not necessarily have web interfaces, the following two fields must be configured when creating a content source Content Sources do the following: Receive data from the Source System via the Connection, Filter the data it receives, Provide the results to the Target, Define the specific search index that contains the content you wish to index (and later search). bound to the LDAP connector:

Setting Description
Item Url

This is the URL for the record indexed.

  • Search engines use this URL to make search results click-able.

If you do not have a web interface, use the following examples to configure this property:

  • For users, you can set it to mailto: [mail_property] to bring up an email client when users click the links.
  • For computers, you can set it to file://[computer_property] to bring up the server and any shared folder on it.
Note: This works only with Internet Explorer.
Item Title

  • Defines the title that appears in the user's search results.

  • Common entries for this field include: CN, FullName, GivenName, etc...

Other Configuration Specifics

The following settings can be found in the file web.config:

Setting Description
Item Cache in Minutes

  • The sliding expiration time for the items cache.

  • Default value: 90

Client Timeout In Minutes

The maximum amount of time that the client waits for the server to return results.

Provider Cache In Minutes The sliding expiration time for the providers cache.

Note: For target A Target is a "pointer" to a specific instance of a search application, such as Elasticsearch. - (A Search application instance has one or more indexes) sync, set File types to include to blank. This enables every item to be crawled.

LDAP Secured

  • LDAPS is the only supported version of LDAP Secured (STARTTLS is not supported).

  • The certificate for LDAPS must be trusted on the server where the LDAP connector is deployed.

Info | Metadata Provides context with details such as the source, type, owner, and relationships to other data sets. Metadata provides details around the item being crawled by Connectivity Hub.

  • The only data type supported for metadata is string.

  • Other data types like Guid, UUID, Sid etc. are not supported.