Introduction

There are a number of open source adapters that can aid you as BizTalk developer. These adapters are not the out of the box offered by BizTalk Server: BizTalk Server Adapter pack (that provides connectivity to SAP, Siebel, SQL and many more).

In some cases, BizTalk Server may need to transport messages to a specific custom application or use a protocol for which a native adapter does not exist. Third-party companies have written adapters to support additional protocols. You may want to determine if there is an adapter for your protocol before deciding to write a custom adapter. For a list of adapters and associated vendors see http://go.microsoft.com/fwlink/?LinkId=47140. If you are unable to locate an adapter to support your communication requirements, you can develop your own custom adapter.

Writing a custom adapter can be a challenging exercise. To simplify this process Microsoft has developed a foundation called the Adapter Framework. You can use this framework as a basis for your development along with sample adapter source code in the BizTalk Server SDK. (See more: http://msdn.microsoft.com/library/aa559841)

Through the internet, you can find numerous open source adapters created by people from BizTalk community, Microsoft, Microsoft Community Contributors (MCC) and Microsoft® Most Valuable Professionals (MVP), which can help you speed up the development process of our projects.

This article is intended to be a knowledge base of all BizTalk open sources adapters that are available.

BizTalk SFTP Adapter

This adapter was developed for a customer who needed to transfer files independent from any choice of platform. Much concern for security, along with already invested infrastructure, where the main reasons for choosing SFTP before other protocols like FTPS, and utilizes an open source library for the actual communication with the SFTP/SSH server.

Features:
  • Receive port load balancing.
  • Scheduled polling interval.
  • Notify on "Empty Batch" message - the adapter will submit an error message if the receive endpoint didn’t pick up any files. This property is disabled by default.
  • Public key authentication - (RSA, DSA).
  • SFTP connection pooling.
  • Host throttling - restrict the number of open connections to any SFTP host.

This adapter can be download from CodePlex: http://sftpadapter.codeplex.com/

BizTalk Scheduled Task Adapter

The BizTalk Scheduled Task Adapter is an in-process receive adapter that executes a prescribed task on a daily, weekly or monthly schedule. The adapter is configured entirely within BizTalk, all configurations are stored within the SSODB and can be exported and imported via binding files.

The schedule capabilities are similar to those available with the Windows Scheduled Task Service.

Four simple tasks are included:

  • XmlStringStreamProvider - generates a BizTalk message from a configured Xml string
  • FileStreamProvider - generates a BizTalk message from the contents of a file
  • HttpDownload - generates a BizTalk message from data downloaded from a website
  • SQLStreamProvider - generates a BizTalk message from the contents of a SQL Query (similar to the old SQL adapter) - Since version 3.0

Custom tasks can be created. Any .NET class that implements the appropriate interface can be scheduled.

This adapter can be download from CodePlex: http://biztalkscheduledtask.codeplex.com/

BizTalk WCF Loopback Adapter

Calling the pipeline in an orchestration is a good option but it complicates the orchestrations with loops and expressions. You’ll also end up repeating the “code” for each message type/orchestration.

A loopback adapter is simply a two way send adapter that simply returns a copy of the outbound message. It gives you two opportunities to execute pipelines and maps on the way out and when it comes back in without the overhead of some kind of repository. One negative of the loopback adapter is that it’s a solicit response send port. You can’t bind a one way logical port in an orchestration to the send operation of a two way. So you’ll have to use content based routing (CBR) if an orchestration constructs the envelope.

You can find more information about this adapter and download here: http://synthesisconsulting.net/blog/2012/5/17/biztalk-wcf-loopback-binding.html

BizTalk Server 2013 TCP/IP Adapter

This project is a migration of the 2010 adapter below and has the same functionality as the original 2006/2009 version. References and configuration have been updated for .Net Framework 4.5. Also, a new setup-project has been added (InstallShield Limited Edition), since the original Visual Studio setup is no longer supported.

The adapter can be downloaded from CodePlex: http://tcpip2013.codeplex.com/.

BizTalk Server 2010 TCP/IP Adapter

This project is a migration of existing BizTalk server 2009 TCP/IP adapter to BizTalk server 2010. I have made few configuration changes which are making this adapter and installation compatible to BizTalk Server 2010. I have not modified adapter source code.

This adapter can be download from CodePlex: http://tcpipbz2010.codeplex.com/

BizTalk Server 2006/2009 TCP/IP Adapter

This adapter implements an in-process adapter for BizTalk Server that uses the raw TCP/IP socket library to pass messages between BizTalk Server and remote clients.

On top of supporting the basic BizTalk Server message exchange patterns, it also supports a mode called Duplex whereby a client can initiate a connection with the adapter where it then allows two way traffic down the one connection which can remain open for as long as is needed.

The adapter sends and receives raw data over TCP sockets and uses only a minimal protocol to determine message boundaries. This is known as message framing and is fully configurable.

The adapter supports the following message exchange patterns.

  • Request Only    Messages are sent to BizTalk that can be routed by BizTalk to any orchestration or send port.
  • Request-Response    Messages are sent to BizTalk and the appropriate response is returned to the adapter by BizTalk which is then sent back to the remote client.
  • Solicit Only    Messages are sent from BizTalk to a remote client.
  • Solicit-Response    Messages are sent from BizTalk to a remote client and that remote client returns a response to BizTalk which it can then route appropriately.
  • Dynamic Solicit    A send port can be set to be a dynamic send port that receives its destination address at run-time rather than being statically configured on the port. The adapter supports the use of the tcp:// prefix with two different URI styles depending on whether the send port supports sending the data over a duplex connection or not.
  • Duplex Request    A connection request to a duplex supported receive location allows message traffic from the remote client and to the remote client down the same initiated connection. The adapter sets the initiated connection address on a BizTalk Party that has an alias that matches the DNS name or IP address of the remote client.
  • Duplex Solicit    Messages are transmitted to the initiated connection to be returned to the remote client. It resolves the initiated connection against a BizTalk Party that has been updated with the appropriate duplex listener address.

This adapter can be download from CodePlex: http://btstcpip.codeplex.com/

WCF LOB TCP Adapter

This adapter can be download from CodePlex: http://wcflobadapter.codeplex.com/

Acme.Wcf.Lob.Socket Adapter

The application (which I will refer to as the socket application for this post) is exposed as a socket interface. On this project we had done a POC at one point to explore using the BizTalk TCPIP Socket Adapter to connect with it.

This adapter can be download from Michael Stephenson blog: http://geekswithblogs.net/michaelstephenson/archive/2009/02/10/129302.aspx

BizTalk WCF Adapter for Windows Azure Storage

The BizTalk WCF Adapter for Windows Azure Storage Services enables communication between .Net framework applications and Windows Azure Storage Queues and Blobs. Designed for BizTalk Server as a WCF Binding, it can be used from any regular .Net Framework application.

This release includes Initial support for PutMessage, ClearMessages outbound operations and GetMessage inbound operation on Azure Queues as well as for AddBlob, DeleteBlob outbound operations and GetBlob inbound operation on Azure Blobs. We also have implemented a basic polling strategy with fixed PollingIntervalInSeconds value.

This adapter can be download from CodePlex: http://azurestorageadapter.codeplex.com/

BizTalk 0MQ Adapter

The BizTalk 0MQ Adapter allows BizTalk to send and receive messages using the ZeroMq cross platform messaging framework. The BizTalk 0MQ Adapter is a work in progress. And if you like, contribute to it.

This adapter can be download from CodePlex: http://biztalk0mq.codeplex.com/

BizTalk Cache Adapter

A generic cache adapter for BizTalk. The adapter caches responses from send ports, and can be configured to use different caching options for different message types. The adapter is independent of the cache provider; the initial release supports NCache Express.

This adapter can be download from CodePlex: http://biztalkcacheadapter.codeplex.com/

BizTalk Azure Adapters SDK

The BizTalk Azure Adapters SDK 1.0 is a collection of BizTalk WCF Adapters that extend BizTalk Server 2009 capabilities of supporting integration of existing on-premise applications with new cloud-based applications and services running on the Windows Azure platform.

This release includes two first adapters capable of connecting on-premise applications with Microsoft Windows Azure Live Framework and .NET Services.

The BizTalk Azure Adapters SDK includes:

  • LiveMesh Adapter
  • Internet Service Bus Adapter

This adapter can be download from CodePlex: http://btsazureadapters.codeplex.com/

WCF Adapter for BizTalk Server 2006

Windows Communication Foundation Adapter for BizTalk Server 2006. As BizTalk Server 2006 R2 has built in support for WCF, this project will not be continued.

This adapter can be download from CodePlex: http://wcfbiztalk.codeplex.com/

NISHIL-Custom Receive File Adapter

This adapter can be download from CodePlex: http://receivefileadapter.codeplex.com/

Fax Adapter

The FaxAdapter is written on top of the File Adapter Sample in Microsoft Visual C# .NET to work with Microsoft BizTalk Server 2006. It provides code to build either a dynamic or a static adapter. However, the following procedure only outlines the static adapter. A static adapter is an adapter with a static set of schemas and no custom user interface. A dynamic adapter has a custom user interface and potentially a dynamic set of schemas. Both static and dynamic adapters use the Add Adapter Wizard to add their schemas to a BizTalk project.

This adapter can be download from CodeProject: http://www.codeproject.com/Articles/15748/Fax-Adapter

BizTalk Null Adapter

This adapter simply deletes anything that comes through it. Nice adapter to use if you need to send something out in order to initialize a correlation set without actually having a message go anywhere.

The BizTalk 2004 Null Adapter can be download here: http://www.winterdom.com/dev/bts/NullAdapterSol.zip

The BizTalk 2006 R2 Null Adapter can be download here: http://www.winterdom.com/dev/bts/NullAdapterR2.zip

New download location for Null Adapter : https://github.com/tomasr/nulladapter/tree/R2

A WCF Null Adapter : https://github.com/sbanwart/WCF-NULLAdapter

Another WCF Null binding Adapter from Akshat Sharma : https://blogs.msdn.microsoft.com/akshar/2010/09/09/wcf-null-binding/

Community BizTalk Adapter for ODBC

The Community BizTalk Adapter for ODBC is based on the code that was first made available on GotDotNet a few years ago. TwoConnect has refreshed this code, added an installer, and tested it against the latest BizTalk editions. We are releasing the updates back to the BizTalk developer, user and partner community as part of our ongoing community initiatives. This is the second adapter package that TwoConnect makes available to the community after the very successful release of the BizTalk WSE 3 adapter a couple of years ago. This adapter is useful in all ODBC based integration scenarios. The following are the new features added and fixes made to the old code base on GotDotNet.

New Features

  • Poll While Data Found option on Receive Location.
  • Performance Counters and Event Source created at install time.
  • No longer requires Administrator rights at runtime.

Tested with

  • BizTalk Server 2006 R2/2009/2010/2013
  • Microsoft SQL Server 2005/2008/2008 R2/2012
  • Sybase 15 and versions higher
  • MySQL 5.1

The Adapter can be download here: http://www.twoconnect.com/odbc-biztalk-adapter-free-download

Walkthrough: https://connectedenterprise.wordpress.com/2012/07/27/connecting-biztalk-2010-to-mysql-using-twoconnect-odbc-adapter/

WCF File Adapter

The transport implemented in this example is a fairly easy one, namely file. (The send channel writes to files and the receive channel reads files.) In order to make this work, I have studied the Transport- UDP sample and even stolen some code from it. I have also used a lot of trial and error.

This tutorial is explain in 3 parts: 1 part, 2 part and 3 part.

Custom BizTalk File Adapter (zero byte file)

The native FILE adapter released with BizTalk eats all zero-byte (empty) files without triggering any associated processes. This behaviour, according to Microsoft, is by design. Though you can argue that it is not consistent how empty files are treated by different adapters, e.g. FTP adapter can transfer empty files with no problem.

What we want here is to have a custom file adapter that will ignore zero-byte files and leave them untouched.

You can found this tutorial here and here.

BizTalk Ping Adapter

Use to check the connectivity between BizTalk and a receive/send location before you receive/send any message from/to Biztalk. .

You can find details from http://biztek.blogspot.co.uk/2006/09/ping-adapter-for-biztalk-2006-using.html

Other Resources

WCF LOB Adapter SDK

The WCF LOB Adapter SDK is built on top of the WCF Channel Model and provides design-time and run-time extensions for adapter developers to create adapters to line-of-business systems that have large and dynamic metadata. An adapter created using the WCF LOB Adapter SDK is surfaced to the consumer as a custom WCF binding. The following figure shows the internal architecture and main components of WCF LOB Adapter SDK.

Know more about WCF LOB Adapter SDK: Understanding the WCF LOB Adapter SDK

Download WCF LOB Adapter SDK 2010: http://www.microsoft.com/en-us/download/details.aspx?id=10903

BizTalk Adapter Wizard

The BizTalk Adapter Wizard for BizTalk Server 2006 is a Visual Studio 2005 project wizard which creates all of the framework code for your custom BizTalk adapter. The adapter wizard is accessible from the Visual Studio menu: File - New - Project - BizTalk projects.

This wizard can be download from CodePlex: http://biztalkadapterwizard.codeplex.com/

Wiki articles about adapters

See Also

Read suggested related topics:

Another important place to find a huge amount of BizTalk related articles is the TechNet Wiki itself. The best entry point is BizTalk Server Resources on the TechNet Wiki.



Back to Top