Installing the new BizTalk Health Monitor snap-in on Biztalk Server 2010 or BizTalk Server 2013

BizTalk Health Monitor is a snap-in, basically it’s the same of BizTalk MsgBoxViewer tool that we used to monitor a BizTalk environment by gathering all information of a BizTalk group and detecting any issues, non-critical or critical warnings to detect any potential problems in advance, but in this case is integrated more closely with the BizTalk Administration Console to provide BizTalk administrators a quick and complete dashboard of a BizTalk group which will help them monitor the health of their BizTalk platform.

You can see more info about BizTalk Health Monitor (BHM) at:

BHM was originally released as a new feature with BizTalk Server 2013 R2 but luckily for us, Microsoft decided to release a standalone version of BHM for use with BizTalk Server 2010 and BizTalk Server 2013.

You can download the standalone version of BHM from Microsoft Download Center here: BizTalk Health Monitor

How to install BizTalk Health Monitor snap-in

Prerequisites:

  • BizTalk Server 2010 or 2013 should be installed and configured.

How to register BizTalk Health Monitor Snap-In

After you download and unzip the BHM.ZIP file from the Microsoft Download Center, you the “InstallUtil.exe” which comes with BizTalk Health Monitor tool to register the BHM snap-in.

Important: You shouldn’t replace or create a new BHM folder under “C:\Program Files (x86)\Microsoft BizTalk Server 2013 R2\SDK\Utilities\Support Tools” otherwise you will have issues installing BizTalk cumulative updates (see BizTalk 2013 R2 CU1 install failing with “Package does not contain compatible branch patch”)

Important: Unzip the BHM.ZIP to a final destination before you register the snap-in for example: C:\Program Files (x86)\Microsoft BizTalk Support Tools\BHM. Once you register the BizTalk Health Monitor Snap-In you cannot delete the folder or BHM will stop working

Note: New versions of the BHM snap-in (version 3.1) don’t include anymore the “InstallUtil.exe” file

  • You can still use the old “InstallUtil.exe” file to register the snap-in (but you need to copy this file to the BHM folder)
  • But instead you should use now the “BHMSetup.exe” file which will register in a more simpler way the snap-in (see BizTalk Health Monitor v3.1 released!)

To accomplish that we need to:

  • Open a command prompt as an administrator
  • Navigate to the directory file where you unzipped the BHM.ZIP file
    • For example C:\Program Files (x86)\Microsoft BizTalk Support Tools\BHM
  • And from the command prompt type:
    • InstallUtil.exe MBVSnapIn.dll
  • And hit enter. This step will do some registry changes and register the SnapIn to be used

How to integrate BHM Snap-In into BizTalk Admin Console

Important note: BHM Snap-In can be used independently and don’t need to be integrated with the BizTalk Administration Console. The handicap of this approach is that a BizTalk Administration will need to use two different places/tools to monitor and administrate the environment.

To be easier and more convenience for BizTalk Administrators BHM Snap-In can also be integrated it so that it can be used with BizTalk Administration Console.

To accomplish that we need to open a 32-bit Microsoft Management Console (MMC):

  • Click Start, click Run, type:
    • mmc /32
  • Press enter or click OK. This will open a new 32-bit version of MMC (MMC32).
  • From MMC console, go to File menu and select “Options…” option
    • In the text box, replace “Console1” for “BizTalk Administration Console”
    • In the Console mode combo box, select “User mode – full access”
    • And confirm that the option “Do not save changes to this console” is unchecked
MMC console properties
  • From MMC console, go to File menu and select “Add/Remove Snap-in…” option
MMC window Add Remove Snap-in
  • From the “Add or Remove Snap-ins” window, add following snap-ins and then click Ok
    • Microsoft BizTalk Server Administration
    • BizTalk Health Monitor
MMC window Add or Remove Snap ins selection
  • You can add the snap-ins by selecting them from the “Available snap-ins” list and click “Add >”
  • Is recommend that you respect the order present in the “Selected snap-ins” list as shown in the picture above
new BizTalk Administration Console

Now you might want to save this as a new .msc file so that you don’t have to repeat these steps again but before we complete the creation process of the “new” BizTalk Administration Console, I recommend that you navigate to the BizTalk Server Installation folder:

  • Example: C:\Program Files (x86)\Microsoft BizTalk Server 2010
  • And rename “BTSmmc.msc” file, for example: “BTSmmc-old.msc”

This because we will save the “new” BizTalk Administration Console as “BTSmmc.msc” so that you don’t need to create new shortcuts or having different ways to access the BizTalk Administration Console, however, this step is optional!

To finish the creation process of the “new” BizTalk Administration Console

  • From MMC console, go to File menu and select “Save As…” option:
    • Give a name and then save it.
      • Access to BizTalk Server Installation folder
        • C:\Program Files (x86)\Microsoft BizTalk Server 2010
      • Save the file as “BTSmmc.msc”

From next time onwards, when you open the BizTalk Server Administration Console

start BizTalk Administration Console

The “new” BizTalk Administration Console will be incorporated with the BizTalk Health Monitor

BizTalk Administration Console with BizTalk Health Monitor

You can download the standalone version of BHM from Microsoft Download Center here: BizTalk Health Monitor

Author: Sandro Pereira

Sandro Pereira lives in Portugal and works as a consultant at DevScope. In the past years, he has been working on implementing Integration scenarios both on-premises and cloud for various clients, each with different scenarios from a technical point of view, size, and criticality, using Microsoft Azure, Microsoft BizTalk Server and different technologies like AS2, EDI, RosettaNet, SAP, TIBCO etc. He is a regular blogger, international speaker, and technical reviewer of several BizTalk books all focused on Integration. He is also the author of the book “BizTalk Mapping Patterns & Best Practices”. He has been awarded MVP since 2011 for his contributions to the integration community.

6 thoughts on “Installing the new BizTalk Health Monitor snap-in on Biztalk Server 2010 or BizTalk Server 2013”

Leave a Reply

Your email address will not be published. Required fields are marked *

BizTalk360
BizTalk Server

Over 500+ customers across
30+ countries depend on BizTalk360

Learn More
Serverless360
Azure

Manage and monitor serverless
components effortlessly

Learn More
Atomicscope
Business Users

Monitor your Business Activity in iPaaS
or Hybrid integration solutions

Learn More

Back to Top