ESB Toolkit 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.  The Deployment Framework must be directed to the XML file, not the .itinerary file.

NOTE: You MUST re-export your itinerary any time it is modified.  Unfortunately, there is currently no tool in the ESB Toolkit that can automate the export.

To deploy one or more ESB itineraries, edit your Deployment Framework for BizTalk project file (.btdfproj) as follows:

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>

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>

The following is the default configuration, which corresponds to the optional naming conventions.  This default is in effect if you do not include any EsbItineraries elements in your project file.

<ItemGroup>

 <EsbItineraries Include="$(ProjectName).itinerary">

   <LocationPath>..\$(ProjectName).ESB</LocationPath>

 </EsbItineraries>

</ItemGroup>

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.

Created with the Personal Edition of HelpNDoc: Create HTML Help, DOC, PDF and print manuals from 1 single source