Updating the BizTalk Server Monitoring Agent

This guide teaches how to update the Microsoft BizTalk Server Monitoring Agent.

Release notes

For information about the releases, please visit the Release Notes for the BizTalk Monitoring Agent.

Running Version

The installed version is displayed in the 'Version' text box.

You can also get this information from the file details property on the local installation:

PreReq: You must have successfully installed the Microsoft BizTalk Server Monitoring Agent prior to an update. The Service account credentials to use must have Logon as Service Right. See Prerequisites for BizTalk Monitoring Agent for more information.

Note
You must be a local administrator to have the right to install (and thereby update) Windows Services.

Compatibility and versioning issues

5.x -> 5.1
- The new Cluster support requires the monitoring database to be updated. This agent tries to perform the update automatically but may fail due to lacking the required access rights. Make sure to update the database during the install process (during setup, an exception message is displayed; Perform the database update manually; then retry the start Service operation)
Review the Agent Database user guide for more information
4.1.0.x -> 4.1.0.y
- Additional features have been added, make sure to review settings and affected Monitor Views after an update
- LogText written by the LogAgents have been modified to never change unless the state does.
4.0 -> 4.1
- Update from older XML configuration based versions requires a re-configuration

Step 1: Start the installer

Double-click on the MSI file to start the update of the Microsoft BizTalk Server Monitoring Agent.

Step 2: Welcome Screen

On successful execution of the MSI file, a Welcome screen is presented.

Click the 'Next' button to continue with the update process or click the 'Cancel' button to quit the installer.

Step 3: Accept End User License Agreement (EULA)

The Licensee is ultimately responsible for making sure Nodinite products are used according to the End User License Agreement. Make sure you have the assigned formal rights to install and perform modifications to the target environment before you continue installing any Nodinite products.

Step 4: Custom Setup

Select Components and Location of installation. Default settings are recommended.

Note
If you change the location your old configuration will be lost

Click the 'Next' button to continue with the update process or click the 'Cancel' button to quit the installer.

Step 5: Service Account Information

Enter the credentials for the Account to run Microsoft BizTalk Server Monitoring Agent. Depending on the connection string settings this account will be used to log on and query the databases being monitored.

Domain: The name of the Domain the Server belongs to. If a local account is being used, use the name of the server or a . (dot) as Domain
User: The name of the account
Password: The password for the account.

Note
The account must have 'Log on as Service Right'

Click the 'Next' button to continue with the update process or click the 'Cancel' button to quit the installer.

Insufficient Privileges

Error message when account information does not meet Prerequisites.

If you get this message, the most common reason is that the account is not allowed to run as a service or is not a local Administrator on the server. Follow the guide How to set Logon as a Service right and click retry. If the problem remains, click cancel and restart. Make sure to enter valid credentials!

Tip
Check the local event log if there are errors (both System and Application)

Step 6: Completed setup

The last step of the update process gives either a success or a premature exit.

Successful update example.

Click the 'Finish' button to Exit and quit the installer (update process).

When the setup has finished the default text editor will open a text file named the 'README.txt'. The README.txt file holds additional information that you need to manage the agent as a Monitoring Agents.