- 5 minutes to read

Installing the Nodinite LDAP Adapter for Microsoft BizTalk Server

Accelerate your integration projects with the Nodinite LDAP Adapter for Microsoft BizTalk Server. This guide walks you through a seamless installation process, ensuring you get the most out of your LDAP and Active Directory integrations.

  • ✅ Simple MSI-based installation for rapid deployment
  • ✅ Supports side-by-side versioning and easy upgrades
  • ✅ Flexible configuration for multiple BizTalk nodes and environments
  • ✅ Robust ALM support with best practices for updating and maintenance

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

Important

Use the MSI only for the first installation. To update an existing installation, use the ZIP package and follow Updating.

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 the MSI file to install the binaries.

    Setup wizard License Agreement page
    Accept the EULA to proceed with installation.

    You must accept the EULA; check the checkbox 'I accept the terms in the License Agreement'. If you do not accept the terms, you cannot install or use the product.

  5. Choose the installation path. The Advanced option lets you choose an alternate install path and select where to install components. We recommend using this option to copy the proposed path for later use. Always include a version number if you provide an alternate path. You can install this adapter side by side with future or older versions.

    Setup wizard with the default installation path
    Example with the default installation path.

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

    Tip

    Save the selected installation paths and options in your documentation.

  6. 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.
    • Choose only the features you need for your environment.

    Setup wizard feature selection
    Example of selecting features during installation.

  7. Finish the installation of the binaries by clicking Finish.

    Completed setup wizard
    Example of completed setup wizard.

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 contain the following files and folders (all features installed). Verify that this is the case.

    Don't run anything at this point yet; follow the steps below.

    Installation folder with the adapter binaries
    Verify all binaries are present before proceeding.

  2. Register the LDAP Adapter in the BizTalk Server group. Open an administrative command prompt (run as administrator) and navigate to the folder where you installed the binaries (path in your clipboard!). We recommend this approach since the installation client outputs valuable information about its progress.

  3. From the administrative command prompt, run IS.BizTalk.Adapters.LDAP.InstallationClient.exe.

    Installation client output ending with Done
    Register the adapter using the installation client tool.

    Make sure you get the same output with Done and no errors as shown above.

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

  1. Open the BizTalk Administration Console and navigate to Adapters, right-click, and select New > Adapter....

    BizTalk Administration Console with New Adapter selected
    Add a new LDAP Adapter in the BizTalk Administration Console.

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

  3. Name the LDAP Adapter. We strongly recommend a name that includes the version. The adapter supports deploying multiple versions of the same adapter in the same environment, and a unique name with version information lets you upgrade without uninstalling dependent artifacts, a common hassle for BizTalk solutions. The name stays with the BizTalk group for the rest of its life, so choose it carefully.

    Adapter Properties dialog with a name that includes the version number
    Example: Naming the adapter with version information for easy upgrades.

  4. A dialog informs you about a pending restart of the host instances. Set the send handlers first, which is the next step: click OK and continue.

    Dialog about restarting host instances
    Dialog prompts for host instance restart—set send handlers first.

  5. Navigate to the LDAP Adapter and set the preferred send handlers (Hosts) available for use in send ports in your solutions. Then enter the license on each send handler, see Configuration.

    LDAP Adapter send handlers in the BizTalk Administration Console
    Assign send handlers to the LDAP Adapter for your BizTalk solutions.

    The adapter supports both 32-bit and 64-bit handlers, and any number of send handlers can be associated with this adapter.

  6. If there are multiple nodes in the BizTalk group, install the LDAP adapter by running the MSI installer on each node with the selected host instances. Since this might be a late design decision that may change over time, we recommend installing the binaries on all BizTalk Server nodes, using the same path on all nodes.

  7. Restart all host instances (on all nodes) associated with this adapter. Navigate to Host Instances in the BizTalk Administration Console for the group where you installed the LDAP adapter and restart them.

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 Steps

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.