About the WCF LOB Adapter SDK

System Requirements

Software Prerequisites

Installing the WCF LOB Adapter SDK

Post-Installation Instructions

Performing a Silent Installation

Copyright

Welcome to the Microsoft Windows Communication Foundation (WCF) Line of Business (LOB) Adapter SDK installation guide. This guide explains how to install and configure the WCF LOB Adapter SDK.

About the WCF LOB Adapter SDK

The WCF LOB Adapter SDK is a collection of a run-time engine and tools that help adapter developers create service-oriented interfaces to existing LOB systems by using WCF. The goal of the SDK is to facilitate uniform development of reusable, metadata-oriented, WCF-based adapters that enable enterprise applications, databases, and messaging platforms to integrate with each other.

This WCF-based SDK surfaces an adapter to an LOB system as a WCF binding. For an adapter consumer, the adapter can be accessed like a typical WCF service; the consumer does not have to learn a new programming model. The same adapter developed can be reused in multiple .NET applications including custom .NET applications, BizTalk Server 2013, Microsoft Office SharePoint Server, and Microsoft SQL Server Integration Services (SSIS) through an adapter developer–provided ADO.NET shim. In addition, the adapter provides metadata browse, search, and retrieval functionality; the adapter consumer can selectively generate WCF contracts that reflect live type modeling of the LOB system.

Top of page

System Requirements

To install the WCF LOB Adapter SDK, you need a computer that meets the following requirements:

  • Supported platforms: x86-based and x64-based

  • Supported operating systems: Windows 8, Windows Server 2012, Windows Server 2008 R2 SP1, Windows 7 SP1

  • Processor: 1.6 GHz Pentium III or greater

  • RAM: 1 gigabyte (GB) of available physical RAM (The amount of physical RAM depends on what applications are running on the client computer. You can use Task Manager to identify how much physical RAM is available on your computer.)

Top of page

Software Prerequisites

Make sure you have the following components installed on the system where you will install the WCF LOB Adapter SDK:

  • .NET Framework 4.5

  • Microsoft Visual Studio 2012

    Note

    You need this only if you want to either build custom adapters or develop solutions that use the adapters built by using the WCF LOB Adapter SDK.

  • BizTalk Server 2013

    Note

    You need this only if you want to use the adapters with BizTalk Server.

Top of page

Installing the WCF LOB Adapter SDK

After ensuring that you have the necessary software prerequisites installed, you must also do the following before installing the WCF LOB Adapter SDK:

  • Ensure that Visual Studio is not running. If it is running, close it before proceeding with the installation steps.

  • To choose the Complete setup type, ensure that BizTalk Server 2013 is installed on the computer.

To install the WCF LOB Adapter SDK
  1. From the BizTalk Server installation media, run Setup.exe.

  2. From the splash screen, click Install Microsoft BizTalk Adapters. In the next splash screen, select Install Microsoft WCF LOB Adapter SDK.

  3. On the Welcome screen, click Next.

  4. To accept the license agreement, click Next.

  5. In the Choose Setup Type dialog box, select the type of installation:

    • To install the common run time and tools, click Typical.

    • To select the features that you want to install and the installation location, select Custom and then select the features you want to install.

    • To install all the features, click Complete.

  6. Click Install.

Top of page

Post-Installation Instructions

This section provides information on how to modify or remove the WCF LOB Adapter SDK.

To modify the WCF LOB Adapter SDK
  1. Open Control Panel and then click Uninstall a program.

  2. In the list of installed programs, right-click, select Windows Communication Foundation LOB Adapter SDK, and then click Change.

  3. On the Welcome screen, click Next.

  4. In the Change, repair, or remove installation dialog box, do one of the following:

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

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

    • To remove the WCF LOB Adapter SDK from the computer, click Remove.

  5. If you choose to modify the installation:

    1. Click Next.

    2. Click Change, and then click Finish.

  6. If you choose to repair the installation, in the Ready to repair WCF LOB Adapter SDK dialog box, click Repair, and then click Finish.

  7. If you choose to remove the adapters, in the Ready to remove WCF LOB Adapter SDK dialog box, click Remove, and then click Finish.

To remove the WCF LOB Adapter SDK
  1. Open Control Panel and then click Uninstall a program.

  2. In the list of installed programs, right-click, select Windows Communication Foundation LOB Adapter SDK, and then click Uninstall.

  3. In the dialog box, click Yes.

If you have developed any custom adapters using the WCF LOB Adapter SDK, and you have registered these adapters on your computer, you must also complete the following procedure.

To remove custom adapters after uninstalling the WCF LOB Adapter SDK
  1. Remove the custom adapter from the global assembly cache (GAC).

    1. Open a Visual Studio command prompt.

    2. Remove the custom adapter .dll from the GAC using command gacutil /u.

  2. Remove the references to the custom adapter binding from machine.config

    1. Navigate to the machine.config file under <system drive>:\WINDOWS\Microsoft.NET\Framework\<version>\CONFIG.

    2. Open the file by using a text editor.

    3. Search for the element bindingExtensions, client and bindingElementExtensions under system.serviceModel\extensions.

    4. Remove the WCF binding that pertains to your custom adapter.

Top of page

Performing a Silent Installation

A silent installation is ideal for test scenarios or as part of a large-scale enterprise deployment. WCF LOB Adapter SDK provides command line parameters that you can use with AdapterFramework.msi to perform a silent installation.

To perform a silent installation
  1. On the Start menu, click Run.

    Note

    To perform silent installation, you should be an Administrator on the computer.

  2. In the Open box, type cmd, and then click OK.

  3. Type the following at the command prompt to install WCF LOB Adapter SDK silently:

    AdapterFramework.msi /quiet MUOPTIN=”Yes”

You must use the following command line options in conjunction with AdapterFramework.msi:

  • Use /quiet to install WCF LOB Adapter SDK silently.

  • Use MUOPTIN=”Yes”|”No” to indicate if the WCF LOB Adapter SDK should check for updates with Microsoft Update. When set to Yes, WCF LOB Adapter SDK will check for updates through Microsoft Update; when set to no WCF LOB Adapter SDK will not check for updates with Microsoft Update.

Note

In order to display additional options for command line installation, type AdapterFramework.msi /?at the command prompt.

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.

© 2013 Microsoft Corporation. All rights reserved.

Microsoft, MS-DOS, Visual Studio, Windows, Windows Server, Windows 7, Windows 8, 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