About the Microsoft BizTalk Adapter Pack

Software Prerequisites

Software Prerequisites When Using the Adapters Through a .NET Application

Software Prerequisites When Using the Adapters with BizTalk Server

Software Prerequisites When Using the Adapters with ADO

Software Prerequisites When Using the Adapters with Microsoft Office SharePoint Server

Supported Enterprise Application Versions

For the Oracle Database Adapter

For the SAP Adapter

For the Siebel Adapter

Compatibility Matrix Between 32 and 64-bit Versions of the Adapter, BizTalk Server, and Operating System

Preparing Your Enterprise Applications to Work with the Adapters

Preparing the Oracle Client

Preparing the SAP Client

Preparing the Siebel Client

Installing the BizTalk Adapter Pack

Types of Installation

Scenarios for Installing the BizTalk Adapter Pack on 32-bit and 64-bit Platforms

Installing the BizTalk Adapter Pack in Interactive Mode

Installing the BizTalk Adapter Pack in Silent Mode

After Installing the BizTalk Adapter Pack

Hotfixes Released Since the Release of the BizTalk Adapter Pack

Installing the Enterprise Applications

Installation and Post-Installation Checklist

Modifying the BizTalk Adapter Pack Installation

Removing the BizTalk Adapter Pack

After Removing the BizTalk Adapter Pack

Upgrading from Previous Releases of the BizTalk Adapter Pack

Samples for the BizTalk Adapter Pack

Accessing the Adapter Pack Forum

Copyright

This topic was last updated on: June 05, 2009

Welcome to the Microsoft BizTalk Adapter Pack 1.0 Installation Guide. This document provides software requirements and detailed instructions for installing the Microsoft BizTalk Adapter Pack.

For the latest version of this installation guide, go to http://go.microsoft.com/fwlink/?LinkID=106952.

About the Microsoft BizTalk Adapter Pack

The Microsoft BizTalk Adapter Pack contains adapters that enable enterprise applications and databases to interface with each other by implementing a common adapter framework. Similar to programming to Web services, adapters enable clients to program to different enterprise applications. Technically, adapters are a binding to Windows Communication Framework (WCF). The BizTalk Adapter Pack consists of the following adapters:

  • Microsoft BizTalk Adapter 3.0 for mySAP Business Suite (SAP adapter). This also includes the .NET Framework Data Provider for mySAP Business Suite (Data Provider for SAP).

  • Microsoft BizTalk Adapter 3.0 for Oracle Database (Oracle Database adapter).

  • Microsoft BizTalk Adapter 3.0 for Siebel eBusiness Applications (Siebel adapter). This also includes the .NET Framework Data Provider for Siebel eBusiness Applications (Data Provider for Siebel).

    Note

    The Siebel adapter is not available for 64-bit platforms.

Top of page

Software Prerequisites

The BizTalk Adapter Pack can be consumed from:

  • A .NET application

  • BizTalk Server 2006 R2

  • An ADO interface

  • A Microsoft SharePoint portal

Based on how you consume the adapters, the required software will vary.

Software Prerequisites When Using the Adapters Through a .NET Application

You must ensure the following software is installed on the computer where you will be using the BizTalk Adapter Pack to write .NET applications on top of the adapter.

  • Microsoft .NET Framework 3.0.

  • Microsoft Visual Studio 2005.

  • The Microsoft Windows Communication Foundation (WCF) Line of Business (LOB) Adapter SDK (WCF LOB Adapter SDK) Service Pack 1 (SP1). You can download the WCF LOB Adapter SDK SP1 from http://go.microsoft.com/fwlink/?LinkID=106906.

  • Respective enterprise application clients and associated software. See Supported Enterprise Application Versions for the enterprise application client versions and other supporting DLLs that you must install for each adapter.

Software Prerequisites When Using the Adapters with BizTalk Server

You must ensure the following software is installed on the computer where you will be using the BizTalk Adapter Pack with BizTalk Server.

  • Microsoft .NET Framework 3.0.

    Important

    You must install Microsoft .NET Framework 3.0 before installing BizTalk Server 2006 R2.

  • Microsoft Visual Studio 2005.

  • The Microsoft Windows Communication Foundation (WCF) Line of Business (LOB) Adapter SDK (WCF LOB Adapter SDK) Service Pack 1 (SP1). You can download the WCF LOB Adapter SDK SP1 from http://go.microsoft.com/fwlink/?LinkID=106906.

    Important

    You must also install a BizTalk add-in (Consume Adapter Service BizTalk Project Add-in) for Visual Studio 2005 that is shipped with the WCF LOB Adapter SDK SP1. To install this add-in, you must perform a Custom or Complete installation of the WCF LOB Adapter SDK SP1. Under the Custom option, select BizTalk Server Addin. Also, to install the add-in you must have installed Visual Studio 2005 before installing the WCF LOB Adapter SDK SP1.

  • Respective enterprise application clients and associated software. See Supported Enterprise Application Versions for the enterprise application client versions and other supporting DLLs that you must install for each adapter.

  • Microsoft BizTalk Server 2006 R2.

    Important

    Make sure you install BizTalk Server 2006 R2 RTM (version 3.6.1404.0). The WCF LOB Adapter SDK SP1 installation checks for this version when you try to install a BizTalk add-in (Consume Adapter Service BizTalk Project Add-in).

    Important
    • For certain scenarios where you use a template message with string encoding on WCF-Custom send port, you must also install the hotfix for BizTalk Server 2006 R2 available at http://go.microsoft.com/fwlink/?LinkID=106011. The same hotfix can be used both for 32-bit and 64-bit versions of BizTalk Server 2006 R2.

Software Prerequisites When Using the Adapters with ADO

The Microsoft BizTalk Adapter 3.0 for mySAP Business Suite and Microsoft BizTalk Adapter 3.0 for Siebel eBusiness Applications also include an ADO layer (Data Provider for SAP and Data Provider for Siebel), which you can use to write an ADO.NET client to connect to an SAP system or Siebel system, respectively. You can also use the ADO layer with SQL Server Integration Services (SSIS) to import and export data from the LOB application.

Ensure that the following software is installed on the computer where you will be using the BizTalk Adapter Pack with an ADO interface.

  • Microsoft .NET Framework 3.0.

  • Microsoft Visual Studio 2005.

  • The Microsoft Windows Communication Foundation (WCF) Line of Business (LOB) Adapter SDK (WCF LOB Adapter SDK) Service Pack 1 (SP1). You can download the WCF LOB Adapter SDK SP1 from http://go.microsoft.com/fwlink/?LinkID=106906.

  • Respective enterprise application clients and associated software. See Supported Enterprise Application Versions for the enterprise application client versions and other supporting DLLs that you must install for each adapter.

  • To use the Data Providers with SSIS, you must install SQL Server 2005 Service Pack 2.

Software Prerequisites When Using the Adapters with Microsoft Office SharePoint Server

The goal of using the adapters with Microsoft Office SharePoint Server is to present data from an LOB application on a SharePoint portal. To achieve this, a typical setup with the BizTalk Adapter Pack and Microsoft Office SharePoint Server involves the following:

  • A computer where you run the WCF Adapter Service Development Wizard.

  • A computer where you host the WCF service.

  • A computer where you use the Business Data Catalog Definition Editor to create an application definition XML file.

  • A computer where you use Microsoft Office SharePoint Server to present the information from an LOB application.

You may choose to have a single computer that can be used to do all the preceding tasks. However, if you choose to use different computers for different tasks, the following table summarizes the software prerequisites for each computer. If you are using a single computer, all the software must be present on that computer.

Where the WCF Adapter Service Development Wizard is usedWhere the WCF service is hostedWhere the Business Data Catalog Definition Editor is usedWhere Microsoft Office SharePoint Server is used
  • Microsoft .NET Framework 3.0

  • Microsoft Visual Studio 2005 Service Pack 1.

  • The WCF LOB Adapter SDK SP1. You can download the WCF LOB Adapter SDK SP1 from http://go.microsoft.com/fwlink/?LinkID=106906. This will install the Visual Studio template for the WCF Adapter Service Development Wizard.

  • BizTalk Adapter Pack.

  • Respective enterprise application clients and associated software. See Supported Enterprise Application Versions for the enterprise application client versions and other supporting DLLs that you must install for each adapter.

  • Microsoft .NET Framework 3.0

  • The WCF LOB Adapter SDK SP1. You can download the WCF LOB Adapter SDK SP1 from http://go.microsoft.com/fwlink/?LinkID=106906.

  • BizTalk Adapter Pack.

  • Respective enterprise application clients and associated software. See Supported Enterprise Application Versions for the enterprise application client versions and other supporting DLLs that you must install for each adapter.

  • Internet Information Services (IIS):

    • For the SAP adapter: IIS 6.0 or IIS 7.0 on 32-bit and 64-bit computers.

    • For the Siebel adapter: IIS 6.0 on 32-bit computer.

Top of page

Supported Enterprise Application Versions

The following section presents the server and client versions for the enterprise applications with which BizTalk Adapter Pack can be used. This section also provides information about the other client DLLs required for the BizTalk Adapter Pack.

For the Oracle Database Adapter

  • Supported server versions: Oracle 9.2.0.2, Oracle 10.1.0.2.0, Oracle 10.2.0.1.0

  • Supported client versions:

    For 32-bit

    For a 32-bit Oracle client you need:

    • Oracle client version 10.2.0.3.

    • Oracle Data Provider for .NET 2.0, 10.2.0.2.20. This is available as part of Oracle Data Access Components (ODAC) 10.2.0.2.21.

    You must install the client in the following order:

    • Install the Oracle client 10.2.0.3.

    • Install ODAC in the same destination folder as the Oracle client.

    For 64-bit

    For a 64-bit Oracle client you need:

    • Oracle client version 10.2.0.3. This is available as part of the following patches:

      • 10.2.0.3.0 (patch number 5337014)

      • 10.2.0.3 patch 10 (patch number 6344569 )

    • Oracle Data Provider for .NET 2.0, 10.2.0.3.02. This is available as part of Oracle Data Access Components (ODAC) 10.2.0.3 for Windows x64.

    You must install the client in the following order:

    • Install ODAC.

    • Install Oracle client patch 5337014 in the same destination folder as ODAC.

    • Install Oracle client patch 6344569 in the same destination folder as ODAC.

  • Supported client platforms: Windows XP SP2, Windows Server 2003 SP1, Windows Server 2003 SP2, Windows Server 2003 R2, Windows Vista (32-bit).

  • Required drivers:

    • For 32-bit: Oracle.DataAccess.dll version 2.102.2.20

    • For 64-bit: Oracle.DataAccess.dll version 2.102.3.2

      You must manually add the Oracle.DataAccess.dll to the global assembly cache (GAC). This DLL will be installed on your computer, typically at <installation drive>:\oracle\product\10.2.0\client_1\odp.net\bin\2.x.

For the SAP Adapter

  • Supported server versions: SAP R/3 4.6c Non-Unicode, SAP R/3 4.7 Non-Unicode, SAP R/3 4.7 Unicode, SAP ECC 5.0 Non-Unicode, SAP ECC 5.0 Unicode, SAP ECC 6.0 Non-Unicode, SAP ECC 6.0 Unicode.

  • Supported client versions: SAP RFC SDK 6.4 UNICODE, SAP RFC SDK 7.0 UNICODE, SAP RFC SDK 7.1 UNICODE.

    Note

    The SAP adapter requires Unicode version of the RFC SDK irrespective of whether the SAP Server is Unicode or non-Unicode.

  • Supported client platforms: Windows XP SP2, Windows Server 2003 SP1, Windows Server 2003 SP2, Windows Server 2003 R2, Windows Vista.

  • Required drivers: The following table lists the DLLs required by the BizTalk Adapter Pack to interface with the SAP system. Most of the packages that contain these DLLs must be downloaded from the SAP Service Marketplace.

    To obtain downloads from the SAP Service Marketplace, you must first:

    • Install the Download Manager available from the SAP Service Marketplace.

    • Configure the Download Manager by using your credentials for the SAP Service Marketplace.

    • Be authorized by the SAP administrator in your organization to download software from the SAP service Web site. This is required because access to the SAP Software Distribution Center is restricted by a 'Download Software' authorization object. This ensures that software is downloaded only by authorized users.

    • Install the program, SAPCAR, required to extract the files from the packages that you download from the SAP Service Marketplace. The SAPCAR is also available from the SAP Service Marketplace.

    For the 32-bit and 64-bit version of the BizTalk Adapter Pack, you must have the respective 32-bit and 64-bit versions of these DLLs.

    • On a 32-bit computer, the 32-bit version of the DLLs must be added to the C:\Windows\System32 folder.

    • On a 64-bit computer, the 32-bit version of the DLLs must be added to the C:\Windows\SysWow64 folder. The 64-bit version of the DLLs must be added to the C:\Windows\System32 folder.

    SAP client versionRequired drivers

    6.4

    • SAP RFC SDK 6.40 UNICODE. This is available as part of SNOTE* 27517. The instructions to download the SDK are available at http://go.microsoft.com/fwlink/?LinkID=94691. After you have downloaded and extracted the SDK, copy all the DLLs from the \rfcsdk\bin and \rfcsdk\lib folders and copy them to the relevant location mentioned just preceding this table.

    • DLLs available from SAP as part of R3DLLINST.zip. This contains Microsoft run-time DLLs and can be downloaded from the SAP site. See SNOTE* 684106 for more information. You can download the .zip file from http://go.microsoft.com/fwlink/?LinkID=94693. This link has an “Attachments” option from where you can download the package.

    • If you will be using SAP Secure Network Communications (SNC) to connect to an SAP system, you must also have the relevant DLLs from SAP. These DLLs are different for 32-bit and 64-bit platforms and are available with SNOTE* 352295. You can download the DLLs from http://go.microsoft.com/fwlink/?LinkID=104032. This link has an “Attachments” option from where you can download the package. The names of the DLLs are:

      • For 32-bit: gsskrb5.dll, gssntlm.dll

      • For 64-bit x86: gx64krb5.dll, gx64ntlm.dll

    7.0

    • SAP RFC SDK 7.00 UNICODE. This is available as part of SNOTE* 27517. The instructions to download the SDK are available at http://go.microsoft.com/fwlink/?LinkID=94691. After you have downloaded and extracted the SDK, copy all the DLLs from the \rfcsdk\bin and \rfcsdk\lib folders and copy them to the relevant location mentioned just preceding this table.

    • DLLs available from SAP as part of R3DLLINST.zip. This contains Microsoft run-time DLLs and can be downloaded from the SAP site. See SNOTE* 684106 for more information. You can download the .zip file from http://go.microsoft.com/fwlink/?LinkID=94693. This link has an “Attachments” option from where you can download the package.

    • If you will be using SAP Secure Network Communications (SNC) to connect to an SAP system, you must also have the relevant DLLs from SAP. These DLLs are different for 32-bit and 64-bit platforms and are available with SNOTE* 352295. You can download the DLLs from http://go.microsoft.com/fwlink/?LinkID=104032. This link has an “Attachments” option from where you can download the package. The names of the DLLs are:

      • For 32-bit: gsskrb5.dll, gssntlm.dll

      • For 64-bit x86: gx64krb5.dll, gx64ntlm.dll

    7.1

    • SAP RFC SDK 7.10 UNICODE. This is available as part of SNOTE* 27517. The instructions to download the SDK are available at http://go.microsoft.com/fwlink/?LinkID=94691. After you have downloaded and extracted the SDK, copy all the DLLs from the \rfcsdk\bin and \rfcsdk\lib folders and copy them to the relevant location mentioned just preceding this table.

    • DLLs available from SAP as part of R3DLLINST.zip. This contains Microsoft run-time DLLs and can be downloaded from the SAP site. See SNOTE* 684106 for more information. You can download the .zip file from http://go.microsoft.com/fwlink/?LinkID=94693. This link has an “Attachments” option from where you can download the package.

    • Microsoft Visual C++ run-time DLLs required for SAP 7.1 client. These are available from the following links:

    • If you will be using SAP Secure Network Communications (SNC) to connect to an SAP system, you must also have the relevant DLLs from SAP. These DLLs are different for 32-bit and 64-bit platforms and are available with SNOTE* 352295. You can download the DLLs from http://go.microsoft.com/fwlink/?LinkID=104032. This link has an “Attachments” option from where you can download the package. The names of the DLLs are:

      • For 32-bit: gsskrb5.dll, gssntlm.dll

      • For 64-bit x86: gx64krb5.dll, gx64ntlm.dll

    * SNOTEs are release notes that accompany fixes released by SAP.

For the Siebel Adapter

  • Supported server versions: Siebel 7.5 (7.5.3.15[16279] with FP[QF0F65]), Siebel 7.7 (7.7.2.8[18379]), Siebel 7.8 (7.8.2.6 [19230]), Siebel 8.0 (8.0.0.1 [20408])

  • Supported client versions: Siebel Web Client 7.5, Siebel Web Client 7.7, Siebel Web Client 7.8, Siebel Web Client 8.0

  • Supported client platforms: Windows XP SP2, Windows Server 2003 SP1, Windows Server 2003 SP2, Windows Server 2003 R2

Top of page

Compatibility Matrix Between 32 and 64-bit Versions of the Adapter, BizTalk Server, and Operating System

The following table presents a compatibility matrix between the 32-bit and 64-bit versions of the operating system, adapter, and BizTalk Server 2006 R2.

Oracle Adapter + BizTalk ServerSAP Adapter + BizTalk ServerSiebel Adapter + BizTalk Server

Operating System

32-bit

64-bit

32-bit64-bit

Yes

N/A

Yes

Yes

32-bit64-bit

Yes

N/A

Yes

Yes

32-bit64-bit

Yes

N/A

No

No

Legend

  • Yes = Supported.

  • No = Not supported.

  • N/A = Not Applicable.

For more information about the supported scenarios for installing the BizTalk Adapter Pack on 32-bit and 64-bit platforms, see Scenarios for Installing the BizTalk Adapter Pack on 32-bit and 64-bit Platforms.

Top of page

Preparing Your Enterprise Applications to Work with the Adapters

This section provides a checklist of items to make sure your enterprise application clients are properly set up to work with the adapters. The items listed in the checklist are not dependent on the BizTalk Adapter Pack installation. You can install the BizTalk Adapter Pack and then perform the steps in the checklist, or vice-versa.

Preparing the Oracle Client

Perform the following tasks on the computer that has the Oracle client and Oracle Database adapter installed:

  • Make sure you have the required version of Oracle Data Access Components (ODAC) installed. As part of the ODAC installation, make sure you install the Oracle client and the right version of ODP.NET. For the list of supported versions, see Supported Enterprise Application Versions.

    Note

    To make sure your application works with the most recent version of ODP.NET, you must have the "policy DLLs" installed on the computer and registered in the GAC. For more information, see "Oracle Data Provider for .NET FAQ" at http://go.microsoft.com/fwlink/?LinkID=92834.

  • Make sure you added the Oracle.DataAccess.dll (for 32-bit or 64-bit) to the GAC. See Supported Enterprise Application Versions.

  • Make sure that the net service name that you specify to connect to the Oracle database is properly configured in tnsnames.ora. You can configure a net service name by using the Net Configuration Assistant. For instructions on using the Net Configuration Assistant, see the "Configuring the Oracle Client" topic in the Oracle Database adapter documentation. The document is installed typically at <installation drive>:\Program Files\Microsoft BizTalk Adapter Pack\Documents.

Preparing the SAP Client

Perform the following tasks on the computer that has the SAP client and SAP adapter installed:

Preparing the Siebel Client

In terms of your Siebel client and server setup, make sure that:

  • The Siebel Web client is installed on the computer where you have the BizTalk Adapter Pack installed.

  • The configuration file (.cfg) for your Siebel application includes the name of the database DLL that you will be using with Siebel. By default, the configuration file includes the name of the IBM DB2 database DLL.

  • The user name with which you will be connecting to the Siebel system exists in the backend database and has required privileges to perform operations on the Siebel system.

Top of page

Installing the BizTalk Adapter Pack

Make sure you have the prerequisites installed before installing the BizTalk Adapter Pack. See Software Prerequisites. You can install the BizTalk Adapter Pack in the following two ways:

  • In interactive mode: By running Setup from the GUI

  • In silent mode: By using the command line

    Important

    You must have administrative privileges on the computer where you will install the BizTalk Adapter Pack, irrespective of whether you are installing by using the GUI or the command line.

Types of Installation

This section lists the types of BizTalk Adapter Pack installations and the features that install according to the particular type of installation you choose when running Setup.

Setup allows you to choose from the following types of installation:

  • The Typical and Complete options will install all the adapters, with the associated data providers. You do not have the option of choosing a particular adapter to install.

  • The Custom option installs one or more adapters, with the associated data providers. You can choose the adapters that you want to install. If you choose to install a data provider, you must install the corresponding adapter as well. However, you can install an adapter without installing the corresponding data provider. You do this by expanding the ADO Providers node, and then selecting the providers that you do not want to install. See Installing the BizTalk Adapter Pack in Interactive Mode.

    For example, if you choose to install the Data Provider for SAP, you must also install the SAP adapter. However, you can install the SAP adapter without installing the Data Provider for SAP.

Scenarios for Installing the BizTalk Adapter Pack on 32-bit and 64-bit Platforms

With BizTalk Server 2006 R2, the BizTalk Adapter Pack can be used for:

  • Visual Studio design time (when generating metadata for operations on LOB applications).

  • BizTalk Server Administration console design time (for creating physical ports).

    Note

    BizTalk Server Administration console runs as a 32-bit Microsoft Management Console (MMC) application.

  • BizTalk run time (when sending and receiving messages from LOB applications).

You can have an installation setup where you perform all these tasks on the same computer or different computers. Because both Visual Studio and BizTalk MMC are 32-bit processes, you must install the 32-bit BizTalk Adapter Pack on the computer where you want to perform the design-time tasks. Here are the supported scenarios for installing the BizTalk Adapter Pack on 32-bit and 64-bit platforms.

Scenarios for Installing the BizTalk Adapter Pack on a 32-bit Platform

The following are the supported scenarios for installing the BizTalk Adapter Pack on a 32-bit platform.

For Visual Studio design timeFor BizTalk MMC design timeFor BizTalk run timeFor Visual Studio design time and/or BizTalk MMC design time + BizTalk run time
  • Install 32-bit WCF LOB Adapter SDK.

  • Install 32-bit BizTalk Adapter Pack.

  • Install 32-bit LOB client and other required DLLs.

  • Install 32-bit WCF LOB Adapter SDK.

  • Install 32-bit BizTalk Adapter Pack.

  • Install 32-bit LOB client and other required DLLs.

  • Install 32-bit WCF LOB Adapter SDK.

  • Install 32-bit BizTalk Adapter Pack.

  • Install 32-bit LOB client and other required DLLs.

  • Install 32-bit WCF LOB Adapter SDK.

  • Install 32-bit BizTalk Adapter Pack.

  • Install 32-bit LOB client and other required DLLs.

Scenarios for Installing the BizTalk Adapter Pack on a 64-bit Platform

The following are the supported scenarios for installing the BizTalk Adapter Pack on a 64-bit platform.

For Visual Studio design timeFor BizTalk MMC design timeFor BizTalk run timeFor Visual Studio design time and/or BizTalk MMC design time + BizTalk run time
  • Install 64-bit WCF LOB Adapter SDK.

  • Install 32-bit BizTalk Adapter Pack.

  • Install 32-bit LOB client and other required DLLs.

  • Install 64-bit WCF LOB Adapter SDK.

  • Install 32-bit BizTalk Adapter Pack.

  • Install 32-bit LOB client and other required DLLs.

For a 32-bit BizTalk process:

  • Install 64-bit WCF LOB Adapter SDK.

  • Install 32-bit BizTalk Adapter Pack.

  • Install 32-bit LOB client and other required DLLs.

For a 64-bit BizTalk process:

  • Install 64-bit WCF LOB Adapter SDK.

  • Install 64-bit BizTalk Adapter Pack.

  • Install 64-bit LOB client and other required DLLs.

For a 32-bit BizTalk process:

  • Install 64-bit WCF LOB Adapter SDK.

  • Install 32-bit BizTalk Adapter Pack.

  • Install 32-bit LOB client and other required DLLs.

For a 64-bit BizTalk process:

  • Install 64-bit WCF LOB Adapter SDK.

  • Install 64-bit BizTalk Adapter Pack.

  • Install 64-bit LOB client and other required DLLs.

  • Install 32-bit BizTalk Adapter Pack.

  • Install 32-bit LOB client and other required DLLs.

Note

On any computer where you want to perform design-time tasks, using either Visual Studio or BizTalk MMC, you must install the 32-bit BizTalk Adapter Pack.

Installing the BizTalk Adapter Pack in Interactive Mode

Perform the following steps to install the BizTalk Adapter Pack using the Setup.

To install the BizTalk Adapter Pack in interactive mode

  1. Insert the Microsoft BizTalk Adapter Pack installation disk into the CD-ROM drive.

  2. Double-click AdaptersSetup.msi located in the root of the installation CD.

  3. Read the information on the Welcome screen, and then click Next.

  4. Read and accept the end-user license agreement (EULA), and then click Next.

  5. In the Choose Setup Type dialog box:

    • To install the most common features, click Typical.

    • To select the adapters you want to install, click Custom, and then proceed to the next step.

    • To install all the features, click Complete.

      Important

      To install only the adapter that you will use to interface with your enterprise application, you should perform a Custom installation.

      Note

      For this release, Typical and Complete options essentially perform the same action.

  6. Perform this step if you chose to do a Custom installation in the previous step. If you chose to perform a Typical or Complete installation, skip this step and proceed to the next step.

    1. In the Custom Setup dialog box, expand the Base Adapters node to see the list adapters available with the BizTalk Adapter Pack version.

    2. For the adapters that you do not want to install, click the icon next to the adapter name, and then select Entire feature will be unavailable.

    3. Similarly, expand the ADO Providers node, and then select the providers that you do not want to install.

    4. Click Next.

  7. Click Install.

  8. Click Finish.

Installing the BizTalk Adapter Pack in Silent Mode

Use the msiexec command to perform a silent installation of the BizTalk Adapter Pack. As part of the msiexec command, you must specify the individual components that you want to install. The following table lists the values for each component in the BizTalk Adapter Pack. Provide these values to install (or remove) specific components. To install (or remove) more than one component, you can provide a combination of these values separated by a comma.

Component nameCorresponding value for command-line properties

Oracle Database adapter

DbFeature

SAP adapter

SapBaseAdapterFeature

Siebel adapter

SiebelBaseAdapterFeature

Data Provider for SAP

SapAdoFeature

Note

You must provide this value only if you are installing the SAP adapter also.

Data Provider for Siebel

SiebelAdoFeature

Note

You must provide this value only if you are installing the Siebel adapter also.

All components

ALL

Important

The feature names are case-sensitive.

The following procedure demonstrates how to perform a silent installation of BizTalk Adapter Pack for different components.

To install the BizTalk Adapter Pack in silent mode

  1. Insert the Microsoft BizTalk Adapter Pack installation disk into the CD-ROM drive.

  2. Open a command prompt, and navigate to the root of the installation CD.

  3. Run the following commands based on what you want to install:

    • To perform a complete installation, which installs all the adapters including the .NET Framework Data Providers, type:

      msiexec /i AdaptersSetup.msi /qn ADDLOCAL=ALL
    • To install only the Oracle Database adapter, type:

      msiexec /i AdaptersSetup.msi /qn ADDLOCAL=DbFeature
    • To install only the SAP adapter, type:

      msiexec /i AdaptersSetup.msi /qn ADDLOCAL=SapBaseAdapterFeature
    • To install the SAP adapter along with Data Provider for SAP, type:

      msiexec /i AdaptersSetup.msi /qn ADDLOCAL=SapBaseAdapterFeature,SapAdoFeature
    • To install only the Siebel adapter, type:

      msiexec /i AdaptersSetup.msi /qn ADDLOCAL=SiebelBaseAdapterFeature
    • To install the Siebel adapter along with Data Provider for Siebel, type:

      msiexec /i AdaptersSetup.msi /qn ADDLOCAL=SiebelBaseAdapterFeature,SiebelAdoFeature
    • To install all three base adapters, type:

      msiexec /i AdaptersSetup.msi /qn ADDLOCAL=SapBaseAdapterFeature,SiebelBaseAdapterFeature,DbFeature
    • To install the two .NET Framework Data Providers, type:

      msiexec /i AdaptersSetup.msi /qn ADDLOCAL=SapAdoFeature,SiebelAdoFeature

    You can perform any type of Custom installation by separating the components by a comma. For example, to install the SAP adapter with the Data Provider for SAP, and the Siebel adapter type:

    msiexec /i AdaptersSetup.msi /qn ADDLOCAL=SapBaseAdapterFeature,SapAdoFeature,SiebelBaseAdapterFeature

    For more information about the msiexec command, see http://go.microsoft.com/fwlink/?LinkID=103199.

After Installing the BizTalk Adapter Pack

You might need to perform the following tasks after installing the BizTalk Adapter Pack, based on what operations you want to perform using the adapter:

  • Invoking transactional RFCs (tRFCs) in an SAP system. If you want to invoke tRFCs in an SAP system, you must run the SQL script, SapAdapter-DbScript-Install.sql. This script is installed as part of the BizTalk Adapter Pack installation.

  • Manually registering the bindings. Register the adapter bindings and the .NET Framework Data Providers if the setup wizard failed to do so.

  • Using the Data Provider for SAP. You must install the custom RFCs if you chose to install the Data Provider for SAP.

Creating SQL Server Database Objects (Only for the SAP Adapter)

To invoke tRFCs in an SAP system you must run the SQL script, SapAdapter-DbScript-Install.sql. This script is installed as part of the BizTalk Adapter Pack installation and creates database objects in SQL Server. The script is typically installed at <installation drive>:\Program Files\Microsoft BizTalk Adapter Pack. You can run this script against any SQL Server database, as long as you specify that database name while using the adapter to invoke tRFCs.

Registering the Bindings

You only need to perform these steps if the setup wizard fails to register the adapter bindings or .NET Framework Data Providers in the machine.config file.

To register the adapter bindings or the .NET Framework Data Providers

  1. Navigate to the machine.config file on the computer. For example, on a 32-bit platform, the machine.config is available under <system drive>:\WINDOWS\Microsoft.NET\Framework\<version>\CONFIG.

    In the preceding path, <version> is the version of the .NET Framework. For example, for Microsoft .NET Framework 3.0, the version is v2.0.50727.

  2. Open the file using a text editor.

  3. To register the adapter bindings:

    1. Search for the element "system.serviceModel" and add the following under it:

      <client>
  <endpoint binding="sapBinding" contract="IMetadataExchange" name="sap" />
  <endpoint binding="siebelBinding" contract="IMetadataExchange" name="siebel" />
  <endpoint binding="oracleDBBinding" contract="IMetadataExchange" name="oracleDb" />
</client>
    2. Search for the element "bindingElementExtensions" under system.serviceModel\extensions.

    3. Look for the missing adapter binding. Add the following sections under the "bindingElementExtensions" node, depending on the missing adapter binding. You must register all the bindings if the setup wizard fails to register any.

      For the SAP adapter, add:

      <add name="sapAdapter" type="Microsoft.Adapters.SAP.SAPAdapterExtensionElement,Microsoft.Adapters.SAP, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
      For the Siebel adapter, add:

      <add name="siebelAdapter" type="Microsoft.Adapters.Siebel.SiebelAdapterExtensionElement,Microsoft.Adapters.Siebel, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
      For the Oracle Database adapter, add:

      <add name="oracleDBAdapter" type="Microsoft.Adapters.OracleDB.OracleDBAdapterExtensionElement,Microsoft.Adapters.OracleDB, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
    4. Search for the element "bindingExtensions" under system.serviceModel\extensions.

    5. Look for the missing adapter binding. Add the following sections under the "bindingExtensions" node, depending on the missing adapter binding. You must register all the bindings if the setup wizard fails to register any.

      For SAP adapter, add:

      <add name="sapBinding" type="Microsoft.Adapters.SAP.SAPAdapterBindingSection,Microsoft.Adapters.SAP, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
      For Siebel adapter, add:

      <add name="siebelBinding" type="Microsoft.Adapters.Siebel.SiebelAdapterBindingSection,Microsoft.Adapters.Siebel, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
      For Oracle Database adapter, add:

      <add name="oracleDBBinding" type="Microsoft.Adapters.OracleDB.OracleDBAdapterBindingSection,Microsoft.Adapters.OracleDB, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
    Note

    For information about how to determine the public key, see Determining the Public Key and Version.

  4. To register the .NET Framework Data Providers:

    1. Search for the element DbProviderFactories under the system.data node.

    2. Look for the missing .NET Framework Data Providers. Add the following sections under the DbProviderFactories node, depending on the missing provider. You must register all the providers if the setup wizard fails to register any.

      For the Data Provider for SAP, add:

      <add name="SAPClient Data Provider" invariant="Microsoft.Data.SAPClient" 
    description=".NET Framework Data Provider for mySAP Business Suite"    type="Microsoft.Data.SAPClient.SAPClientFactory,Microsoft.Data.SAPClient, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
      For the Data Provider for Siebel, add:

      <add name="SiebelClient Data Provider" invariant="Microsoft.Data.SiebelClient"
    description=".NET Framework Data Provider for Siebel eBusiness Applications"
    type="Microsoft.Data.SiebelClient.SiebelProviderFactory,Microsoft.Data.SiebelClient, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />

  5. Save and close the machine.config file.

Determining the Public Key and Version

Perform the following steps to determine the public key and version for an adapter or .NET Framework Data Provider.

To determine the public key

  1. Navigate to the Windows directory, typically C:\WINDOWS\assembly.

  2. Right-click the DLL for which you want the public key, and then select Properties. The following table lists the name of the DLLs for each adapter and provider.

    Adapter/.NET Framework Data ProviderName of the DLL

    SAP adapter

    Microsoft.Adapters.SAP

    Siebel adapter

    Microsoft.Adapters.Siebel

    Oracle Database adapter

    Microsoft.Adapters.OracleDB

    Data Provider for SAP

    Microsoft.Data.SAPClient

    Data Provider for Siebel

    Microsoft.Data.SiebelClient

  3. On the General tab, the value against the Public Key Token label specifies the public key for the DLL. Similarly, the value against the Version label specifies the version number for the DLL.

  4. Copy the public key, and then click Cancel.

Installing the Custom RFCs

You only need to perform this task if you want to use the Data Provider for SAP. For instructions on installing custom RFCs, see the "Installing Custom RFCs for the Data Provider for SAP" topic in the SAP adapter documentation. The document is installed typically at <installation drive>:\Program Files\Microsoft BizTalk Adapter Pack\Documents.

Important

If you are using an earlier version of the custom RFCs provided with the BizTalk Adapter Pack (shipped with Beta2 or CTP releases), you must upgrade them to the RFCs provided with this release. You must do so by removing the earlier RFCs and instead installing the RFCs shipped with this release.

Top of page

Hotfixes Released Since the Release of the BizTalk Adapter Pack

The following table provides a list of hotfixes that were released since the release of the BizTalk Adapter Pack.

HotfixApplicable ForDownload Location

HOTFIX: “The Oracle Database adapter fails and an Error event is logged in the Application log when you run a stored procedure in BizTalk Server 2006 R2”

Oracle Database adapter

http://go.microsoft.com/fwlink/?LinkID=125090

HOTFIX: “The receive location loses its connection when you use a WCF-based SAP adapter in BizTalk Server 2006 R2”

SAP adapter

http://go.microsoft.com/fwlink/?LinkID=125612

HOTFIX: “SAP adapter handling of "empty" DATS and TIMS values (eg. "00000000")”

SAP adapter

http://go.microsoft.com/fwlink/?LinkID=128336

HOTFIX: “The .NET Framework Data Provider for mySAP Business Suite returns an error in the Report Project wizard”

SAP adapter

http://go.microsoft.com/fwlink/?LinkID=128337

HOTFIX: “The WCF-based SAP adapter from BizTalk Server 2006 Adapter Pack v1.0 does not support the SAP TABLE type”

SAP adapter

http://go.microsoft.com/fwlink/?LinkID=128338

Top of page

Installing the Enterprise Applications

For instructions on installing the enterprise applications, see the respective installation guides for enterprise applications. See the user documentation for each adapter for information about specific configuration changes, if any, required to be performed for each enterprise applications. The user documents for the adapters are installed along with the adapters, typically at <installation drive>:\Program Files\Microsoft BizTalk Adapter Pack\Documents.

Top of page

Installation and Post-Installation Checklist

Perform the following tasks related to installation and post-installation of the BizTalk Adapter Pack:

Top of page

Modifying the BizTalk Adapter Pack Installation

Perform the following steps to modify the BizTalk Adapter Pack installation. Make sure you have the WCF LOB Adapter SDK installed before you run the setup wizard to modify the BizTalk Adapter Pack installation.

You can modify the BizTalk Adapter Pack installation in the following two ways:

  • In interactive mode: By running the Setup

  • In silent mode: By using the command line

To modify the BizTalk Adapter Pack installation in interactive mode

  1. Click Start > All Programs > Control Panel.

  2. In Control Panel, click Add or Remove Programs.

  3. In the Add or Remove Programs window, highlight Microsoft BizTalk Adapter Pack, and then click Change.

  4. Read the information on the Welcome screen, and then click Next.

  5. In the Change, repair, or remove installation dialog box:

    • To select the components you want to install, click Change.

    • To repair errors in the most recent installation, click Repair.

    • To remove Microsoft BizTalk Adapter Pack from the computer, click Remove.

  6. If you chose to modify the installation:

    • Expand the Microsoft BizTalk Adapter Pack node to specify whether you want to install the base adapters or the .NET Framework Data Providers, or both.

    • Expand the Base Adapters node to specify whether you want to install all the adapters or specific adapters.

    • Expand the ADO Providers node to specify whether you want to install all the providers or specific providers.

    • Click Next.

    • Click Change, and then click Finish.

  7. If you chose to repair the installation, in the Ready to repair Microsoft BizTalk Adapter Pack dialog box, click Repair, and then click Finish.

  8. If you chose to remove the adapters, in the Ready to remove Microsoft BizTalk Adapter Pack dialog box, click Remove, and then click Finish.

To modify the BizTalk Adapter Pack installation in silent mode

  1. Open a command prompt, and navigate to the root directory of the BizTalk Adapter Pack installer.

  2. Run a command similar to the following:

    msiexec /i AdaptersSetup.msi /qn REMOVE=DbFeature ADDLOCAL=SapBaseAdapterFeature

    This command removes the Oracle Database adapter and installs the SAP adapter.

    By using different values for the REMOVE and ADDLOCAL properties, you can add or remove specific components. Refer to the table under the Installing the BizTalk Adapter Pack in Silent Mode section for information about the values that you can specify for the ADDLOCAL and REMOVE properties.

    For more information about the msiexec command, see http://go.microsoft.com/fwlink/?LinkID=103199.

Top of page

Removing the BizTalk Adapter Pack

If you created tables in the SQL Server database to work with the tRFC feature of the SAP adapter, you must manually remove them before removing the BizTalk Adapter Pack. The BizTalk Adapter Pack installation copies a SapAdapter-DbScript-Uninstall.sql file typically at <installation drive>:\Program Files\Microsoft BizTalk Adapter Pack. You must run this file to remove the tables you created.

Perform the following steps to remove the BizTalk Adapter Pack from your computer. Make sure you have the WCF LOB Adapter SDK SP1 installed before you run the setup wizard to remove the adapters.

You can remove the BizTalk Adapter Pack in the following two ways:

  • In interactive mode: By running the Setup

  • In silent mode: By using the command line

To remove the BizTalk Adapter Pack in interactive mode

  1. Click Start > All Programs > Control Panel.

  2. In Control Panel, click Add or Remove Programs.

  3. In the Add or Remove Programs window, highlight Microsoft BizTalk Adapter Pack, and then click Remove.

  4. In the dialog box, click Yes.

To remove the BizTalk Adapter Pack in silent mode

  1. Open a command prompt, and navigate to the root directory of the BizTalk Adapter Pack installer.

  2. Run a command similar to the following:

    msiexec /i AdaptersSetup.msi /qn REMOVE=DbFeature

    This command removes the Oracle Database adapter from the BizTalk Adapter Pack installation.

    By providing different values for the REMOVE property, you can remove specific components from the BizTalk Adapter Pack installation. Refer to the table in the Installing the BizTalk Adapter Pack in Silent Mode section for information about the values that you can specify for the REMOVE property.

    To completely remove the BizTalk Adapter Pack, execute the following command:

    msiexec /x AdaptersSetup.msi /qn

    For more information about the msiexec command, see http://go.microsoft.com/fwlink/?LinkID=103199.

After Removing the BizTalk Adapter Pack

Perform the following steps after removing the BizTalk Adapter Pack:

  • Remove the adapter bindings or the .NET Framework Data Provider registration, if the setup wizard failed to do so.

  • Remove the custom RFCs, if you chose to install the Data Provider for SAP.

Removing the Bindings or the .NET Framework Data Provider registration

Perform these steps only if the setup wizard fails to remove the adapter bindings or .NET Framework Data Provider registration from the machine.config file.

To remove the adapter bindings or .NET Framework Data Provider registration

  1. Navigate to the machine.config file on the computer. For example, on a 32-bit platform, the machine.config is available under <system drive>:\WINDOWS\Microsoft.NET\Framework\<version>\CONFIG.

    In this path, <version> is the version of the .NET Framework. For example, for Microsoft .NET Framework 3.0, the version will be v2.0.50727.

  2. Open the file using a text editor.

  3. To remove the adapter binding registration:

    1. Search for the element "system.serviceModel" and remove the following from under the element:

      <client>
  <endpoint binding="sapBinding" contract="IMetadataExchange" name="sap" />
  <endpoint binding="siebelBinding" contract="IMetadataExchange" name="siebel" />
  <endpoint binding="oracleDBBinding" contract="IMetadataExchange" name="oracleDb" />
</client>
    2. Search for the element "bindingElementExtensions" under system.serviceModel\extensions.

    3. Remove the following sections under the "bindingElementExtensions" node, depending on the available adapter binding. You must remove all the bindings if the setup wizard fails to remove any.

      For SAP adapter, remove:

      <add name="sapAdapter" type="Microsoft.Adapters.SAP.SAPAdapterExtensionElement,Microsoft.Adapters.SAP, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
      For Siebel adapter, remove:

      <add name="siebelAdapter" type="Microsoft.Adapters.Siebel.SiebelAdapterExtensionElement,Microsoft.Adapters.Siebel, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
      For Oracle Database adapter, remove:

      <add name="oracleDBAdapter" type="Microsoft.Adapters.OracleDB.OracleDBAdapterExtensionElement,Microsoft.Adapters.OracleDB, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
    4. Search for the element "bindingExtensions" under system.serviceModel\extensions.

    5. Remove the following sections under the "bindingExtensions" node, depending on the available adapter binding. You must remove all the bindings if the setup wizard fails to remove any.

      For SAP adapter, remove:

      <add name="sapBinding" type="Microsoft.Adapters.SAP.SAPAdapterBindingSection,Microsoft.Adapters.SAP, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
      For Siebel adapter, remove:

      <add name="siebelBinding" type="Microsoft.Adapters.Siebel.SiebelAdapterBindingSection,Microsoft.Adapters.Siebel, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
      For Oracle Database adapter, remove:

      <add name="oracleDBBinding" type="Microsoft.Adapters.OracleDB.OracleDBAdapterBindingSection,Microsoft.Adapters.OracleDB, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />

  4. To remove the .NET Framework Data Provider registration:

    • Search for the element "DbProviderFactories" under the system.data node.

    • Look for the .NET Framework Data Providers that are still registered. Remove the following sections under the DbProviderFactories node, depending on the existing .NET Framework Data Providers. You must remove all the providers if they exist.

      For Data Provider for SAP, remove:

      <add name="SAPClient Data Provider" invariant="Microsoft.Data.SAPClient" 
    description=".NET Framework Data Provider for mySAP Business Suite"    type="Microsoft.Data.SAPClient.SAPClientFactory,Microsoft.Data.SAPClient, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
      For Data Provider for Siebel, remove:

      <add name="SiebelClient Data Provider" invariant="Microsoft.Data.SiebelClient"
    description=".NET Framework Data Provider for Siebel eBusiness Applications"
    type="Microsoft.Data.SiebelClient.SiebelProviderFactory,Microsoft.Data.SiebelClient, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />

  5. Save and close the machine.config file.

Removing the Custom RFCs

You must perform this step to remove the custom RFCs that you installed in the SAP system. For instructions on removing the custom RFC, see the "Installing Custom RFCs for the Data Provider for SAP" topic in the SAP adapter documentation. The document is installed along with the adapters, typically at <installation drive>: \Program Files\Microsoft BizTalk Adapter Pack\Documents.

Top of page

Upgrading from Previous Releases of the BizTalk Adapter Pack

The BizTalk Adapter Pack does not support upgrades from previous releases such as Beta 2, CTP, or other releases. An upgrade involves manually removing the BizTalk Adapter Pack and then installing the latest version. Make sure you remove and install the components in the right order:

  1. Remove the installed version of the BizTalk Adapter Pack.

  2. Remove the installed version of the WCF LOB Adapter SDK.

  3. Install the latest version of the WCF LOB Adapter SDK.

  4. Install the latest version of the BizTalk Adapter Pack.

    Note

    You do not need to back up any files or projects that you created using the previous version of the BizTalk Adapter Pack.

Top of page

Samples for the BizTalk Adapter Pack

This BizTalk Adapter Pack release provides samples demonstrating how to use the adapters with:

  • BizTalk Server.

  • The Windows Communication Foundation (WCF) channel model.

  • The WCF service model.

  • The Data Provider for SAP, in the case of the SAP adapter.

  • The Data Provider for Siebel, in the case of the Siebel adapter.

  • Microsoft Office SharePoint Server.

In addition, migration samples are provided.

The samples are available at http://go.microsoft.com/fwlink/?LinkID=106690.

Top of page

Accessing the Adapter Pack Forum

You can use the Adapter Pack forum to discuss any issues you encounter with BizTalk Adapter Pack. The BizTalk Adapter Pack forum is available at http://go.microsoft.com/fwlink/?LinkId=87695.

Top of page

Copyright

Information in this document, including URL and other Internet Web site references, is subject to change without notice. Unless otherwise noted, the companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted in examples herein are fictitious. No association with any real company, organization, product, domain name, e-mail address, logo, person, place, or event is intended or should be inferred. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Microsoft Corporation.

Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from Microsoft, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property.

© 2009 Microsoft Corporation. All rights reserved.

Microsoft, MS-DOS, Windows, Windows Server, Windows Vista, and BizTalk are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

All other trademarks are property of their respective owners.

Top of page