Installing ESB Pack for BizTalk

You are here:


  • Microsoft BizTalk Server Enterprise or Developer Editions ( 2010 or 2016)
  • Microsoft BizTalk ESB Toolkit
  • Microsoft SQL Server Standard or Enterprise Editions ( required by database resolver)
  • Microsoft SQL Server Management Objects (SMO)


Installing ESB Components:

  1. Install ESBPack.msi package on BizTalk machine.
  2. Make copy of the esb.config file used by BizTalk ESB Toolkit.
  3. Open Bin folder in ESB Pack install directory in command prompt.
  4. Ensure that path to ESBFunctions.ps1 specified in the Install.cmd file is valid. ( The ESBFunctions.ps1 is included in BizTalk Server distribution media as part of ESB Toolkit samples.
  5. Execute Install.cmd from Bin folder in the installation directory. This script will replace esb.config with generated version and create new BizTalk application using user credentials.

Configuring SQL resolver

This step is required to use SQL resolver to retrieve set of settings from configuration database.

  1. Create new SQL Server database, for example EsbConfigDb.
  2. Open Sql folder in ESB Pack install directory and execute install script for new database.
  3. Add database read permissions to allow “BizTalk Isolated Host Users” and “BizTalk Users”. Modify database name in SQL resolver connection string by editing esb.config file in ESB Toolkit installation directory.

Removing  ESB Components

  1. Open Bin folder in ESB Pack install directory in command prompt.
  2. Ensure that path to ESBFunctions.ps1 in Uninstall.cmd is valid.
  3. Execute Uninstall.cmd from Bin folder in the installation directory and then manually replace esb.config with generated version.

Updating BAM Tracking Profile

This step is necessary if you ned to correlate itineraries and failed messages provided using BAM. Note that this update will only add new fields and indexes to BAM exception messages tracking schema.

  1. Open Bam folder in ESB Pack install directory in command prompt and execute the following command:

Bm.exe update-all -DefinitionFile:”Infragravity.BizTalk.ESB.BAM.Exceptions.xml”

  1. Create indexes by executing the following commands:
    bm.exe create-index -IndexName:IDX_ItineraryUUID -Activity:EsbExceptions -     Checkpoint:ItineraryUUID bm.exe create-index -IndexName:IDX_InterchangeID -Activity:EsbExceptions -Checkpoint:InterchangeID
  2. Enable BAM in Bam Tracker pipeline component from ESB Pack in Infragravity.AllExceptons send port using BizTalk Administration console.
  3. Execute SQL query to retrieve itineraries and related failed messages:
    select [itineraryBeginTime] ,[ItineraryState] ,[ItineraryName] ,[ESBServiceName] ,[ServicePosition] ,[ServiceState] ,[ServiceType] ,[ServiceBusinessName] ,[Serviceuuid] ,ics.[InterchangeID] ,ics.[ItineraryUUID] ,ecs.[FaultDescription] FROM [bam_ItineraryServiceActivity_CompletedInstances] ics LEFT OUTER Join[bam_ESBExceptions_CompletedInstances] ecs ON ecs.[ItineraryUUID]=ics.[ItineraryUUID] WHERE ics.[ItineraryState] <> 'Complete' AND ics.[ServicePosition] = ( SELECT max ([ServicePosition]) FROM [bam_ItineraryServiceActivity_CompletedInstances] ics2 WHERE ics2.[ItineraryUUID] = ics.[ItineraryUUID]) ORDER BY [ItineraryBeginTime] DESC


To enable trace output, add the following section to machine.config file for version of .NET framework used by BizTalk Server:

<add name="BizTalkESBPack" value="4" />

Known Issues

The following knows issues have been identified for this release:

  1. Powershell scripts are not signed – workaround is to inspect scripts and temporarily change execution policy for allowing scripts to run.
  2. Import of binding file during execution of Install.cmd may fail due host mismatch for SQL adapter – modify binding file to match your target 32 bit host name for SQL adapter send handler.
  3. The original esb.config file should be restored manually –  the backup copy created by install script during the installation.
Last Updated On January 02, 2018