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.



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.



2. Add an EsbItineraries ItemGroup
The following is a typical example that properly follows the common ItemGroup structure:

 <EsbItineraries Include="MyItinerary1.xml">

If you have more than one ESB itinerary, then repeat the <EsbItineraries> element for each file
(usually within the same ItemGroup).

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:

Pingbacks and trackbacks (1)+

Add comment

  Country flag

  • Comment
  • Preview

About the author

Tomasso Groenendijk lives in Netherlands and is a Solution Architect at Insight. He has over 20 years experience in software development and software design. Tomasso is specialized in application integration with a strong interest in the Windows Azure cloud platform. From 2014, Tomasso has been awarded six times with the Microsoft Azure MVP award. He is an active contributor to the integration community through his work on his blog, GitHub samples, TechNet Wiki and speaking on events. Furthermore he is an official board member of the Dutch Microsoft Integration User Group.

MVP profile Tomasso Groenendijk
Sentinet Product Specialist
BizTalk360 Product Specialist

Month List