ESB Toolkit Tip #16 Use the Deployment Framework for BizTalk Server to deploy your ESB itineraries

When an itinerary is created using the Itinerary Designer you normally deploy the Itinerary with the ESB Itinerary Import Utility. This utility is located under the \bin directory of the BizTalk ESB Toolkit and is named EsbImportUtil.exe. It can be used to publish or deploy the itinerary XML into the ESBItineraryDB database. Unfortunately, the tool is not very convenient to use because you have to deploy the Itineraries manually.
Another option is to use the Deployment Framework for BizTalk. The Deployment Framework for BizTalk eliminates the pain associated with BizTalk application deployments, and goes far beyond BizTalk’s out-of-the-box deployment functionality because you can also use it to deploy ESB itineraries.

 

Steps

The Deployment Framework can automatically deploy your ESB itineraries during deployment.  Before an itinerary can be deployed, you must manually export it to an XML file using the Itinerary Designer’s XML Exporter. 
 
1. Set the IncludeEsbItineraries property to true
The property may be included in any PropertyGroup, but is commonly placed in the first PropertyGroup in the project file.

<PropertyGroup>
 ...
 <IncludeEsbItineraries>true</IncludeEsbItineraries>
 ...
</PropertyGroup>.csharpcode, .csharpcode pre
{
	font-size: small;
	color: black;
	font-family: consolas, "Courier New", courier, monospace;
	background-color: #ffffff;
	/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt 
{
	background-color: #f4f4f4;
	width: 100%;
	margin: 0em;
}
.csharpcode .lnum { color: #606060; }

 

2. Add an EsbItineraries ItemGroup

The following is a typical example that properly follows the common ItemGroup structure:

<ItemGroup>
 <EsbItineraries Include="MyItinerary1.xml">
   <LocationPath>..\Itineraries</LocationPath>
 </EsbItineraries>
</ItemGroup>

.csharpcode, .csharpcode pre { font-size: small; color: black; font-family: consolas, "Courier New", courier, monospace; background-color: #ffffff; /*white-space: pre;*/ } .csharpcode pre { margin: 0em; } .csharpcode .rem { color: #008000; } .csharpcode .kwrd { color: #0000ff; } .csharpcode .str { color: #006080; } .csharpcode .op { color: #0000c0; } .csharpcode .preproc { color: #cc6633; } .csharpcode .asp { background-color: #ffff00; } .csharpcode .html { color: #800000; } .csharpcode .attr { color: #ff0000; } .csharpcode .alt { background-color: #f4f4f4; width: 100%; margin: 0em; } .csharpcode .lnum { color: #606060; }

If you have more than one ESB itinerary, then repeat the <EsbItineraries> element for each file

(usually within the same ItemGroup).

Note

The Microsoft ESB Toolkit does not include a tool to undeploy itineraries, so the Deployment Framework cannot undeploy them.  Once deployed, they remain deployed.

 

See Also

For more information on using the Deployment Framework to deploy your ESB itineraries see:

Unable to create binding configuration element for editing. Check the values of the bindyingType and BindingConfiguration properties.

Unable to create binding configuration element for editing. Check the values of the bindyingType and BindingConfiguration properties.

I have a BizTalk Server 2010 Test Environment that was working properly for some time, all the adapters from BizTalk Server Adapter Pack 2010 were installed with the last cumulative updates and also working properly, in this environment we use the SQL Server Adapter. However the last time the team try to configure the receive […]
Blog Post by: Sandro Pereira

10 reasons to walk from BizTalk – an analysis and retort

10 reasons to walk from BizTalk – an analysis and retort

This article has been jointly written byConnected Pawns’ Mark Brimble andAdventures inside the Message Box’s Johann Cooper and is a response to MuleSoft’s recent blog article “10 reasons to walk from BizTalk” in an attempt to analyse whether the article has any merit. A quick disclaimer first. Our trade is primarily but not limited to […]
Blog Post by: Johann

Our response to MuleSoft blog "10 Reasons to Walk from BizTalk"

Last week Aaron Landgraf from MuleSoft published a lengthy blog article “10 Reasons to Walk from BizTalk” trying to showcase MuleSoft is better than BizTalk. I felt some of the facts are completely wrong, misleading and one sided. I always welcome competition, healthy competition is good for innovation, but playing marketing games and bad mouthing […]

The post Our response to MuleSoft blog "10 Reasons to Walk from BizTalk" appeared first on BizTalk360 Blog.

Blog Post by: Saravana Kumar

ESB Toolkit Tip #15 Enable the ESB Toolkit trace switch in the Machine.config file

When you start developing with the ESB Toolkit it can be difficult to debug an error in an itinerary. When an exception occurs, you can see the error in the Event Viewer, in the BizTalk Administration Console (if you don’t use the ESB Exception Management Framework) ore in the Management Portal but sometimes this information is not enough because you want to see which steps are already done in the itinerary and want to trace exactly when and where the error occurs.
Fortunately you can enable tracing in the ESB Toolkit and trace the steps inside the Itinerary.

The following information can be traced in the ESB Toolkit:

  • If the Itinerary could be resolved
  • Which Itineray is attached to the message
  • What the Document Message Type is
  • If a Resolver or Adapter Provider is stored in the Cache
  • Activities inside an Itinerary Service
    • Initializing
    • Resolver information
    • Adapter information
      • Endpoint information

 

Use a tool like DebugView to see the trace output. DebugView is an application that lets you monitor debug output on your local system, or any computer on the network that you can reach via TCP/IP.

 

How to configure diagnostics and trace information

To enable the Microsoft BizTalk ESB Toolkit trace switch, add the following <switches> element to the system.diagnostics section of the machine.config file.

<system.diagnostics>
      <switches>
          <add name="BizTalkESBToolkit" value="4"/>
      </switches>
 </system.diagnostics>

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, “Courier New”, courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

Note

In every version of the ESB Toolkit is the switch name a little different. In previous versions it was "BizTalkESBToolkit" with the version number appended to it but in BizTalk 2013 it is only "BizTalkESBToolkit". Unfortunately, the documentation of the ESB Toolkit is not updated every version so beware that if you copy and paste the switches element from the documentation you have to change the switch name.

 

See Also

For more information on configuring diagnostics and trace information see:

Contest: Win a e-copy of the book Getting Started with BizTalk Services

Contest: Win a e-copy of the book Getting Started with BizTalk Services

Exciting news for BizTalk community! I have 2 e-copies of the new book Getting Started with BizTalk Services to give away, courtesy of PACKT Publishing. This book was written by Karthik Bharathy (Lead Program Manager in the BizTalk product group) and Jon Fancey (Microsoft Integration MVP) published by Packet Publishing. You can read more about […]
Blog Post by: Sandro Pereira

Here is to 10 Years of Blogging on BizTalk Server!

Here is to 10 Years of Blogging on BizTalk Server!

I was just looking around some of my older blog posts and noticed today is my 10 year Anniversary of starting my blog!

My first blog post was titled “Welcome to My BizTalk Blog”. 

Since then, I have made 235 blog posts and uploaded over 76 code samples & videos!

Stephen W Thomas BizTalk Guru in 2004

Stephen W. Thomas in 2004

Stephen W Thomas BizTalk Guru in 2014

Stephen W. Thomas in 2014
A few pounds heavier (ok, maybe 30 or so), same amount of hair, and +2 kids.

In honor of my 10 year Anniversary I am giving away some prizes!  Just be one of the first people to email me at [email protected]

I have the following items to give away:

A few 30-day Pluralsight Subscriptions – $30 value.
You could use your subscription to watch my courses on “What’s New in BizTalk Server 2013” or my new course “Into to BizTalk Server 2013 ESB Toolkit”.

A few “Getting Started with BizTalk Services 2013” eBooks – $15 value.

If you do not win the book, you can buy it at Packt or at Amazon.
This is one of those books that every BizTalk Developer should own.

Here is to another 10 years of blogging on BizTalk!

New Pluralsight Course – “DevOps: The Big Picture” – Just Released

New Pluralsight Course – “DevOps: The Big Picture” – Just Released

DevOps has the potential to completely transform how an organization delivers technologyservices to its customers.But what does “DevOps” really mean? How canyou get started on this transformation? What tools and technologies can assist in the adoption of a DevOps culture? To answer these questions, I put together a brief, easy-to-consume course for Pluralsight subscribers. “DevOps: […]
Blog Post by: Richard Seroter