Tutorial – ESB

ESB Exception Management Console

  • ESB Exception Management Console
  • Prerequities of ESB toolkit
  • Installation ESB toolkit
  • Configuration of ESB toolkit
  • ESB with BAM
  • Configuring ESB Management Portal
BizTalk Server Monitoring

1.    ESB Exception Management Console

                         Microsoft provides ESB toolkit along with BizTalk for Exception management, reprocess & sending alert mail to support team/person if any exception occurs in BizTalk application. And there is not require any coding for handling the exception in BizTalk applications.

The ESB Management Portal, included as part of the Microsoft BizTalk ESB Toolkit, is a sample site that demonstrates the use of metrics and the possibilities that exist for extending the BizTalk ESB Toolkit. The portal provides a starting point from which you can build your own customized portal.

THE ESB Management portal consumes data from the ESBExceptionDb database where the faults information is published.

Below are some main benefits of ESB Management console:

  • The ESB Management Portal provides exception mediation capabilities through an auditing and tracking mechanism
  • It captures messages (including the context properties) at the time that the exception occurred.
  • This enables powerful exception recovery and “repair and resubmit” patterns.
  •  This portal also provides an alert and notification mechanism that can generate alerts based on custom conditions and send notifications to subscribers
  • The portal can generate and display a range of charts and reports, configurable over specified periods of time, and include data from specified BizTalk applications to monitor application performance and analyse fault trends
  • The portal integrates with a Microsoft UDDI 3.0 server to provide a graphical user interface for publishing BizTalk endpoints to UDDI, either automatically or through an administrator-controlled approval process

2.    Prerequisites for ESB Toolkit:

  • Install Enterprise Library 5.0 from below link-


  • Install Microsoft Report Viewer Redistributable 2008 from below link-


  • Add Roles & Features in windows features: –
    • Roles: –
      • IIS with IIS 6 compatibility Tools(complete)
  • Windows Authentication & Basic Authentication (Under: Web Server (IIS) -> Security)
  • Features: –WCF & HTTP Activation for both .Net 3.5 and 4.0/4.5

3.    Installation of ESB Toolkit:

ESB toolkit comes along with BizTalk software. For BizTalk 2013 & 2013 R2 you can download ESB toolkit from here. After installation of BizTalk & LOB WCF Adapters. You can install BizTalk ESB toolkit by again launching the BizTalk setup file.

4.    Configuring Microsoft BizTalk ESB Toolkit

  1. After installation, go to C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit\Bin and Launch ESB Configuration Tool


From the Start menu, type ESB Configuration Tool or Scroll and select Microsoft BizTalk ESB Toolkit, and then select ESB Configuration Tool

  • In the ESB Configuration Tool, from the left pane, select ESB Configuration.
  • On the right pane, for Database Server: specify the database server where the databases, which are required for BizTalk ESB Toolkit, are created
  • Here you need to go each section and fill the respective details:
  • In below configuration section, select File Configuration Source. Also, when you configure in multi-server environment then also select File Configuration Source.
  • After installation Microsoft.Pracvices.ESB application will launch. You can check in BizTalk admin console and corresponding database EsbExceptionDb & EsbItineraryDb will be created in Database.

In BizTalk Admin console:


Here all the applications’ s exception can be checked in Fault table in ESBExceptionDb database

For how to setup Exception handling in ESB, please refer following links:

Exception handling in Orchestration and send details to ESB


Exception handling at ports (Receive/send) and send details to ESB


if you don’t want to use ESB and handling the port level exception then please refer:


Access of original message from ESBExceptionDB for failed message, you need to run following SQL query:

select MessageData from MessageData where MessageID in (select MessageID from Message where FaultID in (select FaultID from Fault where Application = <Application Name> and InsertedDate >= <Datetime value>

5.    Configuring Microsoft BizTalk ESB Toolkit in multi-server environment:

In multi-server environment, there is not require much changes. You need to just select use existing database and select File Configuration Source in configuration section. And remaining other activity will be same activity as above as defined.

6.    ESB with BAM:

ESB Details can be also shown on BAM portal. Exception details of application and itinerary details can be show on Bam portal.

BAM Activity Files will be at below location after installation of ESB Toolkit.

C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit\Bam

  • Microsoft.BizTalk.ESB.BAM.Exceptions.xml

This will show the exception details of applications on BAM portal

  • Microsoft.BizTalk.ESB.BAM.Itinerary.xml: this will show the Itinerary details of BizTalk applications on BAM Portal

To set up ESB on BAM portal, run the following command in command prompt:

Navigate to C:\Program Files (x86)\Microsoft BizTalk Server 2016\Tracking

  • Run Bm.exe deploy-all -DefinitionFile:”C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit\Bam\Microsoft.BizTalk.ESB.BAM.Itinerary.xml”
  •  Run Bm.exe deploy-all -DefinitionFile:”C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit\Bam\Microsoft.BizTalk.ESB.BAM.Exceptions.xml”

Open SQL Management studio and connect to server having BAM Star Schema database and run the following command:

use BAMStarSchema

EXEC sp_addrolemember ‘db_owner’, ‘NT AUTHORITY\SYSTEM’

For more details related to BAM click here

  • Configure BizTalk with full BAM configuration. For BAM configuration click here. Ensure to check “Enable Analysis Services forBAM aggregations”, give the Server Name and Apply Configurations.

8.    Configure ESB management Portal

  1. Create a folder named: C:\Projects\Microsoft.Practices.ESB
  2. Unzip C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit\ESBSource.zip file into this folder
  3. Remove Read-only attribute from all files in C:\Projects\Microsoft.Practices.ESB folder.
  4. Create the strong name key for the Samples with name Microsoft.Practices.ESB.snk
  5. Run sn -k c:\Microsoft.Practices.ESB.snk
  6. Copy this key to C:\Projects\Microsoft.Practices.ESB\Keys
  7. Fix the WCF Resubmit Port

a. Navigate to C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit\Web\ESB.ItineraryServices.WCF

b. Open the web.config file

c. Locate: <soapHeaderMetadata enabled=”true”> and Update to be <soapHeaderMetadata enabled=”false”>

  • In the ESB.BAM.Service.Implementation C# project add a reference to Microsoft.Practices.ServiceLocation.dll.

This can be found at C:\Program Files (x86)\Microsoft Enterprise Library 5.0\Bin

  1. Open a 32-Bit PowerShell windows as Administrator
  2. Type: Set-ExecutionPolicy –ExecutionPolicy Unrestricted (confirm Y when promoted)
  3. Run Management_Install.cmd file found in C:\Projects\Microsoft.Practices.ESB\Source\Samples\Management Portal\Install\Scripts
  4. Open http://localhost/ESB.Portal in explorer

Note: if there is any issue then please check in event log. There you will find real cause of error. If you are configuring ESB management portal in multi-server then you need to update database server name in web config file in folder location:  C:\Projects\ Microsoft.Practices.ESB \Source\Samples\Management Portal\ESB.Portal

Some troubleshoot info you will get here



When you get below the exception after launching the BizTalk ESB Portal:

ESB Portal – (400) Bad Request

Please refer: https://blog.jeroenmaes.eu/2014/10/esb-portal-400-bad-request/

9.    Install the ESB Management Portal Alert Service

When there is reequipment of sending mail to support team or user if any exception occurs in BizTalk. In ESB management portal there is provide the feature to send mail on exception.

The service notifies any users or groups of users that have subscribed to the alert. The service retrieves notification e-mail addresses and group memberships from Active Directory. This service has no dependency on BizTalk Server.


Install C:\Projects\Microsoft.Practices.ESB\Source\Samples\Management Portal\ESB.AlertService.Install\bin\Debug\Setup.msi

If we get error while run the alert service- BizTalk ESB Exception Notification in services.msc. please check the event log and below blog will help you:


BizTalk Server Monitoring

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

Blog at WordPress.com.

%d bloggers like this: