BizTalk Server includes a powerful publish/subscribe mechanism for messaging applications that work by creating and filling subscriptions, which provides a highly efficient and scalable platform for service-oriented architecture (SOA) applications. The BizTalk ESB Toolkit extends the functionality of BizTalk Server to provide a range of new capabilities focused on building robust, connected, service-oriented applications that incorporate itinerary-based service invocation for lightweight service composition, dynamic resolution of endpoints and maps, Web service and WS-* integration, fault management and reporting, and integration with third-party SOA governance solutions.
The good news is that with BizTalk Server 2013, the Microsoft BizTalk ESB Toolkit is integrated with the BizTalk Server setup.
📝 One-Minute Brief
The BizTalk ESB Toolkit extends BizTalk Server’s capabilities by providing itinerary-based service invocation, dynamic resolution, and robust fault management. This guide covers the end-to-end setup process for BizTalk 2013, where the toolkit is now integrated into the main installer. It details the installation steps, the use of the ESB Configuration Tool (as Administrator), setting up Exception Management and Itinerary databases, and final registration within IIS and the BizTalk Administration Console.
To install the Microsoft BizTalk ESB Toolkit
- Close any programs you have open. Run the BizTalk Server 2013 installer as Administrator.
- On the BizTalk Server installation Start screen, click Install Microsoft BizTalk ESB Toolkit.

- On the License Agreement screen, select Yes, I accept the terms of the license agreement to accept the license agreement and click Next.

- On the Component Installation screen, select the components you want to install and then click Next.

- On the Summary screen, review installation details and then click Install.

- On the Installation Completed screen, click Finish to close the installation wizard.

To configure the Microsoft BizTalk ESB Toolkit
- Press the Windows key to switch to Metro UI and type ESB Configuration tool or ESB, right-click the ESB Configuration tool option on the Apps menu, and then click Run as Administrator.
- Note: You must run the ESB Configuration Tool as an administrator.

- In the ESB Configuration Tool screen, from the left pane, select ESB Configuration, and on the right pane:
- For Database Server (Defaults): specify the database server name where the databases required for BizTalk ESB Toolkit will be created.
- In the IIS Web Services (Defaults) box:
- Specify the user credentials under which the applications required for BizTalk ESB Toolkit will be created.
- Also, specify the name of the website in IIS under which the applications will be created.
- The BizTalk User Groups (Defaults) box lists the default user groups available for ESB configuration.
- Leave the default values
- Important: At this stage, you can click Apply Configuration towards the top of the ESB Configuration Tool to configure the Microsoft BizTalk ESB Toolkit with the default settings. However, we will continue to configure the remaining steps for a custom configuration.

- From the left pane, expand Exception Management and do the following:
- Click on the Database option and on the right pane:
- Select the Enable Exception Management Database checkbox to configure an exception management database.
- In Database server name: specify the database server name where you want to create this database (specify the same database server name that you specify in the ESB Configuration panel under Database Server (Default) option).
- In Database name: leave the default name EsbExceptionDb.
- Leave the default groups.
- Click on the Database option and on the right pane:

- Click on the Exception Web Services option from the left pane, and on the right pane:
- Select the Enable Exception Services checkbox to configure these services.
- In User Account and User Account Password: specify the user account and password under which these services will run.
- In BizTalk Isolated Group – Leave the default value BizTalk Isolated Host Users.
- In Website Name: specify the website where you want to run these services.

- From the left pane, expand ESB Core Components, and do the following:
- Click the Itinerary Database option and in the right pane:
- Select the Itinerary Database checkbox to configure an itinerary database.
- In Database server name: specify the database server name where you want to create this database (specify the same database server name that you specify in the ESB Configuration panel under Database Server (Default) option)
- In Database name: leave the default name EsbItineraryDb.
- Leave the default groups.
- Click the Itinerary Database option and in the right pane:

- Click on the Core Web Services option from the left pane, and on the right pane:
- Select the Enable Core Services checkbox to configure these services.
- In User Account and User Account Password: specify the user account and password under which these services will run.
- In BizTalk Isolated Host Group – Leave the default value BizTalk Isolated Host Users.
- In Website Name: specify the website where you want to run these services.

- From the left pane, click Configuration to specify the SSO configuration.
- If you are installing and configuring the Microsoft BizTalk ESB Toolkit in a single server environment, you should select “File Configuration Source”, which is the default selection. However, if you are setting up a multiple-machine deployment, you must select the SSO Configuration Source, and then provide the following values.
- SSO Server: Name of the SSO server.
- Configuration file: Click the ellipsis button (…), and then browse to the Esb.config file, which is included in the Microsoft BizTalk ESB Toolkit
- Application Name: Type a name for the SSO application. For example, ESB Toolkit.
- Contact Information: Type the appropriate contact information in the following format: someone@example.com.
- Administrator Group Name: Click the ellipsis button (…), and then browse to the appropriate name
- User Group Name: Click the ellipsis button (…), and then browse to the appropriate name
- Select File Configuration Source.
- If you are installing and configuring the Microsoft BizTalk ESB Toolkit in a single server environment, you should select “File Configuration Source”, which is the default selection. However, if you are setting up a multiple-machine deployment, you must select the SSO Configuration Source, and then provide the following values.

- Click Apply Configuration at the top of the ESB Configuration Tool to configure the Microsoft BizTalk ESB Toolkit. Open IIS and notice that the applications required for Microsoft BizTalk ESB Toolkit are now created under the website you specified.

- Back to the ESB Configuration Tool, from the left pane, click the ESB BizTalk Applications option, from the right pane, do the following:
- Select the Enable ESB Core Components in BizTalk Server checkbox to create the application in the BizTalk Server Administration console.
- Select the Use Default Binding to bind this application to the default host.
- Optionally, you can select Do not use Default Binding if you do not want to bind the application to the default host. In such a case, you must explicitly bind the application to a host once the application is created.
- Select the Enable ESB JMS/WMQ Components in BizTalk Server checkbox to create the application in the BizTalk Server Administration console.
- Select the Use Default Binding to bind this application to the default host.
- Optional you select the “Do not use Default Binding” if you do not want to bind the application to the default host. In such a case, you must explicitly bind the application to a host once the application is created.
- Select the Enable ESB Core Components in BizTalk Server checkbox to create the application in the BizTalk Server Administration console.

- Click Apply Configuration at the top of the ESB Configuration Tool to create the applications you selected. Verify that the applications are created in the BizTalk Server Administration console.

Install Critical Windows Updates and BizTalk Server Cumulative Update Package
Once again, after all of this installations, I like to do a Windows update and if necessary restart the server, this step is not necessary.
However, I would like to mention that until this date, there’s already one Cumulative Update for BizTalk Server 2013 (Cumulative update package 1 for BizTalk Server 2013) that you should install to solve or fix minor problems that were detected.
Another great news in BizTalk Server 2013 is that cumulative packages for BizTalk Server will be available for delivery using Microsoft Update:
- Check for windows update
- Notice available fixes for BizTalk Server under optional updates
- Select the update and install
The CU will also be available through the hotfix download as well.
Related links
- BizTalk 2013 Installation and Configuration – Important considerations before set up the server (Part 1)
- BizTalk 2013 Installation and Configuration – Enable Internet Information Services (Part 2)
- BizTalk 2013 Installation and Configuration – Install Windows Identity Foundation (Part 3)
- BizTalk 2013 Installation and Configuration – Install and configure SMTP Server Feature (Part 4)
- BizTalk 2013 Installation and Configuration – Install Microsoft Office Excel 2013 (Part 5)
- BizTalk 2013 Installation and Configuration – Install Visual Studio 2012 (Part 6)
- BizTalk 2013 Installation and Configuration – Install SQL Server 2012 (Part 7)
- BizTalk 2013 Installation and Configuration – Configure SQL Server Database Mail feature (Part 8)
- BizTalk 2013 Installation and Configuration – Install and Configure BizTalk Server 2013 (Part 9)
- BizTalk 2013 Installation and Configuration – Configure SQL Server Network Configuration protocols (Part 10)
- BizTalk 2013 Installation and Configuration – Validate Mail account used by BizTalk to send BAM Alerts (Part 11)
- BizTalk 2013 Installation and Configuration – Installing BizTalk Adapter Pack (Part 12)
- BizTalk 2013 Installation and Configuration – Install and Configure Microsoft UDDI Services (Part 13)
- BizTalk 2013 Installation and Configuration – Configure BizTalk Server SQL Jobs (Part 15)
- BizTalk 2013 Installation and Configuration – Configure BizTalk Server Windows Services (Part 16)
Hope you find this helpful! If you liked the content or found it useful and would like to support me in writing more, consider buying (or helping to buy) a Star Wars Lego set for my son.
Thank for the post. Any guide on how to installed/configure ESB management portal (ESB toolkit 2,3)