- 5 minutes to read

Installing the Nodinite LDAP Adapter for Microsoft BizTalk Server

Info

This guide teaches how to install the Nodinite LDAP Adapter for Microsoft BizTalk Server for use with LDAP and Active Directory.

Before you begin

Make sure you comply with the prerequisites.

Step 1: Execute the MSI-based installer

Repeat all steps on every BizTalk node part of the same BizTalk group

  1. Log on to the BizTalk node.
  2. Download the version of the LDAP adapter to the BizTalk node.
  3. Exit/quit/close all instances of BizTalk administration console(s) MMC.
  4. On the BizTalk node; Run/Execute the MSI file to install the binaries.
    EULA

/* You must accept the EULA; Check the checkbox 'I accept the terms in the License Agreement', if you accept the license terms. If you do not accept the terms you cannot install and/or use the product.

The 'Advanced' option provides an alternate install path and the custom selection of where to install components. We recommend using this install option to facilitate the copy of the proposed path into the clipboard buffer for later use in this guide. Always include a version number if you provide an alternate path of your choosing. You can install this adapter side by side with future/older versions.

Tip

Save the selected installation paths and options in your documentation.

Install Path

C:\Program Files (x86)\IS BizTalk LDAP Adapter 1.0\

Example with the default installation path.

  1. Select the features to install.
  • On developer machines, you do not have to install the LDAP Adapter.
  • On TEST/PROD machines, you do not need the examples (or the test client).
    Features
  1. Finish the installation process of binaries by pushing the finish button.
    Finished setup

Step 2: Register the Nodinite LDAP Adapter for Microsoft BizTalk Server

In this step, you will GAC some assemblies by running an executable.

  1. Depending on the features installed, the target folder(s) now contains the following files and folders (all features installed). Please verify that this is the case.
    Don't run anything at this point yet, follow the documented steps that follows next.
    Installed binaries

  2. Import the LDAP Adapter into the BizTalk Server group. Open an administrative command prompt (run as administrator) and navigate to the folder where you installed the binaries in earlier steps (path in your clipboard?!). We recommend this approach since the install client may output valuable information about its progress.

From inside the administrative command prompt, execute the 'IS.BizTalk.Adapters.LDAP.InstallationClient.exe'
Register adapter

Make sure you got the same output with Done without errors as image above.

Step 3: Import the Nodinite LDAP Adapter for Microsoft BizTalk Server

  1. Open the BizTalk Administration Console

  1. Navigate to Adapters | right click to open dialogue | New | Adapter... |
    New Adapter

  2. Select the LDAP Adapter from the Adapter drop down list

  3. Name the LDAP Adapter. We strongly recommend a name including the version. This adapter was engineered with great versioning support and you are able to deploy multiple versions of the same adapter on the same environment (!!!) A unique name with version information will facilitate an upgrade without the need to uninstall dependent artifacts. A common hassle for BizTalk solutions…

You are free to choose name however choosing a name for your LDAP Adapter can be a daunting prospect. It stays with the BizTalk Server for the rest of its life, so no pressure it's a big decision.

Example with name including version number
Name example

  1. A dialogue will appear informing about pending restart of the host instance. However, you should explicitly set the send handlers first which is next step. Press Ok and go to the next step in this guide.
    Restart

  2. Navigate to the LDAP Adapter and make sure to set the preferred send handlers (Hosts) available for use in send ports in your solutions.
    Send Handlers

The adapter supports both 32 and 64 bit handlers and there can be arbitrary number of send handlers associated with this adapter.

  1. If there are multiple nodes part of the BizTalk group, the LDAP adapter must be installed running the MSI installer on each and every node having the host instances selected in the previous step. Since this might be a late design decision that may change over time we recommend that you install the binaries on all BizTalk Server nodes. Make sure to install the run-time binaries on the other nodes before proceeding to the next step. Also, make sure to install the binaries using the same path on all nodes (this is recommended approach to simplify maintenance and your own documentation).

  2. All host instances (on all nodes) associated with this adapter must now be restarted. Navigate to "Host Instances" in the BizTalk admin console for the group where the LDAP adapter was installed and restart the host instances.

Warning

Restarting BizTalk host instances can disrupt the availability of your other BizTalk Server integration solutions using the same set of BizTalk Host instances.

Next Step

The LDAP Adapter is a software product under constant development and new features and bug fixes are added over time. New releases are regularly available and free download and usage is covered by your SA.

We recommend that you plan for the updates of the LDAP Adapter within the context of your ALM process.

Nodinite LDAP Web API