Export (0) Print
Expand All

BizTalk Accelerator for HL7 Management Pack Guide

Microsoft Corporation

November 2004

This document describes how to deploy and configure the sample HL7 Management Pack (MOM Pack). It also describes the integration of Microsoft BizTalk Accelerator for HL7 (BTAHL7) 1.0 Windows Performance Counters and Windows Management Instrumentation (WMI) events with Microsoft Operations Manager 2005 (MOM). (10 pages)

Microsoft BizTalk Accelerator for HL7 1.0 (BTAHL7)

Microsoft Operations Manager Server 2005 (MOM)

This document describes how to deploy and configure the sample HL7 Management Pack (MOM Pack). It also describes the integration of Microsoft BizTalk Accelerator for HL7 (BTAHL7) 1.0 Windows Performance Counters and Windows Management Instrumentation (WMI) Events with Microsoft Operations Manager 2005 (MOM).

After completing the deployment, you can monitor the connectivity and health of Minimal Lower Layer Protocol (MLLP)-based end points and load patterns of the HL7 processing engine. You can use MOM to monitor multiple BTAHL7 computers.

It is also possible to integrate the HL7 Management Pack with other management packs to present a holistic view of the status of deployed servers, as shown in Figure 1.

Figure 1 MOM state view presents overall server health

ms864768.Local_-1684735156_stateviews(en-US,BTS.10).gif

The MOM Pack enables proactive and reactive monitoring of BTAHL7-enabled end point connections and throughput metrics.

It provides monitoring of Microsoft BizTalk Server functionality in the following areas:

  • BTAHL7 availability monitoring
  • BTAHL7 performance monitoring
  • Public views of BTAHL7 computers, events, alerts, state, and groups in the MOM Operator Console

It is recommended that you install and use the Microsoft BizTalk Server 2004 Management Pack from http://go.microsoft.com/fwlink/?LinkId=39582 and the Microsoft SQL Server 2000 Management Pack from http://go.microsoft.com/fwlink/?LinkId=39583 in conjunction with the BTAHL7 MOM Pack. Use of the three management packs will give you many event, alert, and performance rules related to your BTAHL7 solution.

To deploy and operate the BizTalk Accelerator for HL7 Management Pack, it is recommended that you possess the following knowledge and skills:

  • Have a working knowledge of the Microsoft Operations Manager 2005 (MOM) monitoring features.
  • Be familiar with the recommended process for deploying Management Packs as described in Chapter 6, "Deploying MOM 2005 Management Packs", in the Microsoft Operations Manager 2005 Deployment Guide.
  • Have an administrative and working knowledge of Microsoft BizTalk Server 2004 and BizTalk Accelerator for HL7 1.0.

Monitoring Scenarios

BizTalk Accelerator for HL7 Management Pack monitors key data points to ensure the availability and performance of BTAHL7. MOM Pack performs monitoring using data generated by the MLLP adapter in the form of WMI events and performance counters (see Figure 2). WMI events provide information about the connection status (connectivity and state transitioning); while performance counters provide throughput data.

MOM Pack provides configuration through event and performance rules to enable the MOM server to collect, process, and present the data to the users on the MOM 2005 Operator Console.

Figure 2 WMI Events and Performance Counters Used by the MOM Pack

ms864768.Local_-1779590499_wmieventsbymom(en-US,BTS.10).gif

Event Rules: WMI Events Reporting Connection Status and Health

BizTalk Accelerator for HL7 MOM Pack monitors the ConnectDown, ConnectUp, MessageFailed, and MessageOK events to ensure the availability and processing health of the MLLP adapter end points. Because the MLLP adapter in BTAHL7 generates these events, similar events and alerts may currently not be available to other BizTalk Server adapters.

The events raised for the MLLP adapter connection status and message processing status are the following:

  • MLLP adapter connection status by WMI event provider type. This class of WMI event applies to the send and receive MLLP adapters.
  • ConnectDown (event rule name MLLPConnectDown). This event indicates that the MLLP adapter cannot open a new or reuse an existing connection with the partner application. This event is only raised the first time that such an attempt fails. Subsequent attempts are filtered out to make sure that duplicate error events are not raised. This WMI event is configured to generate an alert with the alert severity level set to Error. This classification is configured according to the guidelines of the HL7.org MLLP Specification, which requires permanence of connections.
  • ConnectUp (event rule name MLLPConnectUp). This event indicates that the MLLP send adapter successfully opened a new connection or reused an existing connection with the designated destination application. This WMI event is not configured to generate an alert.
  • MLLP adapter message processing status (not to be confused with HL7 Schema-XSD-based validation) by WMI event provider type.
  • MessageFailed (event rule name MLLPMessageFailed). This event indicates that the MLLP receive adapter processed a data stream with wrappers that are not valid (Start Block or End Block), or an expected state transition did not occur. This event is only raised by the first failure on the BizTalk Server receive port. Subsequent failures are filtered out to make sure that duplicate error events are not raised. This WMI event is configured to generate an alert with the alert severity level set to Error. This event is not applicable for the send adapter since it applies to the configured wrappers.
  • MessageOK (event rule name MLLPMessageOK). This event indicates that the MLLP receive adapter successfully processed a data stream from a source application. This WMI event is not configured to generate an alert.

The following table lists the event rules that BizTalk Accelerator for HL7 Management Pack deploys. MOM Pack preconfigures MLLPConnectDown and MLLPMessageFailed to raise alerts.

Table 1 List of event rules that BizTalk Accelerator for HL7 Management Pack deploys

Rule name Description Converted to alert level

MLLPConnectDown

The adapter cannot open a new or reuse an existing connection.

Error

ConnectUp

The adapter opened a new or reused an existing connection.

MessageFailed

The receive adapter processed a data stream with wrappers that are not valid or an expected state transition did not occur.

Error

MessageOk

The receive adapter processed a data stream with valid wrappers and the expected state transition occurred.

Performance Rules: Counters Reporting Message Processing Health

Performance counters generated by the MLLP adapter report throughput data that indicates message-processing health. Performance rules installed by MOM Pack make this available for monitoring on the MOM 2005 Operator Console (see Figure 3).

Figure 3 Performance data displayed by the MOM Pack

ms864768.Local_-1428598263_performancebymom(en-US,BTS.10).gif

The following table lists the performance rules that BizTalk Accelerator for HL7 Management Pack deploys to monitor data points/performance counters that the MLLP adapter generates.

Table 2 List of performance rules used to monitor data points/performance counters that the MLLP adapter generates

Rule name Description Configuration

MllpBytesCounter

The count of bytes of the payload (excluding wrappers) of all documents received or sent. This is an incremental or cumulative counter.

Enabled as a rule

MllpBytesPerSecondCounter

The current throughput of the payload received or sent. This counter presents instantaneous values.

Enabled as a rule

MllpDocumentsFailedCounter

In a receive scenario, this counts the number of documents not delivered to the MessageBox database.

In a send scenario, this counts the number of documents not delivered to the remote application. This is an incremental or cumulative counter.

Enabled as a rule

MllpDocumentsProcessedCounter

In a receive scenario, this counts the number of documents successfully delivered to the MessageBox database.

In a send scenario, this counts the number of documents successfully delivered to the remote application. This is an incremental or cumulative counter.

Enabled as a rule

Deployment

The BTAHL7 MOM system includes a management group with MOM management servers and console computers, and BTAHL7 agent computers (see Figure 4).

Figure 4 MOM management system for BTAHL7

ms864768.Local_1635627689_mgmtgroup(en-US,BTS.10).gif

To deploy Microsoft Operations Manager and BizTalk Accelerator for HL7 Management Pack, you must follow these steps in the order shown:

  1. Install QFE 890349.
  2. Install MOM on the management server.
  3. Install BTAHL7 Management Pack.
  4. Update registry key entries for WMI events.
  5. Import MOM Management Pack onto the management server.
  6. On the management server, add the agent computers to the computer group.
  7. Install the MOM agent on each agent computer (from the management server).

Installing QFE 890349

After installing BTAHL7, you need to install QFE 890349. This QFE resolves an issue with how the MLLP adapter raises the ConnectDown event. You can get this QFE from Microsoft Product Support Services.

Installing MOM

Install Microsoft Operations Manager 2005 (MOM) on a server that you designate as the MOM management server. To do this, see "Installing MOM 2005 on a Single Computer" or "Deploying MOM 2005 Across Multiple Computers" in the MOM 2005 Deployment Guide.

Installing BTAHL7 Management Pack

After unzipping the package, install the file BTAHL7 Management Pack.akm in the <drive>:\Program Files\Microsoft Operations Manager\Management Packs folder.

Creating Registry Key Entry

To generate the WMI events, you must first create, and set the value of an EnableMLLPWmiNotification registry key entry (see Figure 5).

To enable MLLP WMI notifications
  1. Click Start, click Run, type RegEdit, and then click OK.

  2. In Registry Editor, expand My Computer, expand HKEY_LOCAL_MACHINE, expand SOFTWARE, and then expand Microsoft BizTalk Accelerator for HL7.

  3. Right-click Version 1.0, point to New, and then click String Value.

  4. In the right pane, name the value EnableMLLPWmiNotification.

  5. Double-click EnableMLLPWmiNotification in the right pane.

  6. In the Edit String dialog box, type EnableMLLPWmiNotifications as the value data. Click OK.

  7. Close Registry Editor.

  8. Restart the BizTalk Service.

This update is required on each BTAHL7 server that the MOM server will monitor.

Figure 5 Setting the EnableMLLPWmiNotification registry key

ms864768.Local_820975577_enablemllp(en-US,BTS.10).gif

Importing the Management Pack

After you install MOM on the management server, you must import BTAHL7 Management Pack onto that management server. After doing this, you must import other management packs onto the management server, including BizTalk Server 2004 Management Pack and Microsoft SQL Server 2000 Management Pack.

To import BTAHL7 Management Pack
  1. Log on to the management server as an administrator.

  2. Click Start, point to All Programs, point to Microsoft Operations Manager 2005, and then click Administrator Console.

  3. In the left pane of the Administrator Console, expand Microsoft Operations Manager, and then right-click Management Packs.

  4. Click Import/Export Management Pack.

  5. In the Welcome screen, click Next.

  6. In the Import or Export Management Packs screen, click Import Management Packs and/or reports.

  7. In the Select a Folder and Choose Import Type screen, locate C:\Program Files\Microsoft Operations Manager 2005\Management Packs, click Import Management Packs only, and then click Next.

  8. In the Select Management Packs screen, select BTAHL7 Management Pack.akm.

  9. In the Import Options section, select Update existing Management Pack and Backup existing Management Pack, and then click Next.

  10. Click Finish.

When you import BTAHL7 Management Pack onto the management server, the management pack creates the BTAHL7 computer group. The computer group should contain all computers that the operations staff will monitor, and can contain sub-hierarchies.

In the next topic, you add agent computers to the BTAHL7 computer group.

Adding Agent Computers

To enable the MOM management server to display monitoring information from another computer, add that computer to the BTAHL7 computer group.

To add an agent computer
  1. Log on to the management server as an administrator.

  2. Click Start, point to All Programs, point to Microsoft Operations Manager 2005, and then click Administrator Console.

  3. In the left pane of the Administrator Console, expand Microsoft Operations Manager, expand Management Packs, and then expand Computer Groups.

  4. Right-click BTAHL7, and then click Properties.

  5. In the Properties dialog box, on the Included Computers tab, click Add.

  6. Click New, in the Domain Name box, type a domain name, in the Computer Name box, type a computer name, and then click OK.

  7. Click OK, and then click OK again.

Installing the MOM Agent

After you add the agent computer to the BTAHL7 computer group, you install the MOM agent on the agent computer.

To install the MOM agent on the agent computer
  1. Log on to the management server as an administrator.

  2. Click Start, point to All Programs, point to Microsoft Operations Manager 2005, and then click Administrator Console.

  3. In the left pane of the Administrator Console, expand Microsoft Operations Manager, then Administration, and then Computer.

  4. Right-click All Computers, and then click Install/Uninstall Agents Wizard.

  5. On the Welcome page, click Next.

  6. On the Install or Uninstall Agents page, click Install Agents, and then click Next.

  7. On the Method for Discovering Computers and Installing Agents page, click Browse to locate, or type, specific computer names, and then click Next.

  8. On the Computer Names page, click Browse.

  9. On the Select Computers page, type the computer name, click OK, and then click Next.

  10. On the Agent Installation Permissions page, select Management Server Action Account (the default), and then click Next.

  11. On the Agent Action Account page, select Local System, or click Other and add an account to use for the agent action, and then click Next.

  12. On the Agent Installation page, select the local directory where the wizard will install the MOM agent, and then click Next.

  13. On the Completing page, review your selections, and then click Finish.

Configuration

You can change the configuration of event, alert, or performance rules in the MOM 2005 Administration Console. After changing the configuration, commit the changes by right clicking the Management Packs node (under the Microsoft Operations Manager node), and then click Commit Configuration Change.

Generating Alerts from Events

By default, the MessageFailed and ConnectDown events generate alerts, and the MessageOk and ConnectUp events do not. You can change which events generate alerts. By default, set up sets the Alert severity property to Error, but you can change it to any one of the other severity settings.

To set an event to generate an alert
  1. Log on to the management server as an administrator.

  2. Click Start, point to All Programs, point to Microsoft Operations Manager 2005, and then click Administrator Console.

  3. In the left pane of the Administrator Console, expand Microsoft Operations Manager (%server name%), expand Management Packs, expand Rule Groups, click BTAHL7 Group, and then click Event Rules.

  4. Right-click the rule that you want to set an alert for, and then click Properties.

  5. In the Properties dialog box, on the Alert tab, click Generate alert.

  6. In the Alert severity box, select the severity of the alert, and then click OK.

Figure 6 shows the alert tab of the Event Rule Properties dialog box for the ConnectDown WMI event.

Figure 6 Event Rule Properties

ms864768.Local_-1736212142_mom2005admconsole(en-US,BTS.10).gif

Setting the Data Sampling Frequency

The MOM Pack sets the data sampling frequency for performance rules to one time every 15 minutes. If you have to change the data sampling frequency, you can do so in the MOM 2005 Operator Console.

To set the data sampling frequency
  1. Log on to the management server as an administrator.

  2. Click Start, point to All Programs, point to Microsoft Operations Manager 2005, and then click Administrator Console.

  3. In the left pane of the Administrator Console, expand Microsoft Operations Manager (%server name%), expand Management Packs, expand Rule Groups, click BTAHL7 Group, and then click Performance Rules.

  4. Double-click the rule for which you want to set the timing.

  5. In the Performance Measure Rule Properties dialog box, on the Data Provider tab, in the Provider name box, select the data provider for which you want to change the timing, and then click Modify.

  6. In the Windows NT Performance Counter Provider Properties dialog box, in the Sample every box, type an interval amount, and select the unit of time, if it is required.

  7. Click OK, and then click OK again.

Figure 7 Setting the data sampling frequency

ms864768.Local_-86378957_mom2005admconsoleproperties(en-US,BTS.10).gif

Operations

You monitor information in the MOM 2005 Operator Console. You only need a user account to display the MOM 2005 Operator Console. Use the following step to open the MOM 2005 Operator Console.

To open the MOM 2005 Operator Console
  • Click Start, point to All Programs, point to Microsoft Operations Manager 2005, and then click Administrator Console.

The Operator Console contains tabs for Alerts, State, Events, and Performance Counters, all which display information of interest to you in monitoring BTAHL7.

It is a best practice to review and prioritize all alerts daily. The alert dashboard is the default display on the console. It provides details about which events involve failures. You should also perform other tasks regularly, depending on your environment. Many important problems do not cause alerts, but they still may require periodic attention.

You should also verify daily that all servers running BizTalk Server and SQL Server are successfully communicating with the MOM Administrator console.

You can perform the tasks as specified in this paper, and you can adjust the frequency of these tasks to meet the needs of your particular environment.

Interpreting Event Information

You can find detailed information about an event in the machineName property. This property indicates on which computer the event occurred. The message property indicates what occurred. For example, the message property may contain information about the connection in the following form: recv:test:127.0.0.1:2980. This information means the following:

  • Recv: The Minimal Lower Layer Protocol (MLLP) receive adapter processes the message.
  • Test: The name of the connection. Based on this information, you can determine which port MLLP is listening on.
  • 127.0.0.1: The IP address of the remote entity sending the message to MLLP.
  • 2980: The port of the remote entity involved in the message exchange.
    ms864768.note(en-US,BTS.10).gifImportant
    In this version of BTAHL7 Management Pack, the Alert Details pane of the MOM screen does not display the alert details as name-value pairs, and some of the alert details are not fully populated. This can make it difficult to interpret the properties of the event. All event information is available in the event message. In future versions of the Management Pack, the Alert Details pane will display alert details in fully populated and correctly formatted name-value pairs.

State

For each computer, the State pane displays a single entry. If there is an error alert, the state entry will be Error. If there is no error alert, but only success events, the state entry will be Success. The State pane (see Figure 1) provides the highest-level troubleshooting information, indicating those computers that are in an error condition and those that are in a success condition. As soon as you set the alert resolution state for the final alert to Resolved, the state changes to Success.


By following the procedures in this technical paper, you can deploy and configure the "sample" HL7 Management Pack (MOM Pack). You can also integrate BTAHL7 1.0 Windows Performance Counters and Windows Management Instrumentation (WMI) Events with MOM 2005. This enables you to monitor the connectivity and health of MLLP-based end points and load patterns of the HL7 processing engine.

For more information, see the following documentation:

Show:
© 2014 Microsoft