Posts Tagged ‘ESB Toolkit’

Tracing with ESB Toolkit 2.2

May 13, 2013 3 comments

Thanks to Tomasso Groenendijk for figuring this one out and sharing.

As with previous versions of the ESB Toolkit there is a minor change required to get tracing working. The switch name no longer has the version number appended to it. So instead of “BizTalkESBToolkit20” or “BizTalkESBToolkit21” as in previous versions, it is now “BizTalkESBToolkit”.

This should remain constant going forward removing the need to guess what the switch name is on each release!

Similar to ESB Toolkit 2.1, the full list of steps are:

  1. In Notepad openC:\Windows\Microsoft.NET\Framework\v4.0.30319\CONFIG\machine.config for 32-bit
    C:\Windows\Microsoft.NET\Framework64\v4.0.30319\CONFIG\machine.config for 64-bit
  2. Locate the line with the closing configSections tag.
  3. Under that line paste the following section:
              <add name="BizTalkESBToolkit" value="4"/>
  4. Save and close machine.config.
  5. Start the DebugView program (Download)
  6. In DebugView, on the Capture menu, click Capture Global Win32 to make sure that it is checked.
  7. In the BizTalk Server Administration console, restart the BizTalkServerApplication host instance.

ESB Toolkit 2.2 Itinerary Designer Installation

April 22, 2013 4 comments

Brian Loesgen has a post on his blog describing an issue he ran into performing a clean build of BizTalk Server 2013 and ESB Toolkit 2.2, where the Itinerary Designer extension is not registered in Visual Studio 2012 after the ESB Toolkit 2.2 installation step.

I experienced this also so it may be more widespread than first thought. I’d be interested to hear how many other people run into it; it might be the case that this step will need to be added to installation instructions.

Before Brian pointed me to his post I had resolved this inadvertently when I installed the latest Visual Studio 2012 update, which would have resulted in a similar command being executed with the same outcome.

ESB Toolkit 2.1 Installation Checklists

April 8, 2013 2 comments


One of the biggest barriers to ESB Toolkit adoption I have come across is the installation and configuration overhead. This is a genuine concern, especially when you need to deviate from the standard configuration. If project timelines are tight, this can result in the ESB Toolkit being overlooked.

Through working on a number of ESB Toolkit based solutions for different customers I have compiled some high level installation checklists that cover the most common environment configurations. I will cover each of these in this blog series with a view to removing the initial barrier to building solutions based on the ESB Toolkit.

The Installing BizTalk 2010 ESB Toolkit 2.1 guide and Installing the BizTalk ESB Toolkit MSDN library topic should be used as a reference for drilling down into the detail of the steps included in the checklists.

If there is anything you have come across that you feel should be included in the checklist please get in touch and we can look at adding it.


  1. ESB Toolkit 2.1 Core Standalone Installation Checklist

ESB Toolkit 2.1 Core Standalone Installation

April 1, 2013 3 comments


The environment configuration covered under this checklist is as follows:

  • 1 x 64-bit Windows Server 2008 R2 Enterprise Edition
  • BizTalk Server 2010 Developer Edition
  • SQL Server 2008 R2 Developer Edition
  • ESB Toolkit 2.1
  • All programs are installed on a drive isolated from the OS, an E drive in this case


  1. Install the BizTalk ESB Toolkit 2.1-x64.msi
  2. Install the Microsoft.Practices.Services.Itinerary.DslPackage
  3. Import and install the Microsoft.Practices.ESB.CORE64.msi
  4. Create a 32-bit Host, Host Instance and assign the SQL send and receive handlers to it
  5. Configure the All.Exceptions send port in the Microsoft.Practices.ESB application to use the 32-bit SQL send handler
  6. Launch the ESB Configuration Tool and configure the toolkit
  7. Copy the following ESB Toolkit pipeline components from the “C:\Program Files (x86)\Microsoft BizTalk Server 2010\Pipeline Components” folder to the “E:\Program Files (x86)\Microsoft BizTalk Server 2010\Pipeline Components” folder:
    • Microsoft.Practices.ESB.ExceptionHandling.PipelineComponents.dll
    • Microsoft.Practices.ESB.Itinerary.PipelineComponents.dll
    • Microsoft.Practices.ESB.Namespace.PipelineComponents.dll
    • Microsoft.Practices.ESB.PipelineComponents.dll
  8. Copy the ItineraryDescription.xsd from the “E:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Web\ESB.ItineraryServices.Response.WCF\App_Data” folder to the “E:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Web\ESB.ItineraryServices.Generic.Response.WCF\App_Data” folder
  9. Add the SQL Server Service Analysis account as a User to the BAMStarSchema database and grant it the db_datareader role
  10.   Deploy the BAM activities
  11.   Configure Tracing
  12.   Restart host instances and perform an IISRESET
  13.   Verify all services are browse-able

Download OneNote Checklist

ESB Toolkit 2.1 Training Kit

I was browsing through the BizTalk Server Downloads section on MSDN recently and came across an excellent resource for BizTalk Server professionals looking to learn and leverage the capabilities of the ESB Toolkit.

BizTalk Server 2010 ESB Toolkit Training Kit

I wasn’t aware of it’s release and it doesn’t appear to be publicised anywhere on Microsoft’s site but I highly recommend you check it out.

The kit contains hands-on labs, PowerPoint slides and instructor-led videos. There is also the option to download two virtual machines for use with the labs.

The topics covered are:

  1. Understanding the BizTalk ESB Toolkit
  2. Installing the BizTalk ESB Toolkit
  3. Processing Messages Using the ESB Itinerary Mechanism
  4. ESB Pipeline Processing
  5. The ESB Resolver and Adapter Provider Framework
  6. Using ESB External Services
  7. Exception Management and the ESB Management Portal
  8. Modifying and Extending the ESB Toolkit


ESB Management Portal Customization

March 23, 2012 3 comments

The ESB Management Portal that ships with the ESB Toolkit is a sample site and is intended as a starting point for building your own portal for exception management and beyond.

This view of the portal is something that is often overlooked with the assumption made that it is a production ready component of the ESB Toolkit.

To make the most out of the portal it should be customized to suit the needs of your client or enterprise.

Resubmitting XML

The first customization required is to facilitate the resubmission of failed XML messages. “Out-of-the-box” fault messages are logged with a content type of “text/plain”. This results in only HTTP On-Ramps being visible in the resubmission location drop-down list.

To resolve this modify the usp_insert_Message stored procedure in the EsbExceptionDb as follows

IF (@ContentType = 'text/plain' AND LEFT(@MessageData,1) = '<')
  SET @ContentType = 'text/xml'

This will set the content type of all XML fault messages received to “text/xml” resulting in the WCF and SOAP On-Ramps being visible in the resubmission location drop-down list.

While there are many customizations that should be applied to the portal this is the main one to make if you require the ability to resubmit XML messages, which I am certain the majority of users will want.


MSDN Forum post by MikeGBUK