Appendix B: Install the Microsoft SharePoint Adapter

3 minutes to read Contributors
  • Mandi Ohlinger
  • Saisang Cai

BizTalk Server includes a SharePoint Services adapter that can receive messages or send messages to SharePoint Services.

This topic describes the SharePoint adapter. The software requirements for BizTalk Server 2016 and BizTalk Server 2013 R2 / 2013 list the supported SharePoint versions.

SharePoint adapter in BizTalk Server 2016

The BizTalk Server setup automatically installs the CSOM redistributable package, just like the File adapter, FTP adapter, and other out-of-the-box adapters.

The SSOM option is removed, and is not available.

SharePoint adapter in BizTalk Server 2013 and R2

In BizTalk Server 2013 R2 and BizTalk Server 2013, there are two options for the SharePoint adapter.

SharePoint object model Description
CSOM - SharePoint Services Adapter Recommended. The BizTalk Server setup automatically installs the CSOM redistributable package, just like the File adapter, FTP adapter, and other out-of-the-box adapters.

There are no installation requirements on the SharePoint computer.
SSOM - SharePoint Services Web Service Deprecated. On the SharePoint computer, run the BizTalk Server setup, and only select the SharePoint Services Adapter. This setup installs an IIS web service that handles the communication to the SharePoint adapter on BizTalk Server.

In most environments, BizTalk Server and SharePoint Services are on separate computers.

Before You Install

  • The SharePoint Services SSOM and CSOM components can both be installed if BizTalk Server 2013 R2 or 2013 and SharePoint Services are installed on the same computer.

  • The BAM Portal only runs in 32-bit mode. If the BAM Portal is installed on a 64-bit machine, ensure that ASP.NET 2.0 32-bit is enabled and the IIS application pool is in 32-bit mode. To do this:

    • ASP.NET: Open IIS Manager, click the BAM Portal web site, and then double-click Handler Mappings. In the Enabled list, confirm PageHandlerFactory-ISAPI-2.0 is listed.

    • Application Pool: Open IIS Manager, click Application Pools, click the BAMAppPool, and then click Advanced Settings. In Enable 32-bit applications, select True.

  • When installing SharePoint Services, click the Server Farm option, even when you are creating a single-server BizTalk Server and SharePoint Services installation. A Server Farm installation allows you to configure the SharePoint Services databases.

  • CSOM: SharePoint Services Adapter provides information on configuring a SharePoint receive location and send port.
  • BizTalk Server 2010 and previous versions use the Server Side Object Model (SSOM) to connect to SharePoint 2010.

CSOM and SSOM supported versions

The SharePoint Services support is listed in the following table:

Supports CSOM Supports SSOM
SharePoint Services 2016 Yes No
SharePoint Services 2013 Yes No
SharePoint Services Online Yes No
SharePoint Services 2010 Yes Yes
SharePoint Services 2007 No Yes

Install the CSOM SharePoint adapter

  1. Use a SharePoint computer based on the following requirements:

    CSOM Support
    SharePoint Services 2016

    Install SharePoint 2016    		 Yes
    SharePoint Services 2013

    Install SharePoint 2013    		 Yes
    SharePoint Services Online

    SharePoint Online administration    		 Yes
    SharePoint Services 2010

    Installation and Deployment for SharePoint Server 2010    		 Yes
    SharePoint Services 2007 No

  2. On the BizTalk Server, install Windows Identity Foundation:

    Operating System Info
    Windows 10, Windows 8.1, Windows Server 2016, Windows Server 2012, and Windows Server 2012 R2 Windows Identity Foundation is included with the operating system as a Feature in Turn Windows features on or off.
    Windows 7 SP1 Download available at Windows Identity Foundation.

  3. Install BizTalk Server:
    BizTalk Server 2016 Run BizTalk setup.
    BizTalk Server 2013 R2 Run BizTalk setup, and do not check Windows SharePoint Services Adapter.
    BizTalk Server 2013 Run BizTalk setup, and do not check Windows SharePoint Services Adapter.

Install the SSOM SharePoint adapter (deprecated)

  1. Use a SharePoint Services computer based on the following SSOM requirements:

    SSOM Support
    SharePoint Services 2016

    Install SharePoint 2016    		 No
    SharePoint Services 2013

    Install SharePoint 2013    		 No
    SharePoint Services Online

    SharePoint Online administration    		 No
    SharePoint Services 2010

    Installation and Deployment for SharePoint Server 2010    		 Yes
    SharePoint Services 2007

    Installation for SharePoint Server 2007    		 Yes

  2. On the SharePoint Services computer, configure SharePoint, and extend the Default Web Site. When you extend the web site, a separate IIS web site is created that contains the same content but also provides a unique URL and authentication type.

    See SharePoint 2010: Extend a Web Application.

  3. On the SharePoint Services computer, run the BizTalk Server installation and only check Windows SharePoint Services Adapter. This installs the web service. Do not run the BizTalk configuration.

  4. On the BizTalk Server, install BizTalk Server. Do not check Windows SharePoint Services Adapter.

  5. The SharePoint Services Web Service (SSOM) only runs in 64-bit mode. ASP.NET and the IIS application pool must be in 64-bit mode on the SharePoint computer before installing SharePoint. To do this:

    • ASP.NET: Open IIS Manager, click the web site, and then double-click Handler Mappings. In the Enabled list, confirm PageHandlerFactory-ISAPI-2.0-64 is listed.

    • Application Pool: Open IIS Manager, click Application Pools, select the application pool, and then click Advanced Settings. In Enable 32-bit applications, select False.