Microsoft BizTalk Server agent: User's Guide

IBM Tivoli Composite Application Manager for MicrosoftApplications: Microsoft BizTalk Server AgentVersion 6.3

User's Guide

SC23-9757-05

��

NoteBefore using this information and the product it supports, read the information in “Notices” on page 337.

This edition applies to version 6.3 of IBM Tivoli Composite Application Manager for Microsoft Applications:Microsoft BizTalk Server Agent (product number 5724-U17) and to all subsequent releases and modifications untilotherwise indicated in new editions.

© Copyright IBM Corporation 2010, 2011.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Chapter 1. Overview of the agent

The IBM Tivoli Composite Application Manager for Microsoft Applications: Microsoft BizTalk ServerAgent provides you with the capability to monitor Microsoft BizTalk Server.

IBM® Tivoli® Monitoring is the base software for the Microsoft BizTalk Server agent. The MicrosoftBizTalk Server agent monitors the following functions:v Availability and resourcesv Performancev Error and event logv Historical data

IBM Tivoli MonitoringIBM Tivoli Monitoring provides a way to monitor the availability and performance of all the systems inyour enterprise from one or several designated workstations. It also provides useful historical data thatyou can use to track trends and to troubleshoot system problems.

You can use IBM Tivoli Monitoring to achieve the following tasks:v Monitor for alerts on the systems that you are managing by using predefined situations or custom

situations.v Establish your own performance thresholds.v Trace the causes leading to an alert.v Gather comprehensive data about system conditions.v Use policies to take actions, schedule work, and automate manual tasks.

The Tivoli Enterprise Portal is the interface for IBM Tivoli Monitoring products. You can use theconsolidated view of your environment as seen in the Tivoli Enterprise Portal to monitor and resolveperformance issues throughout the enterprise.

See the IBM Tivoli Monitoring publications listed in “Prerequisite publications” on page 331 for completeinformation about IBM Tivoli Monitoring and the Tivoli Enterprise Portal.

Functions of the monitoring agentAvailability and resource monitoring

Monitors the following components, indicating when the status is down:v BizTalk Server Host Instancesv Base EDIv Enterprise Single Sign-Onv Rule Engine Updatev BizTalk Sharepoint Messaging Adapterv BizTalk Application Statusv Send Portsv Send Port Groupsv Orchestrationsv Receive Locationsv Service Instances

© Copyright IBM Corp. 2010, 2011 1

v Microsoft BizTalk RFID Service

Error and event log monitoringMonitors the following event sources for collecting data related to errors and events that affectthe BizTalk Server availability or performance:v BizTalk Server 2006v BizTalk DW Reportingv BizTalk Server Deploymentv BusinessRulesEnginev BizTalk Server 2004v BizTalk Server 2004 Deploymentv EDI Subsystemv EDI Receiverv EDI Transmitterv ENTSSOv HWSv HWS WMIv BAM EventBus Servicev Bam Aggregated Event Providerv Bam Event Providerv BamManagementUtilityv BAM Portalv BAM Web Servicesv BITS Extensionsv RuleEngineUpdateServicev TDDSEventBusMgmtv Windows SharePoint Services 2.0v Windows SharePoint Services 3v Windows SharePoint Services 3 Error Reportingv Windows SharePoint Services 3 Searchv XLANG/sv MSSQLServerv BizTalk Server 2009v BizTalk Server 2009 EDIv Microsoft BizTalk Adapter Pack v2.0v Microsoft BizTalk Bam Interceptorsv BizTalk Serverv BizTalk Server EDIv MSBizTalkRFID

Performance monitoringCollects performance attributes in the following areas, providing situations where appropriate:v Tracking Data Decode Service (TDDS), also known as BAM Event Busv Messagingv Human Workflow Servicesv Orchestrationsv MessageBox

2 Microsoft BizTalk Server agent: User's Guide

v Adaptersv Host Throttlingv BizTalk .NET Adapter for SAPv BizTalk .NET Adapter for Oracle DBv BizTalk .NET Adapter for Siebelv BizTalk Adapter for Oracle E-Business Suitev BizTalk Adapter for SQLv BizTalk databases attribute groups, such as BAM Database, Management Database, Messagebox

Database, Single Sign-On Database, Tracking Database, and Rule Engine Databasev Configuration and Statusv Microsoft BizTalk RFID Server

Note: The attribute groups related to Adapters and Host Throttling, and situations based onthese attribute groups are not applicable for BizTalk Server 2004.

Take ActionsProvides Take Action commands to start and stop the following services:v BizTalk Server Host Instancesv Rule Engine Update Servicev BizTalk Base EDI Servicev BizTalk SharePoint Messaging Adapter Servicev Microsoft BizTalk RFID Service

Historical dataProvides a history enablement file that enables the agent to generate reports for all attributes thatare collected.

New in this releaseFor version 6.3 of the Microsoft BizTalk Server agent, the following enhancements were made sinceversion 6.2.3, including the fix packs:v Additional supported operating systems, as listed in the Prerequisites topic for the Microsoft BizTalk

Server agent in the IBM Tivoli Composite Application Manager for Microsoft Applications InformationCenter

v Added self-describing agent support for the monitoring agent to generate agent support files as part ofthe agent image

v Updated kqb.baroc file to support Tivoli Enterprise Console® event mapping changesv Added the prerequisites checking utility to verify prerequisites before agent is installed or upgradedv Added new Cognos® data models and reportsv Integration with Tivoli Business Service Manager V6.1, or laterv Integration with Tivoli Application Dependency Discovery Manager (TADDM)v Added the RFID Navigator itemv New attribute groups:

– RFID Devices– RFID Processes– Send Port Group Status– BizTalk Host– BizTalk Server

v New or changed attributes in the following attribute groups:

Chapter 1. Overview of the agent 3

– Messagebox Database– Send Port Status– Receive Location Status– Availability– Service Instance Status and Class

v New situations:– KQB_RFID_Service_StartUpFail– KQB_RFID_Device_Conn_Fail– KQB_RFID_ProcessEngine_Fatal– KQB_RFID_ProcessEng_MaxRestart– KQB_RFID_Service_Auth_Fail– KQB_RFID_DeviceName_Conflict– KQB_RFID_Device_Disabled– KQB_RFID_InsufPrivil_On_Dev– KQB_RFID_Dev_StateSave_Fail– KQB_Send_Port_Group_Stopped– KQB_Host_Inst_Crashed– KQB_No_Host_Instance– KQB_RFID_Service_Down

v New workspaces:– RFID– BizTalk Group Topology

v New or changed workspaces:– Current Status– Databases

v New Take Action commands:– Start Send Port Group– Stop Send Port Group– Start Microsoft BizTalk RFID Service– Stop Microsoft BizTalk RFID Service

Components of the IBM Tivoli Monitoring environmentAfter you install and set up the Microsoft BizTalk Server agent, you have an environment that containsthe client, server, and monitoring agent implementation for Tivoli Monitoring.

This Tivoli Monitoring environment contains the following components:

Tivoli Enterprise Portal clientThe portal has a user interface based on Java™ for viewing and monitoring your enterprise.

Tivoli Enterprise Portal ServerThe portal server is placed between the client and the Tivoli Enterprise Monitoring Server andenables retrieval, manipulation, and analysis of data from the monitoring agents. The TivoliEnterprise Portal Server is the central repository for all user data.

Tivoli Enterprise Monitoring ServerThe monitoring server acts as a collection and control point for alerts received from themonitoring agents, and collects their performance and availability data. The Tivoli EnterpriseMonitoring Server is also a repository for historical data.


Tivoli Enterprise Monitoring Agent, Microsoft BizTalk Server agentThis monitoring agent collects data and distributes the data to the Tivoli Enterprise MonitoringServer, Tivoli Enterprise Portal Server, Tivoli Enterprise Portal, Tivoli Data Warehouse, and TivoliIntegrated Portal.

IBM Tivoli Netcool/OMNIbusTivoli Netcool/OMNIbus is an optional component and the recommended event managementcomponent. The Netcool/OMNIbus software is a service level management (SLM) system thatdelivers real-time, centralized monitoring of complex networks and IT domain events. Eventinformation is tracked in a high-performance, in-memory database and presented to specific usersthrough individually configurable filters and views. The software includes automation functionsthat you can use to perform intelligent processing on managed events. You can use this softwareto forward events for Tivoli Monitoring situations to Tivoli Netcool/OMNIbus.

IBM Tivoli Enterprise ConsoleThe Tivoli Enterprise Console is an optional component that acts as a central collection point forevents from various sources, including events from other Tivoli software applications, Tivolipartner applications, custom applications, network management platforms, and relationaldatabase systems. You can view these events through the Tivoli Enterprise Portal (by using theevent viewer), and you can forward events from Tivoli Monitoring situations to the TivoliEnterprise Console component. If you do not already use Tivoli Enterprise Console and need anevent management component, you can choose to use IBM Tivoli Netcool/OMNIbus.

IBM Tivoli Common ReportingTivoli Common Reporting is a separately installable feature available to users of Tivoli softwarethat provides a consistent approach to generating and customizing reports. Some individualproducts provide reports that are designed for use with Tivoli Common Reporting and have aconsistent look and feel.

IBM Tivoli Application Dependency Discovery Manager (TADDM)TADDM delivers automated discovery and configuration tracking capabilities to build applicationmaps that provide real-time visibility into application complexity.

IBM Tivoli Business Service ManagerThe Tivoli Business Service Manager component delivers real-time information to help yourespond to alerts effectively based on business requirements. Optionally, you can use thiscomponent to meet service-level agreements (SLAs). Use the Tivoli Business Service Managertools to help build a service model that you can integrate with Tivoli Netcool/OMNIbus alerts oroptionally integrate with data from an SQL data source. Optional components provide access todata from other IBM Tivoli applications such as Tivoli Monitoring and TADDM.

Agent Management ServicesYou can use IBM Tivoli Monitoring Agent Management Services to manage the Microsoft BizTalk Serveragent.

Agent Management Services is available for the following IBM Tivoli Monitoring OS agents: Windows,Linux, and UNIX. The services are designed to keep the Microsoft BizTalk Server agent available, and toprovide information about the status of the product to the Tivoli Enterprise Portal. For more informationabout Agent Management Services, see Agent Management Services in the IBM Tivoli MonitoringAdministrator's Guide. IBM Tivoli Monitoring V6.2.2, Fix Pack 2 or later provides support for AgentManagement Services.


User interface optionsInstallation of the base IBM Tivoli Monitoring software and other integrated applications providesvarious interfaces that you can use to work with your resources and data.

The following interfaces are available:

Tivoli Enterprise Portal user interfaceYou can run the Tivoli Enterprise Portal as a desktop application or a browser application. Theclient interface is a graphical user interface (GUI) based on Java on a Windows or Linuxworkstation. The browser application is automatically installed with the Tivoli Enterprise PortalServer. The desktop application is installed by using the Tivoli Monitoring installation media orwith a Java Web Start application. To start the Tivoli Enterprise Portal browser client in yourInternet browser, enter the URL for a specific Tivoli Enterprise Portal browser client installed onyour Web server.

Command-line interfaceYou can use Tivoli Monitoring commands to manage the Tivoli Monitoring components and theirconfiguration. You can also run commands at the Tivoli Enterprise Console event server or theTivoli Netcool/OMNIbus ObjectServer to configure event synchronization for enterprisesituations.

Manage Tivoli Enterprise Monitoring Services windowYou can use the window for the Manage Tivoli Enterprise Monitoring Services utility to configurethe agent and start Tivoli services not designated to start automatically.

IBM Tivoli Netcool/OMNIbus event listYou can use the Netcool/OMNIbus event list to monitor and manage events. An event is createdwhen the Netcool/OMNIbus ObjectServer receives an event, alert, message, or data item. Eachevent is made up of columns (or fields) of information that are displayed in a row in theObjectServer alerts.status table. The Tivoli Netcool/OMNIbus web GUI is also a web-basedapplication that processes network events from one or more data sources and presents the eventdata in various graphical formats.

IBM Tivoli Enterprise ConsoleYou can use the Tivoli Enterprise Console to help ensure the optimal availability of an IT servicefor an organization. The Tivoli Enterprise Console is an event management application thatintegrates system, network, database, and application management. If you do not already useTivoli Enterprise Console and need an event management component, you can choose to useTivoli Netcool/OMNIbus.

IBM Tivoli Common ReportingUse the Tivoli Common Reporting web user interface for specifying report parameters and otherreport properties, generating formatted reports, scheduling reports, and viewing reports. Thisuser interface is based on the Tivoli Integrated Portal.

IBM Tivoli Application Dependency Discovery ManagerThe Discovery Management Console is the TADDM client user interface for managingdiscoveries.

IBM Tivoli Business Service ManagerThe Tivoli Business Service Manager console provides a graphical user interface that you can useto logically link services and business requirements within the service model. The service modelprovides an operator with a second-by-second view of how an enterprise is performing at anymoment in time or how the enterprise performed over a time period.


Data sourcesMonitoring agents collect data from specific data sources.

The Microsoft BizTalk Server agent collects data from the following sources:

WMI You can use WMI (Windows Management Instrumentation) to monitor and control managedresources throughout the network. Resources include hard drives, file systems, operating systemsettings, processes, services, shares, registry settings, networking components, event logs, users,and groups. WMI is built into clients with Windows 2000 or later, and can be installed on any32-bit Windows client.

PerfmonYou can use the Windows Performance Monitor, or Perfmon, to view various system andapplication performance metrics for collection and use by management applications. You typicallyview system metrics on a Windows system through the 'perfmon' application.

AvailabilityYou can use the agent to monitor availability of the application and related components in thefollowing ways:v Monitor the status of the processes.v Monitor the Windows services used by the application.v Perform application-specific tests (such as API calls).

ScriptsYou can use the agent's application-specific commands and interfaces to gather metrics.

Log filesYou can use the agent's file system to monitor application log files or other data files to gathermetrics.

Windows Event LogYou can use the agent to collect Windows Event Log entries that are related to the monitoredresource and forwards them to IBM Tivoli Monitoring.

The following table shows each attribute group and the mechanism that is used to gather the attributes.

Table 1. Mechanisms used to gather attributes

Attribute group Collection source

Availability Windows services and processes

Event Log Windows Event Log

Performance Object Status Agent

Host Throttling Perfmon

TDDS Perfmon

Human Workflow Services Perfmon

Orchestrations Perfmon

Messaging Perfmon

Messaging Latency Perfmon

Message Box General Counters Perfmon

Message Box Host Counters Perfmon

File Receive Adapter Perfmon

File Send Adapter Perfmon

FTP Receive Adapter Perfmon


Table 1. Mechanisms used to gather attributes (continued)


FTP Send Adapter Perfmon

POP3 Receive Adapter Perfmon

SMTP Send Adapter Perfmon

HTTP Receive Adapter Perfmon

HTTP Send Adapter Perfmon

SOAP Receive Adapter Perfmon

SOAP Send Adapter Perfmon

Windows SharePoint Services Perfmon

MSMQ Receive Adapter Perfmon

MSMQ Send Adapter Perfmon

SQL Receive Adapter Perfmon

SQL Send Adapter Perfmon

BizTalk NET Adapter for Oracle DB Perfmon

BizTalk NET Adapter for Oracle EBusiness Suite Perfmon

BizTalk NET Adapter for SAP Perfmon

BizTalk NET Adapter for Siebel Perfmon

BizTalk NET Adapter for SQL Perfmon

Windows SharePoint Services Adapter Perfmon

Messagebox Database WMI

Management Database WMI

Rule Engine Database Script

Single Sign On Database Script

BAM Database WMI

Tracking Database WMI

Application Status Custom Code

Send Port Status WMI

Orchestration Status WMI

Receive Location Status WMI

Service Instance Status and Class WMI

BizTalk Group Server Host WMI

BAM Interceptor Perfmon

Distributors WMI

Events WMI

Subscriptions WMI

Notifications WMI

Delivery Channels WMI

Event Providers WMI

Generator WMI

Vacuumer WMI

RFID Devices Perfmon


Table 1. Mechanisms used to gather attributes (continued)


RFID Processes Perfmon

Send Port Group Status WMI

BizTalk Host WMI

BizTalk Server WMI


Chapter 2. Agent installation and configuration

Agent installation and configuration requires the use of the IBM Tivoli Monitoring Installation and SetupGuide and agent-specific installation and configuration information.

To install and configure the Microsoft BizTalk Server agent, use the Installing monitoring agents proceduresin the IBM Tivoli Monitoring Installation and Setup Guide along with the agent-specific installation andconfiguration information.

If you are installing silently by using a response file, see Performing a silent installation of IBM TivoliMonitoring in the IBM Tivoli Monitoring Installation and Setup Guide.

With the self-describing agent capability, new or updated IBM Tivoli Monitoring agents using IBM TivoliMonitoring V6.2.3 or later can become operational after installation without having to perform additionalproduct support installation steps. To take advantage of this capability, see Enabling self-describing agentcapability at the hub monitoring server in the IBM Tivoli Monitoring Installation and Setup Guide. Also, seeSelf-describing monitoring agents in the IBM Tivoli Monitoring Administrator's Guide.

RequirementsBefore installing and configuring the agent, make sure your environment meets the requirements for theIBM Tivoli Composite Application Manager for Microsoft Applications: Microsoft BizTalk Server Agent.

For information about requirements, see the Prerequisites topic for the agent in the IBM Tivoli CompositeApplication Manager for Microsoft Applications Information Center (http://publib.boulder.ibm.com/infocenter/tivihelp/v24r1/topic/com.ibm.itcamms.doc_6.3/welcome_msapps63.html).

Language pack installationThe steps for installing language packs depend on which operating system and mode of installation youare using.

To install a language pack for the agent support files on the Tivoli Enterprise Monitoring Server, theTivoli Enterprise Monitoring Agent, and the Tivoli Enterprise Portal Server, make sure that you installedthe product in the English language. Then use the steps for the operating system or mode of installationyou are using:v “Installing language packs on Windows systems”v “Installing language packs on UNIX or Linux systems” on page 12v “Silent installation of language packs on Windows, UNIX, or Linux systems” on page 12

Installing language packs on Windows systemsYou can install the language packs on a Windows system.

Before you begin

First, make sure that you installed the product in the English language.

Procedure1. On the language pack CD, double-click the lpinstaller.bat file to start the installation program.2. Select the language of the installer and click OK.3. In the Introduction panel, click Next


http://publib.boulder.ibm.com/infocenter/tivihelp/v24r1/topic/com.ibm.itcamms.doc_6.3/welcome_msapps63.html


4. Click Add/Update and click Next.5. Select the folder where the National Language Support package (NLSPackage) files are located.

Typically, the NLSPackage files are located in the nlspackage folder where the installer executablefile is located.

6. Select the language support for the agent of your choice and click Next. To make multiple selections,press Ctrl and select the language that you want.

7. Select the languages that you want to install and click Next.8. Examine the installation summary page and click Next to begin installation.9. After installation completes, click Finish to exit the installer.

10. Restart the Tivoli Enterprise Portal, Tivoli Enterprise Portal Server, and Eclipse Help Server if any ofthese components are installed.

Installing language packs on UNIX or Linux systemsYou can install the language packs on a UNIX or Linux system.

Before you begin


Procedure1. Enter the mkdir command to create a temporary directory on the computer, for example, mkdir

dir_name. Make sure that the full path of the directory does not contain any spaces.2. Mount the language pack CD to the temporary directory that you created.3. Enter the following command to start the installation program: cd dir_name lpinstaller.sh -c

install_dir where install_dir is where you installed IBM Tivoli Monitoring. Typically, the directoryname is /opt/IBM/ITM for UNIX and Linux systems.

4. Select the language of the installer and click OK.5. In the Introduction panel, click Next.6. Click Add/Update and click Next.7. Select the folder where the National Language Support package (NLSPackage) files are located.

Typically, the NLSPackage files are located in the nlspackage folder where the installer executable fileis located.

8. Select the language support for the agent of your choice and click Next. To make multiple selections,press Ctrl and select the language that you want.

9. Select the languages that you want to install and click Next.10. Examine the installation summary page and click Next to begin installation.11. After installation completes, click Finish to exit the installer.12. Restart the Tivoli Enterprise Portal, Tivoli Enterprise Portal Server, and Eclipse Help Server if any of

these components are installed.

Silent installation of language packs on Windows, UNIX, or LinuxsystemsYou can use the silent-mode installation method to install the language packs. In silent mode, theinstallation process obtains the installation settings from a predefined response file. It does not promptyou for any information.

Before you begin



Procedure1. Copy and paste the ITM_Agent_LP_silent.rsp response file template as shown in “Response file

example.”2. Change the following parameter settings:

NLS_PACKAGE_FOLDERFolder where the National Language Support package (NLSPackage) files are located.Typically, the NLSPackage files are located in the nlspackage folder, for example:NLS_PACKAGE_FOLDER = //tmp//LP//nlspackage.

PROD_SELECTION_PKGName of the language pack to install. Several product components can be included in onelanguage package. You might want to install only some of the available components in alanguage pack.

BASE_AGENT_FOUND_PKG_LISTAgent for which you are installing language support. This value is usually the same asPROD_SELECTION_PKG.

LANG_SELECTION_LISTLanguage you want to install.

3. Enter the command to install the language pack with a response file (silent installation):v For Windows systems:

lpinstaller.bat -f path_to_response_file

v For UNIX or Linux systems:lpinstaller.sh -c candle_home -f path_to_response_file

where candle_home is the IBM Tivoli Monitoring base directory.

Response file example# IBM Tivoli Monitoring Agent Language Pack Silent Installation Operation##This is a sample response file for silent installation mode for the IBM Tivoli#Monitoring Common Language Pack Installer.#.#This file uses the IBM Tivoli Monitoring Common Agent Language Pack with the#install package as an example.#Note:#This response file is for the INSTALLATION of language packs only.#This file does not support UNINSTALLATION of language packs in silent mode.#-------------------------------------------------------------------------------#-------------------------------------------------------------------------------#To successfully complete a silent installation of the the example of Common Agent#localization pack, complete the following steps:##1.Copy ITM_Agent_LP_silent.rsp to the directory where lpinstaller.bat or#lpinstaller.sh is located (IBM Tivoli Monitoring Agent Language Pack build#location).##2.Modify the response file so that it is customized correctly and completely for#your site.# Complete all of the following steps in the response file.##3.After customizing the response file, invoke the silent installation using the#following command:#For Windows:# lpinstaller.bat -f <path_to_response_file>#For UNIX and Linux:# lpinstaller.sh -c <candle_home> -f <path_to_response_file>#Note:<candle_home> is the IBM Tivoli Monitoring base directory.#--------------------------------------------------------------------------------

Chapter 2. Agent installation and configuration 13

#--------------------------------------------------------------------------------#Force silent install mode.#--------------------------------------------------------------------------------INSTALLER_UI=silent#---------------------------------------------------------------------------------#Run add and update actions.#---------------------------------------------------------------------------------CHOSEN_INSTALL_SET=ADDUPD_SET#---------------------------------------------------------------------------------#NLS Package Folder, where the NLS Packages exist.#For Windows:# Use the backslash-backslash(\\) as a file separator (for example,#C:\\zosgmv\\LCD7-3583-01\\nlspackage).#For UNIX and Linux:# Use the slash-slash (//) as a file separator (for example,#//installtivoli//lpsilenttest//nlspackage).#---------------------------------------------------------------------------------#NLS_PACKAGE_FOLDER=C:\\zosgmv\\LCD7-3583-01\\nlspackageNLS_PACKAGE_FOLDER=//tmp//LP//nlspackage#---------------------------------------------------------------------------------#List the packages to process; both variables are required.#Each variable requires that full paths are specified.#Separate multiple entries with a semicolon (;).#For Windows:# Use the backslash-backslash(\\) as a file separator.#For Unix and Linux:# Use the slash-slash (//) as a file separator.#---------------------------------------------------------------------------------#PROD_SELECTION_PKG=C:\\zosgmv\\LCD7-3583-01\\nlspackage\\KIP_NLS.nlspkg#BASE_AGENT_FOUND_PKG_LIST=C:\\zosgmv\\LCD7-3583-01\\nlspackage\\KIP_NLS.nlspkgPROD_SELECTION_PKG=//tmp//LP//nlspackage//kex_nls.nlspkg;//tmp//LP//nlspackage//koq_nls.nlspkgBASE_AGENT_FOUND_PKG_LIST=//tmp//LP//nlspackage//kex_nls.nlspkg;//tmp//LP//nlspackage//koq_nls.nlspkg#--------------------------------------------------------------------------------#List the languages to process.#Separate multiple entries with semicolons.#--------------------------------------------------------------------------------LANG_SELECTION_LIST=pt_BR;fr;de;it;ja;ko;zh_CN;es;zh_TW

Prerequisites checkingThe prerequisite checker utility verifies whether all the prerequisites that are required for the agentinstallation are met. The prerequisite checker creates a log file that contains a report of all theprerequisites checks when the prerequisite checker was run.

For the BizTalk Server agent, the prerequisite checker verifies the following requirements:v Memoryv Diskv Operating systemsv BizTalk Server versions

Additionally, the prerequisite checker verifies whether the user, who installs the agent, is a member of theAdministrators group.

For detailed information about installation prerequisites, see the Prerequisites topic for the agent in theIBM Tivoli Composite Application Manager for Microsoft Applications Information Center(http://publib.boulder.ibm.com/infocenter/tivihelp/v24r1/topic/com.ibm.itcamms.doc_6.3/welcome_msapps63.html).



You can run the prerequisite checker in stand-alone mode or remotely. For more information about theprerequisite checker, see "Prerequisite Checking for IBM Tivoli Monitoring Agents" in the IBM TivoliMonitoring Installation and Setup Guide.

Running as a non-administrator userYou can run the monitoring agent for BizTalk Server as a non-administrator user; however, somefunctionality is unavailable. To create a non-administrator user, create a new user (non-administrator) andset up registry permissions for the new user as follows:v Full access to the HKEY_LOCAL_MACHINE\SOFTWARE\Candle directoryv Read access to the HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib

directory

If you define these permissions for a non-administrator user, data is displayed for all the Perfmon-basedattribute groups. See “Data sources” on page 7 for a list of all the Perfmon-based attributes. Thenon-administrator user must be a member of the Performance Monitor Users and Performance Log Users.

The following attribute groups show data for users who are members of the Administrators group:v Availabilityv Messagebox Databasev Management Databasev Rule Engine Databasev BAM Databasev Tracking Databasev Application Statusv Send Port Statusv Orchestration Statusv Receive Location Statusv Service Instance Status and Classv BizTalk Group Server Hostv Send Port Group Statusv BizTalk Serverv BizTalk Host

Configuring the monitoring agent after installationIn addition to the installation and configuration information in the IBM Tivoli Monitoring Installation andSetup Guide, use the information in this section to install and configure the Microsoft BizTalk Serveragent.

No special setup is necessary to manage this application.

Configuration valuesFor both local and remote configuration, you provide the configuration values for the agent to operate.

When you are configuring an agent, a panel is displayed so you can enter each value. When a defaultvalue exists, this value is pre-entered into the field. If a field represents a password, two entry fields aredisplayed. You must enter the same value in each field. The values you type are not displayed to helpmaintain the security of these values.

The configuration for this agent is organized into the following groups:


Configuration for the Application Status attribute group(KQB_APPLICATION_CONFIGURATION_EXE)

You can configure the BizTalk Application Status attribute group by using the graphical interfaceor the command-line interface. The configuration elements defined in this group are alwayspresent in the agent's configuration.

The configuration elements defined in this group are always present in the agent's configuration.

This group defines information that applies to the entire agent.

API File Path (KQB_API_FILEPATH)Type Default or specify the full path of the Microsoft.BizTalk.ExplorerOM.dll file.

The type is string.

This value is required.

The default value is default.

Command-line configuration option for API File Path:KQB_APPLICATION_CONFIGURATION_EXE.KQB_API_FILEPATH

Use Windows Authentication (KQB_DBACCESS_USE_WINDOWS_AUTHENTICATION)Type True or False. If you type False, then specify the database user ID and password. Ifyou type True to select the Windows Authentication mode, you do not have to specify theuser ID and password to access the BizTalk Management database.

The type is string.

This value is required.

The default value is true.

Command-line configuration option for Windows Authentication:KQB_APPLICATION_CONFIGURATION_EXE.KQB_DBACCESS_USE_WINDOWS_AUTHENTICATION

Database User ID (KQB_DB_USER_ID)Type the user ID for the BizTalk Management database.

The type is string.

This value is optional.

Command-line configuration option for Database User ID:KQB_APPLICATION_CONFIGURATION_EXE.KQB_DB_USER_ID

Database Password (KQB_DB_USER_PWD)Type the password for the BizTalk Management database.

The type is password.

This value is optional.

Command-line configuration option for Database Password:KQB_APPLICATION_CONFIGURATION_EXE.KQB_DB_USER_PWD

You can configure the agent from the graphical interface in two ways:v By using the Configure Advanced option from the Manage Tivoli Enterprise Monitoring Services

(MTEMS) window for the BizTalk Server agent.v By using the Configure option from the Tivoli Enterprise Portal Client

To configure the agent by using the command-line interface:1. Enter the following command to log in to the command-line interface: tacmd configuresystem -m

managedsystemname–p KQB_APPLICATION_CONFIGURATION_EXE.KQB_API_FILEPATH=Default


KQB_APPLICATION_CONFIGURATION_EXE.KQB_DBACCESS_USE_WINDOWS_AUTHENTICATION=true wheremanagedsystemname is the computer on which you have installed the BizTalk Server agent, and filepathis the API file path.

2. Select the Windows Authentication mode by running the following command: tacmd configuresystem-m managedsystemname–p KQB_APPLICATION_CONFIGURATION_EXE.KQB_API_FILEPATH=DefaultKQB_APPLICATION_CONFIGURATION_EXE.KQB_DBACCESS_USE_WINDOWS_AUTHENTICATION=true where filepathis the API file path.-OR- Select the SQL Authentication mode by running the following command:tacmd configuresystem -m managedsystemname-pKQB_APPLICATION_CONFIGURATION_EXE.KQB_API_FILEPATH=DefaultKQB_APPLICATION_CONFIGURATION_EXE.KQB_DBACCESS_USE_WINDOWS_AUTHENTICATION=falseKQB_APPLICATION_CONFIGURATION_EXE.KQB_DB_USER_ID=userIDKQB_APPLICATION_CONFIGURATION_EXE.KQB_DB_USER_PWD=password where user ID and password are theuser ID and password for the BizTalk Management database.

Remote installation and configurationYou can install the monitoring agent remotely from the Tivoli Enterprise Portal or from the commandline.

When installing the agent remotely, you must provide the configuration values for the agent to operate.See “Configuration values” on page 15.

To install from the portal, see the IBM Tivoli Monitoring Installation and Setup Guide.

To remotely install or configure an agent through the Tivoli Enterprise Portal, you must have installed theapplication support for that agent (Tivoli Enterprise Monitoring Server, Tivoli Enterprise Portal Server,and Tivoli Enterprise Portal). You must also have installed the agent bundle into the Remote DeployDepot.

For information about displaying the configuration options that are available to use with theconfigureSystem or addSystem commands see "tacmd describeSystemType" in the IBM Tivoli MonitoringCommand Reference.

If you are using the command line, the following command is an example of remote installation andconfiguration for Windows operating systems:tacmd addSystem -t QB -n Primary:sample.node.name:NT-p KQB_APPLICATION_CONFIGURATION_EXE.KQB_API_FILEPATH=valueKQB_APPLICATION_CONFIGURATION_EXE.KQB_DBACCESS_USE_WINDOWS_AUTHENTICATION=valueKQB_APPLICATION_CONFIGURATION_EXE.KQB_DB_USER_ID=valueKQB_APPLICATION_CONFIGURATION_EXE.KQB_DB_USER_PWD=value

Setting up the Microsoft BizTalk Server agent in a cluster environmentTo use this monitoring agent in a Microsoft Cluster Server environment requires special configuration.

The IBM Tivoli Monitoring Installation and Setup Guide contains an overview of clustering. The informationprovided here is specifically for installing and setting up the Microsoft BizTalk Server agent in aMicrosoft Cluster Server environment.

RequirementsThe BizTalk Server agent supports monitoring of the Microsoft BizTalk Server 2006, Microsoft BizTalkServer 2006 Release 2, Microsoft BizTalk Server 2009, and Microsoft BizTalk Server 2010 when the BizTalkServers are configured in a cluster environment.

In addition to installing and setting up the Microsoft BizTalk Server agent, the following three additionalsteps are required for the cluster environment:


v Creating a monitoring agent cluster resource in the Resource Group of the BizTalk Serverv Setting CTIRA_HOSTNAME to a common value for the BizTalk Server agent (cluster

name.TYPE=REG_EXPAND_SZ)v Setting CTIRA_HIST_DIR to a common disk location if history is stored at the monitoring agents (if

history for the Monitoring Agent for Microsoft BizTalk Server is configured to be stored at themonitoring agent)

v Setting KFW_TOPOLOGY_CLUSTER_LIST at the

On Windows systems, IBM Tivoli Monitoring requires that monitoring agents are installed in the samedirectory path as the OS agent. Therefore, each node in a cluster must have installed all monitoringagents (on the nodes system disk) that are required to support the cluster applications that can run onthat cluster node.

Installing and configuring the monitoring agentInstall and configure the Monitoring Agent for Microsoft BizTalk Server on each node in the clusterwhere it is possible for the Microsoft BizTalk Virtual Server to run.1. Setting the CTIRA_HOSTNAME environment variable

You may include multiple instances of the Monitoring Agent for Microsoft BizTalk Server. You mustconfigure each instance with a CTIRA_HOSTNAME. Set the CTIRA_HOSTNAME environment variable to clustername.TYPE=REG_EXPAND_SZ. By setting the CTIRA_HOSTNAME for all BizTalk agents in the cluster to thesame name, you can navigate to all of the monitoring agents for that cluster in the Tivoli EnterprisePortal Server.

2. Setting the CTIRA_HIST_DIR environment variableIf history for the Monitoring Agent for Microsoft BizTalk Server is configured to be stored at themonitoring agent, each instance of the monitoring agent must be configured with a commonCTIRA_HIST_DIR that points to a shared disk directory.If history is stored at the Tivoli Enterprise Management Server, setting the CTIRA_HIST_DIR is notrequired. Storing history at the Tivoli Enterprise Management Server puts a higher burden on thatserver.The shared disk is a disk that is owned by the Microsoft BizTalk server. By using the shared disk, thehistory file can be maintained from whichever node the BizTalk Server agent is running. When theagent follows the Microsoft BizTalk Server during failover, the agent can store historical data to thatcommon location and the history data is contiguous.

Note: In CTIRA_HIST_DIR settings, you cannot use the shared directory. You must use external physicalshared disk for storing the historical data.

3. Setting the KFW_TOPOLOGY_CLUSTER_LIST

Set the value of this variable to AFF_MS_BIZTALK against the Tivoli Enterprise Portal Server.

Creating a resourceFor Windows 2003 systems, use the following steps to create a resource:1. Click Start > Administrative Tools > Cluster Administrator.2. Select the group for the instance that is being worked.3. Right-click the group, and then click New > Resource.4. In the New Resource window, specify values of the following fields as follows:

Name: BiztalkAgentResourceDescription: Description about the resourceResource type: Generic ServiceGroup: BizTalkTest

5. In the Possible Owners window, accept the default settings of all Available Nodes.


6. In the Dependencies window, add dependencies on the history disk.7. In the Generic Service Parameters window, specify values of the following fields as follows:

Service name: KQBCMAStart Parameters: C:\IBM\ITM\TMAITM6\kqbagent.exe

8. Click Finish.9. Bring the agent resources online.

10. Repeat these steps for the other instances of the monitoring agent in other nodes of the clusterenvironment.

Creating a serviceFor Windows 2008 systems, use the following steps to create a service:1. Click Start > Programs > Administrative Tools > Failover Cluster Management.2. In the navigation pane, expand cluster name.3. Right-click Services and Applications and click Configure a Service or Application. The High

Availability wizard opens.4. On the Select Service or Application page, select Generic Service from the list of services and click

Next.5. On the Select Service page, select Monitoring Agent for Microsoft BizTalk Server – Primary from

the list and click Next.6. On the Client Access Point page, specify a name for the cluster service, select an IP address from the

list of networks, and click Next.7. On the Select Storage page, select the storage (if available).8. Retain the default registry settings on the Replicate Registry Settings page and click Next.9. Confirm the details on the Confirmation page and click Next.

10. On the Summary page, click Finish. The service is created under Services and Applications.11. Right-click the service name that you have created and click Properties.12. In the Properties window, under Preferred owners, select the node names for the failover cluster and

click OK.

Making configuration changesAfter you give the control of the agent cluster resource to the Cluster Server, you must change the agentcluster resource status to offline to make configuration changes or edit the agent variables on the nodefrom which the agent cluster resource runs. If the agent cluster resource status is not offline when theagent config utility attempts to change the status of the agent offline, the Cluster Server receives thestatus of the monitoring agent as offline and attempts to change the status of the monitoring agent toonline. When you complete the configuration changes for the monitoring agent, change the agent clusterresource status to online.


Chapter 3. Workspaces reference

A workspace is the working area of the Tivoli Enterprise Portal application window. The Navigator treecontains a list of the workspaces provided by the agent.

About workspaces

Use the Navigator tree to select the workspace you want to see. As part of the application window, thestatus bar shows the Tivoli Enterprise Portal Server name and port number to which the displayedinformation applies and the ID of the current user.

When you select an item in the Navigator tree, a default workspace is displayed. When you right-click aNavigator item, a menu that includes a Workspace item is displayed. The Workspace item contains a listof workspaces for that Navigator item. Each workspace has at least one view. Some views have links toother workspaces. You can also use the Workspace Gallery tool as described in the Tivoli Enterprise PortalUser's Guide to open workspaces.

The workspaces in the Navigator are displayed in a Physical view that shows your enterprise as aphysical mapping or a dynamically populated logical view that is agent-specific. You can also create aLogical view. The Physical view is the default view.

This monitoring agent provides predefined workspaces. You cannot modify or delete the predefinedworkspaces, but you can create new workspaces by editing them and saving the changes with a differentname.

Workspace views can be any combination of query-based views, event views, and special purpose views.

Additional information about workspaces

For more information about creating, customizing, and working with workspaces, see "Using workspaces"in the Tivoli Enterprise Portal User's Guide.

For a list of the predefined workspaces for this monitoring agent and a description of each workspace,see Predefined workspaces and the information about each individual workspace.

Some attribute groups for this monitoring agent might not be represented in the predefined workspacesor views for this agent. For a full list of the attribute groups, see “Attribute groups for the monitoringagent” on page 39.

Predefined workspacesThe Microsoft BizTalk Server agent provides predefined workspaces, which are organized by Navigatoritem.v Microsoft BizTalk Server Navigator item

– Microsoft BizTalk Server workspacev Adapters Navigator item

– Adapters workspace– File Receive Adapter - Data Received workspace– File Send Adapter workspace– FTP Receive Adapter workspace– FTP Send Adapter workspace


– HTTP Receive Adapter workspace– HTTP Send Adapter workspace– MSMQ Receive Adapter workspace– MSMQ Send Adapter workspace– POP3 Receive Adapter workspace– SMTP Send Adapter workspace– SOAP Receive Adapter workspace– SOAP Send Adapter workspace– SQL Receive Adapter workspace– SQL Send Adapter workspace– Windows SharePoint Services Adapter workspace

v Availability Navigator item– Availability workspace– Performance Object Status workspace

v Business Activity Monitoring Navigator item– BAM Interceptor workspace– Business Activity Monitoring workspace– Delivery Channels and Event Providers workspace– Distributors and Subscriptions workspace– Events workspace– Generator workspace– Notifications workspace– Subscribers workspace– Vacuumer workspace

v Configuration and Status Navigator item– BizTalk Group Topology workspace– Configuration and Status workspace– Current Status workspace– Service Instance workspace

v Databases Navigator item– Databases workspace

v Event Log Navigator item– Event Log workspace

v Host Throttling Navigator item– Host Throttling workspace– Host Throttling Thresholds workspace– Messages Overview workspace– Throttling Details workspace

v Human Workflow Services Navigator item– Human Workflow Services workspace

v MessageBox Navigator item– MessageBox workspace– MessageBox - Host Queue Messages workspace– MessageBox - Host Queue Overview workspace– MessageBox - Purge Jobs workspace


v Messaging Navigator item– Document Transactions workspace– Messaging workspace– Messaging Details workspace– Messaging Latency workspace

v Orchestrations Navigator item– Dehydration Details workspace– Dehydration Status workspace– Orchestration Details workspace– Orchestration Messaging workspace– Orchestration Processing workspace– Orchestrations workspace– Transactional Scopes workspace

v RFID Navigator item– RFID workspace

v TDDS Navigator item– TDDS workspace– TDDS Details workspace

Workspace descriptionsEach workspace description provides information about the workspace such as the purpose and a list ofviews in the workspace.

Workspaces are listed under Navigator items.

Microsoft BizTalk Server Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.Microsoft BizTalk Server workspace

This workspace displays the overall state of the Microsoft BizTalk Server.

This workspace contains the following views:Availability

This report displays the state of services and processes in the application. The state is UPif the service is running, DOWN if the service exists but is not running. UNKNOWNindicates that the service is not installed.

Thread Count for Host InstanceThis bar chart displays the number of threads that are being used within the process.

Host Memory UsageThis bar chart displays the private and virtual memory in megabytes allocated for thehost instance.

Throttled Received BatchesThis bar chart displays the number of batches that have been blocked on receive by theMessaging Engine due to high service load. These batches contain new messages to beprocessed.

Adapters Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.Adapters workspace

This workspace displays detailed information of the File Receive Adapter.

This workspace contains the following views:

Chapter 3. Workspaces reference 23

File Receive Adapter DetailsThis report shows the overall performance information of the File Receive Adapter.

Delete RetriesThis bar chart shows the number of times the File Receive Adapter attempts to delete afile that has been read.

Lock File FailuresThis bar chart shows the number of times the File Receive Adapter failed to lock the file.

File Receive Adapter - Data Received workspaceThis workspace displays detailed information of the File Receive Adapter rate.

This workspace contains the following views:Kilobytes Received

This bar chart shows the total number of kilobytes received by the File Adapter.Messages Received

This bar chart shows the total number of messages received by the File Receive Adapter.It is incremented after a message is read by the File Receive Adapter from the file system.

File Send Adapter workspaceThis workspace displays the File Send Adapter performance measures.

This workspace contains the following views:File Send Adapter Details

This report shows the overview of File Send Adapter performance counters.Kilobytes Sent

This bar chart shows the total number of kilobytes sent by the file adapter.Messages Sent

This bar chart shows the total number of messages sent by the File Send Adapter.FTP Receive Adapter workspace

This workspace displays detailed information of FTP Receive Adapter.

This workspace contains the following views:FTP Receive Adapter Details

This report shows the overall performance information of FTP Receive Adapter.Kilobytes Received

This bar chart shows the total number of kilobytes received by the FTP Receive Adapter.Messages Received

This bar chart shows total number of messages received by the FTP Receive Adapter. It isincremented after a message is read by the FTP Receive Adapter from the FTP server.

FTP Send Adapter workspaceThis workspace shows the FTP Send Adapter performance measures.

This workspace contains the following views:FTP Send Adapter Details

This report contains overall information about the FTP Send Adapter.Kilobytes Sent

This bar chart shows the total number of kilobytes sent by the FTP adapter.Messages Sent

This bar chart shows the total number of messages sent by the FTP Send Adapter. It isincremented only for messages that have been written to the destination FTP server.

HTTP Receive Adapter workspaceThis workspace displays detailed information of the HTTP Receive Adapter.

This workspace contains the following views:HTTP Receive Adapter Details

This report shows the overall performance information of the HTTP Receive Adapter.Messages in Adapter Queue

This bar chart shows the number of incoming messages in the HTTP Receive Adapter'sinternal memory queue.


Messages ReceivedThis bar chart shows the total number of HTTP requests received by the HTTP ReceiveAdapter. It is incremented after a request message is read by the HTTP Receive Adapterfrom the HTTP client.

Messages SentThis bar chart shows the total number of HTTP responses sent by the HTTP ReceiveAdapter. It is incremented only for response messages that have been successfully sent toHTTP clients.

HTTP Send Adapter workspaceThis workspace displays detailed information of HTTP Send Adapter.

This workspace contains the following views:HTTP Send Adapter Details

This report shows the overall performance information of HTTP Send Adapter.Messages in Adapter Queue

This bar chart shows the number of outgoing messages in the HTTP Send adapter'sinternal memory queue.

Messages ReceivedThis bar chart shows the total number of HTTP response messages received by the HTTPSend Adapter. It is incremented after a response message is read by the HTTP SendAdapter from HTTP servers.

Messages SentThis bar chart shows the total number of HTTP requests sent by the HTTP Send Adapter.It is incremented only for request messages that have reached the destination URL.

MSMQ Receive Adapter workspaceThis workspace displays the MSMQ Receive Adapter performance measures.

This workspace contains the following views:MSMQ Receive Adapter Details

This report shows overview of MSMQ performance counters.Kilobytes Received

This bar chart shows the total number of kilobytes received by the MSMQ ReceiveAdapter.

Messages ReceivedThis bar chart shows the total number of messages received by the MSMQ ReceiveAdapter. It is incremented after a message is read by the MSMQ Receive Adapter fromthe source queue.

MSMQ Send Adapter workspaceThis workspace displays detailed information of MSMQ Send Adapter.

This workspace contains the following views:MSMQ Send Adapter Details

This report shows the overall performance information of MSMQ Send Adapter.Kilobytes Sent

This bar chart shows the total number of kilobytes sent by the MSMQ adapter.Messages Sent

This bar chart shows total number of messages sent by the MSMQ Send Adapter. It isincremented only for messages that have reached the destination queue.

POP3 Receive Adapter workspaceThis workspace displays the POP3 Receive Adapter performance measures.

This workspace contains the following views:POP3 Receive Adapter Details

This report shows overview of POP3 performance counters.Kilobytes Received

This bar chart shows the total number of kilobytes received by the POP3 Receive Adapter.


Messages ReceivedThis bar chart shows the total number of number of e-mail messages downloaded by thePOP3 adapter from a mail server.

Active SessionsThis bar chart shows the number of open POP3 connections the POP3 adapter ismanaging at a time.

SMTP Send Adapter workspaceThis workspace displays the SMTP Send Adapter performance measures.

This workspace contains the following views:SMTP Send Adapter Details

This report shows the overview of the SMTP Send Adapter performance counters.Messages Sent

This bar chart shows the total number of messages sent by the SMTP adapter.Messages Sent Per Second

This bar chart shows the number of messages sent by the SMTP adapter per second. Thisapplies only to messages that have been transmitted to the SMTP server.

SOAP Receive Adapter workspaceThis workspace displays detailed information of the SOAP Receive Adapter.

This workspace contains the following views:SOAP Receive Adapter Details

This report shows the overall performance information of the SOAP Receive Adapter.Messages Received

This bar chart shows the total number of messages received by the SOAP ReceiveAdapter. It is incremented after a request message is read by the SOAP adapter from theSOAP client.

Messages Received Per SecondThis bar chart shows the number of messages received per second by the SOAP ReceiveAdapter.

SOAP Send Adapter workspaceThis workspace displays detailed information of the SOAP Send Adapter.

This workspace contains the following views:SOAP Send Adapter Details

This report shows the overall performance information of the SOAP Send Adapter.Messages Sent

This bar chart shows the total number of messages sent by the SOAP Send Adapter. It isincremented only for messages that have reached the destination URL.

Messages Sent Per SecondThis bar chart shows the number of messages sent by the SOAP Send Adapter persecond. This applies only to messages that have reached the destination URL.

SQL Receive Adapter workspaceThis workspace displays detailed information of SQL Receive Adapter.

This workspace contains the following views:SQL Receive Adapter Details

This report shows the overall performance information of SQL Receive Adapter.Messages Received

This bar chart shows the total number of messages read by the SQL Receive Adapterfrom a SQL server.

Messages Received Per SecondThis bar chart shows number of messages read by the SQL Receive Adapter from a SQLserver per second.

SQL Send Adapter workspaceThis workspace displays detailed information of SQL Receive Adapter.



SQL Send Adapter DetailsThis report shows the overall performance information of SQL Send Adapter.

Messages SentThis bar chart shows the total number of messages sent by the SQL Send Adapter. It isincremented only for messages that have been written to the destination SQL table.

Messages Sent Per SecondThis bar chart shows number of messages sent by the SQL Send Adapter per second. Thisis applies only to messages that have been written to the destination SQL table.

Windows SharePoint Services Adapter workspaceThis workspace displays detailed information of the Windows SharePoint Services adapter.

This workspace contains the following views:WSS Adapter Details

This report shows the overall performance information of the Windows SharePointServices adapter.

Percentage FailuresThis bar chart shows the percentage of failure.

Total FailuresThis bar chart shows the total failure information.

Web Service Calls Per SecondThis plot chart the number of Windows SharePoint Services adapter Web service calls persecond.

Availability Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.Availability workspace

The Availability workspace displays the overall health of the application.

This workspace contains the following views:Availability

Displays the state of each component in the application. Each service is displayed using adescriptive name, the short name of the service, and the state of the service (UP, DOWN,or UNKNOWN). The state is UP if the service is running, DOWN if the service exists butis not running. UNKNOWN indicates that the service is not installed, so these elementsare filtered from the view. When the state of the component is DOWN (for a process, orservice) it is highlighted with a red background.

ProcessorDisplays the amount of CPU used by each process that is a component of the application.This displays the 2 main components of CPU usage, privileged time which is time spentin the kernel on behalf of the process and user mode time, which is the time spentrunning the process code.

ThreadsDisplays the number of threads used by each process that is a component of theapplication.

MemoryDisplays the amount of memory being consumed by each process that is a component ofthe application. This total (virtual) size of the process and the size of the process inmemory (working set) are displayed.

Performance Object Status workspaceThis workspace displays the overall health of the application.

This workspace contains the following view:Performance Object Status

This report displays the status of the collection of data from the application. Normallythis will display NO ERROR indicating that the agent is collecting application datacorrectly. If some of the agent's other views are empty, this view will help isolate thecause of the failure. PerfMon objects will display the object class name.


Business Activity Monitoring Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.BAM Interceptor workspace

This workspace shows the information about the duration of extract and flush operations perBAM event.

This workspace contains the following views:Extraction Duration Per BAM Event

This bar chart contains information about the duration of the extract operation for eachBAM event.

Flush Duration Per BAM EventThis bar chart contains information about the duration of the flush operation for eachBAM event.

BAM Interceptor DetailsThis report contains information about the BAM interceptor.

Business Activity Monitoring workspaceThis workspace shows the details about business activity monitoring events.

This workspace contains the following views:BAM Events

This bar chart contains information about the successful and failed BAM events.Event Batches Awaiting Generation

This line chart contains information about the potential backlogs of event batches for anapplication.

Subscriptions DisabledThis line chart contains information about the number of disabled subscriptions.

Distributors DetailsThis report contains information about the distributor components.

Delivery Channels and Event Providers workspaceThis workspace shows information about the delivery channel and event provider objects.

This workspace contains the following views:Delivery Channels Details

This report contains information about the delivery channels.Event Providers Details

This report contains information about the event providers.Events Received Per Second

This line chart contains information about the events received per second.Event Batches Details - Top 5 Event Batches aborted

This bar chart contains information about the top 5 event batches that were aborted.Distributors and Subscriptions workspace

This workspace shows the information about the distributor and subscription objects.

This workspace contains the following views:Format Requests Details - Top 5 Format Requests Failed

This bar chart contains information about the top 5 format requests that failed.Subscriptions Enabled

This line chart contains information about the subscriptions that are enabled.Subscriptions Details

This report contains information about the subscriptions.Delivery Requests Details Top 5 Delivery Requests Failed

This bar chart contains information about the delivery activities of a distributor.Events workspace

This workspace shows information about the events objects.

This workspace contains the following views:Event Batches In Collections

This line chart contains information about the event batches that are in collections.


Event Batches SubmittedThis line chart contains information about the event batches that are submitted.

Events DetailsThis report contains information about the events.

Generator workspaceThis workspace shows information about the generator objects.

This workspace contains the following views:Rules Firing Details - Top 5 Rule Firing Failures

This bar chart contains information about the top 5 rule firing failures.Notifications Generated Per Second

This line chart contains information about the notifications generated per second.Generator Details

This report contains information about the generator.Notifications workspace

This workspace shows the information about the notifications objects.

This workspace contains the following views:Notification Batches Details - Top 5 Notification Batches Failed Delivery

This bar chart contains information about the top 5 notification batches that faileddelivery.

Notifications DetailsThis report contains information about the notifications.

Notifications Delivery Details - Top 5 Notifications Failed DeliveryThis bar chart contains information about the delivery details of top 5 notifications thatfailed delivery.

Subscribers workspaceThis workspace shows information about the subscriber objects.

This workspace contains the following views:Subscribers Disabled

This line chart contains information about the subscribers that are disabled.Subscribers Enabled

This line chart contains information about the subscribers that are enabled.Subscribers Details

This report contains information about the subscribers.Vacuumer workspace

This workspace shows information about the vacuumer objects.

This workspace contains the following views:Quanta vacuumed

This line chart contains information about the quanta vacuumed.Timeouts

This line chart contains information about the timeouts.Vacuumer Details

This report contains information about the vacuumer.

Configuration and Status Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.BizTalk Group Topology workspace

This workspace displays the BizTalk Group topology.

This workspace contains the following view:BizTalk Group Topology

This view displays all BizTalk Servers that are configured under single BizTalk Group.Configuration and Status workspace

This workspace displays information about the BizTalk group, server, host, and host instances.


This workspace contains the following views:BizTalk Group Server Host

This report contains information about the BizTalk group, server, host, host instance, andthe status of some of them.

Application StatusThis report contains information about the BizTalk application name, and status.

Current Status workspaceThis workspace shows the current status of BizTalk components.

This workspace contains the following views:Orchestration Status

This report contains information about the Orchestration name, status, and the host namefor the orchestration.

Send Port StatusThis report contains information about the Send Port name and its status.

Send Port Group StatusThis report contains information about the Send Port Group name and its status.

Receive Location StatusThis report contains information about the Receive Location name and its status.

Service Instance workspaceThis workspace shows information about the BizTalk service instances.

This workspace contains the following view:Service Instance Details

This report contains information about the service instance name,status,and the serviceclass of the service instance.

Databases Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.Databases workspace

This workspace displays the detailed information about the BizTalk databases.

This workspace contains the following views:Single Sign On Database

This report shows the Single Sign-On Database name and the Single Sign-On Databaseserver name.

Management DatabaseThis report shows the Management Database name and the Management Database servername.

BAM DatabaseThis report shows the BAM Database name and the BAM Database server name.

Tracking DatabaseThis report shows the Tracking Database name and the Tracking Database server name.

Messagebox DatabaseThis report shows the Messagebox Database name, the Messagebox Database servername, whether the publication of new Messages is disabled and whether the MessageBoxdatabase is master MessageBox.

Rule Engine DatabaseThis report shows the Rule Engine Database name and the Rule Engine Database servername.

Event Log Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.Event Log workspace

The Event Log workspace shows the details for the recent events logged by the application to the


Windows Event Log. By default, the agent only displays events that occur after the agent isstarted. Events are removed from the Event Log view 1 hour after they occur.

This workspace contains the following view:Event Log

Shows the recent Event Log entries for Microsoft BizTalk Server.

Host Throttling Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.Host Throttling workspace

This workspace displays the Memory usage and Database related information of Host Instances

This workspace contains the following views:Physical Memory Usage

This bar chart displays amount of physical memory in megabytes being used on themachine by each host instance.

Process Memory UsageThis bar chart displays the total process memory consumption in megabytes for each hostinstance.

Database SessionThis bar chart displays the concurrent MessageBox database connections being used andthe current database session threshold.

Database Queue SizeThis bar chart displays number of messages in the database queues that this host instancehas published.

Host Throttling Thresholds workspaceThis workspace shows the detailed information about Throttling.

This workspace contains the following views:Thresholds

This report lists all current thresholds set by BizTalk administrator.Current Values

This report lists current values for Thresholds performance counters.Host Throttling Status

This report lists all current throttling status flags.Host Throttling Details

This report list all host throttling performance counters.Messages Overview workspace

This workspace displays overview information about message processing.

This workspace contains the following views:Total Messages

This bar chart displays the total number of message delivered and published by each hostinstance.

Message PublishingThis bar chart displays the message publishing incoming and outgoing rate.

Messaging DelayThis bar chart displays the message publishing and delivering delay in milliseconds,increase in delay for large amount of time is cause of performance degrading.

Message DeliveryThis bar chart displays the information about message delivery rate. This shows themessage delivery incoming and outgoing rate.

Throttling Details workspaceThis workspace displays the Throttling Threshold and their current status



Throttling State DurationThis bar chart displays seconds since the system entered this state. If the host isthrottling, how long it has been throttling; if it is not throttling, how long since throttlingwas applied.

Message CountThis bar chart displays the in process message count and its threshold.

Thread CountThis bar chart displays the thread count and its current threshold.

Human Workflow Services Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.Human Workflow Services workspace

This workspace gives an overview of the Activity flows, tasks, actions.

This workspace contains the following views:Human Workflow Services Details

This report displays the number of activity flows, tasks, actions created, and retrieved.Tasks Retrieved from Tracking DB

This bar chart displays the number of tasks retrieved from tracking database.Steps Processing

This bar chart displays the number of actions added and retrieved from trackingdatabase.

Activity Flow ProcessingThis bar chart displays the number of activity flows added and retrieved from trackingdatabase.

MessageBox Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.MessageBox workspace

This workspace gives an overview of MessageBox Details.

This workspace contains the following views:MessageBox Details

This report gives details about the MessageBox database and purge jobs.Messages in Tracking Data Table in MessageBox DB

This bar chart displays the size of Tracking Data Table (in terms of messages) on aparticular MessageBox on a particular server.

Spool Depth in terms of MessagesThis bar chart displays the size of the spool on a particular MessageBox on a particularserver.

MessageBox - Host Queue Messages workspaceThis workspace gives an overview of the messages in the MessageBox.

This workspace contains the following views:Host Queue Length

This bar chart displays the total number of messages in the particular host queue.Suspended Messages

This bar chart displays the total number of suspended messages for the particular host.MessageBox - Host Queue Overview workspace

This workspace gives an overview of the MessageBox Host attributes.

This workspace contains the following views:Host Counter Details

This report displays the counters related to host queue.Host Instances

This bar chart displays the number of message references in the instance state queue forthe particular host.


MessageBox - Purge Jobs workspaceThis workspace gives an overview of the Purge jobs run by SQL Agent.

This workspace contains the following views:Purge Jobs

This report displays the attributes that give information about the purge jobs executed bySQL Agent.

Time taken by Purge Jobs in SecondsThis bar chart displays time (in seconds) taken by SQL Agent Purge jobs.

Time taken by MessageBox Cleanup Jobs in SecondsThis bar chart displays time (in seconds) taken by SQL Agent Cleanup Purge Jobs.

Messaging Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.Document Transactions workspace

This workspace gives an overview of the documents that are processed, submitted, or suspended.

This workspace contains the following views:Documents Processed Per Second

This bar chart displays the number of documents processed per second.Documents Received Per Second

This bar chart displays the number of documents received per second.Documents Suspended Per Second

This bar chart displays the number of documents suspended per second.Documents Submitted Per Batch

This bar chart displays the number of documents submitted per batch.Messaging workspace

This workspace gives an overview of document processing and document failures.

This workspace contains the following views:Document Processing

This bar chart displays the number of documents processed and received.Throttled Received Batches

This bar chart displays the number of batches that have been blocked on receive by theMessaging Engine due to high service load. These batches contain new messages to beprocessed.

Document FailuresThis bar chart displays the number of documents suspended or resubmitted by SendAdapters.

Messaging Details workspaceThis workspace gives an overview of the messages and documents processing.

This workspace contains the following views:Pending Actions

This report displays the pending batches, pending messages and blocked batches.Document Processing

This report displays all the attributes which describe the processing of documents.Messaging Overview

This report displays all the attributes for Messaging.Messaging Latency workspace

This workspace gives an overview of the messaging latencies.

This workspace contains the following views:Messaging Latency Details

This report displays the latencies while processing the messages.Average Latency

This bar chart displays the average latency (in milliseconds) required by MessagingEngine, adapters and MessageBox to process the messages.


Average Latency for Request-ResponseThis bar chart displays the average latency (in milliseconds) from when the MessagingEngine receives a request document from the adapter until the time a response documentis given back to the adapter.

Orchestrations Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.Dehydration Details workspace

This workspace gives an overview of orchestration dehydration. Dehydration is a process wherethe state of an orchestration persists and saves to the database. It is done when orchestration isnot running.

This workspace contains the following views:Dehydration Status

This bar chart shows the dehydration overview. This includes the orchestration those thatare dehydrating, dehytrable and scheduled for dehydration.

Persistent PointThis bar chart shows the number of times orchestration was persisted.

Orchestration Resident in MemoryThis bar chart shows number of orchestration instances currently hosted by the hostinstance.

Dehydration Cycles in ProgressThis bar chart shows the number of running dehydration cycles.

Dehydration Cycles CompletedThis bar chart shows the number of dehydration cycles completed.

Dehydration Status workspaceThis workspace gives overview of the dehydration and rehydration of orchestration.

This workspace contains the following views:Dehydrated and Rehydrated Orchestrations

This bar chart shows the number of dehydrated and rehydrated orchestrations.Orchestration Dehydrated Per Second

This bar chart shows the average number of orchestration instances dehydrated persecond.

Orchestration Rehydrated Per SecondThis bar chart shows the average number of orchestration instances rehydrated persecond.

Orchestration Details workspaceThis workspace shows the detailed information of the Orchestration performance.

This workspace contains the following views:Orchestration Memory

This report lists all performance counters related to the orchestration memory.Orchestration Database

This report lists all database related information.Orchestration Overview

This report shows the overview of orchestration performance.Orchestration Messaging workspace

This workspace shows the details about messaging and message box database.

This workspace contains the following views:MessageBox DB Connection Failures

This bar chart shows the number of attempted database connections that failed since thehost instance started.

Pending MessagesThis bar chart shows the number of received messages for which the receipt has not yetbeen acknowledged to the message box.


Orchestration Processing workspaceThis workspace gives information about orchestration processing. It includes the orchestrationscreated, discarded, and suspended.

This workspace contains the following views:Orchestration Created

This bar chart shows number of orchestration created since the host instance started.Orchestration Failure

This bar chart shows the total number of failure per second. It includes the orchestrationsdiscarded and suspended per second. The large number of discarded and suspendedorchestrations per second causes performance degradation.

Orchestrations workspaceThis workspace gives an overview of Orchestrations.

This workspace contains the following views:Created and Completed Orchestrations

This bar chart shows the number of orchestrations created and completed since hostinstance started.

Dehydratable and Dehydrating OrchestrationThis bar chart shows the dehydration of orchestrations. This includes the number oforchestrations currently dehydrating and those ready for dehydration.

Orchestration FailureThis bar chart shows the failure details of orchestration. It includes the number oforchestrations and those that are discarded, suspended, and idle.

Running and Runnable OrchestrationsThis bar chart shows the number of orchestrations currently running (hosted by hostinstance) and runnable.

Transactional Scopes workspaceThis workspace gives an overview of the Transaction Scopes performance measure.

This workspace contains the following views:Transactional Scopes Committed

This bar chart shows the number of long-running or atomic scopes that have successfullycompleted since the host instance started.

Transactional Scopes AbortedThis bar chart shows the number of long-running or atomic scopes that have beenaborted since the host instance started.

Transactional Scopes Committed Per SecondThis bar chart shows the shows average number of committed scopes per second.

Transactional Scopes Aborted Per SecondThis bar chart shows the average number of aborted scopes per second.

RFID Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.RFID workspace

This workspace shows the details about RFID deives and RFID processes.

This workspace contains the following views:RFID Devices

This report displays information about RFID devices.RFID Processes

This report displays information about RFID processes.

TDDS Navigator itemThe workspace descriptions are organized by the Navigator item to which the workspaces are relevant.


TDDS workspaceThis workspace gives an overview of the transactions done by Tracking Data Decode Service(TDDS).

This workspace contains the following views:Failures

This bar chart displays the total batches and events TDDS failed to run.Transactions In Process

This bar chart displays the batches, events and records that are being processed inside thecurrent SQL transaction.

Committed TransactionsThis bar chart displays the batches, events and records committed to the database.

TDDS Details workspaceThis workspace gives an overview of batches, events and records processed by TDDS.

This workspace contains the following views:TDDS Details

This report displays all the counters in the TDDS attribute group.Total Batches and Records

This bar chart displays the total number of batches and records processed by TDDS.Total Events

This bar chart displays the total number of events processed by TDDS.

Cross-linked workspacesThis section contains cross-links within the BizTalk Server agent and from the BizTalk Server agentnavigator items and workspaces to:v .NET Framework agentv SQL Server agent

Table 2 and Table 3 on page 37 contains source, target, and filtering criteria for the cross-linkedworkspaces.

Table 2. Cross-linked workspaces to the .NET Framework agent

Link name

Sourcenavigatoritem

Sourceworkspacename Source view name

Target navigatoritem

Targetworkspace name Filter

Work FlowFoundation

HumanWorkflowservices

HumanWorkflowservices

N.A Databases Windowsworkflowfoundation

N.A

Service ModelEndpoint

Adapters Adapters N.A Databases Service ModelEndpoint

N.A

Service ModelOperation

Adapters Adapters N.A Databases Service ModelOperation

N.A

Service ModelService

Adapters Adapters N.A Databases Service ModelService

N.A


Table 3. Cross-linked workspaces to the SQL Server agent

Link name

Sourcenavigatoritem

Sourceworkspacename Source view name

Target navigatoritem

Targetworkspace name Filter

DatabaseInformation

Database Database v ManagementDatabase

v MessageboxDatabase

v Rule engineDatabase

v Tracking Database

v BAM Database

v Single Sign onDatabase

Databases Log and SpaceInformation

N.A.

Log and Spaceinformation

Database Database v ManagementDatabase

v MessageboxDatabase

v Rule engineDatabase

v Tracking Database

v BAM Database

v Single Sign onDatabase

Databases Databaseinformation

N.A.

DatabasesInformation

MessageBox MessageBox N.A. Databases DatabasesInformation -Linkable

N.A.

SQL ServerSummary

MessageBox MessageBox N.A. Servers Server Summary N.A.

SQL ServerStatistics

MessageBox MessageBox N.A. Servers Server Statistics N.A.


Chapter 4. Attributes reference

Attributes are the application properties that are being measured and reported by the IBM TivoliComposite Application Manager for Microsoft Applications: Microsoft BizTalk Server Agent.

About attributes

Attributes are organized into attribute groups. Attributes in an attribute group relate to a single objectsuch as an application, or to a single kind of data such as status information.

Attributes in a group can be used in queries, query-based views, situations, policy workflows, take actiondefinitions, and launch application definitions. Chart or table views and situations are two examples ofhow attributes in a group can be used:v Chart or table views

Attributes are displayed in chart and table views. The chart and table views use queries to specifywhich attribute values to request from a monitoring agent. You use the Properties editor to apply filtersand set styles to define the content and appearance of a view based on an existing query.

v SituationsYou use attributes to create situations that monitor the state of your operating system, database, orapplication. A situation describes a condition you want to test. When you start a situation, the valuesyou assign to the situation attributes are compared with the values collected by the Microsoft BizTalkServer agent and registers an event if the condition is met. You are alerted to events by indicator iconsthat are displayed in the Navigator.

Additional information about attributes

For more information about using attributes and attribute groups, see the Tivoli Enterprise Portal User'sGuide.

For a list of the attribute groups, a list of the attributes in each attribute group, and descriptions of theattributes for this monitoring agent, see “Attribute groups for the monitoring agent” and “Attributes ineach attribute group” on page 43.

Attribute groups for the monitoring agentThe Microsoft BizTalk Server agent contains the following attribute groups. The table name depends onthe maximum table name limits of the target database being used for the Tivoli Data Warehouse. If themaximum name is 30 characters, any warehouse table name longer than 30 characters is shortened to 30characters.v Attribute group name: Application Status

– Table name: KQBBIZAPP– Warehouse table name: KQB_APPLICATION_STATUS or KQBBIZAPP

v Attribute group name: Availability– Table name: KQBAVAIL– Warehouse table name: KQB_AVAILABILITY or KQBAVAIL

v Attribute group name: BAM Database– Table name: KQBMSBTSG0– Warehouse table name: KQB_BAM_DATABASE or KQBMSBTSG0

v Attribute group name: BAM Interceptor


– Table name: KQBBAMINTC– Warehouse table name: KQB_BAM_INTERCEPTOR or KQBBAMINTC

v Attribute group name: BizTalk Group Server Host– Table name: KQBHSTGRP– Warehouse table name: KQB_BIZTALK_GROUP_SERVER_HOST or KQBHSTGRP

v Attribute group name: BizTalk Host– Table name: KQBGRPHST– Warehouse table name: KQB_BIZTALK_HOST or KQBGRPHST

v Attribute group name: BizTalk NET Adapter for Oracle DB– Table name: KQBORADB– Warehouse table name: KQB_BIZTALK_NET_ADAPTER_FOR_ORACLE_DB or KQBORADB

v Attribute group name: BizTalk NET Adapter for Oracle EBusiness Suite– Table name: KQBORAEBIZ– Warehouse table name: KQB_BIZTALK_NET_ADAPTER_FOR_ORACLE_EBUSINESS_SUITE or

KQBORAEBIZv Attribute group name: BizTalk NET Adapter for SAP

– Table name: KQBSAPAD– Warehouse table name: KQB_BIZTALK_NET_ADAPTER_FOR_SAP or KQBSAPAD

v Attribute group name: BizTalk NET Adapter for Siebel– Table name: KQBSIEBELA– Warehouse table name: KQB_BIZTALK_NET_ADAPTER_FOR_SIEBEL or KQBSIEBELA

v Attribute group name: BizTalk NET Adapter for SQL– Table name: KQBSQLAD– Warehouse table name: KQB_BIZTALK_NET_ADAPTER_FOR_SQL or KQBSQLAD

v Attribute group name: BizTalk Server– Table name: KQBGRPSRV– Warehouse table name: KQB_BIZTALK_SERVER or KQBGRPSRV

v Attribute group name: Delivery Channels– Table name: KQBDELCHN– Warehouse table name: KQB_DELIVERY_CHANNELS or KQBDELCHN

v Attribute group name: Distributors– Table name: KQBDISTRIB– Warehouse table name: KQB_DISTRIBUTORS or KQBDISTRIB

v Attribute group name: Event Log– Table name: KQBEVTLOG– Warehouse table name: KQB_EVENT_LOG or KQBEVTLOG

v Attribute group name: Event Providers– Table name: KQBEVENPD– Warehouse table name: KQB_EVENT_PROVIDERS or KQBEVENPD

v Attribute group name: Events– Table name: KQBEVENTS– Warehouse table name: KQB_EVENTS

v Attribute group name: File Receive Adapter– Table name: KQBFILERCV– Warehouse table name: KQB_FILE_RECEIVE_ADAPTER or KQBFILERCV


v Attribute group name: File Send Adapter– Table name: KQBFILESND– Warehouse table name: KQB_FILE_SEND_ADAPTER or KQBFILESND

v Attribute group name: FTP Receive Adapter– Table name: KQBFTPRECV– Warehouse table name: KQB_FTP_RECEIVE_ADAPTER or KQBFTPRECV

v Attribute group name: FTP Send Adapter– Table name: KQBFTPSEND– Warehouse table name: KQB_FTP_SEND_ADAPTER or KQBFTPSEND

v Attribute group name: Generator– Table name: KQBGENERA– Warehouse table name: KQB_GENERATOR or KQBGENERA

v Attribute group name: Host Throttling– Table name: KQBHOSTTHR– Warehouse table name: KQB_HOST_THROTTLING or KQBHOSTTHR

v Attribute group name: HTTP Receive Adapter– Table name: KQBHTTPRCV– Warehouse table name: KQB_HTTP_RECEIVE_ADAPTER or KQBHTTPRCV

v Attribute group name: HTTP Send Adapter– Table name: KQBHTTPSND– Warehouse table name: KQB_HTTP_SEND_ADAPTER or KQBHTTPSND

v Attribute group name: Human Workflow Services– Table name: KQBHUMANWO– Warehouse table name: KQB_HUMAN_WORKFLOW_SERVICES or KQBHUMANWO

v Attribute group name: Management Database– Table name: KQBMSBTSG1– Warehouse table name: KQB_MANAGEMENT_DATABASE or KQBMSBTSG1

v Attribute group name: Message Box General Counters– Table name: KQBMSGBOXG– Warehouse table name: KQB_MESSAGE_BOX_GENERAL_COUNTERS or KQBMSGBOXG

v Attribute group name: Message Box Host Counters– Table name: KQBMSGBOXH– Warehouse table name: KQB_MESSAGE_BOX_HOST_COUNTERS or KQBMSGBOXH

v Attribute group name: Messagebox Database– Table name: KQBMSBTSMS– Warehouse table name: KQB_MESSAGEBOX_DATABASE or KQBMSBTSMS

v Attribute group name: Messaging– Table name: KQBMESSAG1– Warehouse table name: KQB_MESSAGING or KQBMESSAG1

v Attribute group name: Messaging Latency– Table name: KQBMESSLAT– Warehouse table name: KQB_MESSAGING_LATENCY or KQBMESSLAT

v Attribute group name: MSMQ Receive Adapter– Table name: KQBMSMQRCV– Warehouse table name: KQB_MSMQ_RECEIVE_ADAPTER or KQBMSMQRCV

Chapter 4. Attributes reference 41

v Attribute group name: MSMQ Send Adapter– Table name: KQBMSMQSND– Warehouse table name: KQB_MSMQ_SEND_ADAPTER or KQBMSMQSND

v Attribute group name: Notifications– Table name: KQBNOTIFI– Warehouse table name: KQB_NOTIFICATIONS or KQBNOTIFI

v Attribute group name: Orchestration Status– Table name: KQBMSBTSOS– Warehouse table name: KQB_ORCHESTRATION_STATUS or KQBMSBTSOS

v Attribute group name: Orchestrations– Table name: KQBORCHEST– Warehouse table name: KQB_ORCHESTRATIONS or KQBORCHEST

v Attribute group name: Performance Object Status– Table name: KQBPOBJST– Warehouse table name: KQB_PERFORMANCE_OBJECT_STATUS or KQBPOBJST

v Attribute group name: POP3 Receive Adapter– Table name: KQBPOP3RCV– Warehouse table name: KQB_POP3_RECEIVE_ADAPTER or KQBPOP3RCV

v Attribute group name: Receive Location Status– Table name: KQBMSBTRLS– Warehouse table name: KQB_RECEIVE_LOCATION_STATUS or KQBMSBTRLS

v Attribute group name: RFID Devices– Table name: KQBRFIDDEV– Warehouse table name: KQB_RFID_DEVICES or KQBRFIDDEV

v Attribute group name: RFID Processes– Table name: KQBRFIDPR0– Warehouse table name: KQB_RFID_PROCESSES or KQBRFIDPR0

v Attribute group name: Rule Engine Database– Table name: KQBMSBTSG2– Warehouse table name: KQB_RULE_ENGINE_DATABASE or KQBMSBTSG2

v Attribute group name: Send Port Group Status– Table name: KQBMSBTSPG– Warehouse table name: KQB_SEND_PORT_GROUP_STATUS or KQBMSBTSPG

v Attribute group name: Send Port Status– Table name: KQBMSBTSPS– Warehouse table name: KQB_SEND_PORT_STATUS or KQBMSBTSPS

v Attribute group name: Service Instance Status and Class– Table name: KQBMSBTSIS– Warehouse table name: KQB_SERVICE_INSTANCE_STATUS_AND_CLASS or KQBMSBTSIS

v Attribute group name: Single Sign On Database– Table name: KQBSSODB– Warehouse table name: KQB_SINGLE_SIGN_ON_DATABASE or KQBSSODB

v Attribute group name: SMTP Send Adapter– Table name: KQBSMTPSND– Warehouse table name: KQB_SMTP_SEND_ADAPTER or KQBSMTPSND


v Attribute group name: SOAP Receive Adapter– Table name: KQBSOAPRCV– Warehouse table name: KQB_SOAP_RECEIVE_ADAPTER or KQBSOAPRCV

v Attribute group name: SOAP Send Adapter– Table name: KQBSOAPSND– Warehouse table name: KQB_SOAP_SEND_ADAPTER or KQBSOAPSND

v Attribute group name: SQL Receive Adapter– Table name: KQBSQLRECV– Warehouse table name: KQB_SQL_RECEIVE_ADAPTER or KQBSQLRECV

v Attribute group name: SQL Send Adapter– Table name: KQBSQLSEND– Warehouse table name: KQB_SQL_SEND_ADAPTER or KQBSQLSEND

v Attribute group name: Subscribers– Table name: KQBSUBSCR– Warehouse table name: KQB_SUBSCRIBERS or KQBSUBSCR

v Attribute group name: Subscriptions– Table name: KQBSUBSCRP– Warehouse table name: KQB_SUBSCRIPTIONS or KQBSUBSCRP

v Attribute group name: TDDS– Table name: KQBBIZTDDS– Warehouse table name: KQB_TDDS or KQBBIZTDDS

v Attribute group name: Tracking Database– Table name: KQBMSBTSG3– Warehouse table name: KQB_TRACKING_DATABASE or KQBMSBTSG3

v Attribute group name: Vacuumer– Table name: KQBVACUUM– Warehouse table name: KQB_VACUUMER or KQBVACUUM

v Attribute group name: Windows SharePoint Services– Table name: KQBWSSADAP– Warehouse table name: KQB_WINDOWS_SHAREPOINT_SERVICES or KQBWSSADAP

v Attribute group name: Windows SharePoint Services Adapter– Table name: KQBWSADPTR– Warehouse table name: KQB_WINDOWS_SHAREPOINT_SERVICES_ADAPTER or KQBWSADPTR

Attributes in each attribute groupAttributes in each Microsoft BizTalk Server agent attribute group collect data that the agent uses formonitoring.

The descriptions of the attribute groups contain the following information:

Historical groupWhether the attribute group is a historical type that you can roll off to a data warehouse.

Attribute descriptionsDescription, type, warehouse name (if applicable), and other information for each attribute in theattribute group.


Some attributes are designated as key attributes. A key attribute is an attribute that is used inwarehouse aggregation to identify rows of data that represent the same object.

Application Status attribute groupThe Application Status attribute group includes attributes that provide information about the name andstatus of BizTalk application.Historical group

This attribute group is eligible for use with Tivoli Data Warehouse.Attribute descriptions

The following list contains information about each attribute in the Application Status attributegroup:Node attribute: This attribute is a key attribute.

DescriptionThe managed system name of the agent.

TypeString

SourceThe source for this attribute is agent.

Warehouse nameNODE

Timestamp attributeDescription

The local time at the agent when the data was collected.Type

StringSource

The source for this attribute is agent.Warehouse name

TIMESTAMPApplication Name attribute

DescriptionThis attribute displays the name of the BizTalk application.

TypeString

Warehouse nameAPPLICATION_NAME or APPNAME

Application Status attributeDescription

This attribute displays the status of the BizTalk application.Type

StringWarehouse name

APPLICATION_STATUS or APPSTATUSServer Name attribute

DescriptionThis attribute displays the name of the BizTalk Server.

TypeString

SourceThe source for this attribute is derived - getenv("computername").

Warehouse nameSERVER_NAME or SRVRNME


Availability attribute groupThe Availability attribute group contains the availability data for all processes and services that make upthis application.Historical group


The following list contains information about each attribute in the Availability attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPApplication Component attribute: This attribute is a key attribute.

DescriptionThe descriptive name of a part of the application.

TypeString


Warehouse nameAPPLICATION_COMPONENT or COMPONENT

Name attributeDescription

The name of the process, service, or functionality test. This name matches theexecutable name of the process, the service short name or the name of the processused to test the application.

TypeString with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v N/A (N/A)

Any other value is the value returned by the agent in the Tivoli Enterprise Portal.Source


NAMEStatus attribute

DescriptionThe status of the application component.v For processes 'UP', 'DOWN', 'WARNING', or

'PROCESS_DATA_NOT_AVAILABLE': 'PROCESS_DATA_NOT_AVAILABLE' is


displayed for a process when the matching process is running but the resourceuse information cannot be collected for that process.

v For services 'UP', 'DOWN', or 'UNKNOWN': 'UNKNOWN' is displayed whenthe service is not installed.

v For functionality tests: 'PASSED' or 'FAILED' is displayed.Type

Integer with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v DOWN (0)v UP (1)v WARNING (2)v UNKNOWN (3)v PASSED (4)v FAILED (5)v PROCESS DATA NOT AVAILABLE (6)



STATUSFull Name attribute

DescriptionThe full name of the process including the path.



The source for this attribute is collected from the operating system. It is gatheredfrom the Windows process. It is limited to 256 bytes.

Warehouse nameFULL_NAME or FULLNAME

Type attributeDescription

The type of the application component. Components are processes, services, orfunctionality tests.

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v PROCESS (0)v SERVICE (1)v FUNCTIONALITY TEST (2)



TYPEVirtual Size attribute

DescriptionThe virtual size (in MB) of the process.


TypeInteger (32-bit gauge)

SourceThe source for this attribute is collected from the operating system. It is gatheredfrom the Perfmon counter Process - Private Bytes.

Warehouse nameVIRTUAL_SIZE or VIRTSIZE

Page Faults per Sec attributeDescription

The rate of page faults for the process measured in faults per second. Thisattribute only contains valid data for processes.


SourceThe source for this attribute is collected from the operating system. It is gatheredfrom the Perfmon counter Process - Page Faults/sec.

Warehouse namePAGE_FAULTS_PER_SEC or PAGEFAULTS

Working Set Size attributeDescription

The working set size of the process in MB. This attribute only contains valid datafor processes.


SourceThe source for this attribute is collected from the operating system. It is gatheredfrom the Perfmon counter Process - Working Set.

Warehouse nameWORKING_SET_SIZE or WORKSET

Thread Count attributeDescription

The number of threads currently allocated by this process. This attribute onlycontains valid data for processes.


SourceThe source for this attribute is collected from the operating system. It is gatheredfrom the Perfmon counter Process - Thread Count.

Warehouse nameTHREAD_COUNT or THREADS

PID attributeDescription

The process ID associated with the process. This attribute only contains valid datafor processes.


SourceThe source for this attribute is collected from the operating system. It is gatheredfrom the Perfmon counter Process - ID Process.

Warehouse namePID

Percent Privileged Time attributeDescription

The percentage of the available CPU time that is being used by this process forprivileged operation.



SourceThe source for this attribute is collected from the operating system. It is gatheredfrom the Perfmon counter Process - % Privileged Time.

Warehouse namePERCENT_PRIVILEGED_TIME or PERCPRIV

Percent User Mode Time attributeDescription

The percentage of the available CPU time that is being used by this process foruser mode operation.


SourceThe source for this attribute is collected from the operating system. It is gatheredfrom the Perfmon counter Process - % User Time.

Warehouse namePERCENT_USER_MODE_TIME or PERCUSER

Percent Processor Time attributeDescription

The percentage of the elapsed time that this process used the processor to executeinstructions.


SourceThe source for this attribute is collected from the operating system. It is gatheredfrom the Perfmon counter Process - % Processor Time.

Warehouse namePERCENT_PROCESSOR_TIME or PERCPROC

Command Line attributeDescription

The program name and any arguments specified on the command line when theprocess was started. This has the value N/A if this is a Service, or Functionalitytest.



The source for this attribute is collected from the operating system. It is gatheredfrom the process.

Warehouse nameCOMMAND_LINE or CMDLINE

Functionality Test Status attributeDescription

The return code of the functionality test. When the monitored application isrunning correctly, 'SUCCESS' is displayed. 'NOT_RUNNING' is displayed when itis not running correctly. 'N/A' is displayed when the row does not represent afunctionality test.

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:


v SUCCESS (0)v N/A (1)v GENERAL ERROR (2)v WARNING (3)v NOT RUNNING (4)v DEPENDENT NOT RUNNING (5)v ALREADY RUNNING (6)v PREREQ NOT RUNNING (7)v TIMED OUT (8)v DOESNT EXIST (9)v UNKNOWN (10)v DEPENDENT STILL RUNNING (11)v INSUFFICIENT USER AUTHORITY (12)



FUNCTIONALITY_TEST_STATUS or FUNCSTATUSFunctionality Test Message attribute

DescriptionThe text message that corresponds to the Functionality Test Status. This is onlyvalid for functionality tests.




FUNCTIONALITY_TEST_MESSAGE or FUNCMSG

BAM Database attribute groupThe BAM Database attribute group includes attributes that provide information about the BizTalk BAMDatabase.Historical group


The following list contains information about each attribute in the BAM Database attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



String



Warehouse nameTIMESTAMP

Database Name attributeDescription

This attribute displays the BAM Database name.Type


DATABASE_NAME or BAMDBNAMEServer Name attribute

DescriptionThis attribute displays the BAM Database server name.

TypeString

Warehouse nameSERVER_NAME or BAMDBSERVE

BAM Interceptor attribute groupThe BAM Interceptor attribute group includes attributes that provide information about Business ActivityMonitoring (BAM) events.Historical group


The following list contains information about each attribute in the BAM Interceptor attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPAvg Extraction sec per BAM Event attribute

DescriptionThis attribute displays the average amount of time (in seconds) currently spent inextracting the BAM events.

TypeInteger (32-bit gauge) with enumerated values. The strings are displayed in theTivoli Enterprise Portal. The warehouse and queries return the values shown inparentheses. The following values are defined:v Value Exceeds Maximum (2147483647)v Value Exceeds Minimum (-2147483648)



The source for this attribute is Perfmon - BAM Interceptor\*\Avg. Extractionsec/BAM Event.

Warehouse nameAVG_EXTRACTION_SEC_PER_BAM_EVENT or AVG_EXTRAC

Avg Failed BAM Events per Flush attributeDescription

This attribute displays the average number of BAM events that currently failedduring a data flush to the primary import database since the Biztalk server wasstarted.



The source for this attribute is Perfmon - BAM Interceptor\*\Avg. Failed BAMEvents/Flush.

Warehouse nameAVG_FAILED_BAM_EVENTS_PER_FLUSH or AVGFABAME

Avg Flush sec per BAM Event attributeDescription

This attribute displays the average amount of time (in seconds) currently spent influshing BAM events.



The source for this attribute is Perfmon - BAM Interceptor\*\Avg. Flushsec/BAM Event.

Warehouse nameAVG_FLUSH_SEC_PER_BAM_EVENT or AVGFLBMEV

Avg Successful BAM Events per Flush attributeDescription

This attribute displays the average number of successful BAM events thatoccurred during a data flush to the primary import database.



The source for this attribute is Perfmon - BAM Interceptor\*\Avg. SuccessfulBAM Events/Flush.


Warehouse nameAVG_SUCCESSFUL_BAM_EVENTS_PER_FLUSH or AVGSUCBME

Total Failed BAM Events During Flush attributeDescription

This attribute displays the total number of BAM events that failed during a dataflush since the BizTalk Server was started.

TypeInteger (32-bit counter) with enumerated values. The strings are displayed in theTivoli Enterprise Portal. The warehouse and queries return the values shown inparentheses. The following values are defined:v Value Exceeds Maximum (2147483647)v Value Exceeds Minimum (-2147483648)


The source for this attribute is Perfmon - BAM Interceptor\*\Total Failed BAMEvents During Flush.

Warehouse nameTOTAL_FAILED_BAM_EVENTS_DURING_FLUSH or TOTFABAME

Total Successful BAM Events During Flush attributeDescription

This attribute displays the total number of successful BAM events that occurredduring a data flush operation to the primary import database since the BizTalkServer was started.



The source for this attribute is Perfmon - BAM Interceptor\*\Total SuccessfulBAM Events During Flush.

Warehouse nameTOTAL_SUCCESSFUL_BAM_EVENTS_DURING_FLUSH or TOTSUCBME

Name attribute: This attribute is a key attribute.Description

The name of the instance.Type

StringSource

The source for this attribute is PerfMon.Warehouse name

NAME

BizTalk Group Server Host attribute groupThe BizTalk Group Server Host attribute group includes attributes that provide information about theBizTalk group, server, host, host instance, and host instance service status.Historical group


The following list contains information about each attribute in the BizTalk Group Server Hostattribute group:Node attribute: This attribute is a key attribute.



TypeString


Warehouse nameNODE



StringSource


TIMESTAMPGroup Name attribute: This attribute is a key attribute.

DescriptionThis attribute displays the BizTalk group name.

TypeString

Warehouse nameGROUP_NAME or GRPNAME

Host Instance attributeDescription

This attribute displays the host instance name.Type


HOST_INSTANCE or HOSTINSTHost Name attribute

DescriptionThis attribute displays the host name.

TypeString

Warehouse nameHOST_NAME or HOSTNAME

Host Instance Status attributeDescription

This attribute displays the host instance service status.Type

Integer with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Stopped (1)v Start pending (2)v Stop pending (3)v Running (4)v Continue pending (5)v Pause pending (6)v Paused (7)v Unknown (8)

Any other value is the value returned by the agent in the Tivoli Enterprise Portal.


Warehouse nameHOST_INSTANCE_STATUS or HSTINSTST

Server Name attributeDescription

This attribute displays the name of the BizTalk Server.Type


SERVER_NAME or SRVRNME

BizTalk Host attribute groupThe BizTalk Host attribute group includes attributes that provide information about the BizTalk groupand BizTalk hosts.Historical group


The following list contains information about each attribute in the BizTalk Host attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource




TypeString


Host Name attributeDescription

This attribute displays the host name.Type


HOST_NAME or HOSTNAME

BizTalk NET Adapter for Oracle DB attribute groupThe BizTalk .NET Adapter for Oracle DB attribute group includes attributes that provide informationabout the time spent in milliseconds in completing the Line of Business (LOB) activity for the BizTalk.NET Adapter for Oracle DB.


Historical groupThis attribute group is eligible for use with Tivoli Data Warehouse.

Attribute descriptionsThe following list contains information about each attribute in the BizTalk NET Adapter forOracle DB attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPLOB Time attribute

DescriptionThis attribute displays the total time spent in milliseconds in the LOB applicationfor a specific action type.



The source for this attribute is Perfmon - BizTalk .NET Adapter for OracleDB\*\LOB Time (Cumulative).

Warehouse nameLOB_TIME_CUMULATIVE or LOB_TIME_C

LOB Time Delta attributeDescription

This attribute displays the change in time spent in the LOB application for aspecific action type.

TypeInteger (difference between successive values) with enumerated values. Thestrings are displayed in the Tivoli Enterprise Portal. The warehouse and queriesreturn the values shown in parentheses. The following values are defined:v Value Exceeds Maximum (2147483647)v Value Exceeds Minimum (-2147483648)


The source for this attribute is Perfmon - BizTalk .NET Adapter for OracleDB\*\LOB Time (Cumulative).

Warehouse nameLOB_TIME_CUMULATIVE_DELTA or LOB_TIMECD




StringSource


NAME

BizTalk NET Adapter for Oracle EBusiness Suite attribute groupThe BizTalk .NET Adapter for Oracle E-Business Suite attribute group includes attributes that provideinformation about the time spent in milliseconds in completing the LOB activity for the BizTalk .NETAdapter for Oracle E-Business Suite.Historical group


The following list contains information about each attribute in the BizTalk NET Adapter forOracle EBusiness Suite attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource






The source for this attribute is Perfmon - BizTalk .NET Adapter for OracleE-Business Suite\*\LOB Time (Cumulative).


LOB Time Delta attribute


DescriptionThis attribute displays the change in time spent in the LOB application for aspecific action type.



The source for this attribute is Perfmon - BizTalk .NET Adapter for OracleE-Business Suite\*\LOB Time (Cumulative).




StringSource


NAME

BizTalk NET Adapter for SAP attribute groupThe BizTalk .NET Adapter for SAP attribute group includes attributes that provide information about thetime spent in milliseconds in completing the LOB activity for the BizTalk .NET Adapter for SAP.Historical group


The following list contains information about each attribute in the BizTalk NET Adapter for SAPattribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource







The source for this attribute is Perfmon - BizTalk .NET Adapter for SAP\*\LOBTime (Cumulative).






The source for this attribute is Perfmon - BizTalk .NET Adapter for SAP\*\LOBTime (Cumulative).




StringSource


NAME

BizTalk NET Adapter for Siebel attribute groupThe BizTalk .NET Adapter for Siebel attribute group includes attributes that provide information aboutthe time spent in milliseconds in completing the LOB activity for the BizTalk .NET Adapter for Siebel.Historical group


The following list contains information about each attribute in the BizTalk NET Adapter for Siebelattribute group:Node attribute: This attribute is a key attribute.


TypeString



Warehouse nameNODE



StringSource






The source for this attribute is Perfmon - BizTalk .NET Adapter for Siebel\*\LOBTime (Cumulative).






The source for this attribute is Perfmon - BizTalk .NET Adapter for Siebel\*\LOBTime (Cumulative).




StringSource


NAME


BizTalk NET Adapter for SQL attribute groupThe BizTalk .NET Adapter for SQL attribute group includes attributes that provide information about thetime spent in milliseconds in completing the LOB activity for the BizTalk .NET Adapter for SQL.Historical group


The following list contains information about each attribute in the BizTalk NET Adapter for SQLattribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource






The source for this attribute is Perfmon - BizTalk .NET Adapter for SQL\*\LOBTime (Cumulative).







SourceThe source for this attribute is Perfmon - BizTalk .NET Adapter for SQL\*\LOBTime (Cumulative).




StringSource


NAME

BizTalk Server attribute groupThe BizTalk Server attribute group includes attributes that provide information about the BizTalk groupand BizTalk servers.Historical group


The following list contains information about each attribute in the BizTalk Server attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource




TypeString







Delivery Channels attribute groupThis attribute group includes attributes that provide information about the delivery channels object of aNotification Services instance for BAM.Historical group


The following list contains information about each attribute in the Delivery Channels attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPName attribute: This attribute is a key attribute.

DescriptionThis attribute displays the instance name for the delivery channels object.

TypeString

SourceThe source for this attribute is Script data.

Warehouse nameNAME

Messages Written To Transport attributeDescription

This attribute displays the total number of messages written by the selecteddelivery channel since the distributor was started.



The source for this attribute is Script data.Warehouse name

MESSAGES_WRITTEN_TO_TRANSPORT or MSGWTRNMessages Written To Transport Rate attribute

DescriptionThis attribute displays the number of messages currently written per second bythe selected delivery channel.





MESSAGES_WRITTEN_TO_TRANSPORT_RATE or MSGWTRRServer Name attribute


TypeString



Distributors attribute groupThis attribute group includes attributes that provide information about the distributor components of aNotification Services instance for BAM.Historical group


The following list contains information about each attribute in the Distributors attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource



DescriptionThis attribute displays the instance name for distributor components.

TypeString


Warehouse nameNAME


Delivery Requests Failed attributeDescription

This attribute displays the total number of delivery requests that failed since thedistributor was started.




DELIVERY_REQUESTS_FAILED or DELIVREQUFDelivery Requests Succeeded attribute

DescriptionThis attribute displays the total number of delivery requests that succeeded sincethe distributor was started.




DELIVERY_REQUESTS_SUCCEEDED or DELIVREQUSFormat Requests Failed attribute

DescriptionThis attribute displays the total number of format requests that failed since thedistributor was started.




FORMAT_REQUESTS_FAILED or FORMATREQFFormat Requests Succeeded attribute

DescriptionThis attribute displays the total number of format requests that succeeded sincethe distributor was started.

TypeInteger (32-bit counter) with enumerated values. The strings are displayed in theTivoli Enterprise Portal. The warehouse and queries return the values shown inparentheses. The following values are defined:v Value Exceeds Maximum (2147483647)


v Value Exceeds Minimum (-2147483648)



FORMAT_REQUESTS_SUCCEEDED or FORMATREQSNotification Bodies attribute

DescriptionThis attribute displays the total number of notification bodies that were processedby the distributor since it was started.




NOTIFICATION_BODIES or NOTIFIBODYNotification Headers attribute

DescriptionThis attribute displays the total number of notification headers that wereprocessed by the distributor since it was started.




NOTIFICATION_HEADERS or NOTIFIHEADServer Name attribute


TypeString



Event Log attribute groupThe Event Log attribute group contains any event log entries that pertain to this application.Historical group


The following list contains information about each attribute in the Event Log attribute group:Node attribute: This attribute is a key attribute.



TypeString


Warehouse nameNODE

Log Name attributeDescription

The name of the event log - Application, System, Security or anapplication-specific log

TypeString

Warehouse nameLOG_NAME or LOGNAME

Event Source attributeDescription

The event source defined by the applicationType


EVENT_SOURCE or EVTSOURCEEvent Type attribute

DescriptionEvent Type - Error(0), Warning(1), Informational(2), Audit_Success(3),Audit_Failure(4), Unknown(5)

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Error (0)v Warning (1)v Informational (2)v Audit Success (3)v Audit Failure (4)v Unknown (5)

Any other value is the value returned by the agent in the Tivoli Enterprise Portal.Warehouse name

EVENT_TYPE or EVTTYPEEvent ID attribute

DescriptionThe ID of the event

TypeInteger (32-bit counter)

Warehouse nameEVENT_ID or EVTID

Event Category attributeDescription

The Category of the eventType

String with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v None (None)



EVENT_CATEGORY or EVTCATEGMessage attribute

DescriptionThe event message

TypeString

Warehouse nameMESSAGE

Time Generated attributeDescription

The time the event was generatedType

TimestampWarehouse name

TIME_GENERATED or TIMESTAMP

Event Providers attribute groupThis attribute group includes attributes that provide information about the event provider object of aNotification Services instance for BAM.Historical group


The following list contains information about each attribute in the Event Providers attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource



DescriptionThis attribute displays the instance name for the event provider object.

TypeString


Warehouse nameNAME

Event Batches Aborted attribute


DescriptionThis attribute displays the total number of event batches that failed since theevent provider was started.




EVENT_BATCHES_ABORTED or EVENABTEvent Batches Committed attribute

DescriptionThis attribute displays the number of event batches committed since the eventprovider was started.




EVENT_BATCHES_COMMITTED or EVENBTCMTDEvents Per Batch attribute

DescriptionThis attribute displays the number of events per event batch for the selectedevent provider.




EVENTS_PER_BATCH or EVENPERBTEvents Received attribute

DescriptionThis attribute displays the total number of events received since the eventprovider was started.





EVENTS_RECEIVED or EVENTSRECDEvents Received Per Second attribute

DescriptionThis attribute displays the number of input events received currently per secondfor the selected event provider.




EVENTS_RECEIVED_PER_SECOND or EVENRECPSServer Name attribute


TypeString



Events attribute groupThis attribute group includes attributes that provide information about the events object of a NotificationServices instance for BAM.Historical group


The following list contains information about each attribute in the Events attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMP



This attribute displays the instance name for events object.Type

StringSource


NAMEEvent Batches Awaiting Generation attribute

DescriptionThis attribute displays the number of event batches that are currently committedbut not picked up by the generator.




EVENT_BATCHES_AWAITING_GENERATION or EVENTBATCHEvent Batches In Collection attribute

DescriptionThis attribute displays the number of event batches that are currently in processand not committed.




EVENT_BATCHES_IN_COLLECTION or EVENTBATC0Event Batches Submitted attribute

DescriptionThis attribute displays the number of event batches currently submitted.




EVENT_BATCHES_SUBMITTED or EVENTBATC1Total Events attribute


DescriptionThis attribute displays the number of events that are received since theapplication was started.




TOTAL_EVENTS or TOTALEVENTServer Name attribute


TypeString



File Receive Adapter attribute groupThe File Receive Adapter attribute group includes attributes that provide information about bytes andmessages received by file adapter.Historical group


The following list contains information about each attribute in the File Receive Adapter attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPBytes Received Per Sec (Superseded) attribute

DescriptionThis attribute displays the number of bytes received by the File Receive Adapterper second. The counter applies only to messages that have been completely readby the file adapter from the file system.


TypeReal number (32-bit gauge) with 2 decimal places of precision with enumeratedvalues. The strings are displayed in the Tivoli Enterprise Portal. The warehouseand queries return the values shown in parentheses. The following values aredefined:v Value Exceeds Maximum (2147483647)v Value Exceeds Minimum (-2147483648)


The source for this attribute is Perfmon - BizTalk:FILE Receive Adapter\*\BytesReceived/sec.

Warehouse nameBYTES_RECEIVED_PER_SEC or BYTES_REC0

Delete Retries attributeDescription

This attribute displays the number of times the File Receive Adapter attempts todelete a file that has been read.



The source for this attribute is Perfmon - BizTalk:FILE Receive Adapter\*\Deleteretries.

Warehouse nameDELETE_RETRIES or DELETE_RET

Lock Failures (Superseded) attributeDescription

This attribute displays the number of times the File Receive Adapter failed to lockthe file since the Biztalk server was started.



The source for this attribute is Perfmon - BizTalk:FILE Receive Adapter\*\Lockfailures.

Warehouse nameLOCK_FAILURES or LOCK_FAILU

Lock Failures Per Sec (Superseded) attributeDescription

This attribute displays the number of times the File Receive Adapter failed to lockthe file per second since the Biztalk server was started.

TypeReal number (32-bit gauge) with 2 decimal places of precision with enumeratedvalues. The strings are displayed in the Tivoli Enterprise Portal. The warehouseand queries return the values shown in parentheses. The following values aredefined:


v Value Exceeds Maximum (2147483647)v Value Exceeds Minimum (-2147483648)


The source for this attribute is Perfmon - BizTalk:FILE Receive Adapter\*\Lockfailures/sec.

Warehouse nameLOCK_FAILURES_PER_SEC or LOCK_FAIL0

Messages Received attributeDescription

This attribute displays the total number of messages received by the File ReceiveAdapter since the application started. The counter is incremented after a messageis read by the File Receive Adapter from the file system.



The source for this attribute is Perfmon - BizTalk:FILE ReceiveAdapter\*\Messages received.

Warehouse nameMESSAGES_RECEIVED or MESSAGES_R

Messages Received Per Sec attributeDescription

This attribute displays the number of messages received by the File ReceiveAdapter per second. The counter applies only to messages that have beencompletely read by the File Receive Adapter from the file system.



The source for this attribute is Perfmon - BizTalk:FILE ReceiveAdapter\*\Messages Received/sec.

Warehouse nameMESSAGES_RECEIVED_PER_SEC or MESSAGES_0

Time To Build Batch attributeDescription

This attribute displays the average time taken by File Receive Adapter to build abatch.




SourceThe source for this attribute is Perfmon - BizTalk:FILE Receive Adapter\*\Time tobuild batch.

Warehouse nameTIME_TO_BUILD_BATCH or TIME_TO_BU

Kilobytes Received (Superseded) attributeDescription

This attribute displays the total number of kilobytes received by the File ReceiveAdapter since the application started. The counter is incremented after a messageis read by the adapter from the file system.

TypeReal number (32-bit counter) with 2 decimal places of precision with enumeratedvalues. The strings are displayed in the Tivoli Enterprise Portal. The warehouseand queries return the values shown in parentheses. The following values aredefined:v Value Exceeds Maximum (2147483647)v Value Exceeds Minimum (-2147483648)


The source for this attribute is derived - Bytes_Received / 1024.Warehouse name

KILOBYTES_RECEIVED or BYTES_REC1Bytes Received Per Sec attribute

DescriptionThis attribute displays the number of bytes currently received by the File ReceiveAdapter per second. This attribute is the 64-bit version of the Bytes Received PerSec (Superseded) attribute.



The source for this attribute is Perfmon - BizTalk:FILE Receive Adapter\*\BytesReceived/sec.

Warehouse nameBYTES_RECEIVED_PER_SEC_64 or FBREC0_64

Lock Failures attributeDescription

This attribute displays the number of times the File Receive Adapter currentlyfailed to lock the file. This attribute is the 64-bit version of the Lock Failures(Superseded) attribute.




SourceThe source for this attribute is Perfmon - BizTalk:FILE Receive Adapter\*\Lockfailures.

Warehouse nameLOCK_FAILURES_64 or LOCKFAIL64

Lock Failures Per Sec attributeDescription

This attribute displays the number of times the File Receive Adapter currentlyfailed to lock the file per second. This attribute is the 64-bit version of the LockFailures Per Sec (Superseded) attribute.



The source for this attribute is Perfmon - BizTalk:FILE Receive Adapter\*\Lockfailures/sec.

Warehouse nameLOCK_FAILURES_PER_SEC_64 or LCKFAIL64

Kilobytes Received attributeDescription

This attribute displays the total number of kilobytes currently received by the FileReceive Adapter BizTalk Server was started. This attribute is the 64-bit version ofthe Kilobytes Received (Superseded) attribute.

TypeReal number (64-bit counter) with enumerated values. The strings are displayedin the Tivoli Enterprise Portal. The warehouse and queries return the valuesshown in parentheses. The following values are defined:v Value Exceeds Maximum (9223372036854775807)v Value Exceeds Minimum (-9223372036854775808)



KILOBYTES_RECEIVED_64 or FKBREC64Name attribute: This attribute is a key attribute.

DescriptionThe name of the instance.

TypeString

SourceThe source for this attribute is PerfMon.

Warehouse nameNAME

File Send Adapter attribute groupThe File Send Adapter attribute group includes attributes that provide information about bytes andmessages sent by file adapter.Historical group

This attribute group is eligible for use with Tivoli Data Warehouse.


Attribute descriptionsThe following list contains information about each attribute in the File Send Adapter attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPBytes Sent Per Sec (Superseded) attribute

DescriptionThis attribute displays the number of bytes sent by the File Send Adapter persecond. The counter applies only to messages that have been completely writtento file system.



The source for this attribute is Perfmon - BizTalk:FILE Send Adapter\*\BytesSent/sec.

Warehouse nameBYTES_SENT_PER_SEC or BYTES_SEN0

Messages Sent attributeDescription

This attribute displays the total number of messages sent by the File SendAdapter since the application started. The counter is incremented only formessages that have been completely written to file system.



The source for this attribute is Perfmon - BizTalk:FILE Send Adapter\*\Messagessent.


Warehouse nameMESSAGES_SENT or MESSAGES_S

Messages Sent Per Sec attributeDescription

This attribute displays the number of messages sent by the File Send Adapter persecond. The counter applies only to messages that have been completely writtento file system.



The source for this attribute is Perfmon - BizTalk:FILE Send Adapter\*\MessagesSent/sec.

Warehouse nameMESSAGES_SENT_PER_SEC or MESSAGES_0

Kilobytes Sent (Superseded) attributeDescription

This attribute displays the total number of kilobytes sent by the File SendAdapter since the application started since the application started. The counter isincremented only for messages that have been completely written to file system.



The source for this attribute is derived - Bytes_Sent / 1024.Warehouse name

KILOBYTES_SENT or BYTES_SEN1Bytes Sent Per Sec attribute

DescriptionThis attribute displays the number of bytes currently sent by the File SendAdapter per second. This attribute is the 64-bit version of the Bytes Sent Per Sec(Superseded) attribute.



The source for this attribute is Perfmon - BizTalk:FILE Send Adapter\*\BytesSent/sec.


Warehouse nameBYTES_SENT_PER_SEC_64 or FBSEN0_64

Kilobytes Sent attributeDescription

This attribute displays the total number of KB currently by the File Send Adapter.This attribute is the 64-bit version of the Kilobytes Sent (Superseded) attribute.




KILOBYTES_SENT_64 or FBSEN1_64Name attribute: This attribute is a key attribute.


TypeString


Warehouse nameNAME

FTP Receive Adapter attribute groupThe FTP Receive Adapter attribute group includes attributes that provide information about bytes andmessages received by FTP adapter.Historical group


The following list contains information about each attribute in the FTP Receive Adapter attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource




DescriptionThis attribute displays the number of bytes received by the FTP Receive Adapterper second. The counter applies only to messages that have been completely readby the FTP Receive Adapter from the FTP server.



The source for this attribute is Perfmon - BizTalk:FTP Receive Adapter\*\BytesReceived/sec.



This attribute displays the total number of messages received by the FTP ReceiveAdapter since the application started. The counter is incremented after a messageis read by the FTP Receive Adapter from the FTP server.



The source for this attribute is Perfmon - BizTalk:FTP ReceiveAdapter\*\Messages received.



This attribute displays the number of messages received by the FTP ReceiveAdapter per second. The counter applies only to messages that have beencompletely read by the FTP Receive Adapter from the FTP server.



The source for this attribute is Perfmon - BizTalk:FTP ReceiveAdapter\*\Messages Received/sec.


Kilobytes Received (Superseded) attribute


DescriptionThis attribute displays the total number of kilobytes received by the FTP ReceiveAdapter since the Biztalk server was started. The counter is incremented after amessage is read by the FTP Receive Adapter from the FTP server.





DescriptionThis attribute displays the number of bytes currently received by the FTP ReceiveAdapter per second. This attribute is the 64-bit version of the Bytes Received PerSec (Superseded) attribute.



The source for this attribute is Perfmon - BizTalk:FTP Receive Adapter\*\BytesReceived/sec.

Warehouse nameBYTES_RECEIVED_PER_SEC_64 or FTPREC0_64


This attribute displays the total number of KB currently received by the FTPReceive Adapter. This attribute is the 64-bit version of the Kilobytes Received(Superseded) attribute.




KILOBYTES_RECEIVED_64 or FTPKBRE_64Name attribute: This attribute is a key attribute.



TypeString


Warehouse nameNAME

FTP Send Adapter attribute groupThe FTP Send Adapter attribute group includes attributes that provide information about bytes andmessages sent by FTP adapter.Historical group


The following list contains information about each attribute in the FTP Send Adapter attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource



DescriptionThis attribute displays the number of bytes sent by the FTP Send Adapter persecond. The counter applies only to messages that have been written to thedestination FTP server.



The source for this attribute is Perfmon - BizTalk:FTP Send Adapter\*\BytesSent/sec.



This attribute displays the total number of messages sent by the FTP Send


Adapter since the application started. The counter is incremented only formessages that have been written to the destination FTP server.



The source for this attribute is Perfmon - BizTalk:FTP Send Adapter\*\Messagessent.



This attribute displays the number of messages sent by the FTP Send Adapter persecond. The counter applies only to messages that have been written todestination FTP server.



The source for this attribute is Perfmon - BizTalk:FTP Send Adapter\*\MessagesSent/sec.



This attribute displays the total number of kilobytes sent by the FTP SendAdapter since the Biztalk server was started. The counter is incremented only formessages that have been written to the destination FTP server.





DescriptionThis attribute displays the number of currently bytes sent by the FTP SendAdapter per second. This attribute is the 64-bit version of the Bytes Sent Per Sec(Superseded) attribute.




The source for this attribute is Perfmon - BizTalk:FTP Send Adapter\*\BytesSent/sec.

Warehouse nameBYTES_SENT_PER_SEC_64 or FTPSEN0_64


This attribute displays the total number of kilobytes sent by the FTP SendAdapter since the BizTalk Server was started. This attribute is the 64-bit versionof the Kilobytes Sent (Superseded) attribute.




KILOBYTES_SENT_64 or FTPKBSE_64Name attribute: This attribute is a key attribute.


TypeString


Warehouse nameNAME

Generator attribute groupThis attribute group includes attributes that provide information about the generator object of aNotification Services instance for BAM.Historical group


The following list contains information about each attribute in the Generator attribute group:Node attribute: This attribute is a key attribute.


TypeString



Warehouse nameNODE



StringSource



DescriptionThis attribute displays the instance name for the generator object.

TypeString


Warehouse nameNAME

Notifications Generated Per Second attributeDescription

This attribute displays the number notifications that are currently created persecond.




NOTIFICATIONS_GENERATED_PER_SECOND or NOTIFGPSQuanta Behind attribute

DescriptionThis attribute displays the number of quanta that the generator is currentlylagging.




QUANTA_BEHIND or QNTABHNDQuanta Failed attribute

DescriptionThis attribute displays the number of quanta that failed since the generator wasstarted. Quantum failure indicates that at least one of the rules in the quantumfailed.





QUANTA_FAILED or QNTAFAILQuanta Processed attribute

DescriptionThis attribute displays the total number of quanta that were processed since thegenerator was started. If the generator is trying to catch up, this number can bevery high.




QUANTA_PROCESSED or QUANTAPRCRule Firing Failures attribute

DescriptionThis attribute displays the total number of rule firings that failed since thegenerator was started.




RULE_FIRING_FAILURES or RULEFIRFARule Firings attribute

DescriptionThis attribute displays the total number of rule firings since the generator wasstarted.





Warehouse nameRULE_FIRINGS or RULEFIRNG

Skipped Chronicle Rule Firings attributeDescription

This attribute displays the total number of quanta that was skipped for chroniclerule firings since the generator was started.




SKIPPED_CHRONICLE_RULE_FIRINGS or SKCHRRUFRSkipped Quanta attribute

DescriptionThis attribute displays the total number of quanta that the generator skippedsince the generator was started.




SKIPPED_QUANTA or SKIPEDQUNSkipped Subscription Rule Firings attribute

DescriptionThis attribute displays the number of quanta that is currently skipped forsubscription rule firings.




SKIPPED_SUBSCRIPTION_RULE_FIRINGS or SKSUBRUFRServer Name attribute


TypeString




Host Throttling attribute groupThis attribute group includes attributes that provide information about host throttling in BizTalk Server.This group is applicable for BizTalk 2006/2006 R2, but not for BizTalk 2004. Situations based on thisgroup will not trigger for BizTalk 2004.Historical group


The following list contains information about each attribute in the Host Throttling attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPActive Instance Count attribute

DescriptionThis attribute displays the current number of active instances loaded in memory,including the standby instances.



The source for this attribute is Perfmon - BizTalk:Message agent\*\Activeinstance count.

Warehouse nameACTIVE_INSTANCE_COUNT or ACTIVE_INS

Database Session attributeDescription

This attribute displays the number of open database connections to theMessageBox.

TypeInteger (32-bit gauge) with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the values shown inparentheses. The following values are defined:v Value Exceeds Maximum (2147483647)v Value Exceeds Minimum (-2147483648)


The source for this attribute is Perfmon - BizTalk:Message agent\*\Databasesession.

Warehouse nameDATABASE_SESSION or DATABASE_S

Database Session Threshold attributeDescription

This attribute displays the current threshold for the number of open databaseconnections to the MessageBox.



The source for this attribute is Perfmon - BizTalk:Message agent\*\Databasesession threshold.

Warehouse nameDATABASE_SESSION_THRESHOLD or DATABASE_0

Database Size attributeDescription

This attribute displays the number of messages in the database queues that thisprocess has published.



The source for this attribute is Perfmon - BizTalk:Message agent\*\Database size.Warehouse name

DATABASE_SIZE or DATABASE_1High Database Session attribute

DescriptionThis attribute indicates (in form of status codes) if the number of currentlyopened database sessions exceeds the threshold.

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Normal (0)v Threshold exceeded (1)



SourceThe source for this attribute is Perfmon - BizTalk:Message agent\*\High databasesession.

Warehouse nameHIGH_DATABASE_SESSION or HIGH_DATAB

High Database Size attributeDescription

This attribute indicates (in form of status codes) whether the database size isnormal or exceeded the threshold values.



The source for this attribute is Perfmon - BizTalk:Message agent\*\High databasesize.

Warehouse nameHIGH_DATABASE_SIZE or HIGH_DATA0

High In Process Message Count attributeDescription

This attribute indicates (in form of status codes) whether the In-Process messagecount is normal or exceeded the threshold values.



The source for this attribute is Perfmon - BizTalk:Message agent\*\Highin-process message count.

Warehouse nameHIGH_IN_PROCESS_MESSAGE_COUNT or HIGH_IN_PR

High Message Delivery Rate attributeDescription

This attribute indicates (in form of status codes) if the message delivery rate ishigher than the message processing rate.

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Normal (0)v Exceeded the message processing rate (1)


The source for this attribute is Perfmon - BizTalk:Message agent\*\High messagedelivery rate.

Warehouse nameHIGH_MESSAGE_DELIVERY_RATE or HIGH_MESSA

High Message Publishing Rate attribute


DescriptionThis attribute indicates (in form of status codes) if the message publishing requestrate is higher than the message publishing completion rate.

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Normal (0)v Exceeded the message completion rate (1)


The source for this attribute is Perfmon - BizTalk:Message agent\*\High messagepublishing rate.

Warehouse nameHIGH_MESSAGE_PUBLISHING_RATE or HIGH_MESS0

High Process Memory attributeDescription

This attribute indicates (in form of status codes) if the process memoryconsumption exceeds the threshold.



The source for this attribute is Perfmon - BizTalk:Message agent\*\High processmemory.

Warehouse nameHIGH_PROCESS_MEMORY or HIGH_PROCE

High System Memory attributeDescription

This attribute indicates (in form of status codes) if the system-wide physicalmemory consumption exceeds the threshold.



The source for this attribute is Perfmon - BizTalk:Message agent\*\High systemmemory.

Warehouse nameHIGH_SYSTEM_MEMORY or HIGH_SYSTE

High Thread Count attributeDescription

This attribute indicates (in form of status codes) if the thread count exceeds thethreshold.




The source for this attribute is Perfmon - BizTalk:Message agent\*\High threadcount.

Warehouse nameHIGH_THREAD_COUNT or HIGH_THREA

In Process Message Count attributeDescription

This attribute displays the number of concurrent messages that the service class isprocessing.



The source for this attribute is Perfmon - BizTalk:Message agent\*\In-processmessage count.

Warehouse nameIN_PROCESS_MESSAGE_COUNT or IN_PROCESS

In Process Message Count Threshold attributeDescription

This attribute displays the current threshold for the number of concurrentmessages that the service class is processing.



The source for this attribute is Perfmon - BizTalk:Message agent\*\In-processmessage count threshold.

Warehouse nameIN_PROCESS_MESSAGE_COUNT_THRESHOLD or IN_PROCES0

Message Delivery Delay In Sec attributeDescription

This attribute displays the current delay in seconds imposed on each messagedelivery batch. This is applicable if the message delivery is being throttled.

TypeReal number (32-bit gauge) with 2 decimal places of precision with enumeratedvalues. The strings are displayed in the Tivoli Enterprise Portal. The warehouseand queries return the values shown in parentheses. The following values aredefined:v Value Exceeds Maximum (2147483647)




The source for this attribute is derived - Message_Delivery_Delay_In_MS / 1000.Warehouse name

MESSAGE_DELIVERY_DELAY_IN_SEC or MESSAGE_D5Message Delivery Incoming Rate attribute

DescriptionThis attribute displays the number of messages per second that are beingdelivered to the Orchestration engine or the Messaging engine in the givensample interval.



The source for this attribute is Perfmon - BizTalk:Message agent\*\Messagedelivery incoming rate.

Warehouse nameMESSAGE_DELIVERY_INCOMING_RATE or MESSAGE_D0

Message Delivery Outgoing Rate attributeDescription

This attribute displays the number of messages per second that are beingprocessed by the Orchestration engine or the Messaging engine in the givensample interval.



The source for this attribute is Perfmon - BizTalk:Message agent\*\Messagedelivery outgoing rate.

Warehouse nameMESSAGE_DELIVERY_OUTGOING_RATE or MESSAGE_D1

Message Delivery Throttling State attributeDescription

This attribute indicates the throttling state of the message delivery. A non-zerovalue indicates that the message delivery is being throttled.

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Normal (0)v Imbalanced message delivery rate (1)v High in-process message count (3)v High process memory (4)v High system memory (5)v High thread count (9)


v User override on delivery (10)


The source for this attribute is Perfmon - BizTalk:Message agent\*\Messagedelivery throttling state.

Warehouse nameMESSAGE_DELIVERY_THROTTLING_STATE or MESSAGE_D2

Message Delivery Throttling State Duration In Min attributeDescription

This attribute displays the minutes spent in the current state (throttling or notthrottling) of message delivery throttling.



The source for this attribute is derived -Message_Delivery_Throttling_State_Duration / 60.

Warehouse nameMESSAGE_DELIVERY_THROTTLING_STATE_DURATION_IN_MIN orMESSAGE_D6

Message Delivery Throttling User Override attributeDescription

This attribute displays the message publishing throttling user override that ismonitored by the engine.

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Normal (0)v Always throttle message delivery (1)v Do not throttle message delivery (2)


The source for this attribute is Perfmon - BizTalk:Message agent\*\Messagedelivery throttling user override.

Warehouse nameMESSAGE_DELIVERY_THROTTLING_USER_OVERRIDE or MESSAGE_D4

Message Publishing Delay In Sec attributeDescription

This attribute displays the current delay in seconds imposed on each messagepublishing batch. It is applicable if the message publishing is being throttled andif the batch is not exempted from throttling.




The source for this attribute is derived - Message_Publishing_Delay_In_MS /1000.

Warehouse nameMESSAGE_PUBLISHING_DELAY_IN_SEC or MESSAGE_P5

Message Publishing Incoming Rate attributeDescription

This attribute displays the number of messages per second that are being sent tothe database for publishing in the given sample interval.



The source for this attribute is Perfmon - BizTalk:Message agent\*\Messagepublishing incoming rate.

Warehouse nameMESSAGE_PUBLISHING_INCOMING_RATE or MESSAGE_P0

Message Publishing Outgoing Rate attributeDescription

This attribute displays the number of messages per second that are actuallypublished in the database in the given sample interval.



The source for this attribute is Perfmon - BizTalk:Message agent\*\Messagepublishing outgoing rate.

Warehouse nameMESSAGE_PUBLISHING_OUTGOING_RATE or MESSAGE_P1

Message Publishing Throttling State attributeDescription

This attribute displays the throttling state of the message publishing. A non-zerovalue indicates that the message publishing is being throttled.

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Normal (0)v Imbalanced message publishing rate (2)v High process memory (4)v High system memory (5)v Database growth (6)v High session count (8)v High thread count (9)v User override on publishing (11)



The source for this attribute is Perfmon - BizTalk:Message agent\*\Messagepublishing throttling state.

Warehouse nameMESSAGE_PUBLISHING_THROTTLING_STATE or MESSAGE_P2

Message Publishing Throttling State Duration In Min attributeDescription

This attribute displays the minutes spent in the current state (throttling or notthrottling) of message publish throttling.



The source for this attribute is derived -Message_Publishing_Throttling_State_Duration / 60.

Warehouse nameMESSAGE_PUBLISHING_THROTTLING_STATE_DURATION_IN_MIN orMESSAGE_P6

Message Publishing Throttling User Override attributeDescription

This attribute displays the message delivery throttling user override that ismonitored by the engine.

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Normal (0)v Always throttle message publishing (1)v Do not throttle message publishing (2)


The source for this attribute is Perfmon - BizTalk:Message agent\*\Messagepublishing throttling user override.

Warehouse nameMESSAGE_PUBLISHING_THROTTLING_USER_OVERRIDE or MESSAGE_P4

Physical Memory Usage In MB attributeDescription

This attribute displays the amount of physical memory in megabytes being usedon the machine by all processes.




SourceThe source for this attribute is Perfmon - BizTalk:Message agent\*\Physicalmemory usage (MB).

Warehouse namePHYSICAL_MEMORY_USAGE_IN_MB or PHYSICAL_M

Process Memory Usage In MB attributeDescription

This attribute displays the process memory consumption in megabytes.Type

Integer (32-bit gauge) with enumerated values. The strings are displayed in theTivoli Enterprise Portal. The warehouse and queries return the values shown inparentheses. The following values are defined:v Value Exceeds Maximum (2147483647)v Value Exceeds Minimum (-2147483648)


The source for this attribute is Perfmon - BizTalk:Message agent\*\Processmemory usage (MB).

Warehouse namePROCESS_MEMORY_USAGE_IN_MB or PROCESS_ME

Process Memory Usage Threshold In MB attributeDescription

This attribute displays the current threshold for process memory consumption inmegabytes.



The source for this attribute is Perfmon - BizTalk:Message agent\*\Processmemory usage threshold (MB).

Warehouse namePROCESS_MEMORY_USAGE_THRESHOLD_IN_MB or PROCESS_M0

Thread Count attributeDescription

This attribute displays the number of threads being used within the process.Type



The source for this attribute is Perfmon - BizTalk:Message agent\*\Thread Count.Warehouse name

THREAD_COUNT or THREAD_COUThread Count Threshold attribute

DescriptionThis attribute displays the current threshold for the number of threads in theprocess.




The source for this attribute is Perfmon - BizTalk:Message agent\*\Thread countthreshold.

Warehouse nameTHREAD_COUNT_THRESHOLD or THREAD_CO0

Total Batches Committed attributeDescription

This attribute displays the number of database batches that the service class hascommitted.



The source for this attribute is Perfmon - BizTalk:Message agent\*\Total batchescommitted.

Warehouse nameTOTAL_BATCHES_COMMITTED or TOTAL_BATC

Total Messages Delivered attributeDescription

This attribute displays the number of outbound messages delivered to theOrchestration engine or the End Point Manager (EPM).



The source for this attribute is Perfmon - BizTalk:Message agent\*\Total messagesdelivered.

Warehouse nameTOTAL_MESSAGES_DELIVERED or TOTAL_MESS

Total Messages Published attributeDescription

This attribute displays the total number of messages published.Type




SourceThe source for this attribute is Perfmon - BizTalk:Message agent\*\Total messagespublished.

Warehouse nameTOTAL_MESSAGES_PUBLISHED or TOTAL_MES0



StringSource

The source for this attribute is derived - getenv("computername").Warehouse name

SERVER_NAME or SRVRNMEName attribute: This attribute is a key attribute.


TypeString


Warehouse nameNAME

HTTP Receive Adapter attribute groupThe HTTP Receive Adapter attribute group includes attributes that provide information about requestsreceived and acknowledgements sent by HTTP adapter.Historical group


The following list contains information about each attribute in the HTTP Receive Adapterattribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPMemory Queue Size attribute

DescriptionThis attribute displays the number of incoming messages in the HTTP ReceiveAdapter's internal memory queue.




The source for this attribute is Perfmon - BizTalk:HTTP ReceiveAdapter\*\Memory queue size.

Warehouse nameMEMORY_QUEUE_SIZE or MEMORY_QUE


This attribute displays the total number of HTTP requests received by the HTTPReceive Adapter since the application started. The counter is incremented after arequest message is read by the HTTP Receive Adapter from the HTTP client.



The source for this attribute is Perfmon - BizTalk:HTTP ReceiveAdapter\*\Messages received.



This attribute displays the number of HTTP requests received by the HTTPReceive Adapter per second. The counter applies only to request messages thathave been completely read by the HTTP Receive Adapter from the HTTP client.



The source for this attribute is Perfmon - BizTalk:HTTP ReceiveAdapter\*\Messages Received/sec.



This attribute displays the total number of HTTP responses sent by the HTTPReceive Adapter since the application started. The counter is incremented only forresponse messages that have been successfully sent to HTTP clients.

TypeInteger (32-bit counter) with enumerated values. The strings are displayed in the




The source for this attribute is Perfmon - BizTalk:HTTP ReceiveAdapter\*\Messages sent.



This attribute displays the number of HTTP responses sent by the HTTP ReceiveAdapter per second. The counter applies only to response messages that havebeen successfully sent to HTTP clients.



The source for this attribute is Perfmon - BizTalk:HTTP ReceiveAdapter\*\Messages Sent/sec.


Time To Add Message To Batch attributeDescription

This attribute displays the average time between when a message is given to theHTTP Receive Adapter by IIS and when the message is added to a batch.



The source for this attribute is Perfmon - BizTalk:HTTP Receive Adapter\*\Timeto add message to batch.

Warehouse nameTIME_TO_ADD_MESSAGE_TO_BATCH or TIME_TO_AD

Time To Build Batch attributeDescription

This attribute displays the average time taken by the HTTP Receive Adapter tobuild a message batch.

TypeReal number (32-bit gauge) with 2 decimal places of precision with enumeratedvalues. The strings are displayed in the Tivoli Enterprise Portal. The warehouseand queries return the values shown in parentheses. The following values aredefined:




The source for this attribute is Perfmon - BizTalk:HTTP Receive Adapter\*\Timeto build batch.

Warehouse nameTIME_TO_BUILD_BATCH or TIME_TO_BU



StringSource


NAME

HTTP Send Adapter attribute groupThe HTTP Send Adapter attribute group includes attributes that provide information about responsessent and acknowledgements received by HTTP adapter.Historical group


The following list contains information about each attribute in the HTTP Send Adapter attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPMemory Queue Size attribute

DescriptionThis attribute displays the number of outgoing messages in the HTTP SendAdapter's internal memory queue.




The source for this attribute is Perfmon - BizTalk:HTTP Send Adapter\*\Memoryqueue size.

Warehouse nameMEMORY_QUEUE_SIZE or MEMORY_QUE


This attribute displays the total number of HTTP response messages received bythe HTTP Send Adapter since the application started. The counter is incrementedafter a response message is read by the HTTP Send Adapter from HTTP servers.



The source for this attribute is Perfmon - BizTalk:HTTP SendAdapter\*\Messages received.



This attribute displays the number of HTTP responses received by the HTTP SendAdapter per second. The counter applies only to response messages that havebeen completely read by the HTTP Send Adapter from HTTP servers.



The source for this attribute is Perfmon - BizTalk:HTTP SendAdapter\*\Messages Received/sec.



This attribute displays the total number of HTTP requests sent by the HTTP SendAdapter since the application started. The counter is incremented only for requestmessages that have reached the destination URL.




SourceThe source for this attribute is Perfmon - BizTalk:HTTP SendAdapter\*\Messages sent.



This attribute displays the number of HTTP requests sent by the HTTP SendAdapter per second. The counter applies only to request messages that havereached the destination URL.



The source for this attribute is Perfmon - BizTalk:HTTP SendAdapter\*\Messages Sent/sec.




StringSource


NAME

Human Workflow Services attribute groupThe Human Workflow Services attribute group includes attributes that provide information about theactivities take place between people or processes.Historical group


The following list contains information about each attribute in the Human Workflow Servicesattribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



String




Activity Flows Retrieved attributeDescription

This attribute displays the number of activity flows retrieved from trackingdatabase.



The source for this attribute is Perfmon - Human Workflow Services\*\ActivityFlows Retrieved.

Warehouse nameACTIVITY_FLOWS_RETRIEVED or ACTIVITY_F

New Action Added attributeDescription

This attribute displays the number of actions added to activity flows.Type



The source for this attribute is Perfmon - Human Workflow Services\*\NewAction Added.

Warehouse nameNEW_ACTION_ADDED or NEW_ACTION

New Activity Flows attributeDescription

This attribute displays the number of new activity flows created.Type



The source for this attribute is Perfmon - Human Workflow Services\*\NewActivity Flows.

Warehouse nameNEW_ACTIVITY_FLOWS or NEW_ACTIVI

Steps Retrieved attributeDescription

This attribute displays the number of actions retrieved from tracking database.




The source for this attribute is Perfmon - Human Workflow Services\*\StepsRetrieved.

Warehouse nameSTEPS_RETRIEVED or STEPS_RETR

Tasks Retrieved attributeDescription

This attribute displays the number of tasks retrieved from tracking database.Type



The source for this attribute is Perfmon - Human Workflow Services\*\TasksRetrieved.

Warehouse nameTASKS_RETRIEVED or TASKS_RETR



StringSource



Management Database attribute groupThe Management Database attribute group includes attributes that provide information about the BizTalkManagement Database.Historical group


The following list contains information about each attribute in the Management Databaseattribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE




StringSource


TIMESTAMPDatabase Name attribute

DescriptionThis attribute displays the Management Database name.

TypeString

Warehouse nameDATABASE_NAME or MGMTDBNAME


This attribute displays the Management Database server name.Type


SERVER_NAME or MGMTDBSERV

Message Box General Counters attribute groupThe Message Box General Counters attribute group includes attributes that provide information aboutMessageBox database used by the BizTalk Server.Historical group


The following list contains information about each attribute in the Message Box General Countersattribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPInstances Total Number attribute

DescriptionThis attribute tracks the sum of all the instances of each host, which exist withina particular Message Box.




The source for this attribute is Perfmon - BizTalk:Message Box:GeneralCounters\*\Instances - Total Number.

Warehouse nameINSTANCES_TOTAL_NUMBER or INSTANCES_

MsgBox Dead Processes Cleanup Purge Jobs attributeDescription

This attribute displays time in seconds for the most recent run of the SQL agentjob. This releases the database rows associated with dead BizTalk processes.



The source for this attribute is Perfmon - BizTalk:Message Box:GeneralCounters\*\MsgBox Dead Processes Cleanup (Purge Jobs).

Warehouse nameMSGBOX_DEAD_PROCESSES_CLEANUP_PURGE_JOBS or MSGBOX_DEA

MsgBox Msg Cleanup Purge Jobs attributeDescription

This attribute displays time in seconds for the most recent run of the SQL agentjob. This cleans up message box tables associated with removed messages.



The source for this attribute is Perfmon - BizTalk:Message Box:GeneralCounters\*\MsgBox Msg Cleanup (Purge Jobs).

Warehouse nameMSGBOX_MSG_CLEANUP_PURGE_JOBS or MSGBOX_MSG

MsgBox Parts Cleanup Purge Jobs attributeDescription

This attribute displays time in seconds for the most recent run of the SQL agentjob. This clean up message box tables associated with removed message parts.




The source for this attribute is Perfmon - BizTalk:Message Box:GeneralCounters\*\MsgBox Parts Cleanup (Purge Jobs).

Warehouse nameMSGBOX_PARTS_CLEANUP_PURGE_JOBS or MSGBOX_PAR

MsgBox Purge Subscriptions Job Purge Jobs attributeDescription

This attribute displays time in seconds for the most recent run of the SQL agentjob. This purges subscriptions which are no longer in use.



The source for this attribute is Perfmon - BizTalk:Message Box:GeneralCounters\*\MsgBox Purge Subscriptions Job (Purge Jobs).

Warehouse nameMSGBOX_PURGE_SUBSCRIPTIONS_JOB_PURGE_JOBS or MSGBOX_PUR

Spool Size attributeDescription

This attribute tracks the size of the spool on a particular message box on aparticular server.



The source for this attribute is Perfmon - BizTalk:Message Box:GeneralCounters\*\Spool Size.

Warehouse nameSPOOL_SIZE

Tracked Msgs Copy Purge Jobs attributeDescription

This attribute displays time in seconds for the most recent run of the SQL agentjob. This copies tracked message bodies for tracked messages.



The source for this attribute is Perfmon - BizTalk:Message Box:GeneralCounters\*\Tracked Msgs Copy (Purge Jobs).

Warehouse nameTRACKED_MSGS_COPY_PURGE_JOBS or TRACKED_MS


Tracking Data Size attributeDescription

This attribute tracks the size of the tracking data table on a particular messagebox on a particular server.



The source for this attribute is Perfmon - BizTalk:Message Box:GeneralCounters\*\Tracking Data Size.

Warehouse nameTRACKING_DATA_SIZE or TRACKING_D

Change in Tracking Data Size attributeDescription

This attribute displays the change in 'Tracking Data Size'.Type

Integer (difference between successive values) with enumerated values. Thestrings are displayed in the Tivoli Enterprise Portal. The warehouse and queriesreturn the values shown in parentheses. The following values are defined:v Value Exceeds Maximum (2147483647)v Value Exceeds Minimum (-2147483648)


The source for this attribute is Perfmon - BizTalk:Message Box:GeneralCounters\*\Tracking Data Size.

Warehouse nameCHANGE_IN_TRACKING_DATA_SIZE or TRACKING_0

Tracking Spool Cleanup Purge Jobs attributeDescription

This attribute displays time in seconds for the most recent run of the SQL agentjob. This purges the inactive tracking spool tables.



The source for this attribute is Perfmon - BizTalk:Message Box:GeneralCounters\*\Tracking Spool Cleanup (Purge Jobs).

Warehouse nameTRACKING_SPOOL_CLEANUP_PURGE_JOBS or TRACKING_S



StringSource

The source for this attribute is PerfMon.


Warehouse nameNAME

Message Box Host Counters attribute groupThe Message Box Host Counters attribute group includes attributes that provide information about thehosts of the BizTalk Server.Historical group


The following list contains information about each attribute in the Message Box Host Countersattribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPHost Queue Instance State Msg Refs Length attribute

DescriptionThis attribute tracks the number of message references in the instance state queuefor the particular host.



The source for this attribute is Perfmon - BizTalk:Message Box:HostCounters\*\Host Queue - Instance State Msg Refs - Length.

Warehouse nameHOST_QUEUE_INSTANCE_STATE_MSG_REFS_LENGTH or HOST_QUEUE

Host Queue Length attributeDescription

This attribute tracks the total number of messages in the particular host.Type




The source for this attribute is Perfmon - BizTalk:Message Box:HostCounters\*\Host Queue - Length.

Warehouse nameHOST_QUEUE_LENGTH or HOST_QUEU0

Host Queue Number of Instances attributeDescription

This attribute tracks the number of instances of the particular host.Type



The source for this attribute is Perfmon - BizTalk:Message Box:HostCounters\*\Host Queue - Number of Instances.

Warehouse nameHOST_QUEUE_NUMBER_OF_INSTANCES or HOST_QUEU1

Host Queue Suspended Msgs Length attributeDescription

This attribute tracks the total number of suspended messages for the particularhost.



The source for this attribute is Perfmon - BizTalk:Message Box:HostCounters\*\Host Queue - Suspended Msgs - Length.

Warehouse nameHOST_QUEUE_SUSPENDED_MSGS_LENGTH or HOST_QUEU2



StringSource


NAME

Messagebox Database attribute groupThe Messagebox Database attribute group includes attributes that provide information about the BizTalkMessagebox Database.Historical group



Attribute descriptionsThe following list contains information about each attribute in the Messagebox Database attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource



DescriptionThis attribute displays the Messagebox Database name.

TypeString

Warehouse nameDATABASE_NAME or MSGBOXDBNA


This attribute displays the Messagebox Database server name.Type


SERVER_NAME or MSGBOXDBSEDisable New Message Publication attribute

DescriptionThis attribute displays whether the publication of new messages in theMessageBox database is enabled or disabled.

TypeString

Warehouse nameDISABLE_NEW_MESSAGE_PUBLICATION or DISABLENEW

Is Master Message Box attributeDescription

This attribute displays whether the MessageBox is the master MessageBoxdatabase.

TypeString

Warehouse nameIS_MASTER_MESSAGE_BOX or ISMASTERMS

Messaging attribute groupThe Messaging attribute group includes attributes that provide information about documents processed,submitted.



Attribute descriptionsThe following list contains information about each attribute in the Messaging attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPActive Receive Locations attribute

DescriptionThis attribute displays the number of receive locations currently enabled in thishost instance.



The source for this attribute is Perfmon - BizTalk:Messaging\*\Active receivelocations.

Warehouse nameACTIVE_RECEIVE_LOCATIONS or ACTIVE_REC

Active Receive Threads attributeDescription

This attribute displays the number of threads in the Messaging Engine currentlyprocessing messages received from adapters running in this host instance. Theseinclude messages that have been processed asynchronously by Send Adapters.



The source for this attribute is Perfmon - BizTalk:Messaging\*\Active receivethreads.

Warehouse nameACTIVE_RECEIVE_THREADS or ACTIVE_RE0


Active Send Messages attributeDescription

This attribute displays the number of messages the Messaging Engine hascurrently in send processing. This includes messages currently in send pipelineprocessing as well as response messages for Receive Adapters.



The source for this attribute is Perfmon - BizTalk:Messaging\*\Active sendmessages.

Warehouse nameACTIVE_SEND_MESSAGES or ACTIVE_SEN

Active Send Threads attributeDescription

This attribute displays the number of threads in the Messaging Engine currentlyprocessing messages to send to adapters. This includes response messages toReceive Adapters.



The source for this attribute is Perfmon - BizTalk:Messaging\*\Active sendthreads.

Warehouse nameACTIVE_SEND_THREADS or ACTIVE_SE0

Documents Processed attributeDescription

This attribute displays the documents processed since the application started.Type

Integer (32-bit counter) with enumerated values. The strings are displayed in theTivoli Enterprise Portal. The warehouse and queries return the values shown inparentheses. The following values are defined:v Value Exceeds Maximum (2147483647)v Value Exceeds Minimum (-2147483648)


The source for this attribute is Perfmon - BizTalk:Messaging\*\Documentsprocessed.

Warehouse nameDOCUMENTS_PROCESSED or DOCUMENTS_

Documents Processed Per Sec attributeDescription

This attribute displays the documents processed per second.Type

Real number (32-bit gauge) with 2 decimal places of precision with enumerated


values. The strings are displayed in the Tivoli Enterprise Portal. The warehouseand queries return the values shown in parentheses. The following values aredefined:v Value Exceeds Maximum (2147483647)v Value Exceeds Minimum (-2147483648)


The source for this attribute is Perfmon - BizTalk:Messaging\*\Documentsprocessed/Sec.

Warehouse nameDOCUMENTS_PROCESSED_PER_SEC or DOCUMENTS0

Documents Received attributeDescription

This attribute displays the documents received since the application started.Type



The source for this attribute is Perfmon - BizTalk:Messaging\*\Documentsreceived.

Warehouse nameDOCUMENTS_RECEIVED or DOCUMENTS1

Documents Received Per Sec attributeDescription

This attribute displays the documents received per second.Type

Real number (32-bit gauge) with 2 decimal places of precision with enumeratedvalues. The strings are displayed in the Tivoli Enterprise Portal. The warehouseand queries return the values shown in parentheses. The following values aredefined:v Value Exceeds Maximum (2147483647)v Value Exceeds Minimum (-2147483648)


The source for this attribute is Perfmon - BizTalk:Messaging\*\Documentsreceived/Sec.

Warehouse nameDOCUMENTS_RECEIVED_PER_SEC or DOCUMENTS2

Documents Resubmitted attributeDescription

This attribute displays the total number of documents resubmitted by SendAdapters since the application started.




SourceThe source for this attribute is Perfmon - BizTalk:Messaging\*\Documentsresubmitted.

Warehouse nameDOCUMENTS_RESUBMITTED or DOCUMENTS3

Documents Submitted Per Batch (Superseded) attributeDescription

This attribute displays the average number of documents submitted per batch.Type



The source for this attribute is Perfmon - BizTalk:Messaging\*\Documentssubmitted/Batch.

Warehouse nameDOCUMENTS_SUBMITTED_PER_BATCH or DOCUMENTS4

Documents Suspended attributeDescription

This attribute displays the documents suspended since the application started.Type



The source for this attribute is Perfmon - BizTalk:Messaging\*\Documentssuspended.

Warehouse nameDOCUMENTS_SUSPENDED or DOCUMENTS5

Documents Suspended Per Sec attributeDescription

This attribute displays the documents suspended per second.Type



The source for this attribute is Perfmon - BizTalk:Messaging\*\Documentssuspended/Sec.

Warehouse nameDOCUMENTS_SUSPENDED_PER_SEC or DOCUMENTS6

Documents Transmitted Per Batch (Superseded) attribute


DescriptionThis attribute displays the average number of documents transmitted per batch.



The source for this attribute is Perfmon - BizTalk:Messaging\*\Documentstransmitted/Batch.

Warehouse nameDOCUMENTS_TRANSMITTED_PER_BATCH or DOCUMENTS7

Pending Receive Batches attributeDescription

This attribute displays the number of batches received by the Messaging Enginethat have not completed processing. These include batches that have beenprocessed asynchronously by Send Adapters.



The source for this attribute is Perfmon - BizTalk:Messaging\*\Pending receivebatches.

Warehouse namePENDING_RECEIVE_BATCHES or PENDING_RE

Pending Transmitted Messages attributeDescription

This attribute displays the number of messages given by the Messaging Engine toSend Adapters that have not completed processing. This includes responsemessages for Receive Adapters.



The source for this attribute is Perfmon - BizTalk:Messaging\*\Pendingtransmitted messages.

Warehouse namePENDING_TRANSMITTED_MESSAGES or PENDING_TR

Request Response Timeouts attributeDescription

This attribute displays the number of request messages that have not received aresponse message within the time limit specified by the adapter.




The source for this attribute is Perfmon - BizTalk:Messaging\*\Request/Responsetimeouts.

Warehouse nameREQUEST_RESPONSE_TIMEOUTS or REQUEST_RE

Throttled Receive Batches attributeDescription

This attribute displays the number of batches that have been blocked on receiveby the Messaging Engine due to high service load. These batches contain newmessages to be processed.



The source for this attribute is Perfmon - BizTalk:Messaging\*\Throttled receivebatches.

Warehouse nameTHROTTLED_RECEIVE_BATCHES or THROTTLED_

Documents Submitted Per Batch attributeDescription

This attribute displays the average number of documents currently submitted perbatch. This attribute is the 64-bit version of the Documents Submitted Per Batch(Superseded) attribute.



The source for this attribute is Perfmon - BizTalk:Messaging\*\Documentssubmitted/Batch.

Warehouse nameDOCUMENTS_SUBMITTED_PER_BATCH_64 or DOC4_64

Documents Transmitted Per Batch attributeDescription

This attribute displays the average number of documents currently transmittedper batch. This attribute is the 64-bit version of the Documents Transmitted PerBatch (Superseded) attribute.

TypeReal number (64-bit gauge) with 2 decimal places of precision with enumerated




The source for this attribute is Perfmon - BizTalk:Messaging\*\Documentstransmitted/Batch.

Warehouse nameDOCUMENTS_TRANSMITTED_PER_BATCH_64 or DOC7_64



StringSource


NAME

Messaging Latency attribute groupThe Messaging Latency attribute group includes attributes that provide information about latencies whileprocessing the documents.Historical group


The following list contains information about each attribute in the Messaging Latency attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPInbound Latency In MS attribute

DescriptionThis attribute displays the average latency in milliseconds from when theMessaging Engine receives a document from the adapter until the time it ispublished to Message Box.





The source for this attribute is Perfmon - BizTalk:Messaging Latency\*\InboundLatency (sec).

Warehouse nameINBOUND_LATENCY_IN_MS or INBOUND_LA

Outbound Adapter Latency In MS attributeDescription

This attribute displays the average latency in milliseconds from when the adaptergets a document from the Messaging Engine until the time it is sent by theadapter.



The source for this attribute is Perfmon - BizTalk:Messaging Latency\*\OutboundAdapter Latency (sec).

Warehouse nameOUTBOUND_ADAPTER_LATENCY_IN_MS or OUTBOUND_A

Outbound Latency In MS attributeDescription

This attribute displays the average latency in milliseconds from when theMessaging Engine receives a document from the Message Box until the timedocument is sent by the adapter.



The source for this attribute is Perfmon - BizTalk:Messaging Latency\*\OutboundLatency (sec).

Warehouse nameOUTBOUND_LATENCY_IN_MS or OUTBOUND_L

Request Response Latency In MS attributeDescription

This attribute displays the average latency in milliseconds from when theMessaging Engine receives a request document from the adapter until the time aresponse document is given back to the adapter.





The source for this attribute is Perfmon - BizTalk:Messaging Latency\*\Request-Response Latency (sec).

Warehouse nameREQUEST_RESPONSE_LATENCY_IN_MS or REQUEST_RE



StringSource


NAME

MSMQ Receive Adapter attribute groupThe MSMQ Receive Adapter attribute group includes attributes that provide information about bytes andmessages received by MSMQ adapter.Historical group


The following list contains information about each attribute in the MSMQ Receive Adapterattribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource



DescriptionThis attribute displays the number of bytes received by the MSMQ ReceiveAdapter per second. The counter applies only to messages that have beencompletely read by the MSMQ Receive Adapter from the source queue.





The source for this attribute is Perfmon - BizTalk:MSMQ ReceiveAdapter\*\Bytes Received/sec.



This attribute displays the total number of messages received by the MSMQReceive Adapter since the application started. The counter is incremented after amessage is read by the MSMQ Receive Adapter from the source queue.



The source for this attribute is Perfmon - BizTalk:MSMQ ReceiveAdapter\*\Messages received.



This attribute displays the number of messages received by the MSMQ ReceiveAdapter per second. The counter applies only to messages that have beencompletely read by the MSMQ Receive Adapter from the source queue.



The source for this attribute is Perfmon - BizTalk:MSMQ ReceiveAdapter\*\Messages Received/sec.



This attribute displays the total number of kilobytes received by the MSMQReceive Adapter since the application started. The counter is incremented after amessage is read by the MSMQ Receive Adapter from the source queue.

TypeReal number (32-bit counter) with 2 decimal places of precision with enumerated






DescriptionThis attribute displays the number of bytes currently received by the MSMQReceive Adapter per second since the Biztalk server was started. This attribute isthe 64-bit version of the Bytes Received Per Sec (Superseded) attribute.



The source for this attribute is Perfmon - BizTalk:MSMQ ReceiveAdapter\*\Bytes Received/sec.

Warehouse nameBYTES_RECEIVED_PER_SEC_64 or MSMQBR0_64


This attribute displays the total number of KB received by the MSMQ ReceiveAdapter since the Biztalk server was started. This attribute is the 64-bit version ofthe Kilobytes Received (Superseded) attribute.




KILOBYTES_RECEIVED_64 or MSMQKBR_64Name attribute: This attribute is a key attribute.


TypeString


Warehouse nameNAME


MSMQ Send Adapter attribute groupThe MSMQ Send Adapter attribute group includes attributes that provide information about bytes andmessages sent by MSMQ adapter.Historical group


The following list contains information about each attribute in the MSMQ Send Adapter attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource



DescriptionThis attribute displays the number of bytes sent by the MSMQ Send Adapter persecond. The counter applies only to messages that have reached the destinationqueue.



The source for this attribute is Perfmon - BizTalk:MSMQ Send Adapter\*\BytesSent/sec.



This attribute displays the total number of messages sent by the MSMQ SendAdapter since the application started. The counter is incremented only formessages that have reached the destination queue.




The source for this attribute is Perfmon - BizTalk:MSMQ SendAdapter\*\Messages sent.



This attribute displays the number of messages sent by the MSMQ Send Adapterper second. The counter applies only to messages that have reached thedestination queue.



The source for this attribute is Perfmon - BizTalk:MSMQ SendAdapter\*\Messages Sent/sec.



This attribute displays the total number of kilobytes sent by the MSMQ SendAdapter since the application started. The counter is incremented only formessages that have reached the destination queue.





DescriptionThis attribute displays the number of bytes currently sent by the MSMQ SendAdapter per second. This attribute is the 64-bit version of the Bytes Sent Per Sec(Superseded) attribute.




SourceThe source for this attribute is Perfmon - BizTalk:MSMQ Send Adapter\*\BytesSent/sec.

Warehouse nameBYTES_SENT_PER_SEC_64 or MSMQBS0_64


This attribute displays the total number of kilobytes sent by the MSMQ SendAdapter since the BizTalk Server was started. This attribute is the 64-bit versionof the Kilobytes Sent (Superseded) attribute.




KILOBYTES_SENT_64 or MSMQKBS_64Name attribute: This attribute is a key attribute.


TypeString


Warehouse nameNAME

Notifications attribute groupThis attribute group includes attributes that provide information about the notifications component of aNotification Services instance for BAM.Historical group


The following list contains information about each attribute in the Notifications attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource

The source for this attribute is agent.




This attribute displays the instance name for notifications component.Type

StringSource


NAMEBatches attribute

DescriptionThis attribute displays the total number of notification batches that weregenerated since the application was started.




BATCHESBatches Awaiting Distribution attribute

DescriptionThis attribute displays the number of notification batches that are currentlywaiting to be picked up by the distributor.




BATCHES_AWAITING_DISTRIBUTION or BATAWTDISTBatches Expired attribute

DescriptionThis attribute displays the total number of notification batches that containexpired notifications since the application was started.



The source for this attribute is Script data.


Warehouse nameBATCHES_EXPIRED or BATCHEXPD

Batches Failed Delivery attributeDescription

This attribute displays the total number of batches that contain failed notificationssince the application was started.




BATCHES_FAILED_DELIVERY or BATFAILDELBatches In Retry attribute

DescriptionThis attribute displays the total number of notification batches that are currentlyin the delivery retry queue.




BATCHES_IN_RETRY or BATINRETYBatches Successfully Delivered attribute

DescriptionThis attribute displays the total number of notification batches that weresuccessfully delivered since the application was last started.




BATCHES_SUCCESSFULLY_DELIVERED or BATSUCDELVNotifications attribute

DescriptionThis attribute displays the total number of notifications that were generated sincethe application was started.






NOTIFICATIONS or NOTIFICATINotifications Failed Delivery attribute

DescriptionThis attribute displays the total number of notifications that have failed thedelivery process since the application was last started.




NOTIFICATIONS_FAILED_DELIVERY or NOTFAILDELNotifications Successfully Delivered attribute

DescriptionThis attribute displays the total number of notifications that were successfullydelivered since the application was last started.




NOTIFICATIONS_SUCCESSFULLY_DELIVERED or NOTSUCDELVServer Name attribute


TypeString



Orchestration Status attribute groupThe Orchestration Status attribute group includes attributes that provide information about theorchestration status.Historical group



Attribute descriptionsThe following list contains information about each attribute in the Orchestration Status attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPHost Name attribute

DescriptionThis attribute displays the host name.

TypeString


Orchestration Name attribute: This attribute is a key attribute.Description

This attribute displays the orchestration name.Type


ORCHESTRATION_NAME or NAMEStatus attribute

DescriptionThis attribute displays the orchestration status.

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Unbound (1)v Bound (2)v Stopped (3)v Started (4)


STATUS or ORCHSTATServer Name attribute


TypeString




Orchestrations attribute groupThe Orchestrations attribute group includes attributes that provide information about orchestrations andtransactions being processed.Historical group


The following list contains information about each attribute in the Orchestrations attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPPercent Used Physical Memory attribute

DescriptionThis attribute displays the percentage used of total physical memory on themachine.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\% usedphysical memory.

Warehouse namePERCENT_USED_PHYSICAL_MEMORY or USED_PHYSI

Active Application Domains attributeDescription

This attribute displays the number of loaded orchestration application domains inthe process for hosting orchestrations.

TypeInteger (32-bit gauge) with enumerated values. The strings are displayed in theTivoli Enterprise Portal. The warehouse and queries return the values shown inparentheses. The following values are defined:v Value Exceeds Maximum (2147483647)




The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Activeapplication domains.

Warehouse nameACTIVE_APPLICATION_DOMAINS or ACTIVE_APP

Average Batch Factor attributeDescription

This attribute displays the ratio between the number of persistence pointscommitted and underlying database transactions committed.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Averagebatch factor.

Warehouse nameAVERAGE_BATCH_FACTOR or AVERAGE_BA

Database Transactions attributeDescription

This attribute displays the number of database transactions performed since thehost instance started.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Databasetransactions.

Warehouse nameDATABASE_TRANSACTIONS or DATABASE_T

Database Transactions Per Sec attributeDescription

This attribute displays the number of transaction performed per second.Type



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Databasetransactions/sec.


Warehouse nameDATABASE_TRANSACTIONS_PER_SEC or DATABASE_0

Dehydratable Orchestrations attributeDescription

This attribute displays the total number of idle orchestrations currently hosted bythe application instance which may be dehydrated.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Dehydratable orchestrations.

Warehouse nameDEHYDRATABLE_ORCHESTRATIONS or DEHYDRATAB

Dehydrating Orchestrations attributeDescription

This attribute displays the number of orchestrations that are in the process ofdehydrating.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Dehydrating orchestrations.

Warehouse nameDEHYDRATING_ORCHESTRATIONS or DEHYDRATIN

Dehydration Cycle In Progress attributeDescription

This attribute indicates whether there is a dehydration cycle currently in progress.Type



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Dehydration cycle in progress.

Warehouse nameDEHYDRATION_CYCLE_IN_PROGRESS or DEHYDRATIO

Dehydration Cycles attributeDescription

This attribute displays the number of dehydration cycles completed.Type

Integer (32-bit gauge) with enumerated values. The strings are displayed in the




The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Dehydration cycles.

Warehouse nameDEHYDRATION_CYCLES or DEHYDRATI0

Dehydration Threshold attributeDescription

This attribute is a metric that controls how aggressively services are beingdehydrated (measured in milliseconds).



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Dehydration threshold.

Warehouse nameDEHYDRATION_THRESHOLD or DEHYDRATI1

Idle Orchestrations attributeDescription

This attribute displays the number of idle orchestration instances currently hostedby the host instance.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Idleorchestrations.

Warehouse nameIDLE_ORCHESTRATIONS or IDLE_ORCHE

Allocated Private Memory In MB attributeDescription

This attribute displays the allocated private memory in megabytes for the hostinstance.




SourceThe source for this attribute is Perfmon - XLANG/s Orchestrations\*\Megabytesallocated private memory.

Warehouse nameALLOCATED_PRIVATE_MEMORY_IN_MB or MEGABYTES_

Allocated Virtual Memory In MB attributeDescription

This attribute displays the reserved virtual memory in megabytes for the hostinstance.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Megabytesallocated virtual memory.

Warehouse nameALLOCATED_VIRTUAL_MEMORY_IN_MB or MEGABYTES0

MessageBox Databases Connection Failures attributeDescription

This attribute displays the number of attempted database connections that failedsince the host instance started.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\MessageBox databases connection failures.

Warehouse nameMESSAGEBOX_DATABASES_CONNECTION_FAILURES or MESSAGEBOX

Online MessageBox Databases attributeDescription

This attribute displays the number of MessageBox databases currently available tothe application.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\OnlineMessageBox databases.

Warehouse nameONLINE_MESSAGEBOX_DATABASES or ONLINE_MES

Orchestrations Completed attribute


DescriptionThis attribute displays the number of orchestrations completed since host instancestarted.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations completed.

Warehouse nameORCHESTRATIONS_COMPLETED or ORCHESTRAT

Orchestrations Completed Per Sec attributeDescription

This attribute displays the average number of orchestrations completed persecond.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations completed/sec.

Warehouse nameORCHESTRATIONS_COMPLETED_PER_SEC or ORCHESTRA0

Orchestrations Created attributeDescription

This attribute displays the number of orchestrations created since host instancestarted.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations created.

Warehouse nameORCHESTRATIONS_CREATED or ORCHESTRA1

Orchestrations Created Per Sec attributeDescription

This attribute displays the average number of orchestrations created per second.Type





The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations created/sec.

Warehouse nameORCHESTRATIONS_CREATED_PER_SEC or ORCHESTRA2

Orchestrations Dehydrated attributeDescription

This attribute displays the number of orchestration instances dehydrated since thehost instance started.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations dehydrated.

Warehouse nameORCHESTRATIONS_DEHYDRATED or ORCHESTRA3

Orchestrations Dehydrated Per Sec attributeDescription

This attribute displays the average number of orchestration instances dehydratedper second.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations dehydrated/sec.

Warehouse nameORCHESTRATIONS_DEHYDRATED_PER_SEC or ORCHESTRA4

Orchestrations Discarded attributeDescription

This attribute displays the number of orchestration instances discarded frommemory since the host instance started.




The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations discarded.

Warehouse nameORCHESTRATIONS_DISCARDED or ORCHESTRA5

Orchestrations Discarded Per Sec attributeDescription

This attribute displays the average number of orchestration instances discardedfrom memory per second.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations discarded/sec.

Warehouse nameORCHESTRATIONS_DISCARDED_PER_SEC or ORCHESTRA6

Orchestrations Rehydrated attributeDescription

This attribute displays the number of orchestration instances rehydrated since thehost instance started.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations rehydrated.

Warehouse nameORCHESTRATIONS_REHYDRATED or ORCHESTRA7

Orchestrations Rehydrated Per Sec attributeDescription

This attribute displays the average number of orchestration instances rehydratedper second.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations rehydrated/sec.


Warehouse nameORCHESTRATIONS_REHYDRATED_PER_SEC or ORCHESTRA8

Orchestrations Resident In Memory attributeDescription

This attribute displays the number of orchestration instances currently hosted bythe host instance.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations resident in-memory.

Warehouse nameORCHESTRATIONS_RESIDENT_IN_MEMORY or ORCHESTRA9

Orchestrations Scheduled For Dehydration attributeDescription

This attribute displays the number of dehydratable orchestrations for which thereis dehydration request pending.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations scheduled for dehydration.

Warehouse nameORCHESTRATIONS_SCHEDULED_FOR_DEHYDRATION or ORCHESTR10

Orchestrations Suspended attributeDescription

This attribute displays the number of orchestration instances suspended since thehost instance started.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations suspended.

Warehouse nameORCHESTRATIONS_SUSPENDED or ORCHESTR11

Orchestrations Suspended Per Sec attributeDescription

This attribute displays the average number of orchestration instances suspendedper second.




The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Orchestrations suspended/sec.

Warehouse nameORCHESTRATIONS_SUSPENDED_PER_SEC or ORCHESTR12

Pending Messages attributeDescription

This attribute displays the number of received messages for which receipt has notyet been acknowledged to the MessageBox.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Pendingmessages.

Warehouse namePENDING_MESSAGES or PENDING_ME

Pending Work Items attributeDescription

This attribute displays the number of code execution blocks that are scheduledfor execution.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Pendingwork items.

Warehouse namePENDING_WORK_ITEMS or PENDING_WO

Persistence Points attributeDescription

This attribute displays the number of times an orchestration instance haspersisted its state to the database since the host instance started.

TypeInteger (32-bit counter) with enumerated values. The strings are displayed in theTivoli Enterprise Portal. The warehouse and queries return the values shown inparentheses. The following values are defined:v Value Exceeds Maximum (2147483647)




The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Persistencepoints.

Warehouse namePERSISTENCE_POINTS or PERSISTENC

Persistence Points Per Sec attributeDescription

This attribute displays the average number of orchestration instances persistedper second.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Persistencepoints/sec.

Warehouse namePERSISTENCE_POINTS_PER_SEC or PERSISTEN0

Runnable Orchestrations attributeDescription

This attribute displays the number of orchestration instances ready to execute.Type



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Runnableorchestrations.

Warehouse nameRUNNABLE_ORCHESTRATIONS or RUNNABLE_O

Running Orchestrations attributeDescription

This attribute displays the number of orchestration instances currently executing.Type



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Runningorchestrations.

Warehouse nameRUNNING_ORCHESTRATIONS or RUNNING_OR


Transactional Scopes Aborted attributeDescription

This attribute displays the number of long-running or atomic scopes that havebeen aborted since the host instance started.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Transactional scopes aborted.

Warehouse nameTRANSACTIONAL_SCOPES_ABORTED or TRANSACTIO

Transactional Scopes Aborted Per Sec attributeDescription

This attribute displays the average number of aborted scopes per second.Type



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Transactional scopes aborted/sec.

Warehouse nameTRANSACTIONAL_SCOPES_ABORTED_PER_SEC or TRANSACTI0

Transactional Scopes Committed attributeDescription

This attribute displays the number of long-running or atomic scopes that havesuccessfully completed since the host instance started.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Transactional scopes committed.

Warehouse nameTRANSACTIONAL_SCOPES_COMMITTED or TRANSACTI1

Transactional Scopes Committed Per Sec attributeDescription

This attribute displays the average number of committed scopes per second.Type





The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Transactional scopes committed/sec.

Warehouse nameTRANSACTIONAL_SCOPES_COMMITTED_PER_SEC or TRANSACTI2

Transactional Scopes Compensated attributeDescription

This attribute displays the number of long-running or atomic scopes that havesuccessfully completed compensation scopes since the application started.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Transactional scopes compensated.

Warehouse nameTRANSACTIONAL_SCOPES_COMPENSATED or TRANSACTI3

Transactional Scopes Compensated Per Sec attributeDescription

This attribute displays the average number of transactional compensated scopesper second.



The source for this attribute is Perfmon - XLANG/s Orchestrations\*\Transactional scopes compensated/sec.

Warehouse nameTRANSACTIONAL_SCOPES_COMPENSATED_PER_SEC or TRANSACTI4



StringSource


NAME


Performance Object Status attribute groupThe Performance Object Status attribute group contains information that reflects the status of otherattribute groups so you can see the status of all of the performance objects that make up this applicationall at once. Each of these other performance attribute groups is represented by a row in this table (orother type of view). The status for an attribute group reflects the result of the last attempt to collect datafor that attribute group, which allows you to see whether the agent is performing correctly. Unlike otherattribute groups, the Performance Object Status attribute group does not reflect the state of the monitoredapplication. This attribute group is most often used to determine why data is not available for one of theperformance attribute groups.Historical group


The following list contains information about each attribute in the Performance Object Statusattribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPQuery Name attribute: This attribute is a key attribute.

DescriptionThe name of the attribute group.

TypeString

Warehouse nameQUERY_NAME or ATTRGRP

Object Name attributeDescription

The name of the performance object.Type


OBJECT_NAME or OBJNAMEObject Type attribute

DescriptionThe type of the performance object.

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v WMI (0)v PERFMON (1)


v WMI ASSOCIATION GROUP (2)v JMX (3)v SNMP (4)v SHELL COMMAND (5)v JOINED GROUPS (6)v CIMOM (7)v CUSTOM (8)v ROLLUP DATA (9)v WMI REMOTE DATA (10)v LOG FILE (11)v JDBC (12)v CONFIG DISCOVERY (13)v NT EVENT LOG (14)v FILTER (15)v SNMP EVENT (16)v PING (17)v DIRECTOR DATA (18)v DIRECTOR EVENT (19)v SSH REMOTE SHELL COMMAND (20)


OBJECT_TYPE or OBJTYPEObject Status attribute

DescriptionThe status of the performance object.

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v ACTIVE (0)v INACTIVE (1)


OBJECT_STATUS or OBJSTTSError Code attribute

DescriptionThe error code associated with the query.

TypeInteger with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v NO ERROR (0)v GENERAL ERROR (1)v OBJECT NOT FOUND (2)v COUNTER NOT FOUND (3)v NAMESPACE ERROR (4)v OBJECT CURRENTLY UNAVAILABLE (5)v COM LIBRARY INIT FAILURE (6)v SECURITY INIT FAILURE (7)v PROXY SECURITY FAILURE (9)v NO INSTANCES RETURNED (10)v ASSOCIATOR QUERY FAILED (11)v REFERENCE QUERY FAILED (12)v NO RESPONSE RECEIVED (13)v CANNOT FIND JOINED QUERY (14)


v CANNOT FIND JOIN ATTRIBUTE IN QUERY 1 RESULTS (15)v CANNOT FIND JOIN ATTRIBUTE IN QUERY 2 RESULTS (16)v QUERY 1 NOT A SINGLETON (17)v QUERY 2 NOT A SINGLETON (18)v NO INSTANCES RETURNED IN QUERY 1 (19)v NO INSTANCES RETURNED IN QUERY 2 (20)v CANNOT FIND ROLLUP QUERY (21)v CANNOT FIND ROLLUP ATTRIBUTE (22)v FILE OFFLINE (23)v NO HOSTNAME (24)v MISSING LIBRARY (25)v ATTRIBUTE COUNT MISMATCH (26)v ATTRIBUTE NAME MISMATCH (27)v COMMON DATA PROVIDER NOT STARTED (28)v CALLBACK REGISTRATION ERROR (29)v MDL LOAD ERROR (30)v AUTHENTICATION FAILED (31)v CANNOT RESOLVE HOST NAME (32)v SUBNODE UNAVAILABLE (33)v SUBNODE NOT FOUND IN CONFIG (34)v ATTRIBUTE ERROR (35)v CLASSPATH ERROR (36)v CONNECTION FAILURE (37)v FILTER SYNTAX ERROR (38)v FILE NAME MISSING (39)v SQL QUERY ERROR (40)v SQL FILTER QUERY ERROR (41)v SQL DB QUERY ERROR (42)v SQL DB FILTER QUERY ERROR (43)v PORT OPEN FAILED (44)v ACCESS DENIED (45)v TIMEOUT (46)v NOT IMPLEMENTED (47)v REQUESTED A BAD VALUE (48)v RESPONSE TOO BIG (49)v GENERAL RESPONSE ERROR (50)v SCRIPT NONZERO RETURN (51)v SCRIPT NOT FOUND (52)v SCRIPT LAUNCH ERROR (53)v CONF FILE DOES NOT EXIST (54)v CONF FILE ACCESS DENIED (55)v INVALID CONF FILE (56)v EIF INITIALIZATION FAILED (57)v CANNOT OPEN FORMAT FILE (58)v FORMAT FILE SYNTAX ERROR (59)v REMOTE HOST UNAVAILABLE (60)v EVENT LOG DOES NOT EXIST (61)v PING FILE DOES NOT EXIST (62)v NO PING DEVICE FILES (63)v PING DEVICE LIST FILE MISSING (64)v SNMP MISSING PASSWORD (65)v DISABLED (66)v URLS FILE NOT FOUND (67)v XML PARSE ERROR (68)v NOT INITIALIZED (69)v ICMP SOCKETS FAILED (70)


v DUPLICATE CONF FILE (71)


ERROR_CODE or ERRCODELast Collection Start attribute

DescriptionThe most recent time a data collection of this group started.

TypeTimestamp with enumerated values. The strings are displayed in the TivoliEnterprise Portal. The warehouse and queries return the values shown inparentheses. The following values are defined:v NOT COLLECTED (0691231190000000)v NOT COLLECTED (0000000000000001)


LAST_COLLECTION_START or COLSTRTLast Collection Finished attribute

DescriptionThe most recent time a data collection of this group finished.

TypeTimestamp with enumerated values. The strings are displayed in the TivoliEnterprise Portal. The warehouse and queries return the values shown inparentheses. The following values are defined:v NOT COLLECTED (0691231190000000)v NOT COLLECTED (0000000000000001)


LAST_COLLECTION_FINISHED or COLFINILast Collection Duration attribute

DescriptionThe duration of the most recently completed data collection of this group inseconds.

TypeReal number (32-bit counter) with 2 decimal places of precision

Warehouse nameLAST_COLLECTION_DURATION or COLDURA

Average Collection Duration attributeDescription

The average duration of all data collections of this group in seconds.Type

Real number (32-bit counter) with 2 decimal places of precision with enumeratedvalues. The strings are displayed in the Tivoli Enterprise Portal. The warehouseand queries return the values shown in parentheses. The following values aredefined:v NO DATA (-100)


AVERAGE_COLLECTION_DURATION or COLAVGDRefresh Interval attribute

DescriptionThe interval at which this group is refreshed in seconds.



Warehouse nameREFRESH_INTERVAL or REFRINT

Number of Collections attributeDescription

The number of times this group has been collected since agent start.Type

Integer (32-bit counter)Warehouse name

NUMBER_OF_COLLECTIONS or NUMCOLLCache Hits attribute

DescriptionThe number of times an external data request for this group was satisfied fromthe cache.


Warehouse nameCACHE_HITS or CACHEHT

Cache Misses attributeDescription

The number of times an external data request for this group was not available inthe cache.


Warehouse nameCACHE_MISSES or CACHEMS

Cache Hit Percent attributeDescription

The percentage of external data requests for this group that were satisfied fromthe cache.

TypeReal number (32-bit counter) with 2 decimal places of precision

Warehouse nameCACHE_HIT_PERCENT or CACHPCT

Intervals Skipped attributeDescription

The number of times a background data collection for this group was skippedbecause the previous collection was still running when the next one was due tostart.


Warehouse nameINTERVALS_SKIPPED or INTSKIP

POP3 Receive Adapter attribute groupThe POP3 Receive Adapter attribute group includes attributes that provide information about bytes andmessages received by POP3 adapter.Historical group


The following list contains information about each attribute in the POP3 Receive Adapterattribute group:Node attribute: This attribute is a key attribute.



TypeString


Warehouse nameNODE



StringSource


TIMESTAMPActive Sessions attribute

DescriptionThis attribute displays the number of open POP3 connections the POP3 adapter ismanaging at a time.



The source for this attribute is Perfmon - BizTalk:POP3 Receive Adapter\*\ActiveSessions.

Warehouse nameACTIVE_SESSIONS or ACTIVE_SES

Bytes Received Per Sec (Superseded) attributeDescription

This attribute displays the number of bytes downloaded by the POP3 adapterfrom a mail server per second.



The source for this attribute is Perfmon - BizTalk:POP3 Receive Adapter\*\BytesReceived/sec.



This attribute displays the total number of e-mail messages downloaded by thePOP3 adapter from a mail server since the application started.





The source for this attribute is Perfmon - BizTalk:POP3 ReceiveAdapter\*\Messages received.



This attribute displays the number of e-mail messages downloaded by the POP3adapter from mail server per second.



The source for this attribute is Perfmon - BizTalk:POP3 ReceiveAdapter\*\Messages Received/sec.



This attribute displays the total number of kilobytes downloaded by the POP3adapter from a mail server since the application started.





DescriptionThis attribute displays the number of bytes currently downloaded by the POP3adapter from a mail server per second. This attribute is the 64-bit version of theBytes Received Per Sec (Superseded) attribute.




The source for this attribute is Perfmon - BizTalk:POP3 Receive Adapter\*\BytesReceived/sec.

Warehouse nameBYTES_RECEIVED_PER_SEC_64 or POPBRE0_64


This attribute displays the total number of kilobytes downloaded by the POP3adapter from a mail server since the BizTalk Server was started. This attribute isthe 64-bit version of the Kilobytes Received (Superseded) attribute.




KILOBYTES_RECEIVED_64 or POPKBRE_64Name attribute: This attribute is a key attribute.


TypeString


Warehouse nameNAME

Receive Location Status attribute groupThe Receive Location Status attribute group includes attributes that provide information about the receivelocation status.Historical group


The following list contains information about each attribute in the Receive Location Statusattribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



String




Status attributeDescription

This attribute displays the current receive location status.Type

String with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Disabled (True)v Enabled (False)


STATUS or ISDISABLEDReceive Location Name attribute: This attribute is a key attribute.

DescriptionThis attribute displays the receive location name.

TypeString

Warehouse nameRECEIVE_LOCATION_NAME or NAME

Is Primary attributeDescription

This attribute indicates whether the Receive Location is primary.Type


IS_PRIMARY or ISPRIMARYTransport Type attribute

DescriptionThis attribute displays the name of the adapter that is used by the ReceiveLocation.

TypeString

Warehouse nameTRANSPORT_TYPE or RLTRPTY

Transport Address attributeDescription

This attribute displays the adapter-specific URL that is listened by the giveninstance of the Receive Location.

TypeString

Warehouse nameTRANSPORT_ADDRESS or RLTRPURL

Receive Port Name attributeDescription

This attribute displays the name of the Receive Port that is used by the ReceiveLocation.

TypeString

Warehouse nameRECEIVE_PORT_NAME or RLPORT

Receive Handler attribute


DescriptionThis attribute displays the name of the Receive Handler that is used by theReceive Location.

TypeString

Warehouse nameRECEIVE_HANDLER or RLHOST



StringSource



RFID Devices attribute groupThe RFID Devices attribute group includes attributes that provide information about RFID devices.Historical group


The following list contains information about each attribute in the RFID Devices attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPTotal Tags Written attribute

DescriptionThis attribute displays the total number of tags that are currently sent from adevice instance.



The source for this attribute is Perfmon - RFID:Devices\*\Total Tags Written.


Warehouse nameTOTAL_TAGS_WRITTEN or TAGS_WRIT

Total Tags Read attributeDescription

This attribute displays the total number of tags that are currently received from adevice instance.



The source for this attribute is Perfmon - RFID:Devices\*\Total Tags Read.Warehouse name

TOTAL_TAGS_READ or TAGS_READTags Written Per Sec attribute

DescriptionThis attribute displays the rate at which tags are currently sent from a deviceinstance.



The source for this attribute is Perfmon - RFID:Devices\*\Tags Written/sec.Warehouse name

TAGS_WRITTEN_PER_SEC or TAGS_WRPSTags Read Per Sec attribute

DescriptionThis attribute displays the rate at which tags are currently received from a deviceinstance.



The source for this attribute is Perfmon - RFID:Devices\*\Tags Read/sec.Warehouse name

TAGS_READ_PER_SEC or TAGS_RDPSDowntime attribute

DescriptionThis attribute displays the duration for which a device is currently not workingafter a connection error.





The source for this attribute is Perfmon - RFID:Devices\*\Downtime.Warehouse name

DOWNTIMEErrors Raised Per Sec attribute

DescriptionThis attribute displays the rate at which errors are currently raised by a device.



The source for this attribute is Perfmon - RFID:Devices\*\# of Errors raised / sec.Warehouse name

ERRORS_RAISED_PER_SEC or ERR_RSPSErrors Raised attribute

DescriptionThis attribute displays the number of errors that are currently raised by a device.



The source for this attribute is Perfmon - RFID:Devices\*\# of Errors raised.Warehouse name

ERRORS_RAISED or ERR_RSName attribute: This attribute is a key attribute.


TypeString


Warehouse nameNAME

RFID Processes attribute groupThe RFID Processes attribute group includes attributes that provide information about RFID processes.Historical group


The following list contains information about each attribute in the RFID Processes attributegroup:


Node attribute: This attribute is a key attribute.Description

The managed system name of the agent.Type

StringSource


NODETimestamp attribute

DescriptionThe local time at the agent when the data was collected.

TypeString



Process Uptime attributeDescription

This attribute displays the amount of time that has currently elapsed after aprocess was started.



The source for this attribute is Perfmon - RFID:Processes\*\Process Uptime.Warehouse name

PROCESS_UPTIME or PROCESS_UPTags Being Processed attribute

DescriptionThis attribute displays the number of tags that are currently being processed inthe process pipeline.



The source for this attribute is Perfmon - RFID:Processes\*\Tags Being Processed.Warehouse name

TAGS_BEING_PROCESSED or TAGS_BEINGTags In Queue attribute

DescriptionThis attribute displays the total number of tags that are currently queued forprocessing.





The source for this attribute is Perfmon - RFID:Processes\*\Tags In Queue.Warehouse name

TAGS_IN_QUEUE or TAGS_IN_QUTags Processed attribute

DescriptionThis attribute displays the total number of tags that are currently processed by aprocess.



The source for this attribute is Perfmon - RFID:Processes\*\Tags Processed.Warehouse name

TAGS_PROCESSED or TAGS_PROCETags Suspended attribute

DescriptionThis attribute displays the number of tags (tags that caused failures) that arecurrently sent to the suspended queue.



The source for this attribute is Perfmon - RFID:Processes\*\Tags Suspended.Warehouse name

TAGS_SUSPENDED or TAGS_SUSPEName attribute: This attribute is a key attribute.


TypeString


Warehouse nameNAME

Rule Engine Database attribute groupThe Rule Engine Database attribute group includes attributes that provide information about the BizTalkRule Engine Database.Historical group



Attribute descriptionsThe following list contains information about each attribute in the Rule Engine Database attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource



DescriptionThis attribute displays the Rule Engine Database name.

TypeString


Warehouse nameDATABASE_NAME or RULEENGINE


This attribute displays the Rule Engine Database server name.Type

StringSource


SERVER_NAME or RULEENGIN0

Send Port Group Status attribute groupThe Send Port Group Status attribute group includes attributes that provide information about the SendPort Group status.Historical group


The following list contains information about each attribute in the Send Port Group Statusattribute group:Node attribute: This attribute is a key attribute.


TypeString



Warehouse nameNODE



StringSource


TIMESTAMPSend Port Group Name attribute: This attribute is a key attribute.

DescriptionThis attribute displays the Send Port Group name.

TypeString

Warehouse nameSEND_PORT_GROUP_NAME or NAME


This attribute displays the Send Port Group status.Type

Integer with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Bound (1)v Stopped (2)v Started (3)


STATUSServer Name attribute


TypeString



Send Port Status attribute groupThe Send Port Status attribute group includes attributes that provide information about the send portstatus.Historical group


The following list contains information about each attribute in the Send Port Status attributegroup:Node attribute: This attribute is a key attribute.


TypeString



Warehouse nameNODE



StringSource


TIMESTAMPSend Port Name attribute: This attribute is a key attribute.

DescriptionThis attribute displays the send port name.

TypeString

Warehouse nameSEND_PORT_NAME or NAME


This attribute displays the send port status.Type

Integer with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Bound (1)v Stopped (2)v Started (3)


STATUSIs Dynamic attribute

DescriptionThis attribute indicates whether the port is dynamic or static.

TypeString

Warehouse nameIS_DYNAMIC or ISDYNM

Is TwoWay attributeDescription

This attribute indicates whether the port is one way or two way.Type


IS_TWOWAY or IS2WAYTransport Type attribute

DescriptionThis attribute displays the transport type of the primary transport for the port.

TypeString

Warehouse nameTRANSPORT_TYPE or PRITRPTY

Primary Transport Address attribute


DescriptionThis attribute displays the primary transport URL for the port.

TypeString

Warehouse namePRIMARY_TRANSPORT_ADDRESS or PRITRPURL



StringSource



Service Instance Status and Class attribute groupThe Service Instance Status and Class attribute group includes attributes that provide information aboutthe status and class of service instances.Historical group


The following list contains information about each attribute in the Service Instance Status andClass attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPInstance ID attribute: This attribute is a key attribute.

DescriptionThis attribute displays the service instance identifier.

TypeString

Warehouse nameINSTANCE_ID or INSTID

Host Name attribute: This attribute is a key attribute.Description

This attribute displays the host name.Type

String



Service Class attributeDescription

This attribute displays the service class for a service instance.Type

Integer with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Orchestration (1)v Tracking (2)v Messaging (4)v MSMQT (8)v Other (16)v Isolated adapter (32)v Routing failure report (64)


SERVICE_CLASS or SERVICECLAService Name attribute

DescriptionThis attribute displays the service instance name.

TypeString

Warehouse nameSERVICE_NAME or SERVICENAM

Service Status attributeDescription

This attribute displays the service status of a service instance.Type

Integer with enumerated values. The strings are displayed in the Tivoli EnterprisePortal. The warehouse and queries return the values shown in parentheses. Thefollowing values are defined:v Ready to run (1)v Active (2)v Suspended resumable (4)v Dehydrated (8)v Completed with discarded messages (16)v Suspended not resumable (32)v In breakpoint (64)


SERVICE_STATUS or SERVICESTAError Description attribute

DescriptionThis attribute displays the error description for a service instance.

TypeString

Warehouse nameERROR_DESCRIPTION or ERRORDESC



String




Single Sign On Database attribute groupThe Single Sign-On Database attribute group includes attributes that provide information about the SingleSign-On Database.Historical group


The following list contains information about each attribute in the Single Sign On Databaseattribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource



DescriptionThis attribute displays the Single Sign-On Database name.

TypeString


Warehouse nameDATABASE_NAME or SSODBNAM


This attribute displays the Single Sign-On Database server name.Type

StringSource


SERVER_NAME or SERVERNAM

SMTP Send Adapter attribute groupThe SMTP Send Adapter attribute group includes attributes that provide information about messages sentby SMTP adapter.Historical group



Attribute descriptionsThe following list contains information about each attribute in the SMTP Send Adapter attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPMessages Sent attribute

DescriptionThis attribute displays the total number of messages sent by the SMTP adaptersince the application started. The counter is incremented only for messages thathave been transmitted to the SMTP server.



The source for this attribute is Perfmon - BizTalk:SMTP SendAdapter\*\Messages sent.



This attribute displays the number of messages sent by the SMTP adapter persecond. The counter applies only to messages that have been transmitted to theSMTP server.



The source for this attribute is Perfmon - BizTalk:SMTP SendAdapter\*\Messages Sent/sec.





StringSource


NAME

SOAP Receive Adapter attribute groupThe SOAP Receive Adapter attribute group includes attributes that provide information about messagesreceived by SOAP adapter.Historical group


The following list contains information about each attribute in the SOAP Receive Adapterattribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPMessages Received attribute

DescriptionThis attribute displays the total number of messages received by the SOAPReceive Adapter since the application started. The counter is incremented after arequest message is read by the adapter from the SOAP client.



The source for this attribute is Perfmon - BizTalk:SOAP ReceiveAdapter\*\Messages received.




This attribute displays the number of messages received by the SOAP ReceiveAdapter. The counter applies only to request messages that have been completelyread by the adapter from the SOAP client.



The source for this attribute is Perfmon - BizTalk:SOAP ReceiveAdapter\*\Messages Received/sec.




StringSource


NAME

SOAP Send Adapter attribute groupThe SOAP Send Adapter attribute group includes attributes that provide information about messages sentby SOAP adapter.Historical group


The following list contains information about each attribute in the SOAP Send Adapter attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource




DescriptionThis attribute displays the total number of messages sent by the SOAP SendAdapter since the application started. The counter is incremented only formessages that have reached the destination URL.



The source for this attribute is Perfmon - BizTalk:SOAP SendAdapter\*\Messages sent.



This attribute displays the number of messages sent by the SOAP Send Adapterper second. The counter applies only to messages that have reached thedestination URL.



The source for this attribute is Perfmon - BizTalk:SOAP SendAdapter\*\Messages Sent/sec.




StringSource


NAME

SQL Receive Adapter attribute groupThe SQL Receive Adapter attribute group includes attributes that provide information about messagesreceived by SQL adapter.Historical group


The following list contains information about each attribute in the SQL Receive Adapter attributegroup:Node attribute: This attribute is a key attribute.



TypeString


Warehouse nameNODE



StringSource


TIMESTAMPMessages Received attribute

DescriptionThis attribute displays the total number of messages read by the SQL ReceiveAdapter from a SQL server since the application started.



The source for this attribute is Perfmon - BizTalk:SQL ReceiveAdapter\*\Messages received.



This attribute displays the number of messages read by the SQL Receive Adapterfrom a SQL server per second.



The source for this attribute is Perfmon - BizTalk:SQL ReceiveAdapter\*\Messages Received/sec.




String



Warehouse nameNAME

SQL Send Adapter attribute groupThe SQL Send Adapter attribute group includes attributes that provide information about messages sentby SQL adapterHistorical group


The following list contains information about each attribute in the SQL Send Adapter attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource



DescriptionThis attribute displays the total number of messages sent by the SQL SendAdapter since the application started. The counter is incremented only formessages that have been written to the destination SQL table.



The source for this attribute is Perfmon - BizTalk:SQL Send Adapter\*\Messagessent.



This attribute displays the number of messages sent by the SQL Send Adapter persecond. The counter applies only to messages that have been written to thedestination SQL table.





The source for this attribute is Perfmon - BizTalk:SQL Send Adapter\*\MessagesSent/sec.




StringSource


NAME

Subscribers attribute groupThis attribute group includes attributes that provide information about the subscribers object of aNotification Services instance for BAM.Historical group


The following list contains information about each attribute in the Subscribers attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource



DescriptionThis attribute displays the instance name for the subscribers object.

TypeString


Warehouse nameNAME


Subscribers Added attributeDescription

This attribute displays the number of subscribers that were added since theinstance was last started.




SUBSCRIBERS_ADDED or SUBSCADDSubscribers Disabled attribute

DescriptionThis attribute displays the number of subscribers that are currently marked asdisabled.




SUBSCRIBERS_DISABLED or SUBSCDISSubscribers Enabled attribute

DescriptionThis attribute displays the number of subscribers that are currently marked asenabled.




SUBSCRIBERS_ENABLED or SUBSCENServer Name attribute


TypeString




Subscriptions attribute groupThis attribute group includes the attributes that provide information about the subscriptions object of aNotification Services instance for BAM.Historical group


The following list contains information about each attribute in the Subscriptions attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource



DescriptionThis attribute displays the instance name for the subscription object.

TypeString


Warehouse nameNAME

Subscriptions Added attributeDescription

This attribute displays the number of subscriptions that were added since theapplication was started.




SUBSCRIPTIONS_ADDED or SUBSCRIPTISubscriptions Disabled attribute

DescriptionThis attribute displays the number of subscriptions that are currently disabled.






SUBSCRIPTIONS_DISABLED or SUBSCRIPT0Subscriptions Enabled attribute

DescriptionThis attribute displays the total number of subscriptions that are currentlyenabled.




SUBSCRIPTIONS_ENABLED or SUBSCRIPT1Server Name attribute


TypeString



TDDS attribute groupThe TDDS attribute group includes attributes that provide information about the events, records, andbatches that are processed.Historical group


The following list contains information about each attribute in the TDDS attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE


The local time at the agent when the data was collected.


TypeString



Batches Being Processed attributeDescription

This attribute displays the number of batches that are being processed inside thecurrent SQL transaction.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Batches beingprocessed.

Warehouse nameBATCHES_BEING_PROCESSED or BATCHES_BE

Batches Committed attributeDescription

This attribute displays the number of batches that are currently committed to thedestination database.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Batches Committed.Warehouse name

BATCHES_COMMITTED or BATCHES_COEvents Being Processed attribute

DescriptionThis attribute displays the number of events that are being processed inside thecurrent SQL transaction.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Events beingprocessed.

Warehouse nameEVENTS_BEING_PROCESSED or EVENTS_BEI


Events Committed attributeDescription

This attribute displays the number of events that are committed to the destinationdatabase within this second.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Events Committed.Warehouse name

EVENTS_COMMITTED or EVENTS_COMRecords Being Processed attribute

DescriptionThis attribute displays the number of records that are being processed inside thecurrent SQL transaction.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Records beingprocessed.

Warehouse nameRECORDS_BEING_PROCESSED or RECORDS_BE

Records Committed attributeDescription

This attribute displays the number of records committed to the destinationdatabase during this second.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Records Committed.Warehouse name

RECORDS_COMMITTED or RECORDS_COTotal Batches (Superseded) attribute

DescriptionThis attribute displays the total number of batches the TDDS processed since theBiztalk server was started.





The source for this attribute is Perfmon - BizTalk:TDDS\*\Total Batches.Warehouse name

TOTAL_BATCHES or TOTAL_BATCTotal Events (Superseded) attribute

DescriptionThis attribute displays the total number of events the TDDS processed since theBiztalk server was started.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Total Events.Warehouse name

TOTAL_EVENTS or TOTAL_EVENTotal Failed Batches (Superseded) attribute

DescriptionThis attribute displays the total number of batches that the TDDS failed to runsince the Biztalk server was started.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Total Failed Batches.Warehouse name

TOTAL_FAILED_BATCHES or TOTAL_FAILTotal Failed Events (Superseded) attribute

DescriptionThis attribute displays the total number of events that the TDDS failed to runsince the Biztalk server was started.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Total Failed Events.Warehouse name

TOTAL_FAILED_EVENTS or TOTAL_FAI0


Total Records (Superseded) attributeDescription

This attribute displays the total number of records that the TDDS currentlyprocessed.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Total Records.Warehouse name

TOTAL_RECORDS or TOTAL_RECOTotal Batches attribute

DescriptionThis attribute displays total batches processed by TDDS since the BizTalk Serverwas started. This attribute is the 64 bit version of the Total Batches (Superseded)attribute.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Total Batches.Warehouse name

TOTAL_BATCHES_64 or T_BATC_64Total Events attribute

DescriptionThis attribute displays total events processed by TDDS since the BizTalk Serverwas started. This attribute is the 64 bit version of the Total Events (Superseded)attribute.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Total Events.Warehouse name

TOTAL_EVENTS_64 or T_EVEN_64Total Failed Batches attribute

DescriptionThis attribute displays total batches failed to run by TDDS since the BizTalkServer was started. This attribute is the 64 bit version of the Total Failed Batches(Superseded) attribute.





The source for this attribute is Perfmon - BizTalk:TDDS\*\Total Failed Batches.Warehouse name

TOTAL_FAILED_BATCHES_64 or T_FAIL_64Total Failed Events attribute

DescriptionThis attribute displays total events failed to run by TDDS since the BizTalk Serverwas started. This attribute is the 64 bit version of the Total Failed Events(Superseded) attribute.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Total Failed Events.Warehouse name

TOTAL_FAILED_EVENTS_64 or T_FAI0_64Total Records attribute

DescriptionThis attribute displays total records that were processed by TDDS since theBiztalk Server was started. This attribute is the 64 bit version of the Total Records(Superseded) attribute.



The source for this attribute is Perfmon - BizTalk:TDDS\*\Total Records.Warehouse name

TOTAL_RECORDS_64 or T_RECO_64Name attribute: This attribute is a key attribute.


TypeString


Warehouse nameNAME

Tracking Database attribute groupThe Tracking Database attribute group includes attributes that provide information about the BizTalkTracking Database.



Attribute descriptionsThe following list contains information about each attribute in the Tracking Database attributegroup:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource



DescriptionThis attribute displays the Tracking Database name.

TypeString

Warehouse nameDATABASE_NAME or TRACKINGDB


This attribute displays the Tracking Database server name.Type


SERVER_NAME or TRACKINGD0

Vacuumer attribute groupThis attribute group includes attributes that provide information about the vacuumer object of aNotification Services instance for BAM.Historical group


The following list contains information about each attribute in the Vacuumer attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE

Timestamp attribute


DescriptionThe local time at the agent when the data was collected.

TypeString




This attribute displays the instance name for the vacuumer object.Type

StringSource


NAMECompleted Periods attribute

DescriptionThis attribute displays the number of scheduled vacuuming periods (or intervals)that are currently completed successfully.




COMPLETED_PERIODS or COMPPERIDQuanta Remaining attribute

DescriptionThis attribute displays the number of quanta that was considered for vacuumingat the start of the last vacuuming period, but were not vacuumed.




QUANTA_REMAINING or QUANREMANQuanta Vacuumed attribute

DescriptionThis attribute displays the number of quanta that was vacuumed during the lastvacuuming period.

TypeInteger (64-bit gauge) with enumerated values. The strings are displayed in theTivoli Enterprise Portal. The warehouse and queries return the values shown inparentheses. The following values are defined:





QUANTA_VACUUMED or QUANVACUUTimeouts attribute

DescriptionThis attribute displays the number of vacuuming periods that currently endeddue to the time limit.




TIMEOUTSServer Name attribute


TypeString



Windows SharePoint Services attribute groupThe Windows SharePoint Services attribute group includes attributes that provide information aboutmessages sent, received and message failures.Historical group


The following list contains information about each attribute in the Windows SharePoint Servicesattribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



String




Percent Receive Message Failures attributeDescription

This attribute displays the percentage of Windows SharePoint Services files thathave not been processed by BizTalk Server due to receive errors.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\% Receive Message Failures.

Warehouse namePERCENT_RECEIVE_MESSAGE_FAILURES or RECEIVE_ME

Percent Send Message Failures attributeDescription

This attribute displays the percentage of failed messages BizTalk Server attemptedto send to Windows SharePoint Services.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\% Send Message Failures.

Warehouse namePERCENT_SEND_MESSAGE_FAILURES or SEND_MESSA

Percent Web Service Call Failures attributeDescription

This attribute displays the percentage of Windows SharePoint Services adapterWeb service calls that have failed.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\% Web Service Call Failures.


Warehouse namePERCENT_WEB_SERVICE_CALL_FAILURES or WEB_SERVIC

Total Receive Commit Failures attributeDescription

This attribute displays the total number of Windows SharePoint Services errorsthat were raised when updating the status of the SharePoint documents since theapplication started.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Total Receive Commit Failures.

Warehouse nameTOTAL_RECEIVE_COMMIT_FAILURES or TOTAL_RECE

Total Received Messages attributeDescription

This attribute displays the total number of Windows SharePoint Services filesreceived that have not been processed by BizTalk Server due to errors since theapplication started.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Total Received Messages.

Warehouse nameTOTAL_RECEIVED_MESSAGES or TOTAL_REC0

Total Receive Message Failures attributeDescription

This attribute displays the total number of Windows SharePoint Services filesreceived by the Windows SharePoint Services adapter, including files that failedto process since the application started.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Total Receive Message Failures.

Warehouse nameTOTAL_RECEIVE_MESSAGE_FAILURES or TOTAL_REC1

Total Send Message Failures attribute


DescriptionThis attribute displays the total number of failed messages BizTalk Serverattempted to send to Windows SharePoint Services since the application started.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Total Send Message Failures.

Warehouse nameTOTAL_SEND_MESSAGE_FAILURES or TOTAL_SEND

Total Sent Messages attributeDescription

This attribute displays the total number of messages BizTalk Server sent toWindows SharePoint Services, including files that failed to process since theapplication started.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Total Sent Messages.

Warehouse nameTOTAL_SENT_MESSAGES or TOTAL_SENT

Total Web Service Call Failures attributeDescription

This attribute displays the total number of Windows SharePoint Services adapterWeb service calls that have failed since the application started.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Total Web Service Call Failures.

Warehouse nameTOTAL_WEB_SERVICE_CALL_FAILURES or TOTAL_WEB_

Web Service Calls Per Sec attributeDescription

This attribute displays the number of Windows SharePoint Services adapter Webservice calls per second.





The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Web Service Calls Per Second.

Warehouse nameWEB_SERVICE_CALLS_PER_SEC or WEB_SERVI0

Windows SharePoint Services Adapter attribute groupThe Windows SharePoint Services Adapter attribute group includes attributes that provide informationabout messages sent, received and message failures.Historical group


The following list contains information about each attribute in the Windows SharePoint ServicesAdapter attribute group:Node attribute: This attribute is a key attribute.


TypeString


Warehouse nameNODE



StringSource


TIMESTAMPPercent Receive Message Failures attribute

DescriptionThis attribute displays the percentage of Windows SharePoint Services files thathave not been processed by BizTalk Server due to receive errors.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\% Receive Message Failures.


Warehouse namePERCENT_RECEIVE_MESSAGE_FAILURES or RECEIVE_ME

Percent Send Message Failures attributeDescription

This attribute displays the percentage of failed messages BizTalk Server attemptedto send to Windows SharePoint Services.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\% Send Message Failures.

Warehouse namePERCENT_SEND_MESSAGE_FAILURES or SEND_MESSA

Percent Web Service Call Failures attributeDescription

This attribute displays the percentage of Windows SharePoint Services adapterWeb service calls that have failed.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\% Web Service Call Failures.

Warehouse namePERCENT_WEB_SERVICE_CALL_FAILURES or WEB_SERVIC

Total Receive Commit Failures attributeDescription

This attribute displays the total number of Windows SharePoint Services errorsthat were raised when updating the status of the SharePoint documents since theapplication started.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Total Receive Commit Failures.

Warehouse nameTOTAL_RECEIVE_COMMIT_FAILURES or TOTAL_RECE

Total Received Messages attribute


DescriptionThis attribute displays the total number of Windows SharePoint Services filesreceived that have not been processed by BizTalk Server due to errors since theapplication started.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Total Received Messages.

Warehouse nameTOTAL_RECEIVED_MESSAGES or TOTAL_REC0

Total Receive Message Failures attributeDescription

This attribute displays the total number of Windows SharePoint Services filesreceived by the Windows SharePoint Services adapter, including files that failedto process since the application started.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Total Receive Message Failures.

Warehouse nameTOTAL_RECEIVE_MESSAGE_FAILURES or TOTAL_REC1

Total Send Message Failures attributeDescription

This attribute displays the total number of failed messages BizTalk Serverattempted to send to Windows SharePoint Services since the application started.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Total Send Message Failures.

Warehouse nameTOTAL_SEND_MESSAGE_FAILURES or TOTAL_SEND

Total Sent Messages attributeDescription

This attribute displays the total number of messages BizTalk Server sent toWindows SharePoint Services, including files that failed to process since theapplication started.




The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Total Sent Messages.

Warehouse nameTOTAL_SENT_MESSAGES or TOTAL_SENT

Total Web Service Call Failures attributeDescription

This attribute displays the total number of Windows SharePoint Services adapterWeb service calls that have failed since the application started.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Total Web Service Call Failures.

Warehouse nameTOTAL_WEB_SERVICE_CALL_FAILURES or TOTAL_WEB_

Web Service Calls Per Sec attributeDescription

This attribute displays the number of Windows SharePoint Services adapter Webservice calls per second.



The source for this attribute is Perfmon - BizTalk:Windows SharePoint ServicesAdapter\*\Web Service Calls Per Second.

Warehouse nameWEB_SERVICE_CALLS_PER_SEC or WEB_SERVI0



StringSource


NAME


Disk capacity planning for historical dataDisk capacity planning for a monitoring agent is a prediction of the amount of disk space to beconsumed by the historical data in each attribute group that is collecting historical data. Required diskstorage is an important factor when you define data collection rules and your strategy for historical datacollection.

The Capacity planning for historical data table provides the following information, which is required tocalculate disk space for this monitoring agent:

Table Table name as it is displayed in the warehouse database, if the attribute group is configured to bewritten to the warehouse. The table name corresponds to the table name in “Attribute groups forthe monitoring agent” on page 39.

Attribute groupName of the attribute group that is used to create the table in the warehouse database if it isshort enough to fit in the table naming constraints of the database that is being used for thewarehouse. The attribute group name listed here corresponds to the Warehouse table name in“Attribute groups for the monitoring agent” on page 39.

Bytes per row (agent)Estimate of the record length for each row or instance that is written to the agent disk forhistorical data collection. This estimate can be used for agent disk space planning purposes.

Database bytes per row (warehouse)Estimate of the record length for detailed records that are written to the warehouse database, ifthe attribute group is configured to be written to the warehouse. Detailed records are records thathave been uploaded from the agent for long-term historical data collection. This estimate can beused for warehouse disk-space planning purposes.

Aggregate bytes per row (warehouse)Estimate of the record length for aggregate records that are written to the warehouse database, ifthe attribute group is configured to be written to the warehouse. Aggregate records are created bythe Summarization agent for attribute groups that have been configured for summarization. Thisestimate can be used for warehouse disk-space planning purposes.

In addition to the information in the tables, you must know the number of rows of data that you plan tocollect. An attribute group can have single or multiple rows of data, depending on the applicationenvironment that is being monitored. For example, if your attribute group monitors each processor inyour computer and you have a dual processor computer, the number of rows is two.

Table 4. Capacity planning for historical data logged by the Microsoft BizTalk Server agent

Table Attribute group

Bytes perrow(agent)

Databasebytes perrow(warehouse)

Aggregatebytes perrow(warehouse)

KQBBIZAPP KQB_APPLICATION_STATUS 1680 1687 1724

KQBAVAIL KQB_AVAILABILITY 3272 3296 3606

KQBMSBTSG0 KQB_BAM_DATABASE 691 693 730

KQBBAMINTC KQB_BAM_INTERCEPTOR 208 211 442

KQBHSTGRP KQB_BIZTALK_GROUP_SERVER_HOST 2630 2643 2680

KQBGRPHST KQB_BIZTALK_HOST 1086 1088 1125

KQBORADB KQB_BIZTALK_NET_ADAPTER_FOR_ORACLE_DB

184 183 298

KQBORAEBIZ KQB_BIZTALK_NET_ADAPTER_FOR_ORACLE_EBUSINESS_SUITE

184 183 298


Table 4. Capacity planning for historical data logged by the Microsoft BizTalk Server agent (continued)


Bytes perrow(agent)



KQBSAPAD KQB_BIZTALK_NET_ADAPTER_FOR_SAP 184 183 298

KQBSIEBELA KQB_BIZTALK_NET_ADAPTER_FOR_SIEBEL

184 183 298

KQBSQLAD KQB_BIZTALK_NET_ADAPTER_FOR_SQL 184 183 298

KQBGRPSRV KQB_BIZTALK_SERVER 1616 1622 1659

KQBDELCHN KQB_DELIVERY_CHANNELS 1662 1670 1777

KQBDISTRIB KQB_DISTRIBUTORS 1670 1682 1809

KQBEVENTS KQB_EVENTS 1662 1672 1841

KQBEVTLOG KQB_EVENT_LOG 2240 2246 2283

KQBEVENPD KQB_EVENT_PROVIDERS 1682 1693 1893

KQBFILERCV KQB_FILE_RECEIVE_ADAPTER 240 321 890

KQBFILESND KQB_FILE_SEND_ADAPTER 208 263 570

KQBFTPRECV KQB_FTP_RECEIVE_ADAPTER 208 263 570

KQBFTPSEND KQB_FTP_SEND_ADAPTER 200 263 570

KQBGENERA KQB_GENERATOR 1714 1729 2053

KQBHOSTTHR KQB_HOST_THROTTLING 1082 1166 2109

KQBHTTPRCV KQB_HTTP_RECEIVE_ADAPTER 204 256 566

KQBHTTPSND KQB_HTTP_SEND_ADAPTER 196 222 430

KQBHUMANWO KQB_HUMAN_WORKFLOW_SERVICES 866 872 1104

KQBMSBTSG1 KQB_MANAGEMENT_DATABASE 691 693 730

KQBMSBTSMS KQB_MESSAGEBOX_DATABASE 744 748 785

KQBMSGBOXG KQB_MESSAGE_BOX_GENERAL_COUNTERS 216 223 650

KQBMSGBOXH KQB_MESSAGE_BOX_HOST_COUNTERS 192 193 386

KQBMESSAG1 KQB_MESSAGING 260 352 1118

KQBMESSLAT KQB_MESSAGING_LATENCY 192 241 482

KQBMSMQRCV KQB_MSMQ_RECEIVE_ADAPTER 208 263 570

KQBMSMQSND KQB_MSMQ_SEND_ADAPTER 208 263 570

KQBNOTIFI KQB_NOTIFICATIONS 1718 1733 2045

KQBORCHEST KQB_ORCHESTRATIONS 340 510 1990

KQBMSBTSOS KQB_ORCHESTRATION_STATUS 1860 1868 1905

KQBPOBJST KQB_PERFORMANCE_OBJECT_STATUS 352 399 664

KQBPOP3RCV KQB_POP3_RECEIVE_ADAPTER 212 248 534

KQBMSBTRLS KQB_RECEIVE_LOCATION_STATUS 4010 4034 4110

KQBRFIDDEV KQB_RFID_DEVICES 204 208 518

KQBRFIDPR0 KQB_RFID_PROCESSES 196 198 430

KQBMSBTSG2 KQB_RULE_ENGINE_DATABASE 691 693 730

KQBMSBTSPG KQB_SEND_PORT_GROUP_STATUS 1108 1115 1152

KQBMSBTSPS KQB_SEND_PORT_STATUS 2534 2549 2586


Table 4. Capacity planning for historical data logged by the Microsoft BizTalk Server agent (continued)


Bytes perrow(agent)



KQBMSBTSIS KQB_SERVICE_INSTANCE_STATUS_AND_CLASS

5000 5015 5052

KQBSSODB KQB_SINGLE_SIGN_ON_DATABASE 1066 1068 1105

KQBSMTPSND KQB_SMTP_SEND_ADAPTER 184 195 298

KQBSOAPRCV KQB_SOAP_RECEIVE_ADAPTER 184 195 298

KQBSOAPSND KQB_SOAP_SEND_ADAPTER 184 195 298

KQBSQLRECV KQB_SQL_RECEIVE_ADAPTER 184 195 298

KQBSQLSEND KQB_SQL_SEND_ADAPTER 184 195 298

KQBSUBSCR KQB_SUBSCRIBERS 1670 1679 1829

KQBSUBSCRP KQB_SUBSCRIPTIONS 1666 1675 1813

KQBBIZTDDS KQB_TDDS 260 309 842

KQBMSBTSG3 KQB_TRACKING_DATABASE 691 693 730

KQBVACUUM KQB_VACUUMER 1678 1688 1897

KQBWSSADAP KQB_WINDOWS_SHAREPOINT_SERVICES 116 170 501

KQBWSADPTR KQB_WINDOWS_SHAREPOINT_SERVICES_ADAPTER

216 271 602

For more information about historical data collection, see Managing historical data in the IBM TivoliMonitoring Administrator's Guide.


Chapter 5. Situations reference

A situation is a logical expression involving one or more system conditions. Situations are used tomonitor the condition of systems in your network. You can manage situations from the Tivoli EnterprisePortal by using the Situation Editor or from the command-line interface using the tacmd commands forsituations. You can manage private situations in the private configuration XML file.

About situations

The monitoring agents that you use to monitor your system environment include a set of predefinedsituations that you can use as-is. You can also create new situations to meet your requirements.

Predefined situations contain attributes that check for system conditions common to many enterprises.Using predefined situations can improve the speed with which you can begin using the IBM TivoliComposite Application Manager for Microsoft Applications: Microsoft BizTalk Server Agent. You canchange the conditions or values being monitored by a predefined situation to the conditions or valuesbest suited to your enterprise.

You can display predefined situations and create your own situations using the Situation editor. TheSituation editor initially lists the situations associated with the Navigator item that you selected. Whenyou click a situation name or create a situation, a panel opens with the following tabs:

FormulaFormula describing the condition being tested.

DistributionList of managed systems (operating systems, subsystems, or applications) to which the situationcan be distributed. All the Microsoft BizTalk Server agent managed systems are assigned bydefault.

Expert adviceComments and instructions to be read in the event workspace.

ActionCommand to be sent to the system.

EIF Customize forwarding of the event to an Event Integration Facility receiver. (Available when theTivoli Enterprise Monitoring Server is configured to forward events.)

Until Options to close the event after a period of time, or when another situation becomes true.

Additional information about situations

The Tivoli Enterprise Portal User's Guide contains more information about predefined and customsituations and how to use them to respond to alerts.

For a list of the predefined situations and information about each individual situation for this monitoringagent, see “Predefined situations.”

Predefined situationsThe monitoring agent contains predefined situations, which are organized by Navigator item.v Microsoft BizTalk Server

– Not applicablev Adapters


– Not applicablev Availability

– KQB_Biz_HostInstance_Srv_Down– KQB_Biz_Base_EDI_Service_Down– KQB_Biz_SSO_Service_Down– KQB_BizRuleEngine_Service_Down– KQB_Biz_SP_Msg_Adapter_Down– KQB_No_Host_Instance– KQB_RFID_Service_Down

v Business Activity Monitoring– Not applicable

v Configuration and Status– KQB_Send_Port_Stopped_Warning– KQB_Orchestrn_Stopped_Warning– KQB_Rec_Loc_Stoped_Warning– KQB_Srvc_Inst_Suspend_Warning– KQB_Send_Port_Group_Stopped

v Databases– Not applicable

v Event Log– KQB_Invalid_Receive_Loc_Config– KQB_BizTalk_DBConnection_Fail– KQB_Adptr_Suspends_OutboundMsg– KQB_POP3_Authentication_Fail– KQB_POP3_ServerConnection_Fail– KQB_FILESendAdptr_OpenFileFail– KQB_HostInstance_ConfigDB_Fail– KQB_HTTPSendAdaptr_ConnectFail– KQB_SendPipeline_ExecutionFail– KQB_FileAdptr_FolderAccessFail– KQB_MsgEngine_FailToAddRecvLoc– KQB_Invalid_FileRecieveLoc– KQB_ReceiveLoc_ShutDown– KQB_Stored_ProcCall_Failure– KQB_Inbound_Msg_Proc_Failure– KQB_Adapter_SuspendsInboundMsg– KQB_Msg_Resp_WithoutReq– KQB_MsgEngine_SSOSrverConnFail– KQB_MsgEngine_FailToInit– KQB_MsgEngine_FailToRegAdptr– KQB_MsgEngineFailToGetConfigDB– KQB_RecvLoc_Disabled– KQB_MSMQTSubserviceFail– KQB_RecvFileAttr– KQB_BAM_Config_Changed_Info


– KQB_RFID_Service_StartUpFail– KQB_RFID_Device_Conn_Fail– KQB_RFID_ProcessEngine_Fatal– KQB_RFID_ProcessEng_MaxRestart– KQB_RFID_Service_Auth_Fail– KQB_RFID_DeviceName_Conflict– KQB_RFID_Device_Disabled– KQB_RFID_InsufPrivil_On_Dev– KQB_RFID_Dev_StateSave_Fail– KQB_Host_Inst_Crashed

v Host Throttling– KQB_HT_High_Database_Session– KQB_HT_High_Database_Size– KQB_HT_High_InProcMessageCount– KQB_HT_High_MsgDelivery_Rate– KQB_HT_High_MsgPublishing_Rate– KQB_HT_High_Process_Memory– KQB_HT_High_System_Memory– KQB_HT_High_Thread_Count

v Human Workflow Services– Not applicable

v MessageBox– Not applicable

v Messaging– Not applicable

v Orchestrations– Not applicable

v RFID– Not applicable

v TDDS– Not applicable

Situation descriptionsEach situation description provides information about the situation that you can use to monitor thecondition of systems in your network.

The situation descriptions provide the following information:

DescriptionInformation about the conditions that the situation tests.

FormulaSyntax that contains one or more logical expressions that describe the conditions for the situationto monitor.

DistributionWhether the situation is automatically distributed to instances of the agent or is available formanual distribution.

Chapter 5. Situations reference 195

Run at startupWhether the situation starts monitoring when the agent starts.

Sampling intervalNumber of seconds that elapse between one sample of data that the monitoring agent collects forthe server and the next sample.

Situation persistenceWhether the conditions specified in the situation evaluate to "true" for the defined number ofoccurrences in a row before the situation is raised. The default of one means that nopersistence-checking takes place.

SeveritySeverity of the predefined events: Warning, Informational, or Critical.

Clearing conditionsControls when a true situation closes: after a period, when another situation is true, or whicheveroccurs first if both are selected.

Microsoft BizTalk Server Navigator itemNo predefined situations are included for this Navigator item.

Adapters Navigator itemNo predefined situations are included for this Navigator item.

Availability Navigator itemThe situation descriptions are organized by the Navigator item to which the situations are relevant.KQB_Biz_HostInstance_Srv_Down situation

DescriptionBizTalk Server Application service is not running.

The situation will be evaluated for each distinct value of Full_Name.Formula

*IF *SCAN KQB_AVAILABILITY.Name *EQ ’btssvc’ *AND *VALUE KQB_AVAILABILITY.Status*EQ DOWN

See “Attributes in each attribute group” on page 43 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling interval30 seconds

Situation persistenceThe number of times the conditions of the situation must occur for the situation to betrue is 1.

Error conditionsWarning

Clearing conditionsThe situation clears when the condition becomes false.

KQB_Biz_Base_EDI_Service_Down situationDescription

BizTalk Base EDI Service is not running.

The situation will be evaluated for each distinct value of Full_Name.


Formula*IF *VALUE KQB_AVAILABILITY.Name *EQ ’EDI Subsystem’ *AND *VALUEKQB_AVAILABILITY.Status *EQ DOWN


DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval15 minutes




KQB_Biz_SSO_Service_Down situationDescription

Enterprise Single Sign-On service is not running.


*IF *VALUE KQB_AVAILABILITY.Name *EQ ’ENTSSO’ *AND *VALUE KQB_AVAILABILITY.Status*EQ DOWN



Run at startupNo

Sampling interval1 minute


Error conditionsCritical


KQB_BizRuleEngine_Service_Down situationDescription

Rule Engine Update Service is not running.


*IF *VALUE KQB_AVAILABILITY.Name *EQ ’RuleEngineUpdateService’ *AND *VALUEKQB_AVAILABILITY.Status *EQ DOWN



Run at startupNo






KQB_Biz_SP_Msg_Adapter_Down situationDescription

BizTalk SharePoint Messaging Adapter Service is not running.


*IF *VALUE KQB_AVAILABILITY.Name *EQ’Microsoft.BizTalk.KwTpm.StsBizTalkAdapter.StsBizTalkAdapterService’ *AND *VALUEKQB_AVAILABILITY.Status *EQ DOWN



Run at startupNo





KQB_No_Host_Instance situationDescription

No Host Instance on the BizTalk Server.


*IF *SCAN KQB_AVAILABILITY.Name *EQ ’btssvc’ *AND *COUNT KQB_AVAILABILITY.Name*EQ ’0’



Run at startupNo






KQB_RFID_Service_Down situationDescription

The Microsoft BizTalk RFID service is not running.


*IF *VALUE KQB_AVAILABILITY.Name *EQ ’MSBizTalkRFID’ *AND *VALUEKQB_AVAILABILITY.Status *EQ DOWN



Run at startupNo





Business Activity Monitoring Navigator itemNo predefined situations are included for this Navigator item.

Configuration and Status Navigator itemThe situation descriptions are organized by the Navigator item to which the situations are relevant.KQB_Send_Port_Stopped_Warning situation

DescriptionSend port stopped

The situation is evaluated for each distinct value of the NAME attribute.Formula

*IF *VALUE KQB_SEND_PORT_STATUS.Status *EQ 2



Run at startupNo





KQB_Orchestrn_Stopped_Warning situationDescription

Orchestration stopped



*IF *VALUE KQB_ORCHESTRATION_STATUS.Status *EQ 3



Run at startupNo

Sampling interval1 hour




KQB_Rec_Loc_Stoped_Warning situationDescription

Receive location disabled


*IF *VALUE KQB_RECEIVE_LOCATION_STATUS.Status *EQ Disabled



Run at startupNo





KQB_Srvc_Inst_Suspend_Warning situationDescription

Service instance suspended

The situation is evaluated for each distinct value of the INSTID attribute.Formula

*IF *VALUE KQB_SERVICE_INSTANCE_STATUS_AND_CLASS.Service_Status *EQ 4 *OR *VALUEKQB_SERVICE_INSTANCE_STATUS_AND_CLASS.Service_Status *EQ 32



Run at startupNo






KQB_Send_Port_Group_Stopped situationDescription

The Send Port Group is stopped.

The situation will be evaluated for each distinct value of Send_Port_Group_Name.Formula

*IF *VALUE KQB_SEND_PORT_GROUP_STATUS.Status *EQ 2



Run at startupNo





Databases Navigator itemNo predefined situations are included for this Navigator item.

Event Log Navigator itemThe situation descriptions are organized by the Navigator item to which the situations are relevant.KQB_Invalid_Receive_Loc_Config situation

DescriptionA Receive Location is invalid or incorrectly configured

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5734 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5734 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’))



Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.


Situation persistenceNot Applicable


Clearing conditionsThe situation does not clear automatically.

KQB_BizTalk_DBConnection_Fail situationDescription

BTS Host instance failed to connect to one of its database.


*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 6913 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 6913 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’) *OR ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 6913 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2009’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 6913 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server’))



Run at startupYes





KQB_Adptr_Suspends_OutboundMsg situationDescription

An outbound message is being suspended by the adapter.





Run at startupYes






KQB_POP3_Authentication_Fail situationDescription

POP3 adapter could not authenticate server for credentials.


*IF *VALUE KQB_EVENT_LOG.Event_ID *EQ 6528 *AND *VALUE KQB_EVENT_LOG.Event_Source*EQ ’BizTalk Server 2006’



Run at startupYes





KQB_POP3_ServerConnection_Fail situationDescription

POP3 adapter could not establish connection with POP3 server.





Run at startupYes





KQB_FILESendAdptr_OpenFileFail situationDescription

The FILE Send Adapter cannot open file for writing.


*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 7184 *AND *VALUE


KQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 7184 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’))



Run at startupYes





KQB_HostInstance_ConfigDB_Fail situationDescription

Host Instance failed in BizTalk Configuration DB connection.





Run at startupYes





KQB_HTTPSendAdaptr_ConnectFail situationDescription

HTTP Send Adapter can't connect to remote server. Not for BT2004





Run at startupYes






KQB_SendPipeline_ExecutionFail situationDescription

Execution of Send Pipeline failed.





Run at startupYes





KQB_FileAdptr_FolderAccessFail situationDescription

The FILE adapter cannot access the folder. Not for BT2004.





Run at startupYes






KQB_MsgEngine_FailToAddRecvLoc situationDescription

The Messaging Engine failed to add receive location.


*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5644 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5644 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’) *OR ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5644 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2009’))



Run at startupYes





KQB_Invalid_FileRecieveLoc situationDescription

The file receive location is not valid.





Run at startupYes





KQB_ReceiveLoc_ShutDown situation


DescriptionThe receive location is being shut down.





Run at startupYes





KQB_Stored_ProcCall_Failure situationDescription

A stored procedure call failed.





Run at startupYes





KQB_Inbound_Msg_Proc_Failure situationDescription

An inbound message encountered a routing failure.

The situation is evaluated for each distinct value of the LOGNAME attribute.


Formula*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5778 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5778 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’)*OR ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5778 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2009’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5778 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server’))



Run at startupYes





KQB_Adapter_SuspendsInboundMsg situationDescription

An inbound receive message is suspended by an adapter.





Run at startupYes





KQB_Msg_Resp_WithoutReq situationDescription

The messaging engine has suspended a message.


*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5813 *AND *VALUE


KQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5813 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2009’))



Run at startupYes





KQB_MsgEngine_SSOSrverConnFail situationDescription

The messaging engine cannot contact the SSO Server.





Run at startupYes





KQB_MsgEngine_FailToInit situationDescription

The messaging engine failed to register an adapter.






Run at startupYes





KQB_MsgEngine_FailToRegAdptr situationDescription

The messaging engine failed to initialize.





Run at startupYes





KQB_MsgEngineFailToGetConfigDB situationDescription

Messaging engine failed to retrieve data from the SSO database.





Run at startupYes






KQB_RecvLoc_Disabled situationDescription

Receive locations disabled as MsgBox or Config DB not available.





Run at startupYes





KQB_MSMQTSubserviceFail situationDescription

MSMQT service failed to start because of Windows MSMQ service.





Run at startupYes





KQB_RecvFileAttr situationDescription

The processed file is either a read-only file or a system file.






Run at startupYes





KQB_BAM_Config_Changed_Info situationDescription

BAM Alerts either showing no data or wrong data.


*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 10123 *OR *VALUEKQB_EVENT_LOG.Event_ID *EQ 10115) *AND ( *VALUE KQB_EVENT_LOG.Event_Source *EQ’BamManagementUtility’))



Run at startupYes



Error conditionsInformational


KQB_RFID_Service_StartUpFail situationDescription

The Microsoft BizTalk RFID Service failed to start.


*IF ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 1500 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’MSBizTalkRFID’)




Run at startupYes





KQB_RFID_Device_Conn_Fail situationDescription

RFID device failed to connect to the server.





Run at startupYes





KQB_RFID_ProcessEngine_Fatal situationDescription

Microsoft BizTalk RFID process engine restarts automatically.





Run at startupYes






KQB_RFID_ProcessEng_MaxRestart situationDescription

Microsoft BizTalk RFID process restarts for maximum times.





Run at startupYes





KQB_RFID_Service_Auth_Fail situationDescription

The Microsoft BizTalk RFID Service failed to authorize the user.





Run at startupYes





KQB_RFID_DeviceName_Conflict situationDescription

The physical device name does not match the logical device name.






Run at startupYes





KQB_RFID_Device_Disabled situationDescription

The RFID device is in the disabled state.





Run at startupYes





KQB_RFID_InsufPrivil_On_Dev situationDescription

The user has insufficient privileges for the RFID device.





Run at startupYes





KQB_RFID_Dev_StateSave_Fail situation


DescriptionRFID process is unable to connect to the RFID logical device.





Run at startupYes





KQB_Host_Inst_Crashed situationDescription

Failure occurred while executing a Windows service request.

The situation will be evaluated for each distinct value of Event_Source.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5410 *AND *VALUEKQB_EVENT_LOG.Event_Type *EQ Error *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2006’) *OR (*VALUE KQB_EVENT_LOG.Event_ID *EQ 5410 *AND *VALUEKQB_EVENT_LOG.Event_Type *EQ Error *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2009’) *OR (*VALUE KQB_EVENT_LOG.Event_ID *EQ 5410 *AND *VALUEKQB_EVENT_LOG.Event_Type *EQ Error *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server’))



Run at startupYes





Host Throttling Navigator itemThe situation descriptions are organized by the Navigator item to which the situations are relevant.KQB_HT_High_Database_Session situation

DescriptionDatabase session count exceeds current threshold. Not for BT2004

The situation is evaluated for each distinct value of the NAME attribute.


Formula*IF *VALUE KQB_HOST_THROTTLING.High_Database_Session *EQ 1 *OR *VALUEKQB_HOST_THROTTLING.Message_Publishing_Throttling_State *EQ 8



Run at startupNo





KQB_HT_High_Database_Size situationDescription

Database size count exceeds current threshold. Not for BT2004.


*IF *VALUE KQB_HOST_THROTTLING.High_Database_Size *EQ 1 *OR *VALUEKQB_HOST_THROTTLING.Message_Publishing_Throttling_State *EQ 6



Run at startupNo





KQB_HT_High_InProcMessageCount situationDescription

InProcess msg count exceeds current threshold. Not for BT2004.


*IF *VALUE KQB_HOST_THROTTLING.High_In_Process_Message_Count *EQ 1 *OR *VALUEKQB_HOST_THROTTLING.Message_Delivery_Throttling_State *EQ 3



Run at startupNo






KQB_HT_High_MsgDelivery_Rate situationDescription

Msg delivery rate exceeds msg processing Rate. Not for BT2004.


*IF *VALUE KQB_HOST_THROTTLING.High_Message_Delivery_Rate *EQ 1 *OR *VALUEKQB_HOST_THROTTLING.Message_Delivery_Throttling_State *EQ 1



Run at startupNo





KQB_HT_High_MsgPublishing_Rate situationDescription

Publishing request rate exceeds completion rate. Not for BT2004.


*IF *VALUE KQB_HOST_THROTTLING.High_Message_Publishing_Rate *EQ 1 *OR *VALUEKQB_HOST_THROTTLING.Message_Publishing_Throttling_State *EQ 2



Run at startupNo





KQB_HT_High_Process_Memory situation


DescriptionProcess memory exceeds threshold. Not for BT2004.


*IF *VALUE KQB_HOST_THROTTLING.High_Process_Memory *EQ 1 *OR *VALUEKQB_HOST_THROTTLING.Message_Delivery_Throttling_State *EQ 4 *OR *VALUEKQB_HOST_THROTTLING.Message_Publishing_Throttling_State *EQ 4



Run at startupNo





KQB_HT_High_System_Memory situationDescription

System memory exceeds threshold. Not for BT2004.


*IF *VALUE KQB_HOST_THROTTLING.High_System_Memory *EQ 1 *OR *VALUEKQB_HOST_THROTTLING.Message_Delivery_Throttling_State *EQ 5 *OR *VALUEKQB_HOST_THROTTLING.Message_Publishing_Throttling_State *EQ 5



Run at startupNo





KQB_HT_High_Thread_Count situationDescription

Thread count exceeds current threshold. Not for BT2004.


*IF *VALUE KQB_HOST_THROTTLING.High_Thread_Count *EQ 1 *OR *VALUEKQB_HOST_THROTTLING.Message_Delivery_Throttling_State *EQ 9 *OR *VALUEKQB_HOST_THROTTLING.Message_Publishing_Throttling_State *EQ 9




Run at startupNo





Human Workflow Services Navigator itemNo predefined situations are included for this Navigator item.

MessageBox Navigator itemNo predefined situations are included for this Navigator item.

Messaging Navigator itemNo predefined situations are included for this Navigator item.

Orchestrations Navigator itemNo predefined situations are included for this Navigator item.

RFID Navigator itemNo predefined situations are included for this Navigator item.

TDDS Navigator itemNo predefined situations are included for this Navigator item.


Chapter 6. Take Action commands reference

Take Action commands can be run from the portal client or included in a situation or a policy.

About Take Action commands

When included in a situation, the command runs when the situation becomes true. A Take Actioncommand in a situation is also referred to as reflex automation. When you enable a Take Action commandin a situation, you automate a response to system conditions. For example, you can use a Take Actioncommand to send a command to restart a process on the managed system or to send a text message to acell phone.

In advanced automation, policies are used to take actions, schedule work, and automate manual tasks. Apolicy comprises a series of automated steps called activities that are connected to create a workflow.After an activity is completed, the Tivoli Enterprise Portal receives return-code feedback, and advancedautomation logic responds with subsequent activities that are prescribed by the feedback.

A basic Take Action command shows the return code of the operation in a message box that is displayedafter the action is completed or in a log file. After you close this window, no further information isavailable for this action.

Additional information about Take Action commands

For more information about working with Take Action commands, see Take Action commands in the TivoliEnterprise Portal User's Guide.

Predefined Take Action commandsNot all agents have predefined Take Action commands. But you can create Take Action commands forany agent.

Take Action command descriptionsEach Take Action command description provides information you can use to decide whether to run theTake Action command or whether to include the Take Action command in a situation or a policy.

The descriptions of the Take Action commands provide the following information:

DescriptionActions the command performs on the system to which it is sent, and the permissions requiredfor the Take Action command to function.

Return codesInformation that the Take Action command returns.

Enable Receive Location actionEnables receive location selected by the user. If take action timeout error occurs, increase the timeoutinterval by setting environment variable CDP_DP_ACTION_TIMEOUT. The default interval is 20seconds.System command

To include the Take Action command in a situation or workflow policy, use the following syntaxfor the system command:


ENABLE_RECEIVE_LOCATION \

[KQB_RECEIVE_LOCATION_STATUS.Name]

You can use attribute substitution to supply the Take Action command arguments from thesituation, for example:ENABLE_RECEIVE_LOCATION \

[&{KQB_RECEIVE_LOCATION_STATUS.Name}]

You can also use attribute substitution in a workflow policy though the format is slightlydifferent:ENABLE_RECEIVE_LOCATION \

[&WaitOnSituation:KQB_RECEIVE_LOCATION_STATUS.Name]Authorization

User must be a member of Administrators group.Command arguments

v Name: KQB_RECEIVE_LOCATION_STATUS.Name– Description: Receive Location– Default: KQB_RECEIVE_LOCATION_STATUS.Name

Destination systems_EnDDESTINATIONS_NONE_OR_LIST_EnD

Return codesv Return Code: 1

– Return Code Type: NOT_APPLICABLE– Operating systems: Windows, Windows (64-bit)– Message ID: KQB1001– Message: WARNING::NO MESSAGE FOUND FOR THIS RETURN CODE!!!!!

v Return Code: 8– Return Code Type: TIMED_OUT– Operating systems: Windows, Windows (64-bit)– Message ID: KQB1003– Message: WARNING::NO MESSAGE FOUND FOR THIS RETURN CODE!!!!!

v Return Code: 12– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB1004– Message: WARNING::NO MESSAGE FOUND FOR THIS RETURN CODE!!!!!

v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4043I– Message: Receive Location is enabled.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4044E– Message: Error enabling the Receive Location. Check whether the Receive Location is

already enabled. If not, check the BizTalk Server administration console to ensure all thedependent settings are enabled.

Usage None.

Start BizTalk Base EDI Service actionStarts BizTalk Base EDI Service. Applicable for BizTalk 2006 R2, only if it is upgraded from version 2004or 2006.


AuthorizationUser must be a member of Administrators group.



– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0004I– Message: The BizTalk Base EDI service is started.

v Return Code: 3– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0005I– Message: The BizTalk Base EDI service is already started.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0006E– Message: Error starting the BizTalk Base EDI service.

v Return Code: 9– Return Code Type: WARNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0200W– Message: The service does not exist as an installed service.

v Return Code: 8– Return Code Type: DOESNT_EXIST– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0201I– Message: The service is disabled and cannot be started.

v Return Code: 7– Return Code Type: PREREQ_NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0202E– Message: The dependency service or group failed to start.

v Return Code: 6– Return Code Type: PREREQ_NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0203E– Message: The dependency service does not exist or has been marked for deletion.

v Return Code: 12– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0204E– Message: The service did not start because of a logon failure.

v Return Code: 1– Return Code Type: NOT_APPLICABLE– Operating systems: Windows, Windows (64-bit)– Message ID: KQB1001– Message: WARNING::NO MESSAGE FOUND FOR THIS RETURN CODE!!!!!

Usage None.

Start BizTalk SharePoint Messaging Adapter Service actionStarts the BizTalk SharePoint Messaging Adapter Service (applicable only for BizTalk Server 2004).

Chapter 6. Take Action commands reference 223

AuthorizationUser must be a member of Administrators group.



– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0007I– Message: The BizTalk SharePoint Messaging Adapter service is started.

v Return Code: 3– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0008I– Message: The BizTalk SharePoint Messaging Adapter service is already started.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0009E– Message: Error starting the BizTalk SharePoint Messaging Adapter service.







Usage None.


Start Enterprise Single Sign-On Service actionStarts the Enterprise Single Sign-On Service. If take action timeout error occurs, increase the timeoutinterval by setting environment variable CDP_DP_ACTION_TIMEOUT. The default interval is 20seconds.Authorization

User must be a member of Administrators group.Destination systems

_EnDDESTINATIONS_NONE_OR_LIST_EnDReturn codes

v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0010I– Message: The Enterprise Single Sign-On service is started.

v Return Code: 3– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0011I– Message: The Enterprise Single Sign-On service is already started.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0012E– Message: Error starting the Enterprise Single Sign-On service.







Usage None.


Start Host Instance Service actionStarts Host Instance Service for the host instance selected by the user. If take action timeout error occurs,increase the timeout interval by setting environment variable CDP_DP_ACTION_TIMEOUT. The defaultinterval is 20 seconds.System command

To include the Take Action command in a situation or workflow policy, use the following syntaxfor the system command:START_HOST_INSTANCE_SERVICE \

[KQB_AVAILABILITY.Name]

You can use attribute substitution to supply the Take Action command arguments from thesituation, for example:START_HOST_INSTANCE_SERVICE \

[&{KQB_AVAILABILITY.Name}]

You can also use attribute substitution in a workflow policy though the format is slightlydifferent:START_HOST_INSTANCE_SERVICE \

[&WaitOnSituation:KQB_AVAILABILITY.Name]Authorization


v Name: KQB_AVAILABILITY.Name– Description: Host Instance– Default: &KQB_AVAILABILITY.Name



– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0013I– Message: Host Instance service is started.

v Return Code: 3– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0014I– Message: Host Instance service is already started.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0015E– Message: Error starting Host Instance service.








Usage None.

Start Microsoft BizTalk RFID Service actionStarts the Microsoft BizTalk RFID Service. If a timeout error occurs, set the CDP_DP_ACTION_TIMEOUTenvironment variable to increase the timeout interval. The default interval is 20 seconds.Authorization

The user must be a member of the Administrators group.Destination systems


v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0016I– Message: The Microsoft BizTalk RFID Service is started.

v Return Code: 3– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0017I– Message: The Microsoft BizTalk RFID Service has already started.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0018E– Message: An error occurred while starting the Microsoft BizTalk RFID Service.








Usage None.

Start Orchestration actionStarts orchestration selected by the user. If the take action timeout error occurs, increase the timeoutinterval by setting environment variable CDP_DP_ACTION_TIMEOUT. The default interval is 20seconds.System command

To include the Take Action command in a situation or workflow policy, use the following syntaxfor the system command:START_ORCHESTRATION \

[KQB_ORCHESTRATION_STATUS.Orchestration_Name]

You can use attribute substitution to supply the Take Action command arguments from thesituation, for example:START_ORCHESTRATION \

[&{KQB_ORCHESTRATION_STATUS.Orchestration_Name}]

You can also use attribute substitution in a workflow policy though the format is slightlydifferent:START_ORCHESTRATION \

[&WaitOnSituation:KQB_ORCHESTRATION_STATUS.Orchestration_Name]Authorization


v Name: KQB_ORCHESTRATION_STATUS.Orchestration_Name– Description: Orchestration– Default: KQB_ORCHESTRATION_STATUS.Orchestration_Name



– Return Code Type: TIMED_OUT– Operating systems: Windows, Windows (64-bit)


– Message ID: KQB1003– Message: WARNING::NO MESSAGE FOUND FOR THIS RETURN CODE!!!!!

v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4039I– Message: Orchestration is started.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4040E– Message: Error starting the Orchestration. Check whether the Orchestration is already

started. If not, check the BizTalk Server administration console.v Return Code: 1

– Return Code Type: NOT_APPLICABLE– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4059E– Message: The Orchestration name is not provided.

v Return Code: 6– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4060E– Message: The Orchestration has already started.

v Return Code: 7– Return Code Type: PREREQ_NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4061E– Message: Cannot start the Orchestration. All orchestration ports must be bound and the host

must be set to start the Orchestration.v Return Code: 9

– Return Code Type: DOESNT_EXIST– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4062E– Message: The Orchestration does not exist.

v Return Code: 12– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4063E– Message: The Orchestration did not start because of a logon failure.

Usage None.

Start Rule Engine Update Service actionStarts the Rule Engine Update Service. If take action timeout error occurs, increase the timeout interval bysetting environment variable CDP_DP_ACTION_TIMEOUT. The default interval is 20 seconds.Authorization



v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0001I– Message: The Rule Engine Update service is started.

v Return Code: 3


– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0002I– Message: The Rule Engine Update service is already started.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB0003E– Message: Error starting Rule Engine Update service.







Usage None.

Start Send Port actionStarts send port selected by the user. If take action timeout error occurs, increase the timeout interval bysetting environment variable CDP_DP_ACTION_TIMEOUT. The default interval is 20 seconds.System command

To include the Take Action command in a situation or workflow policy, use the following syntaxfor the system command:START_SEND_PORT \

[KQB_SEND_PORT_STATUS.Send_Port_Name]

You can use attribute substitution to supply the Take Action command arguments from thesituation, for example:START_SEND_PORT \

[&{KQB_SEND_PORT_STATUS.Send_Port_Name}]


You can also use attribute substitution in a workflow policy though the format is slightlydifferent:START_SEND_PORT \

[&WaitOnSituation:KQB_SEND_PORT_STATUS.Send_Port_Name]Authorization


v Name: KQB_SEND_PORT_STATUS.Send_Port_Name– Description: Send Port– Default: KQB_SEND_PORT_STATUS.Send_Port_Name



– Return Code Type: TIMED_OUT– Operating systems: Windows, Windows (64-bit)– Message ID: KQB1003– Message: WARNING::NO MESSAGE FOUND FOR THIS RETURN CODE!!!!!

v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4041I– Message: Send Port is started.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4042E– Message: Error starting the Send Port. Check whether the Send Port is already started. If

not, check the BizTalk Server administration console.v Return Code: 1

– Return Code Type: NOT_APPLICABLE– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4064E– Message: The Send Port name is not provided.

v Return Code: 6– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4065E– Message: The Send Port has already started.

v Return Code: 7– Return Code Type: PREREQ_NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4066E– Message: Cannot start the Send Port.

v Return Code: 9– Return Code Type: DOESNT_EXIST– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4067E– Message: The Send Port does not exist.

v Return Code: 12– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4068E– Message: The Send Port did not start because of a logon failure.

Usage None.


Start Send Port Group actionStarts Send Port Group selected by the user. If take action timeout error occurs, increase the timeoutinterval by setting environment variable CDP_DP_ACTION_TIMEOUT. The default interval is 20seconds.System command

To include the Take Action command in a situation or workflow policy, use the following syntaxfor the system command:START_SEND_PORT_GROUP \

[KQB_SEND_PORT_GROUP_STATUS.Send_Port_Group_Name]

You can use attribute substitution to supply the Take Action command arguments from thesituation, for example:START_SEND_PORT_GROUP \

[&{KQB_SEND_PORT_GROUP_STATUS.Send_Port_Group_Name}]

You can also use attribute substitution in a workflow policy though the format is slightlydifferent:START_SEND_PORT_GROUP \

[&WaitOnSituation:KQB_SEND_PORT_GROUP_STATUS.Send_Port_Group_Name]Authorization

The user must be a member of the Administrators group.Command arguments

v Name: KQB_SEND_PORT_GROUP_STATUS.Send_Port_Group_Name– Description: Send Port Group– Default: KQB_SEND_PORT_GROUP_STATUS.Send_Port_Group_Name




v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4045I– Message: Send Port Group is started.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4046E– Message: An error occurred while starting the Send Port Group. Check the BizTalk Server

Administration Console.v Return Code: 1

– Return Code Type: NOT_APPLICABLE– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4047E– Message: The Send Port Group name is not provided.

v Return Code: 6– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4048E


– Message: The Send Port Group has already started.v Return Code: 7

– Return Code Type: PREREQ_NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4049E– Message: Cannot start the Send Port Group. At least one associated Send Port must be

already enlisted.v Return Code: 9

– Return Code Type: DOESNT_EXIST– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4050E– Message: The Send Port Group does not exist.

v Return Code: 12– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4051E– Message: The Send Port Group did not start because of a logon failure.

Usage None.

Stop BizTalk Base EDI Service actionStops BizTalk Base EDI Service. Applicable for BizTalk 2006 R2, only if it is upgraded from version 2004or 2006.Authorization






v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0104I– Message: The BizTalk Base EDI service is stopped.

v Return Code: 3– Return Code Type: NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0105I– Message: The BizTalk Base EDI service is already stopped.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)


– Message ID: KQH0106E– Message: Error stopping the BizTalk Base EDI service.

v Return Code: 9– Return Code Type: WARNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0200W– Message: WARNING::NO MESSAGE FOUND FOR THIS RETURN CODE!!!!!

Usage None.

Stop BizTalk SharePoint Messaging Adapter Service actionStops the BizTalk SharePoint Messaging Adapter Service (applicable only for BizTalk Server 2004).Authorization






v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0107I– Message: The BizTalk SharePoint Messaging Adapter service is stopped.

v Return Code: 3– Return Code Type: NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0108I– Message: The BizTalk SharePoint Messaging Adapter service is already stopped.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0109E– Message: Error stopping the BizTalk SharePoint Messaging Adapter service.


Usage None.


Stop Enterprise Single Sign-On Service actionStops the Enterprise Single Sign-On Service. If take action timeout error occurs, increase the timeoutinterval by setting environment variable CDP_DP_ACTION_TIMEOUT. The default interval is 20seconds.Authorization






v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0110I– Message: The Enterprise Single Sign-On service is stopped.

v Return Code: 3– Return Code Type: NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0111I– Message: The Enterprise Single Sign-On service is already stopped.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0112E– Message: Error stopping the Enterprise Single Sign-On service.


Usage None.

Stop Host Instance Service actionStops Host Instance Service for the host instance selected by the user. If take action timeout error occurs,increase the timeout interval by setting environment variable CDP_DP_ACTION_TIMEOUT. The defaultinterval is 20 seconds.System command

To include the Take Action command in a situation or workflow policy, use the following syntaxfor the system command:


STOP_HOST_INSTANCE_SERVICE \

[KQB_AVAILABILITY.Name]

You can use attribute substitution to supply the Take Action command arguments from thesituation, for example:STOP_HOST_INSTANCE_SERVICE \

[&{KQB_AVAILABILITY.Name}]

You can also use attribute substitution in a workflow policy though the format is slightlydifferent:STOP_HOST_INSTANCE_SERVICE \

[&WaitOnSituation:KQB_AVAILABILITY.Name]Authorization


v Name: KQB_AVAILABILITY.Name– Description: Host Instance– Default: &KQB_AVAILABILITY.Name






v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0113I– Message: Host Instance service is stopped.

v Return Code: 3– Return Code Type: NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0114I– Message: Host Instance service is already stopped.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0115E– Message: Error stopping Host Instance service.

v Return Code: 9– Return Code Type: WARNING– Operating systems: Windows, Windows (64-bit)


– Message ID: KQH0200W– Message: WARNING::NO MESSAGE FOUND FOR THIS RETURN CODE!!!!!

Usage None.

Stop Microsoft BizTalk RFID Service actionStops the Microsoft BizTalk RFID Service. If a timeout error occurs, set the CDP_DP_ACTION_TIMEOUTenvironment variable to increase the timeout interval. The default interval is 20 seconds.Authorization

The user must be a member of the Administrators group.Destination systems





v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0116I– Message: The Microsoft BizTalk RFID service is stopped.

v Return Code: 3– Return Code Type: NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0117I– Message: The Microsoft BizTalk RFID service has already stopped.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0118E– Message: An error occurred while stopping the Microsoft BizTalk RFID service.


Usage None.

Stop Rule Engine Update Service actionStops the Rule Engine Update Service. If take action timeout error occurs, increase the timeout interval bysetting environment variable CDP_DP_ACTION_TIMEOUT. The default interval is 20 seconds.Authorization

User must be a member of Administrators group.







v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0101I– Message: The Rule Engine Update service is stopped.

v Return Code: 3– Return Code Type: NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0102I– Message: The Rule Engine Update service is already stopped.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQH0103E– Message: Error stopping the Rule Engine Update service.


Usage None.

Stop Send Port Group actionStops Send Port Group selected by the user. If take action timeout error occurs, increase the timeoutinterval by setting environment variable CDP_DP_ACTION_TIMEOUT. The default interval is 20seconds.System command

To include the Take Action command in a situation or workflow policy, use the following syntaxfor the system command:STOP_SEND_PORT_GROUP \

[KQB_SEND_PORT_GROUP_STATUS.Send_Port_Group_Name]

You can use attribute substitution to supply the Take Action command arguments from thesituation, for example:STOP_SEND_PORT_GROUP \

[&{KQB_SEND_PORT_GROUP_STATUS.Send_Port_Group_Name}]


You can also use attribute substitution in a workflow policy though the format is slightlydifferent:STOP_SEND_PORT_GROUP \

[&WaitOnSituation:KQB_SEND_PORT_GROUP_STATUS.Send_Port_Group_Name]Authorization

The user must be a member of the Administrators group.Command arguments

v Name: KQB_SEND_PORT_GROUP_STATUS.Send_Port_Group_Name– Description: Send Port Group– Default: KQB_SEND_PORT_GROUP_STATUS.Send_Port_Group_Name




v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4052I– Message: The Send Port Group is stopped.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4053E– Message: An error occurred while stopping the Send Port Group. Check the BizTalk Server

Administration Console.v Return Code: 1

– Return Code Type: NOT_APPLICABLE– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4054E– Message: The Send Port Group name is not provided.

v Return Code: 4– Return Code Type: NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4055E– Message: The Send Port Group has already stopped.

v Return Code: 7– Return Code Type: PREREQ_NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4056E– Message: Cannot stop the Send Port Group because the state of the Send Port Group is

Bound.v Return Code: 9

– Return Code Type: DOESNT_EXIST– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4057E– Message: The Send Port Group does not exist.

v Return Code: 12– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4058E– Message: The Send Port Group did not start because of a logon failure.


Usage None.


Chapter 7. Policies reference

Policies are used as an advanced automation technique for implementing more complex workflowstrategies than you can create through simple automation. All agents do not provide predefined policies,but you can create policies for any agent.

A policy is a set of automated system processes that can take actions, schedule work for users, orautomate manual tasks. You use the Workflow Editor to design policies. You control the order in whichthe policy executes a series of automated steps, which are also called activities. Policies are connected tocreate a workflow. After an activity is completed, the Tivoli Enterprise Portal receives return-codefeedback, and advanced automation logic responds with subsequent activities prescribed by the feedback.

For more information about working with policies, see Automation with policies in the Tivoli EnterprisePortal User's Guide.

For information about using the Workflow Editor, see the IBM Tivoli Monitoring Administrator's Guide orthe Tivoli Enterprise Portal online help.

Predefined policiesNot all agents have predefined policies. But you can create policies for any agent.

The IBM Tivoli Composite Application Manager for Microsoft Applications: Microsoft BizTalk ServerAgent does not provide predefined policies.


Chapter 8. Tivoli Common Reporting for the monitoring agent

You can use the Tivoli Common Reporting application to generate reports for the Microsoft BizTalkServer agent. For more information about Tivoli Common Reporting, such as prerequisites, importingreports, and running reports, see the IBM Tivoli Monitoring Administrator's Guide V6.2.3.

The IBM Tivoli Monitoring for Microsoft Applications V7.1 reports are historical reports that includesummarized data that is collected in the Tivoli Data Warehouse. These reports are built to run onlyagainst the IBM Tivoli Monitoring for Microsoft BizTalk Server agent V6.3.

The reports can be administered and run on Tivoli Common Reporting V1.3, V2.1, and V2.1.1, Fix Pack 6.

For more information about Tivoli Common Reporting, see the developerWorks website(http://www.ibm.com/developerworks/spaces/tcr).

This version of Tivoli Common Reporting includes Cognos Business Intelligence and Reporting V8.4.

Cognos-based report packagesThe Cognos-based Tivoli Common Reporting tool is used to create, view, and manage reports for theTivoli group of products.

You can use the Cognos reports to analyze resource information such as availability, utilization,performance, and so on. With Cognos reports, you can evaluate the key metrics of the computers that areon the managed environment of your organization.

You can use the Tivoli Common Reporting tool to:v Create custom reports by using the drag-and-drop feature integrated with the web-based editor.v Schedule, share, secure, and administer reports in a single interface.v Save the report in HTML, PDF, Excel, XML, or CSV file formats.v Share reports by email or save the reports in a file system for later use.

The following databases are supported for all reports:v DB2 V9.5 and V9.7 Fix Pack 2v Oracle 10g and 11gv SQL Server 2005 and 2008

You can use Tivoli Common Reporting V1.3, V2.1, and V2.1.1, Fix Pack 6 software that is shippedwithIBM Tivoli Monitoring V6.2.3 or later to administer, run, and edit Cognos reports. For moreinformation about Tivoli Common Reporting, see the Tivoli Common Reporting Information Center(http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.tivoli.tcr.doc_211/ic-home.html).

PrerequisitesBefore you run the Cognos-based reports, ensure that the prerequisites that are required for installing andrunning Tivoli Common Reporting packages are met.

Procedure1. Install Tivoli Common Reporting. For more information see the documentation in the IBM Tivoli

Common Reporting Information Center (http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.tivoli.tcr.doc_211/ichome.html)


http://www.ibm.com/developerworks/spaces/tcr

http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.tivoli.tcr.doc_211/ic-home.html

http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.tivoli.tcr.doc_211/ichome.html

http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.tivoli.tcr.doc_211/ichome.html

To ensure that Tivoli Common Reporting is running, go to:https://machine_name:port_number/ibm/console/.

2. Obtain the reports package from the product media and extract the package.The Cognos reports are available in the following package: Product Media root/REPORTS/KQB/ITCAMMA_BizTalkServer_V630_Cognos_Reports.

3. Copy this package in a directory on any drive of the same computer where the Tivoli CommonReporting Server is installed, and extract the package in the same directory.The directory contents include:v Database scripts required to prepare the Tivoli Data Warehouse for Cognos reports.v A report installer that imports the reports into Tivoli Common Reporting and sets up the database

connection.4. Open the setup.batch file, and verify that the specified drive is the same drive where the Tivoli

Common Reporting Server is installed. If the specified drive is not correct, edit the setup.batch file tospecify the correct drive.For example, change the TCR_DEFAULT_DIR=C:\IBM\tivoli\tip to TCR_DEFAULT_DIR=F:\IBM\tivoli\tipif the Tivoli Common Reporting Server is installed on the F drive.

5. Configure historical collection for Microsoft BizTalk Server agent V6.3 and the IBM Tivoli WarehouseSummarization and Pruning Agent. After IBM Tivoli Monitoring V6.2.3 is installed and the MicrosoftBizTalk Server agent V6.3 is installed and configured, configure historical collection. Also, configurethe Warehouse Summarization and Pruning agent with or without shifts enabled. For moreinformation about how to enable historical collection and configure the Warehouse Summarizationand Pruning agent in IBM Tivoli Monitoring, see the following documentation:v http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/topic/com.ibm.itm.doc_6.2.3fp1/adminuse/

history_manage_intro.htmv http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/topic/com.ibm.itm.doc_6.2.3fp1/adminuse/

history_manage_collection.htm

Note: Historical collection and daily and hourly summarization must be enabled for all attributegroups of Microsoft BizTalk Server agent V6.3.

To ensure that the required views are present, run the following query against the Tivoli DataWarehouse:v DB2: Select distinct "TABNAME" from SYSCAT.VIEWS where "TABNAME" like ’ ITMUSER’v Oracle: Select distinct "OBJECT_NAME" from OBJ where "OBJECT_TYPE" like ’%V’v MS SQL Server: Select distinct "NAME" from SYS.OBJECTS where "TYPE_DESC" like ’%V’

6. Prepare the Tivoli Data Warehouse to support Cognos dimensions.Preparing the Tivoli Data Warehouse for Tivoli Common Reporting includes creating the IBM_TRAMdimensions, which are required for running the Cognos reports and using the data models.See "Creating shared dimension tables and populating the time dimensions table" in the IBM TivoliMonitoring Administrator's Guide at the IBM Tivoli Monitoring V6.2.3, Fix Pack 1 Information Center(http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/topic/com.ibm.itm.doc_6.2.3fp1/adminuse/tcr_reports_dimensionsshared.htm).

7. Connect to the Tivoli Data Warehouse by using the database client over Open Database Connectivity(ODBC).Cognos uses ODBC to connect to the database. Install a database client on the Tivoli CommonReporting Server and connect it to the Tivoli Data Warehouse.See "Connecting to the Tivoli Data Warehouse using the database client over ODBC" in the IBM TivoliMonitoring Administrator's Guide at the IBM Tivoli Monitoring V6.2.3, Fix Pack 1 Information Center(http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/topic/com.ibm.itm.doc_6.2.3fp1/adminuse/tcr_tdwconnect.htm).

Important: All prerequisites described here must be met or the reports cannot run.


http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/topic/com.ibm.itm.doc_6.2.3fp1/adminuse/history_manage_intro.htm

http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/topic/com.ibm.itm.doc_6.2.3fp1/adminuse/history_manage_intro.htm

http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/topic/com.ibm.itm.doc_6.2.3fp1/adminuse/history_manage_collection.htm

http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/topic/com.ibm.itm.doc_6.2.3fp1/adminuse/history_manage_collection.htm

http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/topic/com.ibm.itm.doc_6.2.3fp1/adminuse/tcr_reports_dimensionsshared.htm

http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/topic/com.ibm.itm.doc_6.2.3fp1/adminuse/tcr_tdwconnect.htm

Importing Cognos report packages

You must import the Cognos report package that contains the Microsoft BizTalk Server agent data modeland reports into Tivoli Common Reporting. Before you import the Cognos report package, ensure that allthe prerequisites have been met. Otherwise, reports cannot run.

For Tivoli Common Reporting V1.3, use one of the following options to import the Cognos reportpackage:v Importing by running the reports installer – For information about running the reports installer to

import the Cognos report package, see "Installing and running IBM Cognos reports" in the IBM TivoliMonitoring Administrator's Guide at the IBM Tivoli Monitoring V6.2.2, Fix Pack 2 Information Center(http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/topic/com.ibm.itm.doc_6.2.2fp2/tcr_install_itm.htm).

v Importing manually – For information about manually importing the reports package, see “Importingreport packages” at the IBM Tivoli Systems Management Information Center (http://pic.dhe.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.tivoli.tcr_cog.doc/ttcr_cog_import.html).

For Tivoli Common Reporting V2.1, or later, see "Importing report packages" at the Tivoli CommonReporting Information Center (http://pic.dhe.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.tivoli.tcr.doc_211/ttcr_import.html).

If you are using a schema other than ITMUSER, you must complete the following steps for the datamodel and reports to run:1. Verify that you have completed the following steps:

a. Altered the schema name in the database scripts when you prepared the Tivoli Data Warehousefor Cognos dimensions in Step 6 on page 244 of “Prerequisites” on page 243.

b. Installed the reports package by using the Reports installer as explained in "Importing reports byusing the report installer" topic in the IBM Tivoli Monitoring Administrator's Guide. To verify thatyou have installed the reports package, go to Tivoli Common Reporting and make sure you cansee "ITCAMMA BizTalk V630 Cognos Reports" in the Public Folders of IBM Cognos Connection.

2. Install and configure the Cognos Framework Manager, which is the data modeling tool. See theinstructions at the Tivoli Common Reporting Information Center (http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.tivoli.tcr.doc_211/ttcr_configure_frameworkmgr.html).

3. Open the Framework Manager. Select File > Open. Browse to the extracted ITCAMMA BizTalk V630Cognos Reports package. Browse to the model folder and select the ITCAMMA BizTalk V630 CognosReports.cpf file.

4. If you are prompted to enter login credentials, enter your tipadmin user ID and password.5. After the IBM Tivoli Monitoring for BizTalk Server data model in the Framework Manager opens,

expand Data Sources under Tivoli Reporting and Analytics Model in the Project Viewer.6. Select TDW under Data Sources.7. When you select TDW, the Properties view is updated with information about the Tivoli Data

Warehouse data source. If the Properties view is not visible, select View > Properties.8. In the Properties, edit the Schema field. Change it from ITMUSER to your schema name.9. Save the project.

10. In the Project Viewer, expand Packages.11. Right-click ITCAMMA BizTalk V630 Cognos Reports.12. Select Publish Packages. The Publish Wizard opens.13. Keep the default selection and click Next.14. Click Next on the next screen.15. Clear the Verify the package before publishing check box.

Chapter 8. Tivoli Common Reporting for the monitoring agent 245

http://pic.dhe.ibm.com/infocenter/tivihelp/v15r1/topic/com.ibm.itm.doc_6.2.2fp2/tcr_install_itm.htm

http://pic.dhe.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.tivoli.tcr_cog.doc/ttcr_cog_import.html

http://pic.dhe.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.tivoli.tcr.doc_211/ttcr_import.html

http://pic.dhe.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.tivoli.tcr.doc_211/ttcr_import.html

http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.tivoli.tcr.doc_211/ttcr_configure_frameworkmgr.html

16. Click Publish. A window is displayed that alerts you that A package with that name alreadyexists and asks Do you want to publish this package?

17. Click Yes.18. Go back to Tivoli Common Reporting and check if the Modified field of "ITCAMMA BizTalk V630

Cognos Reports" in the Public Folders of IBM Cognos Connection shows the time of publishing.

After completing these steps, you can run any report from the IBM Tivoli Monitoring for ITCAMMABizTalk V630 Cognos Reports package.

Cognos data models and reportsWhen all the prerequisites are met, you can use the Tivoli Integrated Portal interface to create, modify,and manage Cognos reports.

In Tivoli Common Reporting, the historical data that is collected by the agent is used to build ad hocreports and queries. The package that you import into Tivoli Common Reporting contains a Cognos datamodel. All the reports that you create in Tivoli Common Reporting are based on the data model.

Cognos data models are virtual star schema models that contain facts and dimensions. Facts aremeasurable quantities that can be aggregated, such as CPU utilization and number of processors.Dimensions are the main identifiers by which facts can be grouped, aggregated, and organized. Forexample, time and server are dimensions by which the fact CPU utilization can be grouped.

The facts in the data model are organized into the folders by their summarization type, such as Daily andHourly. The Daily and the Hourly folders contain attribute groups that correspond to tables or views inthe data warehouse. Each attribute group contains a group of facts and measures.

The data model is built on top of the data warehouse to organize data. The data model contains theTivoli Reporting and Analytics Model (TRAM) Shared Dimensions, which are shared across Tivoli byproducts such as Time.

To create reports in Tivoli Common Reporting tool, you can use one of the following report authoringtools:v Query Studio: A web-based product that is used mostly for ad hoc reporting. Users can create simple

queries and reports, and apply basic formatting to the reports.v Report Studio: A web-based tool that is used by technical users and professional report writers for

creating advanced reports. Users can retrieve data from multiple databases and create sophisticatedreports that have multiple pages and multiple queries.

Reports for the monitoring agent

You can verify whether the reporting functionality is installed and configured correctly by running thesample report for the Microsoft BizTalk Server agent. The Microsoft BizTalk Server agent reportingpackage that you imported into Tivoli Common Reporting includes five reports. By using these reports,you can monitor the reporting activity and see what a typical Cognos report includes. These reports areavailable in the Common Reporting panel in Tivoli Common Reporting. The following tables describethese reports.

Table 5. BizTalk Server Services Availability report

Name BizTalk Server Services Availability report

Description The report displays a bar chart that shows the availability status of the services that are relatedto the BizTalk Server and the BizTalk host instances.

Purpose You can use this report to identify the status of the BizTalk Server services that are related tothe BizTalk Server and the BizTalk host instances.


Table 5. BizTalk Server Services Availability report (continued)

ParametersDate Range

Report PeriodSelect the report period from a predefined date range, such as Last Week,Current Month, Last 30 Days, and so on. Alternatively, you can enter a startdate, an end date, and the time for the reporting period.

Start DateSelect a start date from the calendar and the start time from the time widget.You must select both date and time.

End DateSelect an end date from the calendar and an end time from the time widget.You must select both date and time.

Summarization SelectionSummarization Type

Select the summarization types, such as Hourly, Daily, Weekly, Monthly,Quarterly, Yearly, or Default from the list. If you select the Default option, thesummarization type is computed based on the number of days for the daterange.

Shift PeriodIf the shift period is enabled, the hourly tables display the shift period as 1(off-peak hours) or 2 (peak hours), depending on the peak and off-peak hoursthat are configured in the data warehouse. In the daily tables, the value 1corresponds to peak hours, the value 2 corresponds to off-peak hours, and thevalue -1 corresponds to the summarized value for that day. If the shift periodis disabled, the default value is -1.

Vacation PeriodIf the vacation period is disabled, the default value is -1 (All Days). If thevacation period is enabled, you can enter the value 0 (Work Days) or 1(Vacation Days).

Display OptionsServer Name

Select the name of the server from the Server Name list.

Tables/ViewsUsed

KQB_AVAILABILITY_%V

Output The report displays a bar chart that displays the availability status (in percentage) of theservices that are related to the BizTalk Server and the BizTalk host instances for a period oftime. Use the following formula to calculate the percentage of the availability status of theBizTalk services:

Percentage of service availability = (COUNT_Service_ON_Samples ÷ Total samples per timeselected) × 100

The BizTalk services can be in one of the following states:

v UP

v DOWN

v UNKNOWN

Usage The BizTalk administrators can use this report to observe the status of the services that arerelated to the BizTalk Server and the BizTalk host instances.

Table 6. BizTalk Server Services Availability Heat Map report

Name BizTalk Server Services Availability Heat Map report


Table 6. BizTalk Server Services Availability Heat Map report (continued)

Description The report displays a heat map that shows the detailed availability status of the services thatare related to the BizTalk Server and the BizTalk host instances.

Purpose You can use this report to identify the status of the services that are related to the BizTalkServer and the BizTalk host instances.






Select the name of the server from the Server Name list.Service Name

Select the name of the BizTalk Server service.

Thresholds for Status IconsEnter the threshold values (Good, Fair, Warning, and Bad) that are represented by thestatus.

Tables/ViewsUsed

KQB_AVAILABILITY_%V

Output The report displays a heat map that shows the detailed availability status (in percentage) of theservices that are related to the BizTalk Server and the BizTalk host instances. The first columnin the heat map represents the dates during the selected time period and the other columnsrepresent the hours during the day starting with zero. The last column represents the averagevalue for that day.

Usage The BizTalk administrators can use this report to observe the detailed availability status of theservices that are related to the BizTalk Server and the BizTalk host instances.

Table 7. BizTalk Server Orchestration Details report

Name BizTalk Server Orchestration Details report

Description The report displays the number of orchestrations for the selected BizTalk Server. You can viewthe number of orchestrations that are created, completed, suspended, dehydrated, and so on.

Purpose You can use this report to view the details of all orchestrations that run on the selected BizTalkServer. You can also compare the total number of orchestrations created with the number oforchestrations completed, suspended, dehydrated, and so on.


Table 7. BizTalk Server Orchestration Details report (continued)











Tables/ViewsUsed

KQB_ORCHESTRATIONS_%V

Output The report displays a stacked bar chart that shows the overall orchestration activities. Thefollowing attributes represent the orchestrations activities:

v Name (Host Instance Name)

v Orchestrations Dehydrated

v Orchestrations Rehydrated

v Orchestrations Suspended

v Orchestrations Discarded

v Idle Orchestrations

Usage The BizTalk administrators can use this report to view the number of orchestrations that arecreated, completed, suspended, dehydrated, and so on.Restriction: This report does not provide details about different states of orchestration becauseof the limitation of the current BizTalk Server agent.

Table 8. BizTalk Server Messaging Latency Details report

Name BizTalk Server Messaging Latency Details report

Description The report displays the attributes that provide information about the messaging latency whileprocessing the documents using the BizTalk messaging engine.


Table 8. BizTalk Server Messaging Latency Details report (continued)

Purpose You can use this report to view the messaging latency details of the BizTalk Server.











Tables/ViewsUsed

KQB_MESSAGING_LATENCY_%V

Output The report displays a bar chart that shows the messaging latency of the selected BizTalk Server.The following attributes represent the messaging latency:

v Node (System Name)

v Name (Host Instance Name)

v Inbound Latency in MS

v Outbound Latency in MS

v Outbound Adapter Latency

v Request Response Latency in MS

Usage The BizTalk administrators can use this report to view the messaging latency details of theselected BizTalk Server.

Table 9. BizTalk Server Message Box Performance report

Name BizTalk Server Message Box Performance report

Description The report displays the number of messages that are received by the BizTalk Server messagebox.


Table 9. BizTalk Server Message Box Performance report (continued)

Purpose You can use this report to view the details of messages that are received by the adapters on theBizTalk Server from other applications.











Tables/ViewsUsed

KQB_MESSAGE_BOX_GENERAL_COUNTERS_%V

Output The report displays a bar chart that shows the tracking data size and spool size of the selectedBizTalk Server message box. The table below the chart displays the same information.

Usage The BizTalk administrator can use this report to view the details of the BizTalk Server messagebox cleanup activity.


Chapter 9. Troubleshooting

Problems can be related to IBM Tivoli Monitoring or the specific agent that you are using.

For general troubleshooting information, see the IBM Tivoli Monitoring Troubleshooting Guide. For otherproblem-solving options, see “Support information” on page 284.

You can resolve some problems by ensuring that your system matches the system requirements listed inthe Prerequisites topic for the agent in the ITCAM for Microsoft Applications Information Center(http://publib.boulder.ibm.com/infocenter/tivihelp/v24r1/topic/com.ibm.itcamms.doc_6.3/welcome_msapps63.html).

The following activities can help you find a solution to the problem you are having:v “Gathering product information for IBM Software Support”v “Using logging” on page 254v “Consulting the lists of identified problems and workarounds” on page 254

Gathering product information for IBM Software Support

Before contacting IBM Software Support about a problem you are experiencing with this product, gatherthe information shown in Table 10.

Table 10. Information to gather before contacting IBM Software Support

Information type Description

Log files Collect trace log files from failing systems. Most logs arelocated in a logs subdirectory on the host computer. See“Principal trace log files” on page 255 for lists of all tracelog files and their locations.

For general information about the IBM Tivoli Monitoringenvironment, see the Tivoli Enterprise Portal User's Guide.

Operating system Operating system version number and patch level

Messages Messages and other information displayed on the screen

Version numbers for IBM Tivoli Monitoring Version number of the following members of themonitoring environment:

v IBM Tivoli Monitoring. Also provide the patch level, ifavailable.

v IBM Tivoli Composite Application Manager forMicrosoft Applications: Microsoft BizTalk Server Agent

Screen captures Screen captures of incorrect output, if any

You can use the pdcollect tool to collect the most commonly used information from a system. This toolgathers log files, configuration information, version information, and other data. For more informationabout using this tool, see the "pdcollect tool" in the IBM Tivoli Monitoring Troubleshooting Guide.

For information about working with IBM Software Support, see IBM Support Portal Service Requests andPMRs (http://www.ibm.com/support/entry/portal/Open_service_request/Software/Software_support_(general)).



http://www.ibm.com/support/entry/portal/Open_service_request/Software/Software_support_(general)

http://www.ibm.com/support/entry/portal/Open_service_request/Software/Software_support_(general)

Using logging

Logging is the primary troubleshooting feature in the Microsoft BizTalk Server agent. Logging refers to thetext messages and trace data that is generated by the Microsoft BizTalk Server agent. Messages and tracedata are sent to a file.

Trace data captures transient information about the current operating environment when a component orapplication fails to operate as designed. IBM Software Support personnel use the captured traceinformation to determine the source of an error or unexpected condition. See “Trace logging” for moreinformation.

Consulting the lists of identified problems and workarounds

Known problems are organized into types such as those in the following list to make them easier tolocate:v Installation and configurationv General usage and operationv Display of monitoring datav Take Action commands

Information about symptoms and detailed workarounds for these types of problems is located in“Problems and workarounds” on page 264.

For general troubleshooting information, see the IBM Tivoli Monitoring Troubleshooting Guide.

Trace loggingTrace logs are used to capture information about the operating environment when component softwarefails to operate as designed.

The principal log type is the RAS (Reliability, Availability, and Serviceability) trace log. These logs are inthe English language only. The RAS trace log mechanism is available for all components of IBM TivoliMonitoring. Most logs are located in a logs subdirectory on the host computer. See the followinginformation to learn how to configure and use trace logging:v “Principal trace log files” on page 255v “Examples: Using trace logs” on page 257v “Setting RAS trace parameters by using the GUI” on page 258

Note: The documentation refers to the RAS facility in IBM Tivoli Monitoring as "RAS1."

IBM Software Support personnel use the information captured by trace logging to trace a problem to itssource or to determine why an error occurred. All components in the IBM Tivoli Monitoring environmenthave a default tracing level. The tracing level can be changed on a per-component level to adjust the typeof trace information collected, the degree of trace detail, the number of trace logs to be kept, and theamount of disk space used for tracing.

Overview of log file managementKnowing the naming conventions for log files helps you to find the files.

Agent log file naming conventions

Table 11 on page 255 provides the names, locations, and descriptions of IBM Tivoli Monitoring generalRAS1 log files. The log file names for the Microsoft BizTalk Server agent adhere to the following namingconvention:


Windows systemshostname_productcode_program_HEXtimestamp-nn.log

Where:

hostnameHost name of the computer where the monitoring component is running.

HEXtimestampHexadecimal time stamp representing the time at which the program started.

nn Rolling log suffix.

Principal trace log filesTrace log files are located on various systems.

Table 11 contains locations, file names, and descriptions of trace logs that can help determine the sourceof problems with agents.

Table 11. Trace log files for troubleshooting agents

System where log is located File name and path Description

On the Tivoli Enterprise MonitoringServer

v Windows: The file in theinstall_dir\InstallITM path

v UNIX: Thecandle_installation.log file inthe install_dir/logs path

v Linux: Thecandle_installation.log file inthe install_dir/logs path

Provides details about products thatare installed.Note: Trace logging is enabled bydefault. A configuration step is notrequired to enable this tracing.

On the computer that hosts theWarehouse Proxy agent

The configuration log file for theWarehouse Proxy agent is in thefollowing path depending on theoperating system that you are using:

v Windows:install_dir\InstallITM\Warehouse_Configuration.log

v UNIX:install_dir/logs/KHDCFG.log

file is in the following location onWindows systems:install_dir\InstallITM

Provides details about theconfiguration of data warehousingfor historical reporting.

Chapter 9. Troubleshooting 255

Table 11. Trace log files for troubleshooting agents (continued)


On the Tivoli Enterprise MonitoringServer

The name of the RAS log file is asfollows:

v Windows: install_dir\logs\hostname_ms_timestamp-nn.log

v UNIX: install_dir/logs/hostname_ms_timestamp-nn.log

v Linux: install_dir/logs/hostname_ms_timestamp-nn.log

Note: File names for RAS1 logsinclude a hexadecimal time stamp.

Also on UNIX systems, a log with adecimal time stamp is provided:hostname_productcode_timestamp.logand hostname_productcode_timestamp.pid nnnnn in theinstall_dir/logs path, where nnnnnis the process ID.

Traces activity on the monitoringserver.

On the Tivoli Enterprise Portal Server The name of the RAS log file is asfollows:

v Windows: install_dir\logs\hostname_cq_HEXtimestamp-nn.log

v UNIX: install_dir/logs/hostname_cq_HEXtimestamp-nn.log

v Linux: install_dir/logs/hostname_cq_HEXtimestamp-nn.log

Note: File names for RAS1 logsinclude a hexadecimal time stamp.

Also on UNIX systems, a log with adecimal time stamp is provided:hostname_productcode_timestamp.log and hostname_productcode_timestamp.pidnnnnn in theinstall_dir/logs path, where nnnnnis the process ID.

Traces activity on the portal server.

On the Tivoli Enterprise Portal Server The teps_odbc.log file is located inthe following path:

v Windows: install_dir\InstallITM

When you enable historical reporting,this log file traces the status of thewarehouse proxy agent.

On the computer that hosts themonitoring agent

The RAS1 log files are as follows:

v Windows: hostname _qb_kqbagent_HEXtimestamp-nn.log in theinstall_dir\tmaitm6\logsdirectory

On the Windows OS, the logs are inthe following directories:

v Windows32-bit agent:install_dir\tmaitm6\logs

v Windows 64-bit agent:install_dir\tmaitm6_x64\logs

Traces activity of the monitoringagent.


Table 11. Trace log files for troubleshooting agents (continued)


On the computer that hosts themonitoring agent

The agent operations log files are asfollows:

instance_hostnameQB.LG0 is thecurrent log created when the agentwas started.

instance_hostname_QB.LG1 is thebackup of the previous log.

On the Windows OS, the logs are inthe following directories:

v Windows32-bit agent:install_dir\tmaitm6\logs

v Windows 64-bit agent:install_dir\tmaitm6_x64\logs

Shows whether the agent couldconnect to the monitoring server.Shows which situations are startedand stopped, and shows other eventswhile the agent is running. A newversion of this file is generated everytime the agent is restarted.

IBM Tivoli Monitoring generates onebackup copy of the *.LG0 file withthe tag .LG1. View the .LG1 tag tolearn the following details regardingthe previous monitoring session:

v Status of connectivity with themonitoring server

v Situations that were running

v The success or failure status ofTake Action commands

Definitions of variables:

v timestamp is a time stamp with a format that includes year (y), month (m), day (d), hour (h), and minute (m), asfollows: yyyymmdd hhmm

v HEXtimestamp is a hexadecimal representation of the time at which the process was started.

v install_dir represents the directory path where you installed the IBM Tivoli Monitoring component. install_dir canrepresent a path on the computer that hosts the monitoring system, the monitoring agent, or the portal.

v instance_name refers to the name of the agent instance.

v hostname refers to the name of the computer on which the IBM Tivoli Monitoringcomponent runs.

v nn represents the circular sequence in which logs are rotated. this value includes a range from 1 - 5, by default.The first is always retained because it includes configuration parameters.

v productcode specifies the product code, for example, um for Universal Agent or nt for Windows systems.

For more information about the complete set of trace logs that are maintained on the monitoring server,see the IBM Tivoli Monitoring Installation and Setup Guide.

Examples: Using trace logsYou can open trace logs in a text editor to learn some basic facts about your IBM Tivoli Monitoringenvironment.

IBM Software Support applies specialized knowledge to analyze trace logs to determine the source ofproblems. The following examples are from the Tivoli Enterprise Monitoring Server log.

Example oneThis excerpt shows the typical log for a failed connection between a monitoring agent and amonitoring server with the host name server1a:(Thursday, August 11, 2005, 08:21:30-{94C}kdcl0cl.c,105,"KDCL0_ClientLookup") status=1c020006,"location server unavailable", ncs/KDC1_STC_SERVER_UNAVAILABLE(Thursday, August 11, 2005, 08:21:35-{94C}kraarreg.cpp,1157,"LookupProxy") Unable to connect tobroker at ip.pipe:: status=0, "success", ncs/KDC1_STC_OK(Thursday, August 11, 2005, 08:21:35-{94C}kraarreg.cpp,1402,"FindProxyUsingLocalLookup") Unableto find running CMS on CT_CMSLIST <IP.PIPE:#server1a>


Example twoThe following excerpts from the trace log for the monitoring server show the status of an agent,identified here as "Remote node." The name of the computer where the agent is running isSERVER5B:(42C039F9.0000-6A4:kpxreqhb.cpp,649,"HeartbeatInserter") Remote node SERVER5B:QB is ON-LINE.. . .(42C3079B.0000-6A4:kpxreqhb.cpp,644,"HeartbeatInserter") Remote node SERVER5B:QB is OFF-LINE.

See the following key points about the preceding excerpts:v The monitoring server appends the QB product code to the server name to form a unique

name (SERVER5B:QB ) for this instance of the IBM Tivoli Composite Application Manager forMicrosoft Applications: Microsoft BizTalk Server Agent. By using this unique name, you candistinguish multiple monitoring products that might be running on SERVER5B.

v The log shows when the agent started (ON-LINE) and later stopped (OFF-LINE) in theenvironment.

v For the sake of brevity, an ellipsis (...) represents the series of trace log entries that weregenerated while the agent was running.

v Between the ON-LINE and OFF-LINE log entries, the agent was communicating with themonitoring server.

v The ON-LINE and OFF-LINE log entries are always available in the trace log. All trace levelsthat are described in “Setting RAS trace parameters by using the GUI” provide these entries.

On Windows systems, you can use the following alternate method to view trace logs:1. In the Windows Start menu, click Program Files > IBM Tivoli Monitoring > Manage Tivoli

Enterprise Monitoring Services. The Manage Tivoli Enterprise Monitoring Services window isdisplayed.

2. Right-click a component and click Advanced > View Trace Log in the menu. For example, if youwant to view the trace log of the IBM Tivoli Composite Application Manager for MicrosoftApplications: Microsoft BizTalk Server Agent, right-click the name of that agent in the window. Youcan also use the viewer to access remote logs.

Note: The viewer converts time stamps in the logs to a format that is easier to read.

RAS trace parametersPinpoint a problem by setting detailed tracing of individual components of the monitoring agent andmodules

See “Overview of log file management” on page 254 to ensure that you understand log rolling and canreference the correct log files when you manage log file generation.

Setting RAS trace parameters by using the GUIOn Windows systems, you can use the graphical user interface to set trace options.

About this task

The IBM Tivoli Composite Application Manager for Microsoft Applications: Microsoft BizTalk ServerAgent uses RAS1 tracing and generates the logs described in Table 11 on page 255. The default RAS1trace level is ERROR.

Procedure1. Open the Manage Tivoli Enterprise Monitoring Services window.2. Select Advanced > Edit Trace Parms. The Tivoli Enterprise Monitoring Server Trace Parameters

window is displayed.


3. Select a new trace setting in the pull-down menu in the Enter RAS1 Filters field or type a validstring.v General error tracing. KBB_RAS1=ERRORv Intensive error tracing. KBB_RAS1=ERRORv Maximum error tracing. KBB_RAS1=ERROR

Note: As this example shows, you can set multiple RAS tracing options in a single statement.4. Modify the value for Maximum Log Size Per File (MB) to change the log file size (changes LIMIT

value).5. Modify the value for Maximum Number of Log Files Per Session to change the number of log files

per startup of a program (changes COUNT value).6. Modify the value for Maximum Number of Log Files Total to change the number of log files for all

startups of a program (changes MAXFILES value).7. Optional: Click Y (Yes) in the KDC_DEBUG Setting menu to log information that can help you

diagnose communications and connectivity problems between the monitoring agent and themonitoring server. The KDC_DEBUG setting and the Maximum error tracing setting can generate a largeamount of trace logging. Use these settings only temporarily, while you are troubleshooting problems.Otherwise, the logs can occupy excessive amounts of hard disk space.

8. Click OK. You see a message reporting a restart of the monitoring agent so that your changes takeeffect.

What to do next

Monitor the size of the logs directory. Default behavior can generate a total of 45 - 60 MB for each agentthat is running on a computer. See the "Procedure" section to learn how to adjust file size and numbers oflog files to prevent logging activity from occupying too much disk space.

Regularly prune log files other than the RAS1 log files in the logs directory. Unlike the RAS1 log filesthat are pruned automatically, other log types can grow indefinitely, for example, the logs in Table 11 onpage 255 that include a process ID number (PID).

Use collector trace logs as an additional source of troubleshooting information.

Note: The KDC_DEBUG setting and the Maximum error tracing setting can generate a large amount of tracelogging. Use these settings only temporarily while you are troubleshooting problems. Otherwise, the logscan occupy excessive amounts of hard disk space.

Manually setting RAS trace parametersYou can manually edit the RAS1 trace logging parameters.

About this task

The Microsoft BizTalk Server agent uses RAS1 tracing and generates the logs described in Table 11 onpage 255. The default RAS1 trace level is ERROR.

Procedure1. Open the trace options file:

v Windows32-bit agent:

install_dir\tmaitm6\KQBENV

v Windows64-bit agent:

install_dir\tmaitm6_x64\KQBENV


2. Edit the line that begins with KBB_RAS1= to set trace logging preferences. For example, if you wantdetailed trace logging, set the Maximum Tracing option: KBB_RAS1=ERROR (UNIT:kqb ALL) (UNIT:kraALL)

3. Edit the line that begins with KBB_RAS1_LOG= to manage the generation of log files:v MAXFILES: The total number of files that are to be kept for all startups of a specific program. When

this value is exceeded, the oldest log files are discarded. The default value is 9.v LIMIT: The maximum size, in megabytes (MB) of a RAS1 log file. The default value is 5.v IBM Software Support might guide you to modify the following parameters:

– COUNT: The number of log files to keep in the rolling cycle of one program startup. The default is3.

– PRESERVE: The number of files that are not to be reused in the rolling cycle of one programstartup. The default value is 1.

Note: The KBB_RAS1_LOG parameter also provides for the specification of the log file directory, logfile name, and the inventory control file directory and name. Do not modify these values or loginformation can be lost.

4. Restart the monitoring agent so that your changes take effect.

What to do next

Monitor the size of the logs directory. Default behavior can generate a total of 45 - 60 MB for each agentthat is running on a computer. For example, each database instance that you monitor can generate 45 - 60MB of log data. See the "Procedure" section to learn how to adjust file size and numbers of log files toprevent logging activity from occupying too much disk space.

Regularly prune log files other than the RAS1 log files in the logs directory. Unlike the RAS1 log filesthat are pruned automatically, other log types can grow indefinitely, for example, the logs in Table 11 onpage 255 that include a process ID (PID).

Use collector trace logs as an additional source of troubleshooting information.

Note: The KDC_DEBUG setting and the Maximum error tracing setting can generate a large amount of tracelogging. Use these settings only temporarily while you are troubleshooting problems. Otherwise, the logscan occupy excessive amounts of hard disk space.

Dynamic modification of trace settingsYou can dynamically modify the trace settings for an IBM Tivoli Monitoring component, such as, TivoliEnterprise Monitoring Server, Tivoli Enterprise Portal Server, most monitoring agents, and othercomponents. You can access these components, except for a few monitoring agents, from the tracingutility.

Dynamic modification of the trace settings is the most efficient method, because you can do it withoutrestarting the component. Settings take effect immediately. Modifications by this method are notpersistent.

Note: When the component is restarted, the trace settings are read again from the .env file. Dynamicallymodifying these settings does not change the settings in the .env files. To modify these trace settingspermanently, modify them in the .env files.

ras1

Run this command to modify the trace settings for a Tivoli Monitoring component.

The syntax is as follows:


ras1 set|list (UNIT|COMP: class_name ANY|ALL|Detail|ERROR|Flow|INPUT|Metrics|OUTPUT|STATE){(UNIT|COMP: class_name ANY|ALL|Detail|ERROR|Flow|INPUT|Metrics|OUTPUT|STATE)}

You can specify more than one component class to which to apply the trace settings.

Command options

setTurns on or off tracing depending upon the value of its parameters. If the parameter is ANY, it turns itoff. All other parameters turn on tracing based on the specified type or level.

listDisplays the default level and type of tracing that is set by default.

Parameters

The parameters that determine the component classes to which to apply the trace settings are as follows:

COMP: class_nameModifies the trace setting for the name of the component class, as specified by class_name , forexample, COMP:KDH. The output contains trace for the specified class.

UNIT: class_nameModifies the trace setting for any unit that starts with the specified class_name value, for example,UNIT: kra. The output contains trace for any unit that begins with the specified filter pattern.

The parameters that determine the trace level and type are as follows:

ALLDisplays all trace levels, including every trace point defined for the component. This setting mightresult in a large amount of trace, so specify other parameters to exclude unwanted trace. You mightrequire the ALL parameter to isolate a problem, which is the equivalent to setting "Error Detail FlowState Input Output Metrics".

ANYTurns off tracing.

DetailDisplays detailed information about each function.

When entered with the list option, the trace is tagged with Det.

ERRORLogs internal error conditions.

When entered with the list option, the trace is tagged with ER. The output can also be tagged withEVERYE+EVERYU+ER.

FlowDisplays control flow data for each function entry and exit.

When entered with the list option, the trace is tagged with Fl.

INPUTDisplays input data for each function.

When entered with the list option, the trace is tagged with IN.

MetricsDisplays metrics on each function.

When entered with the list option, the trace is tagged with ME.

OUTPUTDisplays output data for each function.


When entered with the list option, the trace is tagged with OUT.

StateDisplays the status for each function.

When entered with the list option, the trace is tagged with St.

Example

If you enter ras1 set (COMP:KDH ALL) (COMP:ACF1 ALL) (COMP:KDE ALL), the trace utility turns on alllevels of tracing for all the files and functions for which KDH, ACF1, and KDE are the classes.kbbcre1.c, 400, May 29 2007, 12:54:43, 1.1, *kbbcrn1.c, 400, May 29 2007, 12:54:42, 1.1, *kdhb1de.c, 400, May 29 2007, 12:59:34, 1.1, KDHkdh0med.c, 400, May 29 2007, 12:59:24, 1.1, KDHkdhsrej.c, 400, May 29 2007, 13:00:06, 1.5, KDHkdhb1fh.c, 400, May 29 2007, 12:59:33, 1.1, KDHkdhb1oe.c, 400, May 29 2007, 12:59:38, 1.2, KDHkdhs1ns.c, 400, May 29 2007, 13:00:08, 1.3, KDHkbbacdl.c, 400, May 29 2007, 12:54:27, 1.2, ACF1kbbaclc.c, 400, May 29 2007, 12:54:27, 1.4, ACF1kbbac1i.c, 400, May 29 2007, 12:54:28, 1.11, ACF1vkdhsfcn.c, 400, May 29 2007, 13:00:11, 1.1, KDHkdhserq.c, 400, May 29 2007, 12:59:53, 1.1, KDHkdhb1pr.c, 400, May 29 2007, 12:59:39, 1.1, KDHkdhsgnh.c, 400, May 29 2007, 12:59:49, 1.1, KDHkdh0uts.c, 400, May 29 2007, 12:59:23, 1.1, KDHkdhsrsp.c, 400, May 29 2007, 13:00:13, 1.2, KDHkdhs1rp.c, 400, May 29 2007, 13:00:12, 1.1, KDHkdhscsv.c, 400, May 29 2007, 12:59:58, 1.9, KDHkdebbac.c, 400, May 29 2007, 12:56:50, 1.10, KDE...

Turning on tracingTo use the tracing utility, you must use a local logon credential for the computer. This tracing methoduses the IBM Tivoli Monitoring Service Console. Access the Service Console by using a web browser.

About this task

When you start the Service Console, information is displayed about the components that are currentlyrunning on that computer. For example, these components are listed as follows:v Tivoli Enterprise Portal Server: cnpv Monitoring Agent for Windows OS: ntv Tivoli Enterprise Monitoring Server: ms

After you log on, you can type a question mark (?) to display a list of the supported commands. Use theras1 command to modify trace settings. If you type this command in the field provided in the ServiceConsole window and click Submit, the help for this command is displayed.

Procedure1. Open a web browser and enter the URL to access the Service Console.

http://hostname:1920

where hostname is the IP address or host name of the computer on which the IBM Tivoli Monitoringcomponent is running.

2. Click the hyperlink associated with the component for which you want to modify its trace settings.

Note: In the previous view, if you want to modify tracing for the Tivoli Enterprise Monitoring Server,select IBM Tivoli Monitoring Service Console under Service Point: system.your host name_ms.


3. Enter a user ID and password to access the system. This ID is any valid user that has access to thesystem.

4. Enter the command to turn on the required level of trace for the specified component classes or units.ras1 set (UNIT|COMP: class_name ALL|Flow|ERROR|Detail|INPUT|Metrics|OUTPUT|STATE){(UNIT|COMP: class_name ALL|Flow|ERROR|Detail|INPUT|Metrics|OUTPUT|STATE)}

For example, to turn on the control flow trace for the KDE, the command is:ras1 (COMP:KDE Flow)

Turning off tracingYou can use the IBM Tivoli Monitoring Service Console to run the ras1 command and dynamically turnoff tracing.

Procedure1. Open a web browser and enter the URL to access the Service Console.

http://hostname:1920

where hostname is the IP address or host name of the computer on which the IBM Tivoli Monitoringcomponent is running.

2. Click the hyperlink associated with the component for which you want to modify its trace settings.3. Enter a user ID and password to access the system. This ID is any valid user that has access to the

system.4. Enter the command to turn off the required level of trace for the specified component classes or units.

ras1 set (UNIT|COMP: class_name ANY){(UNIT|COMP: class_name ANY)}

For example, to turn off tracing for the kbbcrcd class of the Windows OS agent, the command is:ras1 set (UNIT:kbbcrcd ANY)

Setting trace parameters for the Tivoli Enterprise Console serverIn addition to the trace information captured by IBM Tivoli Monitoring, you can also collect additionaltrace information for the Tivoli Enterprise Console components that gather event server metrics.

About this task

To collect this information, modify the .tec_diag_config file on the Tivoli Enterprise Console eventserver. Use the steps in the following procedure to modify the event server trace parameters.

Procedure1. Open the $BINDIR/TME/TEC/.tec_diag_config file in an ASCII editor.2. Locate the entries that configure trace logging for the agent components on the event server. Two

entries are included, one for tec_reception and one for tec_rule:# to debug Agent Utilstec_reception Agent_Utils error /tmp/tec_receptionSP# to debug Agent Utilstec_rule Agent_Utils error /tmp/tec_rule

3. To gather additional trace information, modify these entries to specify a trace level of trace2:# to debug Agent Utilstec_reception Agent_Utils trace2 /tmp/tec_receptionSP# to debug Agent Utilstec_rule Agent_Utils trace2 /tmp/tec_rule

4. In addition, modify the Highest_level entries for tec_rule and tec_reception:


tec_reception Highest_level trace2SPtec_rule Highest_level trace2

Problems and workaroundsThe known problems and workarounds are organized into types of problems that might occur with theMicrosoft BizTalk Server agent, for example installation and configuration problems and workspaceproblems.

Note: You can resolve some problems by ensuring that your system matches the system requirementslisted in the Prerequisites topic for the agent in the IBM Tivoli Composite Application Manager forMicrosoft Applications Information Center.

Note: You can resolve some problems by ensuring that your system matches the system requirementslisted in Requirements and agent installation and configuration.

For general troubleshooting information, see the IBM Tivoli Monitoring Troubleshooting Guide.

Installation and configuration troubleshootingProblems can occur during installation, configuration, and uninstallation of the agent.

The problems and solutions in Table 12 can occur during installation, configuration, and uninstallation ofthe agent.

Table 12. Problems and solutions for installation and configuration

Problem Solution

Diagnosing problems with product browse settings(Windows systems only).

When you have problems with browse settings,complete the following steps:

1. Click Start > Programs > IBM Tivoli Monitoring >Manage Tivoli Enterprise Monitoring Services.The Manage Tivoli Enterprise Monitoring Serviceswindow is displayed.

2. Right-click the Windows agent and select BrowseSettings. A text window is displayed.

3. Click Save As and save the information in the textfile.

If requested, you can forward this file to IBM SoftwareSupport for analysis.

The system is experiencing high CPU usage. Agent process: View the memory usage of theKQBCMA process. If CPU usage seems to be excessive,restart the monitoring agent.

Network cards: The network card configurations candecrease the performance of a system. Each stream ofpackets that a network card receives (assuming that it isa broadcast or destined for theunder-performing system) must generate a CPUinterrupt and transfer the data through the I/O bus. Ifthe network card in question isa bus-mastering card, work can be offloaded and a datatransfer between memory and the network card cancontinue without using CPU processing power.Bus-mastering cards are 32-bit and are based on PCI orEISA bus architectures.


Table 12. Problems and solutions for installation and configuration (continued)

Problem Solution

You have a Microsoft BizTalk Server agent installed on a32-bit or a 64-bit operating system. When you configurethe agent, if you specify false in the Use WindowsAuthentication field on the Configuration for theApplication Status attribute group page, and you do nothave the required privileges for the BizTalkMgmtDbdatabase, no value is displayed for the Application Statusattribute group in the Tivoli Enterprise Portal.

You must either have server-wide privileges for the SQLServer or database-wide privileges for theBizTalkMgmtDb database. If you have server-wideprivileges, you must have rights to the Public andSysadmin server roles. If you have database-wideprivileges, you must have rights to the db_owner anddb_datareader database roles.

The user ID and password that you type to access theSQL server while configuring the Microsoft BizTalkServer agent is not retained on the Tivoli EnterprisePortal Configuration panel when you reconfigure theagent.

OR

The user ID and password that you type in the TivoliEnterprise Portal Configuration panel while configuringthe Microsoft BizTalk Server agent is not reflected on theManage Tivoli Enterprise Monitoring ServicesConfiguration panel.

You must add the BizTalk agent that is included in theITCAM for Microsoft Applications bundle to the depotwhere the Tivoli Enterprise Monitoring Server is located.

When you install an ITCAM for Microsoft Applications32-bit agent on a computer that has a preinstalled 64-bitversion of the same agent, the following situations occur:

Situation 1: The 32-bit agent is not installed. However,when you run the KinCinfo command, the 32-bit agent isdisplayed in the list of installed components.

Situation 2: The preinstalled 64-bit agent stops running.

Situation 1: No solution is available for this problem.

Situation 2: Restart the 64-bit agent.

If you have installed a 64-bit agent for ITCAM forMicrosoft Applications, information about the agentprocesses is not displayed in the Kinviewer window.

No solution is available for this problem at this time.

When you install a 32-bit agent for ITCAM for MicrosoftApplications, the following message is displayed underthe Install the following features list, :

Undefined GSK component:IBM GSKit Security Interface

Ignore this message and proceed with the installation.

You have preinstalled agents of earlier versions of IBMTivoli Monitoring for Microsoft Applications on yourcomputer. When you run the ITCAM for MicrosoftApplications installation wizard to upgrade the agent toV6.3, the Select Features window displays a list of all theagent features that you can install. The installed agentsare selected by default. If you do not want to upgradethe installed features, you cannot clear the defaultselection.

Run the setup.exe file of the Windows OS agent V6.2.2or later to install the Tivoli Enterprise Monitoring AgentFramework. Then, upgrade the preinstalled IBM TivoliMonitoring for Microsoft Applications agents.

While installing the ITCAM for Microsoft Applicationsagent, though the Tivoli Enterprise Monitoring AgentFramework is a mandatory feature, you can specify notto install the Tivoli Enterprise Monitoring AgentFramework. However, even if you specify not to installthe Tivoli Enterprise Monitoring Agent Framework, theTivoli Enterprise Monitoring Agent Framework isinstalled.



Table 12. Problems and solutions for installation and configuration (continued)

Problem Solution

After you upgrade ITCAM for Microsoft Applicationsfrom an earlier version to V6.3, the following entries arecreated in the Add or Remove Programs window:

v IBM Tivoli Monitoring for Microsoft Applications

v IBM Tivoli Monitoring

Ignore IBM Tivoli Monitoring for MicrosoftApplications in the Add or Remove Programs window.If you want to modify or remove the installed agents inIBM Tivoli Monitoring for Microsoft Applications, useIBM Tivoli Monitoring from the Add or RemovePrograms window.

When you use the Installation Launch Pad to install a32-bit agent on a 32-bit computer, the following messageis displayed:

The following components cannot beinstalled because the installation

action failed. IBM Tivoli CompositeApplication Manager for MicrosoftApplications V6.2.3 for Windows on 64-bit AMD

and Intel systems (x64)

No action is required. You can ignore this message andcontinue with the installation.

Table 13. General problems and solutions for uninstallation

Problem Solution

On Windows systems, uninstallation of IBM TivoliMonitoring fails to uninstall the entire environment.

Be sure that you follow the general uninstallationprocess described in the IBM Tivoli Monitoring Installationand Setup Guide:

1. Remove Tivoli Enterprise Monitoring ServerApplication support by completing the followingsteps:

a. Use Manage Tivoli Enterprise MonitoringServices.

b. Select Tivoli Enterprise Monitoring Server.

c. Right-click and select Advanced.

d. Select Remove TEMS application support.

e. Select the agent to remove its application support.

2. Uninstall the monitoring agents first, as in thefollowing examples:

v Uninstall a single monitoring agent for a specificdatabase.

-OR-

v Uninstall all instances of a monitoring product,such as IBM Tivoli Monitoring for Databases.

3. Uninstall IBM Tivoli Monitoring.

The way to remove inactive managed systems (systemswhose status is OFFLINE) from the Navigator tree in theportal is not obvious.

Use the following steps to remove, but not uninstall, anoffline managed system from the Navigator tree:

1. Click the Enterprise icon in the Navigator tree.

2. Right-click, and then click Workspace > ManagedSystem Status.

3. Right-click the offline managed system, and selectClear offline entry.

To uninstall the monitoring agent, use the proceduredescribed in the IBM Tivoli Monitoring Installation andSetup Guide.


Table 13. General problems and solutions for uninstallation (continued)

Problem Solution

An error message is displayed stating: The agent actionREMOVEINSTANCE failed with a return code of 3 forproduct QB.

Do not manually remove the Microsoft BizTalk Serveragent instance. Instead, uninstall the Microsoft BizTalkServer agent to remove the agent instance.

You have a 32-bit agent of ITCAM for MicrosoftApplications installed on your computer. If you uninstallthe 32-bit agent, two entries of IBM Tivoli Monitoring arecreated in the Add or Remove Programs window in thefollowing situations:

v With the 32-bit agent, you have Windows OS agentV6.2.2 or later installed on a managed system and youuninstall the 32-bit agent from the Tivoli EnterprisePortal or by using the command: tacmd removeSystem-t <agentCode> -n <node>

v With the 32-bit agent, you have 64-bit agent of ITCAMfor Microsoft Applications installed on a managedsystem and you uninstall the 32-bit agent using thesilent_agent.txt file.

In both the situations, when you uninstall the 32-bitagent, the preinstalled agent stops running.

Restart the preinstalled agent. Ignore the IBM TivoliMonitoring entry for V6.2.1 in the Add or RemovePrograms window. To modify or remove the installedagents, use the IBM Tivoli Monitoring entry for V6.2.2in the Add or Remove Programs window.

When the agent is installed using group deployment,deploygroup was run multiple times. The groupdeployment starts and completes successfully, but therewere multiple entries in the Deploy Status Summaryworkspace on the Tivoli Enterprise Portal. When thecommand tried to install multiple times, the additionalinstallations were queued and then were in failed statethough the agent was deployed successfully.Note:

v When the bundle group contains a single bundle andthe deployment group contains more than onemember (managed system of the same type as AIX orLinux), the deployment is successful on both systems.

v When the bundle group contains more than onebundle and the deploy group contains single ormultiple members, the deployment will be executedon each group member (managed system) dependingon the members present in the bundle group anddeploy group.

v The command creates a transaction for each XXbundle for each target system; the bundle matchingthe operating system for the deployment member isprocessed successfully; and remaining transactionswere in a queued or failed state.

There is no solution at this time.

Remote deployment troubleshootingProblems can occur with remote deployment and removal of agent software using the Agent RemoteDeploy process.

Table 14 on page 268 contains problems and solutions related to remote deployment.


Table 14. Remote deployment problems and solutions

Problem Solution

While you are using the remote deployment feature toinstall the IBM Tivoli Composite Application Managerfor Microsoft Applications: Microsoft BizTalk ServerAgent, an empty command window is displayed on thetarget computer. This problem occurs when the target ofremote deployment is a Windows computer. (For moreinformation about the remote deployment feature, seethe IBM Tivoli Monitoring Installation and Setup Guide.)

Do not close or modify this window. It is part of theinstallation process and is dismissed automatically.

The removal of a monitoring agent fails when you usethe remote removal process in the Tivoli EnterprisePortal desktop or browser.

This problem might occur when you attempt the remoteremoval process immediately after you restart the TivoliEnterprise Monitoring Server. You must allow time forthe monitoring agent to refresh its connection with theTivoli Enterprise Monitoring Server before you begin theremote removal process.

If you remotely deploy the BizTalk Server agent V6.3 andITCAM for Microsoft Applications on a computer, andlog in as a user that does not have administratorprivileges, the agent is not deployed. The following errormessage is displayed: The property_WIN32_STARTUP_.LocalSystem is invalid for version063000000 of the BizTalk agent.

You must have administrator privileges on the computerwhere you are deploying the agent.

Remote installation (CLI and GUI) of the MicrosoftBizTalk Server agent fails on IPv6 network. The agentgets installed on a computer but fails to configure andstart. The agent appears offline on the Tivoli EnterprisePortal.

You must reconfigure the Microsoft BizTalk Server agentto Tivoli Enterprise Monitoring Server.

To reconfigure the Microsoft BizTalk Server agent, usethe following steps:

1. Open the Manage Tivoli Enterprise MonitoringServices window.

2. Right-click Microsoft BizTalk Server agent that youwant to configure with the IPv6 network and then ,click Advanced.

3. Click Edit Variable. Following message appears: Theservice must be stopped before editingvariables. Do you want to stop the service now?

4. Click Yes. The Edit Variable window appears.

5. Click Add.

6. Enter the following details in the respective fields:

v Variable Name: CT_CMSLIST

v Variable Value: IP6.PIPE:ITM-IPV6;IP6.PIPE:<IPof the TEMS machine>. For example:IP6.PIPE:ITM-IPV6;IP6.PIPE:FE80::215:5DFF:FE44:4012

7. Click Ok.

8. Right-click Microsoft BizTalk Server agent and thenclick Start.

Agent troubleshootingA problem can occur with the agent after it has been installed.

Table 15 on page 269 contains problems and solutions that can occur with the agent after it is installed.


Table 15. Agent problems and solutions

Problem Solution

Log data accumulates too rapidly. Check the RAS trace option settings, which are describedin “Setting RAS trace parameters by using the GUI” onpage 258. The trace option settings that you can set onthe KBB_RAS1= and KDC_DEBUG= lines potentially generatelarge amounts of data.

The following attribute groups and situations based onthese attribute groups are not supported on the BizTalkServer 2006:

v BizTalk .NET Adapter for SAP

v BizTalk .NET Adapter for Oracle DB

v BizTalk .NET Adapter for Siebel

v BizTalk .NET Adapter for Oracle E-Business Suite

v BizTalk .NET Adapter for SQL


The attribute groups that belong to the Human WorkflowServices Navigator item and situations based on theseattribute groups are not supported on the BizTalk Server2009 or later. The BizTalk agent provides cross-link fromthe Human Workflow Services Navigator item to theWorkflow Foundation workspace of the .NET Frameworkagent. The BizTalk Server 2009 uses Windows WorkflowFoundation instead of using Human Workflow Services.


After restarting your computer containing the BizTalkServer and Microsoft BizTalk Server agent, the agentstarts without loading certain Performance Counters.The following attribute groups might not show data:

v All Adapters

v Host Throttling

v Messaging

v Orchestrations

1. After the computer restarts, recycle the MicrosoftBizTalk Server agent from the Manage TivoliEnterprise Services window. It captures each counterand display data for each attribute group in theTivoli Enterprise Portal Client.

2. Mark the Microsoft BizTalk Server agent, denoted asKQBCMA, as a dependent service for the BizTalkhost instance service "BTSSvc $host_instance_name".The Microsoft BizTalk Server agent and BizTalkServer start successfully and show the necessary datafor the attribute groups.Note: Using this solution has the followingdisadvantages:

v For each host instance created, you must modifythe monitoring agent service dependency eachtime.

v If one of the BizTalk Host instance stops, theMicrosoft BizTalk Server agent also stops.

v If the Microsoft BizTalk Server agent containsmultiple Host Instances and one of Host Instanceservices goes down, the Microsoft BizTalk Serveragent service goes into a stopped state.

3. Define custom situations for the above attributegroups. After a situation is triggered, restart theBizTalk agent to capture all performance objects.

The Performance Object Status query has an incompletedescription.

The query and Situation Editor windows can onlydisplay a maximum of 210 characters for the description.No solution is available for this problem at this time.


Table 15. Agent problems and solutions (continued)

Problem Solution

Some of the performance counters are unavailable forBizTalk 2004. The following performance counters do notreturn any data:

v MessageBox

v File Adapter

v FTP Adapter

v SMTP Adapter

v HTTP Adapter

v SOAP Adapter

v MSMQ Adapter

v SQL Adapter


After creating subsequent, non-default Host Instances inthe Microsoft BizTalk Server agent, you might not beable to see data rows for the newly created HostInstances. These Host Instances might not be seen in thefollowing views:

v Adapters

v Host Throttling

v Messaging

v Orchestrations

After creating subsequent Host Instances for theMicrosoft BizTalk Server agent, restart the MicrosoftBizTalk Server agent service to view data for newlycreated Host Instances in the Tivoli Enterprise Portal.

The Tivoli Enterprise Portal unexpectedly displaysnegative values for the following attributes:

v Batches being processed (TDDS attribute group)

v Records being processed (TDDS attribute group)

v Events being processed (TDDS attribute group)

v Active Receive Locations (Messaging attribute group)

v Active Send Messages (Messaging attribute group)

No solution is available for this problem at this time.Note: Other attributes can also display negative valuesunexpectedly.



Problem Solution

A configured and running instance of the monitoringagent is not displayed in the Tivoli Enterprise Portal,but other instances of the monitoring agent on the samesystem are displayed in the portal.

IBM Tivoli Monitoring products use Remote ProcedureCall (RPC) to define and control product behavior. RPCis the mechanism that a client process uses to make asubroutine call (such as GetTimeOfDay orShutdownServer) to a server process somewhere in thenetwork. Tivoli processes can be configured to useTCP/UDP, TCP/IP, SNA, and SSL as the protocol (ordelivery mechanism) for RPCs that you want.

IP.PIPE is the name given to Tivoli TCP/IP protocol forRPCs. The RPCs are socket-based operations that useTCP/IP ports to form socket addresses. IP.PIPEimplements virtual sockets and multiplexes all virtualsocket traffic across a single physical TCP/IP port(visible from the netstat command).

A Tivoli process derives the physical port for IP.PIPEcommunications based on the configured, well-knownport for the hub Tivoli Enterprise Monitoring Server.(This well-known port or BASE_PORT is configured byusing the 'PORT:' keyword on the KDC_FAMILIES /KDE_TRANSPORT environment variable and defaults to'1918'.)

The physical port allocation method is defined as(BASE_PORT + 4096*N), where N=0 for a TivoliEnterprise Monitoring Server process andN={1, 2, ..., 15} for another type of monitoring serverprocess. Two architectural limits result as a consequenceof the physical port allocation method:

v No more than one Tivoli Enterprise Monitoring Serverreporting to a specific Tivoli Enterprise MonitoringServer hub can be active on a system image.

v No more than 15 IP.PIPE processes can be active on asingle system image.

A single system image can support any number of TivoliEnterprise Monitoring Server processes (address spaces)if each Tivoli Enterprise Monitoring Server on thatimage reports to a different hub. By definition, one TivoliEnterprise Monitoring Server hub is available permonitoring enterprise, so this architecture limit has beenreduced to one Tivoli Enterprise Monitoring Server persystem image.

No more than 15 IP.PIPE processes or address spaces canbe active on a single system image. With the first limitexpressed earlier, this second limitation refers specificallyto Tivoli Enterprise Monitoring Agent processes:no more than 15 agents per system image.

Continued on next row.



Problem Solution

Continued from previous row. This limitation can be circumvented (at currentmaintenance levels, IBM Tivoli Monitoring V6.1,Fix Pack 4 and later) if the Tivoli Enterprise MonitoringAgent process is configured to use the EPHEMERALIP.PIPE process. (This process is IP.PIPE configured withthe 'EPHEMERAL:Y' keyword in the KDC_FAMILIES /KDE_TRANSPORT environment variable). The number ofephemeral IP.PIPE connections per system image has nolimitation. If ephemeral endpoints are used, theWarehouse Proxy agent is accessible from the TivoliEnterprise Monitoring Server associated with the agentsusing ephemeral connections either by running theWarehouse Proxy agent on the same computer or byusing the Firewall Gateway feature. (The FirewallGateway feature relays the Warehouse Proxy agentconnection from the Tivoli Enterprise Monitoring Servercomputer to the Warehouse Proxy agent computer ifthe Warehouse Proxy agent cannot coexist on the samecomputer.)

You have installed a 32-bit Windows OS agent and a64-bit agent of ITCAM for Microsoft Applications on a64-bit managed system. If the 64-bit agent abruptly stopsrunning, the Agent Management Service (AMS) fails torestart the agent. The status of the agent in the Agents'Management Status view changes to Unmanaged.

There are two possible solutions to this problem:

Solution 1: Restart the 64-bit agent and then use thefollowing steps to restart the AMS:

1. Right-click the agent, which is in the unmanagedstate, and click Take Action > Select.

2. From the Name list in the Action panel, select AMSStart Management.

3. In the Destination Systems panel, select the managedsystem node for the agent management that youwant to start.

4. Click OK.

Solution 2: Install the Windows OS agent V6.2.2, FixPack 2.



Problem Solution

No events are visible in the Tivoli Enterprise Portal eventhough the agent is started.

This problem can be caused be one of these issues:

v The agent is not configured to send events to IBMTivoli Monitoring

Ensure that the Send ITM Events configuration value isset to "yes" in the command or checked in the GUI.

v The configuration file cannot be found. Theperformance object status attribute group reports"CONF FILE DOES NOT EXIST".

Ensure the value for the configuration fileconfiguration setting is correct. It must be a fullyqualified path to the configuration file and the agentmust have sufficient access rights to read the file.

v The format file cannot be found. The performanceobject status attribute group reports "CANNOTOPEN FORMAT FILE".

Ensure the value for the format file configurationsetting is correct. It must be a fully qualified path tothe format file and the agent must have sufficientaccess rights to read the file.

v There is a parsing error in the format file. Theperformance object status attribute group reports"FORMAT FILE SYNTAX ERROR". The agent's errorlog identifies the line of the format file where theparsing error occurred.

Correct the syntax error in the format file.

v No patterns in the format file match records readfrom the log source.

Configure the agent instance to use an unmatch fileand examine the contents of the unmatch log. Use aregular expression test tool to help write expressionsthat match the records written to the unmatch log.Update the format file.

Some events are initially visible in the Tivoli EnterprisePortal, but no new events are generated even though thelog sources contain records that match expressions in theformat file.

If the agent is configured to send EIF events, but no EIFreceiver is configured or running (such as an OMNIbusprobe) to receive the events, the agent's EIF reception logfills and no events can be processed.

If you do not want EIF events sent, complete thefollowing steps:

1. Stop the agent.

2. Reconfigure the agent and set the Send EIF Events toOMNIbus configuration value to "No".

3. Start the agent.

If you want EIF events sent, complete the followingsteps:

1. Ensure that the EIF receiver is running.

2. Verify the EIF settings in the agent's configurationfile.

3. If too many events are sent, the EIF event cache maynot be large enough to handle the event storm.Increase the value of the BufEvtMaxSize configurationvalue in the agent's configuration file.



Problem Solution

While configuring the Application Status attributegroup, if you type true to select the WindowsAuthentication mode to access the BizTalk Managementdatabase, and you also specify the database user ID andthe database password, the BizTalk agent will ignore thedatabase user ID and the database password, but it willuse the Windows Authentication mode to access thedatabase.

No solution exists for this problem.

No data is displayed in the Service Name attribute ofthe Service Instance Status and Class attribute group.

No solution exists for this problem.

You have configured the monitoring agent version 6.3on the Tivoli Enterprise Monitoring Server by using theself-describing agent feature. You are using IBM TivoliMonitoring version 6.2.3 or version 6.2.3 Fix Pack 1. Onthe Tivoli Enterprise Portal, if you open a situation byusing the Situation Editor and view the advance optionsfor the situation, you can see <none selected> in theDisplay Item window.

Recycle the Tivoli Enterprise Portal Server.

Complete the following steps to recycle the TivoliEnterprise Portal Server on Windows systems:

1. On the computer where the Tivoli Enterprise PortalServer is installed, click Start > Programs > ManageTivoli Enterprise Monitoring Services.

2. Right-click the Tivoli Enterprise Portal Server serviceand click Recycle.

To recycle the Tivoli Enterprise Portal Server on UNIXsystems, use the following commands from the bindirectory of /opt/IBM/ITM (or where you have installedIBM Tivoli Monitoring) in the order shown below:

v ./itmcmd agent stop cq

v ./itmcmd agent start cq

Workspace troubleshootingProblems can occur with general workspaces and agent-specific workspaces.

Table 16 on page 275 contains problems and solutions related to workspaces.


Table 16. Workspace problems and solutions

Problem Solution

The process application components are available, butthe Availability status shows PROCESS_DATA_NOT_AVAILABLE.

This problem occurs because the PerfProc performanceobject is disabled. When this condition exists, IBM TivoliMonitoring cannot collect performance data for thisprocess. Use the following steps to confirm that thisproblem exists and to resolve it:

1. In the Windows Start menu, click Run.

2. Type perfmon.exe in the Open field of the Runwindow. The Performance window is displayed.

3. Click the plus sign (+) in the toolbar. The AddCounters window is displayed.

4. Look for Process in the Performance object menu.

5. Complete one of the following actions:

v If you see Process in the menu, the PerfProcperformance object is enabled and the problem iscoming from a different source. You might need tocontact IBM Software Support.

v If you do not see Process in the menu, use theMicrosoft utility from the Microsoft.comOperations website to enable the PerfProcperformance object.

The Process performance object becomes visible inthe Performance object menu of the Add Counterswindows, and IBM Tivoli Monitoring is able todetect Availability data.

6. Restart the monitoring agent.


http://blogs.technet.com/b/mscom/archive/2008/12/18/the-mystery-of-the-missing-process-performance-counter-in-perfmon.aspx

http://blogs.technet.com/b/mscom/archive/2008/12/18/the-mystery-of-the-missing-process-performance-counter-in-perfmon.aspx

Table 16. Workspace problems and solutions (continued)

Problem Solution

Event Log workspace events are unfiltered, are notcollected more than every 60 seconds, and are removedfrom the Event Log Views after 1 hour of being received.

All events currently in the Application Event Log aresent to the Tivoli Enterprise Monitoring Server when theagent starts. Environment variables that control thebehavior of the Event Log Workspace are stored in theagent ENV file on the Tivoli Enterprise Monitoring Agentwhere the agent is running. These variables are stored:

CDP_DP_CACHE_TTLThis value is the minimum number of secondsbefore data (for a particular table) is collectedagain. By default this variable is present in theENV file and the value is set to 60.

CDP_NT_EVENT_LOG_GET_ALL_ENTRIES_FIRST_TIMEThis variable determines whether the agentsends all events currently in the ApplicationEvent Log to the Tivoli Enterprise MonitoringServer when the agent starts. Legal values areYES and NO. By default this variable is presentin the ENV file and the value is set to NO.

CDP_NT_EVENT_LOG_CACHE_TIMEOUTThis variable determines how long in secondsthat events are displayed in the Tivoli EnterpriseMonitoring Server Event Log Views. By default,this variable is not present in the ENV file. Adefault value of 3600 (1 Hour) is used unlessoverridden by the presence of this variable inthe agent ENV file. The minimum legal value is300.

To view or edit the agent ENV file on the Tivoli EnterpriseMonitoring agent where the agent is installed, useManage Tivoli EnterpriseMonitoring Services to select the agent. Right-click andselect Advanced - Edit ENV File. The agent must berestarted to implement changes.

The name of the attribute does not display in a bar chartor graph view.

When a chart or graph view that includes the attribute isscaled to a small size, a blank space is displayed insteadof a truncated name. To see the name of the attribute,expand the view of the chart until sufficient space isavailable to display all characters of the attribute name.



Problem Solution

You start collection of historical data but the data cannotbe seen.

Use the following managing options for historical datacollection:

v Basic historical data collection populates theWarehouse with raw data. This type of data collectionis turned off by default. For information aboutmanaging this feature including how to set the intervalat which data is collected, see Managing historical datain the IBM Tivoli Monitoring Administrator's Guide. Bysetting a more frequent interval for data collection,you reduce the load on the system incurred every timedata is uploaded.

v Use the Summarization and Pruning agent to collectspecific amounts and types of historical data.Historical data is not displayed until theSummarization and Pruning monitoring agent beginscollecting the data. By default, this agent beginscollection at 2 a.m. daily. At that point, data is visiblein the workspace view. For information about how tomodify the default collection settings, see Managinghistorical data in the IBM Tivoli MonitoringAdministrator's Guide.

Historical data collection is unavailable because ofincorrect queries in the Tivoli Enterprise Portal.

The Sort By, Group By, and First/Last functions columnare not compatible with the historical data collectionfeature. Use of these advanced functions makes a queryineligible for historical data collection.

Even if data collection has started, you cannot use thetime span feature if the query for the chart or tableincludes column functions or advanced query options(Sort By, Group By, First / Last).

To ensure support of historical data collection, do not usethe Sort By, Group By, or First/Last functions in yourqueries.

For information about the historical data collectionfunction, See Managing historical datain the IBM TivoliMonitoring Administrator's Guide or the Tivoli EnterprisePortal online help .

When you use a long process name in the situation, theprocess name is truncated.

Truncation of process or service names for situations inthe Availability table in the portal display is the expectedbehavior. The maximum name length is 100 bytes.

Regular (non-historical) monitoring data fails to bedisplayed.

Check the formation of the queries you use to gatherdata. For example, look for invalid SQL statements.

Navigator items and workspace titles are labeled withinternal names such as Kxx:KXX0000 instead of the correctnames (such as Disk), where XX and xx represent thetwo-character agent code.

Ensure that application support has been added on themonitoring server, portal server, and portal client.

For more information about installing applicationsupport, see Installing and enabling application support inthe IBM Tivoli Monitoring Installation and Setup Guide.

After restarting a system with the BizTalk Server and theMicrosoft BizTalk Server agent both configured toautostart, the Microsoft BizTalk Server agent workspacesdo not contain data.

Restart the Microsoft BizTalk Server agent manually.



Problem Solution

If you install an earlier version of the .Microsoft NetFramework agent (V6.2.0 or earlier) on a workstationand select a cross-linked workspace related to theMicrosoft .Net Framework agent, the following errormessage is displayed on the portal:

KFWITM081E: The link target cannot be found. Thelink definition might be incorrect or the target isunavailable.

Install the latest version of the Microsoft .Net Frameworkagent that is available in the installation package.

The workspaces that are cross-linked with the Microsoft.NET Framework agent do not show a filtered view forthe BizTalk-related instances.

Filter the BizTalk Server instances manually.

No predefined workspaces are available for attributes inthe following attribute groups:

v BizTalk .NET Adapter for SAP

v BizTalk .NET Adapter for Oracle DB

v BizTalk .NET Adapter for Siebel

v BizTalk .NET Adapter for Oracle E-Business Suite

v BizTalk .NET Adapter for SQL

You can create workspaces for attributes in theseattribute groups.

You have installed a 32-bit agent for ITCAM forMicrosoft Applications on a computer where a 64-bitWindows OS agent V6.2.2, Fix Pack 1 is installed. On theTivoli Enterprise Portal, when you expand the WindowsOS node, and select the Agent Management Servicesnavigator item, the installation path of the agent is notcorrectly displayed in the Agents' ManagementDefinitions view. Also, no data is displayed for the agentversion and the build number in the Agents'Management Status view.

Upgrade the Windows OS agent from V6.2.2, Fix Pack 1to V6.2.2, Fix Pack 2.

If the 32-bit OS agent and a 64-bit Microsoft Applicationagent are installed on the same managed system, AgentManagement Services data is not displayed in theAgent's Runtime Status view of the agent. The Agent'sRuntime Status view is available in the AgentManagement Services workspace.


You have installed the ITCAM for Microsoft Applicationsagent and the Windows OS agent in the IPV6environment. In the Agent Management Servicesnavigator, the IP address in the Agents' Runtime Statusview is displayed in the IPV4 format instead of the IPV6format.


You have installed the Tivoli Enterprise MonitoringServer on z/OS®. In the Configuration panel of theHistory Collection Configuration window, if you haveselected TEMS from the Collection Location list, theTivoli Enterprise Portal does not display historical datafor the following attribute groups:

v ASP NET Applications

v Availability

v Event Log

v Performance Object Status

v Search

Reconfigure the history collection, and set the collectionlocation as TEMA for these attribute groups.



Problem Solution

When viewing workspaces that contain many labels,some of the text in the labels is difficult to read.

Use your mouse to hover over the labels to display atooltip that provides the text in the labels.

Situation troubleshootingProblems can occur with situations and situation configuration.

Table 17 contains problems and solutions for situations.

Table 17. Situation problems and solutions

Problem Solution

Monitoring activity requires too much disk space. Check the RAS trace logging settings that are describedin “Setting RAS trace parameters by using the GUI” onpage 258. For example, trace logs grow rapidly whenyou apply the ALL logging option.

Monitoring activity requires too many system resources. “Disk capacity planning for historical data” on page 189describes the performance impact of specific attributegroups. If possible, decrease your use of the attributegroups that require greater system resources.

A formula that uses mathematical operators appears tobe incorrect. For example, if you were monitoring aLinux system, the formula that calculates when FreeMemory falls under 10 percent of Total Memory doesnot work: LT #’Linux_VM_Stats.Total_Memory’ / 10

This formula is incorrect because situation predicatessupport only logical operators. Your formulas cannothave mathematical operators.Note: The Situation Editor provides alternatives to mathoperators. In the example, you can select the % MemoryFree attribute and avoid the need for math operators.

You want to change the appearance of situations whenthey are displayed in the navigation tree.

1. Right-click an item in the navigation tree.

2. Click Situations in the menu. The Situation Editorwindow is displayed.

3. Select the situation that you want to modify.

4. Use the State menu to set the status and appearanceof the Situation when it triggers.Note: The State setting is not related to severitysettings in the Tivoli Enterprise Console.

When a situation is triggered in the Event Log attributegroup, it remains in the Situation Event Console as longas the event ID entry is present in the Event Logworkspace. When this event ID entry is removed fromthe Event Log workspace on the Tivoli Enterprise Portal,the situation is also cleared even if the actual problemthat caused the event is not resolved, and the event IDentry is also present in the Windows Event Viewer.

A timeout occurs on the cache of events for the NT EventLog group. Increase the cache time of Event Logcollection to meet your requirements by adding thefollowing variable and timeout value to the KpcENV filefor the agent (where pc is the two-letter product code):CDP_NT_EVENT_LOG_CACHE_TIMEOUT=3600

This variable determines how long events from the NTEvent Log are kept.

If the Expert Advice for a situation contains a hyperlinkto an external website (for example, a Microsoft TechNetwebsite) and you click the hyperlink, the website opensin an external window. However, the external windowstops responding.

The external window responds after you close thePreview window and Situation Editor window.

The situation for a specific agent is not visible in theTivoli Enterprise Portal.

Open the Situation Editor. Access the All managedservers view. If the situation is not displayed, confirmthat the monitoring server has been seeded for the agent.If not, seed the server, as described in the IBM TivoliMonitoring Installation and Setup Guide.


Table 17. Situation problems and solutions (continued)

Problem Solution

The monitoring interval is too long. Access the Situation Editor view for the situation thatyou want to modify. Check the Sampling interval area inthe Formula tab. Adjust the time interval as required.

The situation did not activate at startup. Manually recycle the situation as follows:

1. Right-click the situation and select Stop Situation.

2. Right-click the situation and select Start Situation.

Note: You can permanently avoid this problem byselecting the Run at Startup check box of the SituationEditor view for a specific situation.

The situation is not displayed. Click the Action tab and check whether the situation hasan automated corrective action. This action can occurdirectly or through a policy. The situation might beresolving so quickly that you do not see the event or theupdate in the graphical user interface.

An Alert event did not occur even though the predicatewas correctly specified.

Check the logs, reports, and workspaces.

A situation fires on an unexpected managed object. Confirm that you distributed and started the situation onthe correct managed system.

The product did not distribute the situation to amanaged system.

Click the Distribution tab and check the distributionsettings for the situation.



Problem Solution

The situation does not fire. This problem can be caused when incorrect predicatesare present in the formula that defines the situation. Forexample, the managed object shows a state that normallytriggers a monitoring event, but the situation is not truebecause the wrong attribute is specified in the formula.

In the Formula tab, analyze predicates as follows:

1. Click the fx icon in the Formula area. The Showformula window is displayed.

a. Confirm the following details in the Formula areaof the window:

v The attributes that you intend to monitor arespecified in the formula.

v The situations that you intend to monitor arespecified in the formula.

v The logical operators in the formula match yourmonitoring goal.

v The numeric values in the formula match yourmonitoring goal.

b. (Optional) Select the Show detailed formulacheck box to see the original names of attributesin the application or operating system that youare monitoring.

c. Click OK to dismiss the Show formula window.

2. (Optional) In the Formula area of the Formula tab,temporarily assign numeric values that immediatelytrigger a monitoring event. The triggering of theevent confirms that other predicates in the formulaare valid.Note: After you complete this test, you must restorethe numeric values to valid levels so that you do notgenerate excessive monitoring data based on yourtemporary settings.

For additional information about situations that do notfire, see Situations are not firing in the IBM TivoliMonitoring Troubleshooting Guide.

Situation events are not displayed in the Events Consoleview of the workspace.

Associate the situation with a Navigator item.Note: The situation does not need to be displayed in theworkspace. It is sufficient that the situation is associatedwith any Navigator item.

You do not have access to a situation. Note: You must have administrator privileges tocomplete these steps.

1. Click Edit > Administer Users to access theAdminister Users window.

2. In the Users area, select the user whose privilegesyou want to modify.

3. In the Permissions tab, Applications tab, andNavigator Views tab, select the permissions orprivileges that correspond to the user role.

4. Click OK.



Problem Solution

A managed system seems to be offline. 1. Select Physical View and click the Enterprise Level ofthe navigator tree.

2. Click View > Workspace > Managed System Statusto see a list of managed systems and their status.

3. If a system is offline, check network connectivity andthe status of the specific system or application.

Associations of custom situations with navigator itemsbreak after upgrading the agent support.

Create the associations again by completing thefollowing steps:

1. Right-click the navigator item, and then clickSituations. A list of situations that are associated withthe navigator item is displayed.Note: If the custom situation that you want toassociate is available in the list, ignore remainingsteps.

2. Click the Set Situation filter criteria icon.

3. Select the Eligible for Association check box, andthen click OK. A list of situations is displayed.

4. Right-click the situation that you want to associatewith the navigator item, and then click Associate.

The situation is associated with the navigator item.

Take Action commands troubleshootingProblems can occur with Take Action commands.

Table 18 contains problems and solutions that can occur with Take Action commands.

When each Take Action command runs, it generates a log file listed in Table 11 on page 255.

Table 18. Take Action commands problems and solutions

Problem Solution

Take Action commands often require several minutes tocomplete.

Allow several minutes. If you do not see a messageadvising you of completion, try to run the commandmanually.

Situations fail to trigger Take Action commands. Attempt to manually run the Take Action command inthe Tivoli Enterprise Portal. If the Take Action commandworks, look for configuration problems in the situation.See “Situation troubleshooting” on page 279. If the TakeAction command fails, for general information abouttroubleshooting Take Action commands, see the IBMTivoli Monitoring Troubleshooting Guide.

Tivoli Common Reporting troubleshootingProblems can occur with the Tivoli Common Reporting predefined reports for the Microsoft BizTalkServer agent.

Table 19 on page 283 contains problems and solutions that can occur with the Tivoli Common Reportingpredefined reports for IBM Tivoli Composite Application Manager for Microsoft Applications: MicrosoftBizTalk Server Agent. See the Tivoli Common Reporting Information Center for more information abouttroubleshooting for the Tivoli Common Reporting tool.


http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.tivoli.tcr.doc/tcr_welcome.html

Table 19. Tivoli Common Reporting for Microsoft BizTalk Server agent problems and solutions

Problem Solution

When you simultaneously query two tables in the QueryStudio interface, no data is displayed. However, whenyou query the two tables separately, data is displayed.

This problem occurs when a relationship between thetables is not defined. To resolve this problem, ensure thatall the ad hoc queries have at least one identifier.

When you create an ad hoc query by dragging somecolumns in the Query Studio interface, the followingerror message is displayed:

RQP-DEF-0177 An error occurred while performingoperation ’sqlPrepareWithOptions’status=’-232’.

This is an SQL error related to arithmetic flow. This erroris generated because the average or the sum for certaincolumns is more than the threshold size that is definedin the database. To resolve this error, use the limitedcolumns and add a standard timestamp while creatingan ad hoc query.

If a view or a table for the selected summarization typedoes not exist in the database for a report, the reportdoes not open and the following error message isdisplayed:


To resolve this problem, complete the following tasks:

v Verify that the summarization and pruning agent isworking correctly.

v Generate data for all the summarization types.

v Verify that the warehouse is collecting historical data.

When you run a report, the report is not displayed in thecorrect format and the following error message isdisplayed:


This problem occurs due to incorrect data source. Toresolve this problem, complete the following tasks:

v Verify that the datasource configuration parameters areconfigured correctly.

v Verify that the specified values for the parameters ofthe summarization and pruning agent such asdatabase URL, driver user, and password match withthe values of these parameters on the database.

If data is not available in the database for the selectedparameters, the following error message is displayedafter querying these parameters:

Empty data set No data returned by query.Try another set of parameters.

To resolve this error, complete the following tasks:

v Configure the summarization and pruning agent andverify that it is working correctly.

v Generate data for all the summarization types in thedatabase.

Reports are not generated correctly in the Microsoft Excelformat.

There are some limitations to generate reports in theMicrosoft Excel format. To view these limitations, see theIBM Cognos Business Intelligence Information Center(http://publib.boulder.ibm.com/infocenter/cbi/v10r1m0/index.jsp?topic=%2Fcom.ibm.swg.im.cognos.ug_cr_rptstd.10.1.0.doc%2Fug_cr_rptstd_id32474excel_limitations.html).

When you view a report spanning multiple pages in thePDF format, the report parameters section is displayed atthe top of each page.


Charts are not displayed correctly in Microsoft Excel2007.



http://publib.boulder.ibm.com/infocenter/cbi/v10r1m0/index.jsp?topic=%2Fcom.ibm.swg.im.cognos.ug_cr_rptstd.10.1.0.doc%2Fug_cr_rptstd_id32474excel_limitations.html

Table 19. Tivoli Common Reporting for Microsoft BizTalk Server agent problems and solutions (continued)

Problem Solution

Labels for some charts are displayed in the HTMLoutput, but are not displayed in the PDF output.

The font size is rendered differently in the HTML andthe PDF output. In the PDF output, some fonts are notdisplayed because of the large font size. To resolve thisissue, reduce the font size by completing the followingsteps:

1. Open the report in Report Studio.

2. Click the chart.

3. In the chart properties, select Font.

4. Modify the font properties, such as family, size,weight, and style.

5. Save the settings, and run the report in the PDFformat.

If you drag the [KQB Receive LocationStatus].[Status(Latest)] column to the reportarea while creating an ad hoc query, the followingerror message is displayed:

UDA-SQL-0353 An error was detectedwhile processing the SQL request.

[IBM][CLI Driver][DB2/NT] SQL0206N <'column name'>is not valid in the context where it is used.SQLSTATE=42703 RSV-SRV-0042


Support informationIf you have a problem with your IBM software, you want to resolve it quickly.

IBM provides the following ways for you to obtain the support you need:

OnlineThe following websites contain troubleshooting information:v Go to the IBM Software Support website (http://www.ibm.com/support/entry/portal/

software) and follow the instructions.v Go to the Application Performance Management Wiki (http://www.ibm.com/developerworks/

servicemanagement/apm/index.html). Feel free to contribute to this wiki.

IBM Support AssistantThe IBM Support Assistant (ISA) is a free local software serviceability workbench that helps youresolve questions and problems with IBM software products. The ISA provides quick access tosupport-related information and serviceability tools for problem determination. To install the ISAsoftware, go to the IBM Support Assistant website (http://www.ibm.com/software/support/isa).

Informational, warning, and error messages overviewMessages relay information about how the system or application is performing and can alert you toexceptional conditions when they occur.

Messages are sent to an output destination, such as a file, database, or console screen.

If you receive a warning or error message, you can do one of the following actions:v Follow the instructions listed in the Detail window of the message if this information is included there.v Consult the message details listed in this topic to see what action you can take to correct the problem.


http://www.ibm.com/support/entry/portal/software

http://www.ibm.com/developerworks/servicemanagement/apm/index.html

http://www.ibm.com/software/support/isa

v Consult the message log for message ID, text, time, and date of the message, as well as other data youcan use to diagnose the problem.

Message formatThe message format contains a message ID and text, an explanation, and an operator response.

IBM Tivoli Composite Application Manager for Microsoft Applications: Microsoft BizTalk Server Agentmessages have the following format:

Message ID and textExplanationOperator Response

The message ID has the following format:CCC####severity

where:

CCC Prefix that indicates the component to which the message applies. The following components areused:

KQB General Microsoft BizTalk Server agent messages

#### Number of the message

severitySeverity of the message. Three levels of severity are used:

I Informational messages provide feedback about something that happened in theproduct or system that might be important. These messages can provide guidancewhen you are requesting a specific action from the product.

W Warning messages call your attention to an exception condition. The conditionmight not be an error but can cause problems if not resolved.

E Error messages indicate that an action cannot be completed because of a user orsystem error. These messages require user response.

The Text of the message provides a general statement regarding the problem or condition that occurred.The Explanation provides additional information about the message and the possible cause for thecondition. The Operator Response provides actions to take in response to the condition, particularly forerror messages (messages with the "E" suffix).

Note: Many message texts and explanations contain variables, such as the specific name of a server orapplication. Those variables are represented in this topic as symbols, such as "&1." Actual messagescontain values for these variables.

Agent messagesThe following messages apply to IBM Tivoli Composite Application Manager for Microsoft Applications:Microsoft BizTalk Server Agent.

KQB0001IThe Rule Engine Update service is started.

Explanation:The Rule Engine Update service is started.

Operator response:None.


KQB0002IThe Rule Engine Update service is already started.

Explanation:The Rule Engine Update service is already started.


KQB0003EError starting Rule Engine Update service.

Explanation:Error starting Rule Engine Update service.

Operator response:Check the event log for more information.

KQH0101IThe Rule Engine Update service is stopped.

Explanation:The Rule Engine Update service is stopped.


KQH0102IThe Rule Engine Update service is already stopped.

Explanation:The Rule Engine Update service is already stopped.


KQH0103EError stopping the Rule Engine Update service.

Explanation:Error stopping the Rule Engine Update service.


KQB0004IThe BizTalk Base EDI service is started.

Explanation:The BizTalk Base EDI service is started.


KQB0005IThe BizTalk Base EDI service is already started.

Explanation:The BizTalk Base EDI service is already started.


KQB0006EError starting the BizTalk Base EDI service.


Explanation:Error starting the BizTalk Base EDI service.


KQH0104IThe BizTalk Base EDI service is stopped.

Explanation:The BizTalk Base EDI service is stopped.


KQH0105IThe BizTalk Base EDI service is already stopped.

Explanation:The BizTalk Base EDI service is already stopped.


KQH0106EError stopping the BizTalk Base EDI service.

Explanation:Error stopping the BizTalk Base EDI service.


KQB0007IThe BizTalk SharePoint Messaging Adapter service is started.

Explanation:The BizTalk SharePoint Messaging Adapter service is started.


KQB0008IThe BizTalk SharePoint Messaging Adapter service is already started.

Explanation:The BizTalk SharePoint Messaging Adapter service is already started.


KQB0009EError starting the BizTalk SharePoint Messaging Adapter service.

Explanation:Error starting the BizTalk SharePoint Messaging Adapter service.


KQH0107IThe BizTalk SharePoint Messaging Adapter service is stopped.

Explanation:The BizTalk SharePoint Messaging Adapter service is stopped.



KQH0108IThe BizTalk SharePoint Messaging Adapter service is already stopped.

Explanation:The BizTalk SharePoint Messaging Adapter service is already stopped.


KQH0109EError stopping the BizTalk SharePoint Messaging Adapter service.

Explanation:Error stopping the BizTalk SharePoint Messaging Adapter service.


KQB0010IThe Enterprise Single Sign-On service is started.

Explanation:The Enterprise Single Sign-On service is started.


KQB0011IThe Enterprise Single Sign-On service is already started.

Explanation:The Enterprise Single Sign-On service is already started.


KQB0012EError starting the Enterprise Single Sign-On service.

Explanation:Error starting the Enterprise Single Sign-On service.


KQH0110IThe Enterprise Single Sign-On service is stopped.

Explanation:The Enterprise Single Sign-On service is stopped.


KQH0111IThe Enterprise Single Sign-On service is already stopped.

Explanation:The Enterprise Single Sign-On service is already stopped.



KQH0112EError stopping the Enterprise Single Sign-On service.

Explanation:Error stopping the Enterprise Single Sign-On service.


KQB0013IHost Instance service is started.

Explanation:Host Instance service is started.


KQB0014IHost Instance service is already started.

Explanation:Host Instance service is already started.


KQB0015EError starting Host Instance service.

Explanation:Error starting Host Instance service.


KQH0113IHost Instance service is stopped.

Explanation:Host Instance service is stopped.


KQH0114IHost Instance service is already stopped.

Explanation:Host Instance service is already stopped.


KQH0115EError stopping Host Instance service.

Explanation:Error stopping Host Instance service.


KQB4039IOrchestration is started.


Explanation:Orchestration is started.


KQB4040EError starting the Orchestration. Check whether the Orchestration is already started. Ifnot, check the BizTalk Server administration console.

Explanation:Error starting the Orchestration.

Operator response:Check the BizTalk Server administration console.

KQB4041ISend Port is started.

Explanation:Send Port is started.


KQB4042EError starting the Send Port. Check whether the Send Port is already started. If not,check the BizTalk Server administration console.

Explanation:Error starting the Send Port.


KQB4043IReceive Location is enabled.

Explanation:Receive Location is enabled.


KQB4044EError enabling the Receive Location. Check whether the Receive Location is alreadyenabled. If not, check the BizTalk Server administration console to ensure all thedependent settings are enabled.

Explanation:Error enabling the Receive Location.


KQB0016IThe Microsoft BizTalk RFID Service is started.

Explanation:The Microsoft BizTalk RFID Service is started.


KQB0017IThe Microsoft BizTalk RFID Service has already started.


Explanation:The Microsoft BizTalk RFID Service has already started.


KQB0018EAn error occurred while starting the Microsoft BizTalk RFID Service.

Explanation:An error occurred while starting the Microsoft BizTalk RFID Service.


KQH0116IThe Microsoft BizTalk RFID service is stopped.

Explanation:The Microsoft BizTalk RFID service is stopped.


KQH0117IThe Microsoft BizTalk RFID service has already stopped.

Explanation:The Microsoft BizTalk RFID service has already stopped.


KQH0118EAn error occurred while stopping the Microsoft BizTalk RFID service.

Explanation:An error occurred while stopping the Microsoft BizTalk RFID service.


KQB0200WThe service does not exist as an installed service.

Explanation:The service does not exist as an installed service.


KQB0201IThe service is disabled and cannot be started.

Explanation:The service is disabled and cannot be started.


KQB0202EThe dependency service or group failed to start.

Explanation:The dependency service or group failed to start.



KQB0203EThe dependency service does not exist or has been marked for deletion.

Explanation:The dependency service does not exist or has been marked for deletion.


KQB0204EThe service did not start because of a logon failure.

Explanation:The service did not start because of a logon failure.


KQB4045ISend Port Group is started.

Explanation:Send Port Group is started.


KQB4046EAn error occurred while starting the Send Port Group. Check the BizTalk ServerAdministration Console.

Explanation:An error occurred while starting the Send Port Group.


KQB4047EThe Send Port Group name is not provided.

Explanation:The Send Port Group name is not provided.


KQB4048EThe Send Port Group has already started.

Explanation:The Send Port Group has already started.


KQB4049ECannot start the Send Port Group. At least one associated Send Port must be alreadyenlisted.

Explanation:Cannot start the Send Port Group.



KQB4050EThe Send Port Group does not exist.

Explanation:The Send Port Group does not exist.


KQB4051EThe Send Port Group did not start because of a logon failure.

Explanation:The Send Port Group did not start because of a logon failure.


KQB4052IThe Send Port Group is stopped.

Explanation:The Send Port Group is stopped.


KQB4053EAn error occurred while stopping the Send Port Group. Check the BizTalk ServerAdministration Console.

Explanation:Error stoping the Send Port Group.


KQB4054EThe Send Port Group name is not provided.

Explanation:The Send Port Group name is not provided.


KQB4055EThe Send Port Group has already stopped.

Explanation:The Send Port Group has already stopped.


KQB4056ECannot stop the Send Port Group because the state of the Send Port Group is Bound.

Explanation:Cannot stop the Send Port Group because the state of the Send Port Group is Bound.



KQB4057EThe Send Port Group does not exist.

Explanation:The Send Port Group does not exist.


KQB4058EThe Send Port Group did not start because of a logon failure.

Explanation:The Send Port Group did not start because of a logon failure.


KQB4064EThe Send Port name is not provided.

Explanation:The Send Port name is not provided.


KQB4065EThe Send Port has already started.

Explanation:The Send Port has already started.


KQB4066ECannot start the Send Port.

Explanation:Could not start the Send Port Group.


KQB4067EThe Send Port does not exist.

Explanation:The Send Port does not exist.


KQB4068EThe Send Port did not start because of a logon failure.

Explanation:The Send Port did not start because of a logon failure.


KQB4059EThe Orchestration name is not provided.


Explanation:The Orchestration name is not provided.


KQB4060EThe Orchestration has already started.

Explanation:The Orchestration has already started.


KQB4061ECannot start the Orchestration. All orchestration ports must be bound and the host mustbe set to start the Orchestration.

Explanation:Could not start the Orchestration.


KQB4062EThe Orchestration does not exist.

Explanation:The Orchestration does not exist.


KQB4063EThe Orchestration did not start because of a logon failure.

Explanation:The Orchestration did not start because of a logon failure.



Appendix A. Event mapping

The Tivoli Event Integration Facility (EIF) interface is used to forward situation events to TivoliNetcool/OMNIbus or Tivoli Enterprise Console.

EIF events specify an event class, and the event data is specified as name-value pairs that identify thename of an event slot and the value for the slot. An event class can have subclasses. IBM TivoliMonitoring provides the base event class definitions and a set of base slots that are included in allmonitoring events. Agents extend the base event classes to define subclasses that include agent-specificslots. For Microsoft BizTalk Server agent events, the event classes correspond to the agent attributegroups, and the agent-specific slots correspond to the attributes in the attribute group.

The situation editor in the Tivoli Enterprise Portal can be used to perform custom mapping of data to EIFslots instead of using the default mapping described in this topic. For more information about EIF slotcustomization, see the Tivoli Enterprise Portal User's Guide.

Tivoli Enterprise Console requires that event classes and their slots are defined in BAROC (Basic Recorderof Objects in C) files. Each agent provides a BAROC file that contains event class definitions for the agentand is installed on the Tivoli Enterprise Monitoring Server in the TECLIB directory (install_dir/cms/TECLIB for Windows systems and install_dir/tables/TEMS_hostname/TECLIB for UNIX systems) whenapplication support for the agent is installed. The BAROC file for the agent and the base BAROC filesprovided with Tivoli Monitoring must also be installed onto the Tivoli Enterprise Console. For details, see"Setting up event forwarding to Tivoli Enterprise Console" in the IBM Tivoli Monitoring Installation andSetup Guide.

Each of the event classes is a child of KQB_Base and is defined in the kqb.baroc (version 6.3) file. TheKQB_Base event class can be used for generic rules processing for any event from the IBM TivoliComposite Application Manager for Microsoft Applications: Microsoft BizTalk Server Agent.

For events that are generated by situations in the Application Status attribute group, events are sent byusing the ITM_KQB_APPLICATION_STATUS event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv application_name: STRINGv application_status: STRINGv server_name: STRING

For events that are generated by situations in the Availability attribute group, events are sent by using theITM_KQB_AVAILABILITY event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv application_component: STRINGv name: STRINGv name_enum: STRINGv kqb_status: INTEGERv kqb_status_enum: STRINGv full_name: STRINGv full_name_enum: STRINGv type: INTEGER


v type_enum: STRINGv virtual_size: INTEGERv page_faults_per_sec: INTEGERv working_set_size: INTEGERv thread_count: INTEGERv pid: INTEGERv percent_privileged_time: INTEGERv percent_user_mode_time: INTEGERv percent_processor_time: INTEGERv command_line: STRINGv command_line_enum: STRINGv functionality_test_status: INTEGERv functionality_test_status_enum: STRINGv functionality_test_message: STRINGv functionality_test_message_enum: STRING

For events that are generated by situations in the BAM Database attribute group, events are sent by usingthe ITM_KQB_BAM_DATABASE event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv database_name: STRINGv server_name: STRING

For events that are generated by situations in the BAM Interceptor attribute group, events are sent byusing the ITM_KQB_BAM_INTERCEPTOR event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv avg_extraction_sec_per_bam_event: INTEGERv avg_extraction_sec_per_bam_event_enum: STRINGv avg_failed_bam_events_per_flush: REALv avg_failed_bam_events_per_flush_enum: STRINGv avg_flush_sec_per_bam_event: INTEGERv avg_flush_sec_per_bam_event_enum: STRINGv avg_successful_bam_events_per_flush: REALv avg_successful_bam_events_per_flush_enum: STRINGv total_failed_bam_events_during_flush: INTEGERv total_failed_bam_events_during_flush_enum: STRINGv total_successful_bam_events_during_flush: INTEGERv total_successful_bam_events_during_flush_enum: STRINGv name: STRING

For events that are generated by situations in the BizTalk Group Server Host attribute group, events aresent by using the ITM_KQB_BIZTALK_GROUP_SERVER_HOST event class. This event class contains thefollowing slots:v node: STRINGv timestamp: STRINGv group_name: STRING


v host_instance: STRINGv host_name: STRINGv host_instance_status: INTEGERv host_instance_status_enum: STRINGv server_name: STRING

For events that are generated by situations in the BizTalk Host attribute group, events are sent by usingthe ITM_KQB_BIZTALK_HOST event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv group_name: STRINGv host_name: STRING

For events that are generated by situations in the BizTalk NET Adapter for Oracle DB attribute group,events are sent by using the ITM_KQB_BIZTALK_NET_ADAPTER_FOR_ORACLE_DB event class. Thisevent class contains the following slots:v node: STRINGv timestamp: STRINGv lob_time_cumulative: INTEGERv lob_time_cumulative_enum: STRINGv lob_time_cumulative_delta: INTEGERv lob_time_cumulative_delta_enum: STRINGv name: STRING

For events that are generated by situations in the BizTalk NET Adapter for Oracle EBusiness Suiteattribute group, events are sent by using theITM_KQB_BIZTALK_NET_ADAPTER_FOR_ORACLE_EBUSINESS_SUITE event class. This event classcontains the following slots:v node: STRINGv timestamp: STRINGv lob_time_cumulative: INTEGERv lob_time_cumulative_enum: STRINGv lob_time_cumulative_delta: INTEGERv lob_time_cumulative_delta_enum: STRINGv name: STRING

For events that are generated by situations in the BizTalk NET Adapter for SAP attribute group, eventsare sent by using the ITM_KQB_BIZTALK_NET_ADAPTER_FOR_SAP event class. This event classcontains the following slots:v node: STRINGv timestamp: STRINGv lob_time_cumulative: INTEGERv lob_time_cumulative_enum: STRINGv lob_time_cumulative_delta: INTEGERv lob_time_cumulative_delta_enum: STRINGv name: STRING

Appendix A. Event mapping 299

For events that are generated by situations in the BizTalk NET Adapter for Siebel attribute group, eventsare sent by using the ITM_KQB_BIZTALK_NET_ADAPTER_FOR_SIEBEL event class. This event classcontains the following slots:v node: STRINGv timestamp: STRINGv lob_time_cumulative: INTEGERv lob_time_cumulative_enum: STRINGv lob_time_cumulative_delta: INTEGERv lob_time_cumulative_delta_enum: STRINGv name: STRING

For events that are generated by situations in the BizTalk NET Adapter for SQL attribute group, eventsare sent by using the ITM_KQB_BIZTALK_NET_ADAPTER_FOR_SQL event class. This event classcontains the following slots:v node: STRINGv timestamp: STRINGv lob_time_cumulative: INTEGERv lob_time_cumulative_enum: STRINGv lob_time_cumulative_delta: INTEGERv lob_time_cumulative_delta_enum: STRINGv name: STRING

For events that are generated by situations in the BizTalk Server attribute group, events are sent by usingthe ITM_KQB_BIZTALK_SERVER event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv group_name: STRINGv server_name: STRING

For events that are generated by situations in the Delivery Channels attribute group, events are sent byusing the ITM_KQB_DELIVERY_CHANNELS event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv name: STRINGv messages_written_to_transport: REALv messages_written_to_transport_enum: STRINGv messages_written_to_transport_rate: REALv messages_written_to_transport_rate_enum: STRINGv server_name: STRING

For events that are generated by situations in the Distributors attribute group, events are sent by usingthe ITM_KQB_DISTRIBUTORS event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv name: STRINGv delivery_requests_failed: INTEGERv delivery_requests_failed_enum: STRINGv delivery_requests_succeeded: INTEGER


v delivery_requests_succeeded_enum: STRINGv format_requests_failed: INTEGERv format_requests_failed_enum: STRINGv format_requests_succeeded: INTEGERv format_requests_succeeded_enum: STRINGv notification_bodies: INTEGERv notification_bodies_enum: STRINGv notification_headers: INTEGERv notification_headers_enum: STRINGv server_name: STRING

For events that are generated by situations in the Event Log attribute group, events are sent by using theITM_KQB_EVENT_LOG event class. This event class contains the following slots:v node: STRINGv log_name: STRINGv event_source: STRINGv event_type: INTEGERv event_type_enum: STRINGv event_id: INTEGERv event_category: STRINGv event_category_enum: STRINGv message: STRINGv time_generated: STRING

For events that are generated by situations in the Event Providers attribute group, events are sent byusing the ITM_KQB_EVENT_PROVIDERS event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv name: STRINGv event_batches_aborted: REALv event_batches_aborted_enum: STRINGv event_batches_committed: REALv event_batches_committed_enum: STRINGv events_per_batch: INTEGERv events_per_batch_enum: STRINGv events_received: REALv events_received_enum: STRINGv events_received_per_second: REALv events_received_per_second_enum: STRINGv server_name: STRING

For events that are generated by situations in the Events attribute group, events are sent by using theITM_KQB_EVENTS event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv name: STRINGv event_batches_awaiting_generation: INTEGER


v event_batches_awaiting_generation_enum: STRINGv event_batches_in_collection: INTEGERv event_batches_in_collection_enum: STRINGv event_batches_submitted: INTEGERv event_batches_submitted_enum: STRINGv total_events: INTEGERv total_events_enum: STRINGv server_name: STRING

For events that are generated by situations in the File Receive Adapter attribute group, events are sent byusing the ITM_KQB_FILE_RECEIVE_ADAPTER event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv bytes_received_per_sec: REALv bytes_received_per_sec_enum: STRINGv delete_retries: INTEGERv delete_retries_enum: STRINGv lock_failures: INTEGERv lock_failures_enum: STRINGv lock_failures_per_sec: REALv lock_failures_per_sec_enum: STRINGv messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv time_to_build_batch: INTEGERv time_to_build_batch_enum: STRINGv kilobytes_received: REALv kilobytes_received_enum: STRINGv bytes_received_per_sec_64: REALv bytes_received_per_sec_64_enum: STRINGv lock_failures_64: REALv lock_failures_64_enum: STRINGv lock_failures_per_sec_64: REALv lock_failures_per_sec_64_enum: STRINGv kilobytes_received_64: REALv kilobytes_received_64_enum: STRINGv name: STRING

For events that are generated by situations in the File Send Adapter attribute group, events are sent byusing the ITM_KQB_FILE_SEND_ADAPTER event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv bytes_sent_per_sec: REALv bytes_sent_per_sec_enum: STRINGv messages_sent: INTEGER


v messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv kilobytes_sent: REALv kilobytes_sent_enum: STRINGv bytes_sent_per_sec_64: REALv bytes_sent_per_sec_64_enum: STRINGv kilobytes_sent_64: REALv kilobytes_sent_64_enum: STRINGv name: STRING

For events that are generated by situations in the FTP Receive Adapter attribute group, events are sent byusing the ITM_KQB_FTP_RECEIVE_ADAPTER event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv bytes_received_per_sec: REALv bytes_received_per_sec_enum: STRINGv messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv kilobytes_received: REALv kilobytes_received_enum: STRINGv bytes_received_per_sec_64: REALv bytes_received_per_sec_64_enum: STRINGv kilobytes_received_64: REALv kilobytes_received_64_enum: STRINGv name: STRING

For events that are generated by situations in the FTP Send Adapter attribute group, events are sent byusing the ITM_KQB_FTP_SEND_ADAPTER event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv bytes_sent_per_sec: REALv bytes_sent_per_sec_enum: STRINGv messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv kilobytes_sent: REALv kilobytes_sent_enum: STRINGv bytes_sent_per_sec_64: REALv bytes_sent_per_sec_64_enum: STRINGv kilobytes_sent_64: REALv kilobytes_sent_64_enum: STRINGv name: STRING


For events that are generated by situations in the Generator attribute group, events are sent by using theITM_KQB_GENERATOR event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv name: STRINGv notifications_generated_per_second: REALv notifications_generated_per_second_enum: STRINGv quanta_behind: INTEGERv quanta_behind_enum: STRINGv quanta_failed: REALv quanta_failed_enum: STRINGv quanta_processed: REALv quanta_processed_enum: STRINGv rule_firing_failures: REALv rule_firing_failures_enum: STRINGv rule_firings: REALv rule_firings_enum: STRINGv skipped_chronicle_rule_firings: REALv skipped_chronicle_rule_firings_enum: STRINGv skipped_quanta: REALv skipped_quanta_enum: STRINGv skipped_subscription_rule_firings: REALv skipped_subscription_rule_firings_enum: STRINGv server_name: STRING

For events that are generated by situations in the Host Throttling attribute group, events are sent byusing the ITM_KQB_HOST_THROTTLING event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv active_instance_count: INTEGERv active_instance_count_enum: STRINGv database_session: INTEGERv database_session_enum: STRINGv database_session_threshold: INTEGERv database_session_threshold_enum: STRINGv database_size: INTEGERv database_size_enum: STRINGv high_database_session: INTEGERv high_database_session_enum: STRINGv high_database_size: INTEGERv high_database_size_enum: STRINGv high_in_process_message_count: INTEGERv high_in_process_message_count_enum: STRINGv high_message_delivery_rate: INTEGERv high_message_delivery_rate_enum: STRINGv high_message_publishing_rate: INTEGER


v high_message_publishing_rate_enum: STRINGv high_process_memory: INTEGERv high_process_memory_enum: STRINGv high_system_memory: INTEGERv high_system_memory_enum: STRINGv high_thread_count: INTEGERv high_thread_count_enum: STRINGv in_process_message_count: INTEGERv in_process_message_count_enum: STRINGv in_process_message_count_threshold: INTEGERv in_process_message_count_threshold_enum: STRINGv message_delivery_delay_in_sec: REALv message_delivery_delay_in_sec_enum: STRINGv message_delivery_incoming_rate: INTEGERv message_delivery_incoming_rate_enum: STRINGv message_delivery_outgoing_rate: INTEGERv message_delivery_outgoing_rate_enum: STRINGv message_delivery_throttling_state: INTEGERv message_delivery_throttling_state_enum: STRINGv message_delivery_throttling_state_duration_in_min: REALv message_delivery_throttling_state_duration_in_min_enum: STRINGv message_delivery_throttling_user_override: INTEGERv message_delivery_throttling_user_override_enum: STRINGv message_publishing_delay_in_sec: REALv message_publishing_delay_in_sec_enum: STRINGv message_publishing_incoming_rate: INTEGERv message_publishing_incoming_rate_enum: STRINGv message_publishing_outgoing_rate: INTEGERv message_publishing_outgoing_rate_enum: STRINGv message_publishing_throttling_state: INTEGERv message_publishing_throttling_state_enum: STRINGv message_publishing_throttling_state_duration_in_min: REALv message_publishing_throttling_state_duration_in_min_enum: STRINGv message_publishing_throttling_user_override: INTEGERv message_publishing_throttling_user_override_enum: STRINGv physical_memory_usage_in_mb: INTEGERv physical_memory_usage_in_mb_enum: STRINGv process_memory_usage_in_mb: INTEGERv process_memory_usage_in_mb_enum: STRINGv process_memory_usage_threshold_in_mb: INTEGERv process_memory_usage_threshold_in_mb_enum: STRINGv thread_count: INTEGERv thread_count_enum: STRINGv thread_count_threshold: INTEGERv thread_count_threshold_enum: STRING


v total_batches_committed: INTEGERv total_batches_committed_enum: STRINGv total_messages_delivered: INTEGERv total_messages_delivered_enum: STRINGv total_messages_published: INTEGERv total_messages_published_enum: STRINGv server_name: STRINGv name: STRING

For events that are generated by situations in the HTTP Receive Adapter attribute group, events are sentby using the ITM_KQB_HTTP_RECEIVE_ADAPTER event class. This event class contains the followingslots:v node: STRINGv timestamp: STRINGv memory_queue_size: INTEGERv memory_queue_size_enum: STRINGv messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv time_to_add_message_to_batch: REALv time_to_add_message_to_batch_enum: STRINGv time_to_build_batch: REALv time_to_build_batch_enum: STRINGv name: STRING

For events that are generated by situations in the HTTP Send Adapter attribute group, events are sent byusing the ITM_KQB_HTTP_SEND_ADAPTER event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv memory_queue_size: INTEGERv memory_queue_size_enum: STRINGv messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv name: STRING


For events that are generated by situations in the Human Workflow Services attribute group, events aresent by using the ITM_KQB_HUMAN_WORKFLOW_SERVICES event class. This event class contains thefollowing slots:v node: STRINGv timestamp: STRINGv activity_flows_retrieved: INTEGERv activity_flows_retrieved_enum: STRINGv new_action_added: INTEGERv new_action_added_enum: STRINGv new_activity_flows: INTEGERv new_activity_flows_enum: STRINGv steps_retrieved: INTEGERv steps_retrieved_enum: STRINGv tasks_retrieved: INTEGERv tasks_retrieved_enum: STRINGv server_name: STRING

For events that are generated by situations in the Management Database attribute group, events are sentby using the ITM_KQB_MANAGEMENT_DATABASE event class. This event class contains the followingslots:v node: STRINGv timestamp: STRINGv database_name: STRINGv server_name: STRING

For events that are generated by situations in the Message Box General Counters attribute group, eventsare sent by using the ITM_KQB_MESSAGE_BOX_GENERAL_COUNTERS event class. This event classcontains the following slots:v node: STRINGv timestamp: STRINGv instances_total_number: INTEGERv instances_total_number_enum: STRINGv msgbox_dead_processes_cleanup_purge_jobs: INTEGERv msgbox_dead_processes_cleanup_purge_jobs_enum: STRINGv msgbox_msg_cleanup_purge_jobs: INTEGERv msgbox_msg_cleanup_purge_jobs_enum: STRINGv msgbox_parts_cleanup_purge_jobs: INTEGERv msgbox_parts_cleanup_purge_jobs_enum: STRINGv msgbox_purge_subscriptions_job_purge_jobs: INTEGERv msgbox_purge_subscriptions_job_purge_jobs_enum: STRINGv spool_size: INTEGERv spool_size_enum: STRINGv tracked_msgs_copy_purge_jobs: INTEGERv tracked_msgs_copy_purge_jobs_enum: STRINGv tracking_data_size: INTEGERv tracking_data_size_enum: STRINGv change_in_tracking_data_size: INTEGER


v change_in_tracking_data_size_enum: STRINGv tracking_spool_cleanup_purge_jobs: INTEGERv tracking_spool_cleanup_purge_jobs_enum: STRINGv name: STRING

For events that are generated by situations in the Message Box Host Counters attribute group, events aresent by using the ITM_KQB_MESSAGE_BOX_HOST_COUNTERS event class. This event class containsthe following slots:v node: STRINGv timestamp: STRINGv host_queue_instance_state_msg_refs_length: INTEGERv host_queue_instance_state_msg_refs_length_enum: STRINGv host_queue_length: INTEGERv host_queue_length_enum: STRINGv host_queue_number_of_instances: INTEGERv host_queue_number_of_instances_enum: STRINGv host_queue_suspended_msgs_length: INTEGERv host_queue_suspended_msgs_length_enum: STRINGv name: STRING

For events that are generated by situations in the Messagebox Database attribute group, events are sentby using the ITM_KQB_MESSAGEBOX_DATABASE event class. This event class contains the followingslots:v node: STRINGv timestamp: STRINGv database_name: STRINGv server_name: STRINGv disable_new_message_publication: STRINGv is_master_message_box: STRING

For events that are generated by situations in the Messaging attribute group, events are sent by using theITM_KQB_MESSAGING event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv active_receive_locations: INTEGERv active_receive_locations_enum: STRINGv active_receive_threads: INTEGERv active_receive_threads_enum: STRINGv active_send_messages: INTEGERv active_send_messages_enum: STRINGv active_send_threads: INTEGERv active_send_threads_enum: STRINGv documents_processed: INTEGERv documents_processed_enum: STRINGv documents_processed_per_sec: REALv documents_processed_per_sec_enum: STRINGv documents_received: INTEGER


v documents_received_enum: STRINGv documents_received_per_sec: REALv documents_received_per_sec_enum: STRINGv documents_resubmitted: INTEGERv documents_resubmitted_enum: STRINGv documents_submitted_per_batch: REALv documents_submitted_per_batch_enum: STRINGv documents_suspended: INTEGERv documents_suspended_enum: STRINGv documents_suspended_per_sec: REALv documents_suspended_per_sec_enum: STRINGv documents_transmitted_per_batch: REALv documents_transmitted_per_batch_enum: STRINGv pending_receive_batches: INTEGERv pending_receive_batches_enum: STRINGv pending_transmitted_messages: INTEGERv pending_transmitted_messages_enum: STRINGv request_response_timeouts: INTEGERv request_response_timeouts_enum: STRINGv throttled_receive_batches: INTEGERv throttled_receive_batches_enum: STRINGv documents_submitted_per_batch_64: REALv documents_submitted_per_batch_64_enum: STRINGv documents_transmitted_per_batch_64: REALv documents_transmitted_per_batch_64_enum: STRINGv name: STRING

For events that are generated by situations in the Messaging Latency attribute group, events are sent byusing the ITM_KQB_MESSAGING_LATENCY event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv inbound_latency_in_ms: REALv inbound_latency_in_ms_enum: STRINGv outbound_adapter_latency_in_ms: REALv outbound_adapter_latency_in_ms_enum: STRINGv outbound_latency_in_ms: REALv outbound_latency_in_ms_enum: STRINGv request_response_latency_in_ms: REALv request_response_latency_in_ms_enum: STRINGv name: STRING

For events that are generated by situations in the MSMQ Receive Adapter attribute group, events are sentby using the ITM_KQB_MSMQ_RECEIVE_ADAPTER event class. This event class contains the followingslots:v node: STRINGv timestamp: STRING


v bytes_received_per_sec: REALv bytes_received_per_sec_enum: STRINGv messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv kilobytes_received: REALv kilobytes_received_enum: STRINGv bytes_received_per_sec_64: REALv bytes_received_per_sec_64_enum: STRINGv kilobytes_received_64: REALv kilobytes_received_64_enum: STRINGv name: STRING

For events that are generated by situations in the MSMQ Send Adapter attribute group, events are sentby using the ITM_KQB_MSMQ_SEND_ADAPTER event class. This event class contains the followingslots:v node: STRINGv timestamp: STRINGv bytes_sent_per_sec: REALv bytes_sent_per_sec_enum: STRINGv messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv kilobytes_sent: REALv kilobytes_sent_enum: STRINGv bytes_sent_per_sec_64: REALv bytes_sent_per_sec_64_enum: STRINGv kilobytes_sent_64: REALv kilobytes_sent_64_enum: STRINGv name: STRING

For events that are generated by situations in the Notifications attribute group, events are sent by usingthe ITM_KQB_NOTIFICATIONS event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv name: STRINGv batches: REALv batches_enum: STRINGv batches_awaiting_distribution: REALv batches_awaiting_distribution_enum: STRINGv batches_expired: REALv batches_expired_enum: STRINGv batches_failed_delivery: REALv batches_failed_delivery_enum: STRING


v batches_in_retry: REALv batches_in_retry_enum: STRINGv batches_successfully_delivered: REALv batches_successfully_delivered_enum: STRINGv notifications: REALv notifications_enum: STRINGv notifications_failed_delivery: REALv notifications_failed_delivery_enum: STRINGv notifications_successfully_delivered: REALv notifications_successfully_delivered_enum: STRINGv server_name: STRING

For events that are generated by situations in the Orchestration Status attribute group, events are sent byusing the ITM_KQB_ORCHESTRATION_STATUS event class. This event class contains the followingslots:v node: STRINGv timestamp: STRINGv host_name: STRINGv orchestration_name: STRINGv kqb_status: INTEGERv kqb_status_enum: STRINGv server_name: STRING

For events that are generated by situations in the Orchestrations attribute group, events are sent by usingthe ITM_KQB_ORCHESTRATIONS event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv percent_used_physical_memory: INTEGERv percent_used_physical_memory_enum: STRINGv active_application_domains: INTEGERv active_application_domains_enum: STRINGv average_batch_factor: INTEGERv average_batch_factor_enum: STRINGv database_transactions: INTEGERv database_transactions_enum: STRINGv database_transactions_per_sec: REALv database_transactions_per_sec_enum: STRINGv dehydratable_orchestrations: INTEGERv dehydratable_orchestrations_enum: STRINGv dehydrating_orchestrations: INTEGERv dehydrating_orchestrations_enum: STRINGv dehydration_cycle_in_progress: INTEGERv dehydration_cycle_in_progress_enum: STRINGv dehydration_cycles: INTEGERv dehydration_cycles_enum: STRINGv dehydration_threshold: INTEGER


v dehydration_threshold_enum: STRINGv idle_orchestrations: INTEGERv idle_orchestrations_enum: STRINGv allocated_private_memory_in_mb: INTEGERv allocated_private_memory_in_mb_enum: STRINGv allocated_virtual_memory_in_mb: INTEGERv allocated_virtual_memory_in_mb_enum: STRINGv messagebox_databases_connection_failures: INTEGERv messagebox_databases_connection_failures_enum: STRINGv online_messagebox_databases: INTEGERv online_messagebox_databases_enum: STRINGv orchestrations_completed: INTEGERv orchestrations_completed_enum: STRINGv orchestrations_completed_per_sec: REALv orchestrations_completed_per_sec_enum: STRINGv orchestrations_created: INTEGERv orchestrations_created_enum: STRINGv orchestrations_created_per_sec: REALv orchestrations_created_per_sec_enum: STRINGv orchestrations_dehydrated: INTEGERv orchestrations_dehydrated_enum: STRINGv orchestrations_dehydrated_per_sec: REALv orchestrations_dehydrated_per_sec_enum: STRINGv orchestrations_discarded: INTEGERv orchestrations_discarded_enum: STRINGv orchestrations_discarded_per_sec: REALv orchestrations_discarded_per_sec_enum: STRINGv orchestrations_rehydrated: INTEGERv orchestrations_rehydrated_enum: STRINGv orchestrations_rehydrated_per_sec: REALv orchestrations_rehydrated_per_sec_enum: STRINGv orchestrations_resident_in_memory: INTEGERv orchestrations_resident_in_memory_enum: STRINGv orchestrations_scheduled_for_dehydration: INTEGERv orchestrations_scheduled_for_dehydration_enum: STRINGv orchestrations_suspended: INTEGERv orchestrations_suspended_enum: STRINGv orchestrations_suspended_per_sec: REALv orchestrations_suspended_per_sec_enum: STRINGv pending_messages: INTEGERv pending_messages_enum: STRINGv pending_work_items: INTEGERv pending_work_items_enum: STRINGv persistence_points: INTEGERv persistence_points_enum: STRING


v persistence_points_per_sec: REALv persistence_points_per_sec_enum: STRINGv runnable_orchestrations: INTEGERv runnable_orchestrations_enum: STRINGv running_orchestrations: INTEGERv running_orchestrations_enum: STRINGv transactional_scopes_aborted: INTEGERv transactional_scopes_aborted_enum: STRINGv transactional_scopes_aborted_per_sec: REALv transactional_scopes_aborted_per_sec_enum: STRINGv transactional_scopes_committed: INTEGERv transactional_scopes_committed_enum: STRINGv transactional_scopes_committed_per_sec: REALv transactional_scopes_committed_per_sec_enum: STRINGv transactional_scopes_compensated: INTEGERv transactional_scopes_compensated_enum: STRINGv transactional_scopes_compensated_per_sec: REALv transactional_scopes_compensated_per_sec_enum: STRINGv name: STRING

For events that are generated by situations in the Performance Object Status attribute group, events aresent by using the ITM_KQB_PERFORMANCE_OBJECT_STATUS event class. This event class contains thefollowing slots:v node: STRINGv timestamp: STRINGv query_name: STRINGv object_name: STRINGv object_type: INTEGERv object_type_enum: STRINGv object_status: INTEGERv object_status_enum: STRINGv error_code: INTEGERv error_code_enum: STRINGv last_collection_start: STRINGv last_collection_start_enum: STRINGv last_collection_finished: STRINGv last_collection_finished_enum: STRINGv last_collection_duration: REALv average_collection_duration: REALv average_collection_duration_enum: STRINGv refresh_interval: INTEGERv number_of_collections: INTEGERv cache_hits: INTEGERv cache_misses: INTEGERv cache_hit_percent: REALv intervals_skipped: INTEGER


For events that are generated by situations in the POP3 Receive Adapter attribute group, events are sentby using the ITM_KQB_POP3_RECEIVE_ADAPTER event class. This event class contains the followingslots:v node: STRINGv timestamp: STRINGv active_sessions: INTEGERv active_sessions_enum: STRINGv bytes_received_per_sec: REALv bytes_received_per_sec_enum: STRINGv messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv kilobytes_received: INTEGERv kilobytes_received_enum: STRINGv bytes_received_per_sec_64: REALv bytes_received_per_sec_64_enum: STRINGv kilobytes_received_64: REALv kilobytes_received_64_enum: STRINGv name: STRING

For events that are generated by situations in the Receive Location Status attribute group, events are sentby using the ITM_KQB_RECEIVE_LOCATION_STATUS event class. This event class contains thefollowing slots:v node: STRINGv timestamp: STRINGv kqb_status: STRINGv kqb_status_enum: STRINGv receive_location_name: STRINGv is_primary: STRINGv transport_type: STRINGv transport_address: STRINGv receive_port_name: STRINGv receive_handler: STRINGv server_name: STRING

For events that are generated by situations in the RFID Devices attribute group, events are sent by usingthe ITM_KQB_RFID_DEVICES event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv total_tags_written: INTEGERv total_tags_written_enum: STRINGv total_tags_read: INTEGERv total_tags_read_enum: STRINGv tags_written_per_sec: INTEGERv tags_written_per_sec_enum: STRINGv tags_read_per_sec: INTEGER


v tags_read_per_sec_enum: STRINGv downtime: INTEGERv downtime_enum: STRINGv errors_raised_per_sec: INTEGERv errors_raised_per_sec_enum: STRINGv errors_raised: INTEGERv errors_raised_enum: STRINGv name: STRING

For events that are generated by situations in the RFID Processes attribute group, events are sent byusing the ITM_KQB_RFID_PROCESSES event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv process_uptime: INTEGERv process_uptime_enum: STRINGv tags_being_processed: INTEGERv tags_being_processed_enum: STRINGv tags_in_queue: INTEGERv tags_in_queue_enum: STRINGv tags_processed: INTEGERv tags_processed_enum: STRINGv tags_suspended: INTEGERv tags_suspended_enum: STRINGv name: STRING

For events that are generated by situations in the Rule Engine Database attribute group, events are sentby using the ITM_KQB_RULE_ENGINE_DATABASE event class. This event class contains the followingslots:v node: STRINGv timestamp: STRINGv database_name: STRINGv server_name: STRING

For events that are generated by situations in the Send Port Group Status attribute group, events are sentby using the ITM_KQB_SEND_PORT_GROUP_STATUS event class. This event class contains thefollowing slots:v node: STRINGv timestamp: STRINGv send_port_group_name: STRINGv kqb_status: INTEGERv kqb_status_enum: STRINGv server_name: STRING

For events that are generated by situations in the Send Port Status attribute group, events are sent byusing the ITM_KQB_SEND_PORT_STATUS event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv send_port_name: STRING


v kqb_status: INTEGERv kqb_status_enum: STRINGv is_dynamic: STRINGv is_twoway: STRINGv transport_type: STRINGv primary_transport_address: STRINGv server_name: STRING

For events that are generated by situations in the Service Instance Status and Class attribute group,events are sent by using the ITM_KQB_SERVICE_INSTANCE_STATUS_AND_CLASS event class. Thisevent class contains the following slots:v node: STRINGv timestamp: STRINGv instance_id: STRINGv host_name: STRINGv service_class: INTEGERv service_class_enum: STRINGv service_name: STRINGv service_status: INTEGERv service_status_enum: STRINGv error_description: STRINGv server_name: STRING

For events that are generated by situations in the Single Sign On Database attribute group, events aresent by using the ITM_KQB_SINGLE_SIGN_ON_DATABASE event class. This event class contains thefollowing slots:v node: STRINGv timestamp: STRINGv database_name: STRINGv server_name: STRING

For events that are generated by situations in the SMTP Send Adapter attribute group, events are sent byusing the ITM_KQB_SMTP_SEND_ADAPTER event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv name: STRING

For events that are generated by situations in the SOAP Receive Adapter attribute group, events are sentby using the ITM_KQB_SOAP_RECEIVE_ADAPTER event class. This event class contains the followingslots:v node: STRINGv timestamp: STRINGv messages_received: INTEGERv messages_received_enum: STRING


v messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv name: STRING

For events that are generated by situations in the SOAP Send Adapter attribute group, events are sent byusing the ITM_KQB_SOAP_SEND_ADAPTER event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv name: STRING

For events that are generated by situations in the SQL Receive Adapter attribute group, events are sent byusing the ITM_KQB_SQL_RECEIVE_ADAPTER event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv name: STRING

For events that are generated by situations in the SQL Send Adapter attribute group, events are sent byusing the ITM_KQB_SQL_SEND_ADAPTER event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv name: STRING

For events that are generated by situations in the Subscribers attribute group, events are sent by using theITM_KQB_SUBSCRIBERS event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv name: STRINGv subscribers_added: REALv subscribers_added_enum: STRINGv subscribers_disabled: REALv subscribers_disabled_enum: STRINGv subscribers_enabled: REALv subscribers_enabled_enum: STRINGv server_name: STRING


For events that are generated by situations in the Subscriptions attribute group, events are sent by usingthe ITM_KQB_SUBSCRIPTIONS event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv name: STRINGv subscriptions_added: INTEGERv subscriptions_added_enum: STRINGv subscriptions_disabled: REALv subscriptions_disabled_enum: STRINGv subscriptions_enabled: REALv subscriptions_enabled_enum: STRINGv server_name: STRING

For events that are generated by situations in the TDDS attribute group, events are sent by using theITM_KQB_TDDS event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv batches_being_processed: INTEGERv batches_being_processed_enum: STRINGv batches_committed: REALv batches_committed_enum: STRINGv events_being_processed: INTEGERv events_being_processed_enum: STRINGv events_committed: REALv events_committed_enum: STRINGv records_being_processed: INTEGERv records_being_processed_enum: STRINGv records_committed: REALv records_committed_enum: STRINGv total_batches: INTEGERv total_batches_enum: STRINGv total_events: INTEGERv total_events_enum: STRINGv total_failed_batches: INTEGERv total_failed_batches_enum: STRINGv total_failed_events: INTEGERv total_failed_events_enum: STRINGv total_records: INTEGERv total_records_enum: STRINGv total_batches_64: REALv total_batches_64_enum: STRINGv total_events_64: REALv total_events_64_enum: STRINGv total_failed_batches_64: REALv total_failed_batches_64_enum: STRINGv total_failed_events_64: REAL


v total_failed_events_64_enum: STRINGv total_records_64: REALv total_records_64_enum: STRINGv name: STRING

For events that are generated by situations in the Tracking Database attribute group, events are sent byusing the ITM_KQB_TRACKING_DATABASE event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv database_name: STRINGv server_name: STRING

For events that are generated by situations in the Vacuumer attribute group, events are sent by using theITM_KQB_VACUUMER event class. This event class contains the following slots:v node: STRINGv timestamp: STRINGv name: STRINGv completed_periods: REALv completed_periods_enum: STRINGv quanta_remaining: REALv quanta_remaining_enum: STRINGv quanta_vacuumed: REALv quanta_vacuumed_enum: STRINGv timeouts: REALv timeouts_enum: STRINGv server_name: STRING

For events that are generated by situations in the Windows SharePoint Services attribute group, eventsare sent by using the ITM_KQB_WINDOWS_SHAREPOINT_SERVICES event class. This event classcontains the following slots:v node: STRINGv timestamp: STRINGv percent_receive_message_failures: REALv percent_receive_message_failures_enum: STRINGv percent_send_message_failures: REALv percent_send_message_failures_enum: STRINGv percent_web_service_call_failures: REALv percent_web_service_call_failures_enum: STRINGv total_receive_commit_failures: INTEGERv total_receive_commit_failures_enum: STRINGv total_received_messages: INTEGERv total_received_messages_enum: STRINGv total_receive_message_failures: INTEGERv total_receive_message_failures_enum: STRINGv total_send_message_failures: INTEGERv total_send_message_failures_enum: STRINGv total_sent_messages: INTEGER


v total_sent_messages_enum: STRINGv total_web_service_call_failures: INTEGERv total_web_service_call_failures_enum: STRINGv web_service_calls_per_sec: REALv web_service_calls_per_sec_enum: STRING

For events that are generated by situations in the Windows SharePoint Services Adapter attribute group,events are sent by using the ITM_KQB_WINDOWS_SHAREPOINT_SERVICES_ADAPTER event class.This event class contains the following slots:v node: STRINGv timestamp: STRINGv percent_receive_message_failures: REALv percent_receive_message_failures_enum: STRINGv percent_send_message_failures: REALv percent_send_message_failures_enum: STRINGv percent_web_service_call_failures: REALv percent_web_service_call_failures_enum: STRINGv total_receive_commit_failures: INTEGERv total_receive_commit_failures_enum: STRINGv total_received_messages: INTEGERv total_received_messages_enum: STRINGv total_receive_message_failures: INTEGERv total_receive_message_failures_enum: STRINGv total_send_message_failures: INTEGERv total_send_message_failures_enum: STRINGv total_sent_messages: INTEGERv total_sent_messages_enum: STRINGv total_web_service_call_failures: INTEGERv total_web_service_call_failures_enum: STRINGv web_service_calls_per_sec: REALv web_service_calls_per_sec_enum: STRINGv name: STRING


Appendix B. Discovery Library Adapter for the MicrosoftBizTalk Server agent

The Tivoli Management Services Discovery Library Adapter (DLA) discovers resources and relationships,and creates a Discovery Library Book file for the agent.

About the DLA

The Book file follows the Discovery Library IdML schema and is used to populate the ConfigurationManagement Database (CMDB) and Tivoli Business Service Manager products. The Tivoli ManagementServices DLA discovers Microsoft BizTalk Server resources. For all VMware systems that are active andonline at the Tivoli Enterprise Portal Server, information is included in the discovery book for thoseresources. The Tivoli Management Services DLA discovers active resources. It is run on demand and canbe run periodically to discover resources that were not active during previous discoveries.

The DLA discovers Microsoft BizTalk Server components.

More information about DLAs

The following sources contain additional information about using the DLA program with all monitoringagents:v The IBM Tivoli Monitoring Administrator's Guide contains information about using the Tivoli

Management Services Discovery Library Adapter.v For information about using a DLA with Tivoli Application Dependency Discovery Manager (TADDM),

see the TADDM Information Center (http://publib.boulder.ibm.com/infocenter/tivihelp/v10r1/topic/com.ibm.taddm.doc_7.2/welcome_page/welcome.html).

DLA data model class types represented in CDMThe source application data objects map to classes in the Common Data Model (CDM) for the MicrosoftBizTalk Server agent.

The following information is provided for each class:

CDM class nameClass name for which the agent is providing information

RelationshipsCDM relationships (hierarchical) between currently identified model objects

CDM attributes, agent attributes, descriptions, and examplesCDM and agent attributes that are required to create an instance of a resource, descriptions of theattributes, and examples of the attributes

DLA data model classes for Microsoft BizTalk Server agentEach agent that uses the Discovery Library Adapter has DLA data model classes defined for the agent.

The Microsoft BizTalk agent has the following Discovery Library Adapter data model classes:v BizTalkGroupv BizTalkServerv BizTalkHost


http://publib.boulder.ibm.com/infocenter/tivihelp/v10r1/topic/com.ibm.taddm.doc_7.2/welcome_page/welcome.html

v BiztalkHostInstancev MessageBoxv BizTalkReceiveAdapterv BizTalkSendAdapter

BizTalkGroup classThis class represents the BizTalk group, which is the container for all the BizTalk resources, includingservers, hosts, applications, and adapters.

CDM class nameApp.biztalk.BizTalkGroup

Relationships

monitorsv Source: appTMSAgentv Target: BizTalkGroupv Example: source="IBMESX3-ITM-V31:QB-TMSAgent" monitors target="IBMESX3-ITM-V31:QB-

BiztalkGroup"

containsv Source: BizTalkGroupv Target: BizTalkServerv Example: source="IBMESX3-ITM-V31:QB-BiztalkGroup" contains target="IBMESX3-ITM-V31:QB-

ibmesx3-itm-v31-BizTalkServer"

containsv Source: BizTalkGroupv Target: BizTalkHostv Example: source="IBMESX3-ITM-V31:QB-BiztalkGroup" contains target="IBMESX3-ITM-V31:QB-

newww-BizTalkHost"

containsv Source: BizTalkGroupv Target: MessageBoxv Example: source="IBMESX3-ITM-V31:QB-BiztalkGroup" contains target="IBMESX3-ITM-V31:QB-

messagebox:ibmesx3-itm-v31-MessageBox"

managedViav Source: BizTalkGroupv Target: app.db.mssql.SqlServerDatabasev Example: source="IBMESX3-ITM-V31:QB-BiztalkGroup" managedVia target="IBMESX3-ITM-

V31:QB-BizTalkMgmtDb-SqlServerDatabase"

containsv Source: app.db.mssql.SqlServerv Target: app.db.mssql.SqlServerDatabasev Example: source="IBMESX3-ITM-V31:QB-IBMESX3-ITM-V31-SqlServer" contains

target="IBMESX3-ITM-V31:QB-BizTalkMgmtDb-SqlServerDatabase"

accessedViav Source: app.db.mssql.SqlServerv Target: net.BindAddress


v Example: source="IBMESX3-ITM-V31:QB-IBMESX3-ITM-V31-SqlServer" accessedViatarget="IBMESX3-ITM-V31:QBServiceList. MSSQLSERVER-0"

bindsTov Source: net.BindAddressv Target: net.IpV4Addressv Example: source="IBMESX3-ITM-V31:QB-ServiceList.MSSQLSERVER-0" bindsTo

target="IBMESX3-ITM-V31:QB- 10.77.69.33-DatabaseServerIPv4"

bindsAsPrimaryv Source: net.BindAddressv Target: net.IpV4Addressv Example: source="IBMESX3-ITM-V31:QB-ServiceList.MSSQLSERVER-0" bindsAsPrimary

target="IBMESX3-ITM-V31:QB- 10.77.69.33-DatabaseServerIPv4"

CDM attributes, agent attributes, descriptions, and examples

v CDM attribute: OnlineMessageBoxesAgent attribute: KQBORCHEST.Online_MessageBox_DatabasesDescription: The number of MessageBox databases that are currently available to theapplication.Example: 1

BizTalkServer classThis class represents the Microsoft BizTalk Server. A single BizTalk Server can exist within a BizTalkgroup, and a BizTalk Server can be a part of only one BizTalk group.

CDM class nameApp.biztalk.BizTalkServer

Relationships

containsv Source: BizTalkGroupv Target: BizTalkServerv Example: source="IBMESX3-ITM-V31:QB-BiztalkGroup" contains target="IBMESX3-ITM-V31:QB-

ibmesx3-itm-v31- BizTalkServer"

runsOnv Source: BizTalkHostInstancev Target: BizTalkServerv Example: source="IBMESX3-ITM-V31:QB-newww-Microsoft BizTalk Server newww

ibmesx3-itm-v31-BiztalkHostInstance" runsOn target="IBMESX3-ITM-V31:QB-ibmesx3-itm-v31-BizTalkServer"


v CDM attribute: NameAgent attribute: KQBHSTINST.Server_NameDescription: The name of the Microsoft BizTalk Server.Example: System_Name

BizTalkHost classThis class represents the BizTalk Host. The BizTalk Host object represents a logical set of zero or moreruntime processes to deploy services, pipelines, and other artifacts.

CDM class nameApp.biztalk.BizTalkHost

Appendix B. Discovery Library Adapter for the Microsoft BizTalk Server agent 323

Relationships

containsv Source: BizTalkGroupv Target: BizTalkHostv Example: source="IBMESX3-ITM-V31:QB-BiztalkGroup" contains target="IBMESX3-ITM-V31:QB-

newww-BizTalkHost"

deployedTov Source: BizTalkHostv Target: BizTalkHostInstancev Example: source="IBMESX3-ITM-V31:QB-newww-BizTalkHost" deployedTo target="IBMESX3-ITM-

V31:QB-newww-Microsoft BizTalk Server newww ibmesx3-itm-v31-BiztalkHostInstance"


v CDM attribute: NameAgent attribute: KQBSVRHST.Host_NameDescription: The name of the BizTalk Host.Example: biztalkserverapplication

BiztalkHostInstance classThis class represents the BizTalk Host. The BizTalk Host object represents a logical set of zero or moreruntime processes to deploy services, pipelines, and other artifacts.

CDM class nameApp.biztalk.BizTalkHostInstance

Relationships

runsOnv Source: BizTalkHostInstancev Target: BizTalkServerv Example: source="IBMESX3-ITM-V31:QB-newww-Microsoft BizTalk Server newww

ibmesx3-itm-v31-BiztalkHostInstance" runsOn target="IBMESX3-ITM-V31:QB-ibmesx3-itm-v31-BizTalkServer"

deployedTov Source: BizTalkHostv Target: BizTalkHostInstancev Example: source="IBMESX3-ITM-V31:QB-newww-BizTalkHost" deployedTo target="IBMESX3-ITM-

V31:QB-newww-Microsoft BizTalk Server newww ibmesx3-itm-v31-BiztalkHostInstance"


v CDM attribute: NameAgent attribute: KQBHSTGRP.HOSTINSTDescription: The name of the host instance.Example: Microsoft BizTalk Server BizTalkServerApplication ibmesx3-itm-v31

v CDM attribute: DocumentsProcessedAgent attribute: KQBMESSAG1.Documents_ProcessedDescription: The number of documents that have been processed since the application wasstarted.Example: 2000

v CDM attribute: DocumentsReceivedAgent attribute: KQBMESSAG1.Documents_ReceivedDescription: The number of documents that were received since the application was started.


Example: 2500v CDM attribute: DocumentsSuspended

Agent attribute: KQBMESSAG1.Documents_SuspendedDescription: The number of documents that were suspended since the application wasstarted.Example: 26

v CDM attribute: ThrottledReceiveBatchesAgent attribute: KQBMESSAG1.Throttled_Receive_BatchesDescription: The number of batches that were blocked by the Messaging Engine due to ahigh service load. These batches contain new messages to be processed.Example: 1

MessageBox classThis class represents the MessageBox database.

CDM class nameApp.biztalk.MessageBox

Relationships

containsv Source: BizTalkGroupv Target: MessageBoxv Example: source="IBMESX3-ITM-V31:QB-BiztalkGroup" contains target="IBMESX3-ITM-V31:QB-

messagebox:ibmesx3-itm-v31-MessageBox"


v CDM attribute: SpoolSizeAgent attribute: KQBMSGBOXG.Spool_SizeDescription: The size of the spool on a particular message box on a particular server.Example: 39

v CDM attribute: NameAgent attribute: KQBMSGBOXG.NameDescription: The name of the MessageBox database.Example: biztalkmsgboxdb:ps4210

BizTalkReceiveAdapter classThis class represents the receive adapter that the BizTalk Server uses to communicate with other systems,ranging from transport protocols, such as FTP, web services, and MQSeries to high-end businessapplications, such as PeopleSoft, SAP, and Siebel.

CDM class nameApp.biztalk.BizTalkReceiveAdapter

Relationships

containsv Source: BizTalkGroupv Target: BizTalkReceiveAdapterv Example: source="PS6877:QB-BiztalkGroup" contains target="PS6877:QB-

BizTalkServerApplication-FILE_RECEIVE_ADAPTER"


v CDM attribute: NameAgent attribute: KQBFILERCV.NameDescription: The name of the receive adapter.

Appendix B. Discovery Library Adapter for the Microsoft BizTalk Server agent 325

Example: FileReceivev CDM attribute: MessagesReceived

Agent attribute: KQBFILERCV.MessagesReceivedDescription: The number of messages that are received by the receive adapter.Example: 10

BizTalkSendAdapter classThis class represents the send adapter that the BizTalk Server uses to communicate with other systems,ranging from transport protocols, such as FTP, web services, and MQSeries to high-end businessapplications, such as PeopleSoft, SAP, and Siebel.

CDM class nameApp.biztalk.BizTalkSendAdapter

Relationships

containsv Source: BizTalkGroupv Target: BizTalkSendAdapterv Example: source="PS6877:QB-BiztalkGroup" contains target="PS6877:QB-

BizTalkServerApplication-FILE_SEND_ADAPTER"


v CDM attribute: NameAgent attribute: KQBFILESND.NameDescription: The name of the send adapter.Example: FileSend

v CDM attribute: MessagesSentAgent attribute: KQBFILESND.MessagesSentDescription: The number of messages that are sent by the send adapter.Example: 10


Appendix C. Integration with Tivoli Business Service Manager

Microsoft BizTalk Server agent provides data to create, update the status of, and view IBM TivoliBusiness Service Manager services.

The Tivoli Management Services Discovery Library Adapter (DLA) and Discovery Library Toolkitprovides data for the Tivoli Business Service Manager service models. The Tivoli Event IntegrationFacility (EIF) probe updates the status of these services, and you use the Tivoli Enterprise Portal to viewthe data for the services. To implement the integration of the agent with Tivoli Business Service Manager,perform the integration tasks.

Components for integrating with Tivoli Business Service ManagerThe data for integrating with Tivoli Business Service Manager is supplied through the followingcomponents: Tivoli Management Services Discovery Library Adapter (DLA) and Discovery LibraryToolkit, Tivoli Event Integration Facility (EIF) probe, and Tivoli Enterprise Portal.

Tivoli Management Services Discovery Library Adapter (DLA) and DiscoveryLibrary Toolkit

By using data from the Tivoli Management Services Discovery Library Adapter, you can build TivoliBusiness Service Manager service models that include resources monitored by the Microsoft BizTalkServer agent.

The DLA files can be imported directly into Tivoli Business Service Manager using the Discovery LibraryToolkit or they can be loaded into IBM Tivoli Application Dependency Discovery Manager (TADDM) andthen fed into Tivoli Business Service Manager using the Discovery Library Toolkit.

See the following sources for more information about the DLA and Discovery Library Toolkit:v Resources and relationships that are discovered by the Microsoft BizTalk Server agent and included in

Tivoli Management Services DLA files: Appendix B, “Discovery Library Adapter for the MicrosoftBizTalk Server agent,” on page 321

v Using the Tivoli Management Services DLA: IBM Tivoli Monitoring Administrator's Guide

v Using the Discovery Library Toolkit: Tivoli Business Service Manager Customization Guide

Tivoli Event Integration Facility (EIF) probe

Situation events detected by the Microsoft BizTalk Server agent can update the status of services in TivoliBusiness Service Manager.

The situation events are forwarded from IBM Tivoli Monitoring to the Netcool/OMNIbus Probe for theTivoli Event Integration Facility. The Microsoft BizTalk Server agent provides a probe rules file thatupdates its events with information to identify the affected service in Tivoli Business Service Manager.The EIF probe then forwards the events to the Netcool/OMNIbus ObjectServer. Tivoli Business ServiceManager monitors the Netcool/OMNIbus ObjectServer for new events and updates the status of affectedservices.

See the following sources for more information about event integration:v Installation (using an existing EIF probe and Netcool/OMNIbus ObjectServer installation or using

Tivoli Business Service Manager to install these components): Netcool/OMNIbus Information Center orthe Tivoli Business Service Manager Installation Guide.


v Setting up event integration between IBM Tivoli Monitoring, the EIF probe, and the Netcool/OMNIbusObjectServer: IBM Tivoli Monitoring Installation and Setup Guide.

v Configuring the EIF probe to use the Microsoft BizTalk Server agent rules file after the EIF probe hasbeen installed and configured for event integration with IBM Tivoli Monitoring: “Configuring theTivoli Event Integration Facility (EIF) probe to enrich events”

Tivoli Enterprise Portal

You can use the integration of the Tivoli Enterprise Portal with Tivoli Business Service Manager to viewthe services in the Tivoli Business Service Manager console.

For more detailed examination and analysis, you can easily link from the Tivoli Business Service Managerconsole to the Tivoli Enterprise Portal to view the data within the Microsoft BizTalk Server agent.

Tasks to integrate the agent with Tivoli Business Service ManagerTo integrate the Microsoft BizTalk Server agent with Tivoli Business Service Manager, you must installand configure the required components. Then, you can view the data in the Tivoli Enterprise Portal.

To integrate the Microsoft BizTalk Server agent with Tivoli Business Service Manager and view the data,complete the following tasks:v Install the Discovery Library Toolkit on theTivoli Business Service Manager server.v Configure the Tivoli Event Integration Facility (EIF) probe to enrich Microsoft BizTalk Server agent

events.v Create a service in the Tivoli Business Service Manager console that you want to monitor.v Create a data source mapping for each data source that you want to access within the Tivoli Business

Service Manager.v Configure an additional IBM Tivoli Monitoring web service for each Tivoli Enterprise Portal Server.v View data in the Tivoli Enterprise Portal for the services that you have created to monitor through

Tivoli Business Service Manager.

Installing the Discovery Library Toolkit on the Tivoli Business ServiceManagerYou must install the Discovery Library Toolkit on the Tivoli Business Service Manager server.

The Discovery Library Toolkit imports data from the DLA files and TADDM, which includes informationabout the hardware and the applications that are discovered by the source.

See "Installing the Discovery Library Toolkit" in the Tivoli Business Service Manager Installation Guide.

Configuring the Tivoli Event Integration Facility (EIF) probe to enricheventsThe Netcool/OMNIbus Probe for Tivoli Event Integration Facility (EIF) forwards the Microsoft BizTalkServer agent events that are received from IBM Tivoli Monitoring to the Netcool/OMNIbus ObjectServer.Tivoli Business Service Manager monitors the Netcool/OMNIbus ObjectServer for new events, andupdates the status of affected services. The Microsoft BizTalk Server agent provides a probe rules includefile that updates its events with information to identify the affected service in Tivoli Business ServiceManager.


Before you begin

Install and configure the Netcool/OMNIbus ObjectServer and EIF probe and set up event integrationbetween IBM Tivoli Monitoring and Netcool/OMNIbus.

About this task

To enable event enrichment, configure the EIF probe to use the rules file for the agent.

Procedure1. Locate the Microsoft BizTalk Server agent rules file (kqb_tbsm.rules) on a computer system where the

Microsoft BizTalk Server agent, Tivoli Enterprise Monitoring Server, or Tivoli Enterprise Portal Serveris installed. The file is in the following locations:v On Windows systems

The file is in the installdir\cms\TECLIB directory of the monitoring server, in theinstalldir\cnps\TECLIB directory of the portal server, or in the installdir\TMAITM6\EIFLIBdirectory of the agent, where installdir is the IBM Tivoli Monitoring or ITCAM for MicrosoftApplications installation directory.

v On Linux and UNIX systemsThe file is in the installdir/tables/cicatrsq/TECLIB directory of the monitoring server or in theinstalldir/platform/xx/TECLIB directory of the agent, where installdir is the IBM Tivoli Monitoringor ITCAM for Microsoft Applications directory, platform is the architecture directory for the agent,and xx is the product code for the agent.

2. Copy the kqb_tbsm.rules file to the following directory on the computer system where the EIF probeis installed:v On Windows systems

%OMNIHOME%\probes\arch

v On UNIX systems$OMNIHOME/probes/arch

Where:

OMNIHOMESystem-defined variable defining the installation location of Netcool/OMNIbus

arch Operating system directory where the probe is installed; for example, solaris2 when runningon a Solaris system, and win32 for a Windows system.

3. Edit the tivoli_eif.rules file and uncomment the include statement for kqb_tbsm.rules. (Thetivoli_eif.rules file is located in the same directory as the kqb_tbsm.rules file.) If you are using aversion of the tivoli_eif.rules file without an include statement for kqb_tbsm.rules, add thefollowing line after the include statement for itm_event.rules:include "kqb_tbsm.rules"

4. Restart the EIF probe.

Creating a service in Tivoli Business Service ManagerYou must create a service in the Tivoli Business Service Manager console for each service that you wantto monitor.

To create the services that you want to monitor in the Tivoli Business Service Manager console, see"Configuring services" in the IBM Tivoli Business Service Manager Service Configuration Guide.

Appendix C. Integration with Tivoli Business Service Manager 329

Creating a data source mapping for each data sourceYou can create a data source mapping for each data source that you want to access within Tivoli BusinessService Manager.

Also, you can create the data fetchers and use the data to create incoming status rules that are populatedin your service templates.

For more information, see "Data sources" and "Data fetchers" in the IBM Tivoli Business Service ManagerService Configuration Guide.

Configuring additional IBM Tivoli Monitoring web servicesYou can configure additional IBM Tivoli Monitoring web services for each Tivoli Enterprise Portal Server.

To configure an additional IBM Tivoli Monitoring web service for each Tivoli Enterprise Portal server, see"Configure TBSM charts" in the IBM Tivoli Business Service Manager Scenarios Guide.

Viewing data in the Tivoli Enterprise PortalFrom Tivoli Business Service Manager, you can open the Tivoli Enterprise Portal and view the MicrosoftBizTalk Server agent.

You can also launch Tivoli Business Service Manager from the Tivoli Enterprise Portal.

For more information about launching applications, see "Launching to and from applications" in the TivoliBusiness Service Manager Customization Guide.


Appendix D. Documentation library

A variety of publications are relevant to the use of the IBM Tivoli Composite Application Manager forMicrosoft Applications: Microsoft BizTalk Server Agent.

The IBM Tivoli Monitoring, OMEGAMON XE, and Composite Application Manager products: DocumentationGuide contains information about accessing and using publications. You can find the DocumentationGuide in the following information centers:v IBM Tivoli Monitoring and OMEGAMON® XE (http://publib.boulder.ibm.com/infocenter/tivihelp/

v15r1/index.jsp)v IBM Tivoli Composite Application Manager (http://publib.boulder.ibm.com/infocenter/tivihelp/

v24r1/index.jsp)

To open the Documentation Guide in the information center, select Using the publications in theContents pane.

To find a list of new and changed publications, click What's new in the information center on theWelcome page of the IBM Tivoli Monitoring and OMEGAMON XE Information Center.

To find publications from the previous version of a product, click Previous versions under the name ofthe product in the Contents pane.

IBM Tivoli Composite Application Manager for Microsoft Applications: MicrosoftBizTalk Server Agent library

The documentation for this agent and other product components is located in the IBM Tivoli CompositeApplication Manager for Microsoft Applications Information Center (http://publib.boulder.ibm.com/infocenter/tivihelp/v24r1/topic/com.ibm.itcamms.doc_6.3/welcome_msapps63.html).

One document is specific to the Microsoft BizTalk Server agent. The IBM Tivoli Composite ApplicationManager for Microsoft Applications: Microsoft BizTalk Server Agent User’s Guide provides agent-specificinformation for configuring, using, and troubleshooting the Microsoft BizTalk Server agent.

The Offering Guide also provides information about installing and configuring the component products inthe offering.

The Prerequisites topic in the information center contains information about the prerequisites for eachcomponent.

Use the information in the user's guide for the agent with the Tivoli Enterprise Portal User's Guide tomonitor Microsoft BizTalk Server resources.

Prerequisite publicationsTo use the information in this publication effectively, you must have some prerequisite knowledge.

See the following publications to gain the required prerequisite knowledge:v IBM Tivoli Monitoring Administrator's Guide

v IBM Tivoli Monitoring Agent Builder User's Guide

v IBM Tivoli Monitoring Command Reference

v IBM Tivoli Management Services on z/OS: Configuring the Tivoli Enterprise Monitoring Server on z/OS


http://publib.boulder.ibm.com/infocenter/tivihelp/v15r1/index.jsp

http://publib.boulder.ibm.com/infocenter/tivihelp/v24r1/index.jsp



v IBM Tivoli Monitoring Installation and Setup Guide

v IBM Tivoli Monitoring High Availability Guide for Distributed Systems

v IBM Tivoli Monitoring: Messages

v IBM Tivoli Monitoring Troubleshooting Guide

v IBM Tivoli Monitoring Universal Agent User's Guide

v IBM Tivoli Universal Agent API and Command Programming Reference Guide

v IBM Tivoli Monitoring: i5/OS™ Agent User's Guide

v IBM Tivoli Monitoring: Linux OS Agent User's Guide

v IBM Tivoli Monitoring: UNIX OS Agent User's Guide

v IBM Tivoli Monitoring: UNIX Logs OS Agent User's

v IBM Tivoli Monitoring: Windows OS Agent User's Guide

v Tivoli Enterprise Portal User's Guide

v Tivoli Performance Analyzer User's Guide

v IBMTivoli Warehouse Proxy Agent User's Guide

v IBMTivoli Warehouse Summarization and Pruning Agent User's Guide

Related publicationsThe publications in related information centers provide useful information.

See the following information centers, which you can find by accessing Tivoli Documentation Central(http://www.ibm.com/developerworks/wikis/display/tivolidoccentral/Home):v IBM Tivoli Monitoringv IBM Tivoli Netcool/OMNIbusv IBM Tivoli Application Dependency Discovery Managerv IBM Tivoli Enterprise Console

Other sources of documentationYou can obtain additional technical documentation about monitoring products from other sources.

See the following sources of technical documentation about monitoring products:v Service Management Connect (SMC)

See the introductory information about SMC (http://www.ibm.com/developerworks/servicemanagement/).For information about Tivoli products, see the Application Performance Management community onSMC (http://www.ibm.com/developerworks/servicemanagement/apm/index.html).Connect, learn, and share with Service Management professionals. Get access to developers andproduct support technical experts who provide their perspectives and expertise. You can use SMC forthese purposes:– Become involved with transparent development, an ongoing, open engagement between external

users and developers of Tivoli products where you can access early designs, sprint demos, productroadmaps, and pre-release code.

– Connect one-on-one with the experts to collaborate and network about Tivoli and Integrated ServiceManagement.

– Benefit from the expertise and experience of others using blogs.– Collaborate with the broader user community using wikis and forums.


http://www.ibm.com/developerworks/wikis/display/tivolidoccentral/Home

http://www.ibm.com/developerworks/servicemanagement/



v IBM Integrated Service Management Library (http://www.ibm.com/software/brandcatalog/ismlibrary/) is an online catalog that contains integration documentation as well as otherdownloadable product extensions.

v IBM Redbook publications (http://www.redbooks.ibm.com/) include Redbooks® publications,Redpapers, and Redbooks technotes that provide information about products from platform andsolution perspectives.

v Technotes (http://www.ibm.com/support/entry/portal/software), which are found through the IBMSoftware Support website, provide the latest information about known product limitations andworkarounds.

v Tivoli wikisTivoli Wiki Central (http://www.ibm.com/developerworks/wikis/display/tivoli/Home) is the homefor interactive wikis that offer best practices and scenarios for using Tivoli products. The wikis containwhite papers contributed by IBM employees, and content created by customers and business partners.Two of these wikis are of particular relevance to IBM Tivoli Monitoring:– Tivoli Distributed Monitoring and Application Management Wiki (http://www-10.lotus.com/ldd/

tivmonitorwiki.nsf) provides information about IBM Tivoli Monitoring and related distributedproducts, including IBM Tivoli Composite Application Manager products.

– Tivoli System z® Monitoring and Application Management Wiki (http://www.ibm.com/developerworks/wikis/display/tivoliomegamon/Home) provides information about theOMEGAMON XE products, Tivoli NetView® for z/OS, Tivoli Monitoring Agent for z/TPF, andother System z monitoring and application management products.

Appendix D. Documentation library 333

http://www.ibm.com/software/brandcatalog/ismlibrary/

http://www.redbooks.ibm.com/

http://www.ibm.com/support/entry/portal/software

http://www.ibm.com/developerworks/wikis/display/tivoli/Home

http://www-10.lotus.com/ldd/tivmonitorwiki.nsf

http://www.ibm.com/developerworks/wikis/display/tivoliomegamon/Home

Accessibility

Accessibility features help users with physical disabilities, such as restricted mobility or limited vision, touse software products successfully.

The major accessibility features in this product enable users in the following ways:v Use assistive technologies, such as screen-reader software and digital speech synthesizer, to hear what

is displayed on the screen. Consult the product documentation of the assistive technology for detailson using those technologies with this product.

v Operate specific or equivalent features using only the keyboard.v Magnify what is displayed on the screen.

In addition, the product documentation was modified to include the following features to aidaccessibility:v All documentation is available in both HTML and convertible PDF formats to give the maximum

opportunity for users to apply screen-reader software.v All images in the documentation are provided with alternative text so that users with vision

impairments can understand the contents of the images.

Navigating the interface using the keyboard

Standard shortcut and accelerator keys are used by the product and are documented by the operatingsystem. See the documentation provided by your operating system for more information.

Magnifying what is displayed on the screen

You can enlarge information in the product windows using facilities provided by the operating systemson which the product is run. For example, in a Microsoft Windows environment, you can reduce theresolution of the screen to enlarge the font sizes of the text on the screen. See the documentationprovided by your operating system for more information.


Notices

This information was developed for products and services offered in the U.S.A. IBM may not offer theproducts, services, or features discussed in this document in other countries. Consult your local IBMrepresentative for information on the products and services currently available in your area. Anyreference to an IBM product, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product, program, or service thatdoes not infringe any IBM intellectual property right may be used instead. However, it is the user'sresponsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in thisdocument. The furnishing of this document does not give you any license to these patents. You can sendlicense inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785 U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual PropertyDepartment in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan, Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any other country where suchprovisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOTLIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY ORFITNESS FOR A PARTICULAR PURPOSE.

Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore,this statement might not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodicallymade to the information herein; these changes will be incorporated in new editions of the publication.IBM may make improvements and/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not inany manner serve as an endorsement of those Web sites. The materials at those Web sites are not part ofthe materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate withoutincurring any obligation to you.


Licensees of this program who wish to have information about it for the purpose of enabling: (i) theexchange of information between independently created programs and other programs (including thisone) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Corporation2Z4A/10111400 Burnet RoadAustin, TX 78758 U.S.A.

Such information may be available, subject to appropriate terms and conditions, including in some casespayment of a fee.

The licensed program described in this document and all licensed material available for it are providedby IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement orany equivalent agreement between us.

Any performance data contained herein was determined in a controlled environment. Therefore, theresults obtained in other operating environments may vary significantly. Some measurements may havebeen made on development-level systems and there is no guarantee that these measurements will be thesame on generally available systems. Furthermore, some measurement may have been estimated throughextrapolation. Actual results may vary. Users of this document should verify the applicable data for theirspecific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, theirpublished announcements or other publicly available sources. IBM has not tested those products andcannot confirm the accuracy of performance, compatibility or any other claims related to non-IBMproducts. Questions on the capabilities of non-IBM products should be addressed to the suppliers ofthose products.

All statements regarding IBM's future direction or intent are subject to change or withdrawal withoutnotice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subject to change withoutnotice. Dealer prices may vary.

This information is for planning purposes only. The information herein is subject to change before theproducts described become available.

This information contains examples of data and reports used in daily business operations. To illustratethem as completely as possible, the examples include the names of individuals, companies, brands, andproducts. All of these names are fictitious and any similarity to the names and addresses used by anactual business enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which illustrate programmingtechniques on various operating platforms. You may copy, modify, and distribute these sample programsin any form without payment to IBM, for the purposes of developing, using, marketing or distributingapplication programs conforming to the application programming interface for the operating platform forwhich the sample programs are written. These examples have not been thoroughly tested under allconditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of theseprograms. You may copy, modify, and distribute these sample programs in any form without payment toIBM for the purposes of developing, using, marketing, or distributing application programs conformingto IBM‘s application programming interfaces.


Each copy or any portion of these sample programs or any derivative work, must include a copyrightnotice as follows:

© IBM 2009. Portions of this code are derived from IBM Corp. Sample Programs. © Copyright IBM Corp.2009. All rights reserved.

If you are viewing this information in softcopy form, the photographs and color illustrations might not bedisplayed.

TrademarksIBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of International BusinessMachines Corp., registered in many jurisdictions worldwide. Other product and service names might betrademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at"Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/orits affiliates.

Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.

Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, orboth.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Intel is a trademark or registered trademark of Intel Corporation or its subsidiaries in the United Statesand other countries.

Notices 339

Index

Aaccessibility 335Active Application Domains attribute 131Active Instance Count attribute 87Active Receive Locations attribute 113Active Receive Threads attribute 113Active Send Messages attribute 114Active Send Threads attribute 114Active Sessions attribute 149activities 241Activity Flows Retrieved attribute 104Adapters

situations 196workspaces

descriptions 23Adapters workspace 23additional information

attributes 39situations 193Take Action commands 221Workspaces 21

agentfunctions 1problems and workarounds 268

Agent Management Services 5Allocated Private Memory In MB attribute 134Allocated Virtual Memory In MB attribute 135Application Component attribute 45Application Name attribute 44Application Status attribute 44Application Status attribute group 44attribute group 43attribute groups

Application Status 44Availability 45BAM Database 49BAM Interceptor 50BizTalk Group Server Host 52BizTalk Host 54BizTalk NET Adapter for Oracle DB 55BizTalk NET Adapter for Oracle EBusiness Suite 56BizTalk NET Adapter for SAP 57BizTalk NET Adapter for Siebel 58BizTalk NET Adapter for SQL 60BizTalk Server 61Delivery Channels 62Distributors 63Event Log 65Event Providers 67Events 69File Receive Adapter 71File Send Adapter 75FTP Receive Adapter 78FTP Send Adapter 81Generator 83Host Throttling 87HTTP Receive Adapter 98HTTP Send Adapter 101Human Workflow Services 103list of all 39Management Database 105

attribute groups (continued)Message Box General Counters 106Message Box Host Counters 110Messagebox Database 111Messaging 113Messaging Latency 119MSMQ Receive Adapter 121MSMQ Send Adapter 124Notifications 126Orchestration Status 129Orchestrations 131overview 39Performance Object Status 144POP3 Receive Adapter 148Receive Location Status 151RFID Devices 153RFID Processes 155Rule Engine Database 157Send Port Group Status 158Send Port Status 159Service Instance Status and Class 161Single Sign On Database 163SMTP Send Adapter 163SOAP Receive Adapter 165SOAP Send Adapter 166SQL Receive Adapter 167SQL Send Adapter 169Subscribers 170Subscriptions 172TDDS 173Tracking Database 179Vacuumer 179Windows SharePoint Services 181Windows SharePoint Services Adapter 185

attributes 43Active Application Domains 131Active Instance Count 87Active Receive Locations 113Active Receive Threads 113Active Send Messages 114Active Send Threads 114Active Sessions 149Activity Flows Retrieved 104additional information 39Allocated Private Memory In MB 134Allocated Virtual Memory In MB 135Application Component 45Application Name 44Application Status 44Availability 45Average Batch Factor 132Average Collection Duration 147Avg Extraction sec per BAM Event 50Avg Failed BAM Events per Flush 51Avg Flush sec per BAM Event 51Avg Successful BAM Events per Flush 51BAM Database 49BAM Interceptor 50Batches 127Batches Awaiting Distribution 127Batches Being Processed 174


attributes (continued)Batches Committed 174Batches Expired 127Batches Failed Delivery 128Batches In Retry 128Batches Successfully Delivered 128BizTalk Group Server Host 52BizTalk Host 54BizTalk NET Adapter for Oracle DB 55BizTalk NET Adapter for Oracle EBusiness Suite 56BizTalk NET Adapter for SAP 57BizTalk NET Adapter for Siebel 58BizTalk NET Adapter for SQL 60BizTalk Server 61Bytes Received Per Sec 74, 80, 123, 150Bytes Received Per Sec (Superseded) 71, 79, 121, 149Bytes Sent Per Sec 77, 82, 125Bytes Sent Per Sec (Superseded) 76, 81, 124Cache Hit Percent 148Cache Hits 148Cache Misses 148Change in Tracking Data Size 109Command Line 48Completed Periods 180Database Name 50, 106, 112, 158, 163, 179Database Session 87Database Session Threshold 88Database Size 88Database Transactions 132Database Transactions Per Sec 132Dehydratable Orchestrations 133Dehydrating Orchestrations 133Dehydration Cycle In Progress 133Dehydration Cycles 133Dehydration Threshold 134Delete Retries 72Delivery Channels 62Delivery Requests Failed 64Delivery Requests Succeeded 64Disable New Message Publication 112Distributors 63Documents Processed 114Documents Processed Per Sec 114Documents Received 115Documents Received Per Sec 115Documents Resubmitted 115Documents Submitted Per Batch 118Documents Submitted Per Batch (Superseded) 116Documents Suspended 116Documents Suspended Per Sec 116Documents Transmitted Per Batch 118Documents Transmitted Per Batch (Superseded) 117Downtime 154Error Code 145Error Description 162Errors Raised 155Errors Raised Per Sec 155Event Batches Aborted 68Event Batches Awaiting Generation 70Event Batches Committed 68Event Batches In Collection 70Event Batches Submitted 70Event Category 66Event ID 66Event Log 65Event Providers 67Event Source 66

attributes (continued)Event Type 66Events 69Events Being Processed 174Events Committed 175Events Per Batch 68Events Received 68Events Received Per Second 69File Receive Adapter 71File Send Adapter 76Format Requests Failed 64Format Requests Succeeded 64FTP Receive Adapter 78FTP Send Adapter 81Full Name 46Functionality Test Message 49Functionality Test Status 48Generator 83Group Name 53, 54, 61High Database Session 88High Database Size 89High In Process Message Count 89High Message Delivery Rate 89High Message Publishing Rate 90High Process Memory 90High System Memory 90High Thread Count 90Host Instance 53Host Instance Status 53Host Name 53, 54, 130, 161Host Queue Instance State Msg Refs Length 110Host Queue Length 110Host Queue Number of Instances 111Host Queue Suspended Msgs Length 111Host Throttling 87HTTP Receive Adapter 98HTTP Send Adapter 101Human Workflow Services 103Idle Orchestrations 134In Process Message Count 91In Process Message Count Threshold 91Inbound Latency In MS 119Instance ID 161Instances Total Number 106Intervals Skipped 148Is Dynamic 160Is Master Message Box 112Is Primary 152Is TwoWay 160Kilobytes Received 75, 80, 123, 151Kilobytes Received (Superseded) 74, 80, 122, 150Kilobytes Sent 78, 83, 126Kilobytes Sent (Superseded) 77, 82, 125Last Collection Duration 147Last Collection Finished 147Last Collection Start 147LOB Time 55, 56, 57, 59, 60LOB Time Delta 55, 57, 58, 59, 60Lock Failures 74Lock Failures (Superseded) 72Lock Failures Per Sec 75Lock Failures Per Sec (Superseded) 72Log Name 66Management Database 105Memory Queue Size 98, 101Message 67Message Box General Counters 106


attributes (continued)Message Box Host Counters 110Message Delivery Delay In Sec 91Message Delivery Incoming Rate 92Message Delivery Outgoing Rate 92Message Delivery Throttling State 92Message Delivery Throttling State Duration In Min 93Message Delivery Throttling User Override 93Message Publishing Delay In Sec 93Message Publishing Incoming Rate 94Message Publishing Outgoing Rate 94Message Publishing Throttling State 94Message Publishing Throttling State Duration In Min 95Message Publishing Throttling User Override 95Messagebox Database 112MessageBox Databases Connection Failures 135Messages Received 73, 79, 99, 102, 122, 149, 165, 168Messages Received Per Sec 73, 79, 99, 102, 122, 150, 166,

168Messages Sent 76, 81, 99, 102, 124, 164, 167, 169Messages Sent Per Sec 77, 82, 100, 103, 125, 164, 167, 169Messages Written To Transport 62Messages Written To Transport Rate 62Messaging 113Messaging Latency 119MsgBox Dead Processes Cleanup Purge Jobs 107MsgBox Msg Cleanup Purge Jobs 107MsgBox Parts Cleanup Purge Jobs 107MsgBox Purge Subscriptions Job Purge Jobs 108MSMQ Receive Adapter 121MSMQ Send Adapter 124Name 45, 52, 56, 57, 58, 59, 61, 62, 63, 67, 70, 75, 78, 80,

83, 84, 98, 101, 103, 109, 111, 119, 121, 123, 126, 127, 143,151, 155, 157, 165, 166, 167, 168, 170, 172, 178, 180, 188

New Action Added 104New Activity Flows 104Node 44, 45, 49, 50, 53, 54, 55, 56, 57, 58, 60, 61, 62, 63, 66,

67, 69, 71, 76, 78, 81, 83, 87, 98, 101, 103, 105, 106, 110,112, 113, 119, 121, 124, 126, 130, 131, 144, 148, 151, 153,156, 158, 159, 161, 163, 164, 165, 166, 168, 169, 170, 172,173, 179, 181, 185

Notification Bodies 65Notification Headers 65Notifications 126, 128Notifications Failed Delivery 129Notifications Generated Per Second 84Notifications Successfully Delivered 129Number of Collections 148Object Name 144Object Status 145Object Type 144Online MessageBox Databases 135Orchestration Name 130Orchestration Status 130Orchestrations 131Orchestrations Completed 136Orchestrations Completed Per Sec 136Orchestrations Created 136Orchestrations Created Per Sec 136Orchestrations Dehydrated 137Orchestrations Dehydrated Per Sec 137Orchestrations Discarded 137Orchestrations Discarded Per Sec 138Orchestrations Rehydrated 138Orchestrations Rehydrated Per Sec 138Orchestrations Resident In Memory 139Orchestrations Scheduled For Dehydration 139

attributes (continued)Orchestrations Suspended 139Orchestrations Suspended Per Sec 139Outbound Adapter Latency In MS 120Outbound Latency In MS 120overview 39Page Faults per Sec 47Pending Messages 140Pending Receive Batches 117Pending Transmitted Messages 117Pending Work Items 140Percent Privileged Time 47Percent Processor Time 48Percent Receive Message Failures 182, 185Percent Send Message Failures 182, 186Percent Used Physical Memory 131Percent User Mode Time 48Percent Web Service Call Failures 182, 186Performance Object Status 144Persistence Points 140Persistence Points Per Sec 141Physical Memory Usage In MB 95PID 47POP3 Receive Adapter 148Primary Transport Address 161Process Memory Usage In MB 96Process Memory Usage Threshold In MB 96Process Uptime 156Quanta Behind 84Quanta Failed 84Quanta Processed 85Quanta Remaining 180Quanta Vacuumed 180Query Name 144Receive Handler 153Receive Location Name 152Receive Location Status 151Receive Port Name 152Records Being Processed 175Records Committed 175Refresh Interval 147Request Response Latency In MS 120Request Response Timeouts 117RFID Devices 153RFID Processes 155Rule Engine Database 158Rule Firing Failures 85Rule Firings 85Runnable Orchestrations 141Running Orchestrations 141Send Port Group Name 159Send Port Group Status 158Send Port Name 160Send Port Status 159Server Name 44, 50, 54, 61, 63, 65, 69, 71, 86, 98, 105, 106,

112, 129, 130, 153, 158, 159, 161, 162, 163, 171, 173, 179,181

Service Class 162Service Instance Status and Class 161Service Name 162Service Status 162Single Sign On Database 163Skipped Chronicle Rule Firings 86Skipped Quanta 86Skipped Subscription Rule Firings 86SMTP Send Adapter 164SOAP Receive Adapter 165

Index 343

attributes (continued)SOAP Send Adapter 166Spool Size 108SQL Receive Adapter 167SQL Send Adapter 169Status 45, 130, 152, 159, 160Steps Retrieved 104Subscribers 170Subscribers Added 171Subscribers Disabled 171Subscribers Enabled 171Subscriptions 172Subscriptions Added 172Subscriptions Disabled 172Subscriptions Enabled 173Tags Being Processed 156Tags In Queue 156Tags Processed 157Tags Read Per Sec 154Tags Suspended 157Tags Written Per Sec 154Tasks Retrieved 105TDDS 173Thread Count 47, 96Thread Count Threshold 96Throttled Receive Batches 118Time Generated 67Time To Add Message To Batch 100Time To Build Batch 73, 100Timeouts 181Timestamp 44, 45, 49, 50, 53, 54, 55, 56, 57, 59, 60, 61, 62,

63, 67, 69, 71, 76, 78, 81, 84, 87, 98, 101, 103, 106, 110, 112,113, 119, 121, 124, 126, 130, 131, 144, 149, 151, 153, 156,158, 159, 160, 161, 163, 164, 165, 166, 168, 169, 170, 172,173, 179, 180, 181, 185

Total Batches 177Total Batches (Superseded) 175Total Batches Committed 97Total Events 71, 177Total Events (Superseded) 176Total Failed BAM Events During Flush 52Total Failed Batches 177Total Failed Batches (Superseded) 176Total Failed Events 178Total Failed Events (Superseded) 176Total Messages Delivered 97Total Messages Published 97Total Receive Commit Failures 183, 186Total Receive Message Failures 183, 187Total Received Messages 183, 187Total Records 178Total Records (Superseded) 177Total Send Message Failures 184, 187Total Sent Messages 184, 187Total Successful BAM Events During Flush 52Total Tags Read 154Total Tags Written 153Total Web Service Call Failures 184, 188Tracked Msgs Copy Purge Jobs 108Tracking Data Size 109Tracking Database 179Tracking Spool Cleanup Purge Jobs 109Transactional Scopes Aborted 142Transactional Scopes Aborted Per Sec 142Transactional Scopes Committed 142Transactional Scopes Committed Per Sec 142Transactional Scopes Compensated 143

attributes (continued)Transactional Scopes Compensated Per Sec 143Transport Address 152Transport Type 152, 160Type 46Vacuumer 179Virtual Size 46Web Service Calls Per Sec 184, 188Windows SharePoint Services 181Windows SharePoint Services Adapter 185Working Set Size 47

Availabilitysituations 196workspaces

descriptions 27Availability attribute group 45Availability workspace 27Average Batch Factor attribute 132Average Collection Duration attribute 147Avg Extraction sec per BAM Event attribute 50Avg Failed BAM Events per Flush attribute 51Avg Flush sec per BAM Event attribute 51Avg Successful BAM Events per Flush attribute 51

BBAM Database attribute group 49BAM Interceptor attribute group 50BAM Interceptor workspace 28Batches attribute 127Batches Awaiting Distribution attribute 127Batches Being Processed attribute 174Batches Committed attribute 174Batches Expired attribute 127Batches Failed Delivery attribute 128Batches In Retry attribute 128Batches Successfully Delivered attribute 128BizTalk Group Server Host attribute group 52BizTalk Group Topology workspace 29BizTalk Host attribute group 54BizTalk NET Adapter for Oracle DB attribute group 55BizTalk NET Adapter for Oracle EBusiness Suite attribute

group 56BizTalk NET Adapter for SAP attribute group 57BizTalk NET Adapter for Siebel attribute group 58BizTalk NET Adapter for SQL attribute group 60BizTalk Server attribute group 61Business Activity Monitoring


descriptions 28Business Activity Monitoring workspace 28Bytes Received Per Sec (Superseded) attribute 71, 79, 121, 149Bytes Received Per Sec attribute 74, 80, 123, 150Bytes Sent Per Sec (Superseded) attribute 76, 81, 124Bytes Sent Per Sec attribute 77, 82, 125

CCache Hit Percent attribute 148Cache Hits attribute 148Cache Misses attribute 148calculate historical data disk space 189capacity planning for historical data 189Change in Tracking Data Size attribute 109


cluster environmentcreating a resource 18creating a service 19installing and configuring the monitoring agent 18making configuration changes 19requirements 17setting up the monitoring agent 17

Command Line attribute 48commands

tacmd addSystem 17Take Action 221

Completed Periods attribute 180components 4

IBM Tivoli Monitoring 4configuration

after installation 15agent 11fields 15problems and workarounds 264remote 17values 15

Configuration and Statussituations 199workspaces

descriptions 29Configuration and Status workspace 29configuring the monitoring agent 11, 15Current Status workspace 30

Ddata collection 7data sources 7Database Name attribute 50, 106, 112, 158, 163, 179Database Session attribute 87Database Session Threshold attribute 88Database Size attribute 88Database Transactions attribute 132Database Transactions Per Sec attribute 132Databases


descriptions 30Databases workspace 30Dehydratable Orchestrations attribute 133Dehydrating Orchestrations attribute 133Dehydration Cycle In Progress attribute 133Dehydration Cycles attribute 133Dehydration Details workspace 34Dehydration Status workspace 34Dehydration Threshold attribute 134Delete Retries attribute 72Delivery Channels and Event Providers workspace 28Delivery Channels attribute group 62Delivery Requests Failed attribute 64Delivery Requests Succeeded attribute 64descriptions 195detailed 258developerWorks website 332Disable New Message Publication attribute 112Discovery Library Adapter 327

See DLADiscovery Library Toolkit 327

installing 328disk capacity planning for historical data 189Distributors and Subscriptions workspace 28Distributors attribute group 63

DLA 321, 327data model 321

classes 321Document Transactions workspace 33documentation

See publicationsDocuments Processed attribute 114Documents Processed Per Sec attribute 114Documents Received attribute 115Documents Received Per Sec attribute 115Documents Resubmitted attribute 115Documents Submitted Per Batch (Superseded) attribute 116Documents Submitted Per Batch attribute 118Documents Suspended attribute 116Documents Suspended Per Sec attribute 116Documents Transmitted Per Batch (Superseded) attribute 117Documents Transmitted Per Batch attribute 118Downtime attribute 154

EEnable Receive Location action 221enhancements 3Error Code attribute 145Error Description attribute 162Errors Raised attribute 155Errors Raised Per Sec attribute 155event

mapping 297Event Batches Aborted attribute 68Event Batches Awaiting Generation attribute 70Event Batches Committed attribute 68Event Batches In Collection attribute 70Event Batches Submitted attribute 70Event Category attribute 66Event ID attribute 66Event Log


descriptions 30Event Log attribute group 65Event Log workspace 30Event Providers attribute group 67Event Source attribute 66Event Type attribute 66Events attribute group 69Events Being Processed attribute 174Events Committed attribute 175Events Per Batch attribute 68Events Received attribute 68Events Received Per Second attribute 69Events workspace 28

FFile Receive Adapter - Data Received workspace 24File Receive Adapter attribute group 71File Send Adapter attribute group 75File Send Adapter workspace 24Format Requests Failed attribute 64Format Requests Succeeded attribute 64FTP Receive Adapter attribute group 78FTP Receive Adapter workspace 24FTP Send Adapter attribute group 81FTP Send Adapter workspace 24Full Name attribute 46

Index 345

Functionality Test Message attribute 49Functionality Test Status attribute 48

GGenerator attribute group 83Generator workspace 29Group Name attribute 53, 54, 61

HHigh Database Session attribute 88High Database Size attribute 89High In Process Message Count attribute 89High Message Delivery Rate attribute 89High Message Publishing Rate attribute 90High Process Memory attribute 90High System Memory attribute 90High Thread Count attribute 90historical data

calculate disk space 189disk capacity planning 189

Host Instance attribute 53Host Instance Status attribute 53Host Name attribute 53, 54, 130, 161Host Queue Instance State Msg Refs Length attribute 110Host Queue Length attribute 110Host Queue Number of Instances attribute 111Host Queue Suspended Msgs Length attribute 111Host Throttling


descriptions 31Host Throttling attribute group 87Host Throttling Thresholds workspace 31Host Throttling workspace 31HTTP Receive Adapter attribute group 98HTTP Receive Adapter workspace 24HTTP Send Adapter attribute group 101HTTP Send Adapter workspace 25Human Workflow Services


descriptions 32Human Workflow Services attribute group 103Human Workflow Services workspace 32

IIBM Tivoli Monitoring 4

overview 1Idle Orchestrations attribute 134In Process Message Count attribute 91In Process Message Count Threshold attribute 91Inbound Latency In MS attribute 119include file 329installation

agent 11problems and workarounds 264remote 17

installing language packs 11installing the monitoring agent 11Instance ID attribute 161Instances Total Number attribute 106Integrated Service Management Library documentation 332

interfaceuser 6

Intervals Skipped attribute 148Is Dynamic attribute 160Is Master Message Box attribute 112Is Primary attribute 152Is TwoWay attribute 160

KKilobytes Received (Superseded) attribute 74, 80, 122, 150Kilobytes Received attribute 75, 80, 123, 151Kilobytes Sent (Superseded) attribute 77, 82, 125Kilobytes Sent attribute 78, 83, 126KQB_Adapter_SuspendsInboundMsg situation 208KQB_Adptr_Suspends_OutboundMsg situation 202KQB_BAM_Config_Changed_Info situation 212KQB_Biz_Base_EDI_Service_Down situation 196KQB_Biz_HostInstance_Srv_Down situation 196KQB_Biz_SP_Msg_Adapter_Down situation 198KQB_Biz_SSO_Service_Down situation 197KQB_BizRuleEngine_Service_Down situation 197KQB_BizTalk_DBConnection_Fail situation 202KQB_FileAdptr_FolderAccessFail situation 205KQB_FILESendAdptr_OpenFileFail situation 203KQB_Host_Inst_Crashed situation 216KQB_HostInstance_ConfigDB_Fail situation 204KQB_HT_High_Database_Session situation 216KQB_HT_High_Database_Size situation 217KQB_HT_High_InProcMessageCount situation 217KQB_HT_High_MsgDelivery_Rate situation 218KQB_HT_High_MsgPublishing_Rate situation 218KQB_HT_High_Process_Memory situation 219KQB_HT_High_System_Memory situation 219KQB_HT_High_Thread_Count situation 219KQB_HTTPSendAdaptr_ConnectFail situation 204KQB_Inbound_Msg_Proc_Failure situation 207KQB_Invalid_FileRecieveLoc situation 206KQB_Invalid_Receive_Loc_Config situation 201KQB_Msg_Resp_WithoutReq situation 208KQB_MsgEngine_FailToAddRecvLoc situation 206KQB_MsgEngine_FailToInit situation 209KQB_MsgEngine_FailToRegAdptr situation 210KQB_MsgEngine_SSOSrverConnFail situation 209KQB_MsgEngineFailToGetConfigDB situation 210KQB_MSMQTSubserviceFail situation 211KQB_No_Host_Instance situation 198KQB_Orchestrn_Stopped_Warning situation 199KQB_POP3_Authentication_Fail situation 203KQB_POP3_ServerConnection_Fail situation 203KQB_Rec_Loc_Stoped_Warning situation 200KQB_ReceiveLoc_ShutDown situation 207KQB_RecvFileAttr situation 211KQB_RecvLoc_Disabled situation 211KQB_RFID_Dev_StateSave_Fail situation 216KQB_RFID_Device_Conn_Fail situation 213KQB_RFID_Device_Disabled situation 215KQB_RFID_DeviceName_Conflict situation 214KQB_RFID_InsufPrivil_On_Dev situation 215KQB_RFID_ProcessEng_MaxRestart situation 214KQB_RFID_ProcessEngine_Fatal situation 213KQB_RFID_Service_Auth_Fail situation 214KQB_RFID_Service_Down situation 199KQB_RFID_Service_StartUpFail situation 212KQB_Send_Port_Group_Stopped situation 201KQB_Send_Port_Stopped_Warning situation 199KQB_SendPipeline_ExecutionFail situation 205


KQB_Srvc_Inst_Suspend_Warning situation 200KQB_Stored_ProcCall_Failure situation 207

Llanguage packs 11

installing 11silent installation 11

Last Collection Duration attribute 147Last Collection Finished attribute 147Last Collection Start attribute 147list of messages 285LOB Time attribute 55, 56, 57, 59, 60LOB Time Delta attribute 55, 57, 58, 59, 60Lock Failures (Superseded) attribute 72Lock Failures attribute 74Lock Failures Per Sec (Superseded) attribute 72Lock Failures Per Sec attribute 75Log Name attribute 66

MManagement Database attribute group 105Memory Queue Size attribute 98, 101Message attribute 67Message Box General Counters attribute group 106Message Box Host Counters attribute group 110Message Delivery Delay In Sec attribute 91Message Delivery Incoming Rate attribute 92Message Delivery Outgoing Rate attribute 92Message Delivery Throttling State attribute 92Message Delivery Throttling State Duration In Min

attribute 93Message Delivery Throttling User Override attribute 93Message Publishing Delay In Sec attribute 93Message Publishing Incoming Rate attribute 94Message Publishing Outgoing Rate attribute 94Message Publishing Throttling State attribute 94Message Publishing Throttling State Duration In Min

attribute 95Message Publishing Throttling User Override attribute 95MessageBox


descriptions 32MessageBox - Host Queue Messages workspace 32MessageBox - Host Queue Overview workspace 32MessageBox - Purge Jobs workspace 33Messagebox Database attribute group 111MessageBox Databases Connection Failures attribute 135MessageBox workspace 32messages

contents 285for IBM Tivoli Composite Application Manager for

Microsoft Applications: Microsoft BizTalk ServerAgent 285

format 285Messages Overview workspace 31Messages Received attribute 73, 79, 99, 102, 122, 149, 165, 168Messages Received Per Sec attribute 73, 79, 99, 102, 122, 150,

166, 168Messages Sent attribute 76, 81, 99, 102, 124, 164, 167, 169Messages Sent Per Sec attribute 77, 82, 100, 103, 125, 164, 167,

169Messages Written To Transport attribute 62Messages Written To Transport Rate attribute 62

Messagingsituations 220workspaces

descriptions 33Messaging attribute group 113Messaging Details workspace 33Messaging Latency attribute group 119Messaging Latency workspace 33Messaging workspace 33Microsoft BizTalk Server


descriptions 23Microsoft BizTalk Server agent

performance considerations 279Microsoft BizTalk Server workspace 23MsgBox Dead Processes Cleanup Purge Jobs attribute 107MsgBox Msg Cleanup Purge Jobs attribute 107MsgBox Parts Cleanup Purge Jobs attribute 107MsgBox Purge Subscriptions Job Purge Jobs attribute 108MSMQ Receive Adapter attribute group 121MSMQ Receive Adapter workspace 25MSMQ Send Adapter attribute group 124MSMQ Send Adapter workspace 25

NName attribute 45, 52, 56, 57, 58, 59, 61, 62, 63, 67, 70, 75, 78,

80, 83, 84, 98, 101, 103, 109, 111, 119, 121, 123, 126, 127, 143,151, 155, 157, 165, 166, 167, 168, 170, 172, 178, 180, 188

New Action Added attribute 104New Activity Flows attribute 104new in this release 3Node attribute 44, 45, 49, 50, 53, 54, 55, 56, 57, 58, 60, 61, 62,

63, 66, 67, 69, 71, 76, 78, 81, 83, 87, 98, 101, 103, 105, 106, 110,112, 113, 119, 121, 124, 126, 130, 131, 144, 148, 151, 153, 156,158, 159, 161, 163, 164, 165, 166, 168, 169, 170, 172, 173, 179,181, 185

Notification Bodies attribute 65Notification Headers attribute 65Notifications attribute 128Notifications attribute group 126Notifications Failed Delivery attribute 129Notifications Generated Per Second attribute 84Notifications Successfully Delivered attribute 129Notifications workspace 29Number of Collections attribute 148

OObject Name attribute 144Object Status attribute 145Object Type attribute 144Online MessageBox Databases attribute 135operating systems 11Orchestration Details workspace 34Orchestration Messaging workspace 34Orchestration Name attribute 130Orchestration Processing workspace 35Orchestration Status attribute group 129Orchestrations


descriptions 34Orchestrations attribute group 131Orchestrations Completed attribute 136

Index 347

Orchestrations Completed Per Sec attribute 136Orchestrations Created attribute 136Orchestrations Created Per Sec attribute 136Orchestrations Dehydrated attribute 137Orchestrations Dehydrated Per Sec attribute 137Orchestrations Discarded attribute 137Orchestrations Discarded Per Sec attribute 138Orchestrations Rehydrated attribute 138Orchestrations Rehydrated Per Sec attribute 138Orchestrations Resident In Memory attribute 139Orchestrations Scheduled For Dehydration attribute 139Orchestrations Suspended attribute 139Orchestrations Suspended Per Sec attribute 139Orchestrations workspace 35Outbound Adapter Latency In MS attribute 120Outbound Latency In MS attribute 120overview

IBM Tivoli Monitoring 1

PPage Faults per Sec attribute 47Pending Messages attribute 140Pending Receive Batches attribute 117Pending Transmitted Messages attribute 117Pending Work Items attribute 140Percent Privileged Time attribute 47Percent Processor Time attribute 48Percent Receive Message Failures attribute 182, 185Percent Send Message Failures attribute 182, 186Percent Used Physical Memory attribute 131Percent User Mode Time attribute 48Percent Web Service Call Failures attribute 182, 186performance considerations 279Performance Object Status attribute group 144Performance Object Status workspace 27Persistence Points attribute 140Persistence Points Per Sec attribute 141Physical Memory Usage In MB attribute 95PID attribute 47policies 241POP3 Receive Adapter attribute group 148POP3 Receive Adapter workspace 25prerequisite publications 331Primary Transport Address attribute 161probe rules file

include 329problems and workarounds 264

agent-specific 268agent-specific workspaces 274configuration 264install 264remote deployment 267situations 279Take Action commands 282Tivoli Common Reporting 282workspaces 274

Process Memory Usage In MB attribute 96Process Memory Usage Threshold In MB attribute 96Process Uptime attribute 156publications 331, 332

developerWorks website 332IBM Tivoli Monitoring 331Integrated Service Management Library 332prerequisite 331Redbooks 332related 332

publications (continued)Technotes 332wikis 332

QQuanta Behind attribute 84Quanta Failed attribute 84Quanta Processed attribute 85Quanta Remaining attribute 180Quanta Vacuumed attribute 180queries, using attributes 39Query Name attribute 144

Rras1 260Receive Handler attribute 153Receive Location Name attribute 152Receive Location Status attribute group 151Receive Port Name attribute 152Records Being Processed attribute 175Records Committed attribute 175Redbooks 332Refresh Interval attribute 147remote

installation and configuration 17remote deployment

problems and workarounds 267Request Response Latency In MS attribute 120Request Response Timeouts attribute 117requirements 11response file template 11RFID


descriptions 35RFID Devices attribute group 153RFID Processes attribute group 155RFID workspace 35Rule Engine Database attribute group 157Rule Firing Failures attribute 85Rule Firings attribute 85Runnable Orchestrations attribute 141Running Orchestrations attribute 141

SSend Port Group Name attribute 159Send Port Group Status attribute group 158Send Port Name attribute 160Send Port Status attribute group 159Server Name attribute 44, 50, 54, 61, 63, 65, 69, 71, 86, 98,

105, 106, 112, 129, 130, 153, 158, 159, 161, 162, 163, 171, 173,179, 181

Service Class attribute 162Service Instance Status and Class attribute group 161Service Instance workspace 30Service Name attribute 162Service Status attribute 162silent installation 11silent installation of language packs 11Single Sign On Database attribute group 163situations 195

additional informationpredefined, defined 193


situations (continued)KQB_Adapter_SuspendsInboundMsg 208KQB_Adptr_Suspends_OutboundMsg 202KQB_BAM_Config_Changed_Info 212KQB_Biz_Base_EDI_Service_Down 196KQB_Biz_HostInstance_Srv_Down 196KQB_Biz_SP_Msg_Adapter_Down 198KQB_Biz_SSO_Service_Down 197KQB_BizRuleEngine_Service_Down 197KQB_BizTalk_DBConnection_Fail 202KQB_FileAdptr_FolderAccessFail 205KQB_FILESendAdptr_OpenFileFail 203KQB_Host_Inst_Crashed 216KQB_HostInstance_ConfigDB_Fail 204KQB_HT_High_Database_Session 216KQB_HT_High_Database_Size 217KQB_HT_High_InProcMessageCount 217KQB_HT_High_MsgDelivery_Rate 218KQB_HT_High_MsgPublishing_Rate 218KQB_HT_High_Process_Memory 219KQB_HT_High_System_Memory 219KQB_HT_High_Thread_Count 219KQB_HTTPSendAdaptr_ConnectFail 204KQB_Inbound_Msg_Proc_Failure 207KQB_Invalid_FileRecieveLoc 206KQB_Invalid_Receive_Loc_Config 201KQB_Msg_Resp_WithoutReq 208KQB_MsgEngine_FailToAddRecvLoc 206KQB_MsgEngine_FailToInit 209KQB_MsgEngine_FailToRegAdptr 210KQB_MsgEngine_SSOSrverConnFail 209KQB_MsgEngineFailToGetConfigDB 210KQB_MSMQTSubserviceFail 211KQB_No_Host_Instance 198KQB_Orchestrn_Stopped_Warning 199KQB_POP3_Authentication_Fail 203KQB_POP3_ServerConnection_Fail 203KQB_Rec_Loc_Stoped_Warning 200KQB_ReceiveLoc_ShutDown 207KQB_RecvFileAttr 211KQB_RecvLoc_Disabled 211KQB_RFID_Dev_StateSave_Fail 216KQB_RFID_Device_Conn_Fail 213KQB_RFID_Device_Disabled 215KQB_RFID_DeviceName_Conflict 214KQB_RFID_InsufPrivil_On_Dev 215KQB_RFID_ProcessEng_MaxRestart 214KQB_RFID_ProcessEngine_Fatal 213KQB_RFID_Service_Auth_Fail 214KQB_RFID_Service_Down 199KQB_RFID_Service_StartUpFail 212KQB_Send_Port_Group_Stopped 201KQB_Send_Port_Stopped_Warning 199KQB_SendPipeline_ExecutionFail 205KQB_Srvc_Inst_Suspend_Warning 200KQB_Stored_ProcCall_Failure 207overview 193predefined 193problems and workarounds 279Situation Editor 193

situations, using attributes 39Skipped Chronicle Rule Firings attribute 86Skipped Quanta attribute 86Skipped Subscription Rule Firings attribute 86SMTP Send Adapter attribute group 163SMTP Send Adapter workspace 26SOAP Receive Adapter attribute group 165

SOAP Receive Adapter workspace 26SOAP Send Adapter attribute group 166SOAP Send Adapter workspace 26Spool Size attribute 108SQL Receive Adapter attribute group 167SQL Receive Adapter workspace 26SQL Send Adapter attribute group 169SQL Send Adapter workspace 26Start BizTalk Base EDI Service action 223Start BizTalk SharePoint Messaging Adapter Service

action 224Start Enterprise Single Sign-On Service action 225Start Host Instance Service action 226Start Microsoft BizTalk RFID Service action 227Start Orchestration action 228Start Rule Engine Update Service action 229Start Send Port action 230Start Send Port Group action 232Status attribute 45, 130, 152, 159, 160Steps Retrieved attribute 104Stop BizTalk Base EDI Service action 233Stop BizTalk SharePoint Messaging Adapter Service

action 234Stop Enterprise Single Sign-On Service action 235Stop Host Instance Service action 235Stop Microsoft BizTalk RFID Service action 237Stop Rule Engine Update Service action 237Stop Send Port Group action 238Subscribers Added attribute 171Subscribers attribute group 170Subscribers Disabled attribute 171Subscribers Enabled attribute 171Subscribers workspace 29Subscriptions Added attribute 172Subscriptions attribute group 172Subscriptions Disabled attribute 172Subscriptions Enabled attribute 173support

list of messages 285

Ttacmd addSystem command 17Tags Being Processed attribute 156Tags In Queue attribute 156Tags Processed attribute 157Tags Read Per Sec attribute 154Tags Suspended attribute 157Tags Written Per Sec attribute 154Take Action commands

additional information 221Enable Receive Location 221overview 221predefined 221, 241problems and workarounds 282Start BizTalk Base EDI Service 223Start BizTalk SharePoint Messaging Adapter Service 224Start Enterprise Single Sign-On Service 225Start Host Instance Service 226Start Microsoft BizTalk RFID Service 227Start Orchestration 228Start Rule Engine Update Service 229Start Send Port 230Start Send Port Group 232Stop BizTalk Base EDI Service 233Stop BizTalk SharePoint Messaging Adapter Service 234Stop Enterprise Single Sign-On Service 235

Index 349

Take Action commands (continued)Stop Host Instance Service 235Stop Microsoft BizTalk RFID Service 237Stop Rule Engine Update Service 237Stop Send Port Group 238

take actionsdescriptions 221

Tasks Retrieved attribute 105TDDS


descriptions 36TDDS attribute group 173TDDS Details workspace 36TDDS workspace 36Technotes 332Thread Count attribute 47, 96Thread Count Threshold attribute 96Throttled Receive Batches attribute 118Throttling Details workspace 31Time Generated attribute 67Time To Add Message To Batch attribute 100Time To Build Batch attribute 73, 100Timeouts attribute 181Timestamp attribute 44, 45, 49, 50, 53, 54, 55, 56, 57, 59, 60,

61, 62, 63, 67, 69, 71, 76, 78, 81, 84, 87, 98, 101, 103, 106, 110,112, 113, 119, 121, 124, 126, 130, 131, 144, 149, 151, 153, 156,158, 159, 160, 161, 163, 164, 165, 166, 168, 169, 170, 172, 173,179, 180, 181, 185

Tivoli Business Service Managercomponents for integrating with 327configuring additional IBM Tivoli Monitoring web

services 330creating a service 329creating data source mapping 330installing Discovery Library Toolkit 328integration 327launching from Tivoli Enterprise Portal 330Tivoli Enterprise Portal

Tivoli Integration Facility (EIF) probe 327viewing data in Tivoli Enterprise Portal 330

Tivoli Business Service Managerintegration tasks 328Tivoli Common Reporting

problems and workarounds 282Tivoli Enterprise Console

event mapping 297Tivoli Event Integration Facility (EIF) probe

configuring 329Total Batches (Superseded) attribute 175Total Batches attribute 177Total Batches Committed attribute 97Total Events (Superseded) attribute 176Total Events attribute 71, 177Total Failed BAM Events During Flush attribute 52Total Failed Batches (Superseded) attribute 176Total Failed Batches attribute 177Total Failed Events (Superseded) attribute 176Total Failed Events attribute 178Total Messages Delivered attribute 97Total Messages Published attribute 97Total Receive Commit Failures attribute 183, 186Total Receive Message Failures attribute 183, 187Total Received Messages attribute 183, 187Total Records (Superseded) attribute 177Total Records attribute 178Total Send Message Failures attribute 184, 187Total Sent Messages attribute 184, 187

Total Successful BAM Events During Flush attribute 52Total Tags Read attribute 154Total Tags Written attribute 153Total Web Service Call Failures attribute 184, 188trace

turn off 263turn on 262

trace settings 260tracing 258Tracked Msgs Copy Purge Jobs attribute 108Tracking Data Size attribute 109Tracking Database attribute group 179Tracking Spool Cleanup Purge Jobs attribute 109Transactional Scopes Aborted attribute 142Transactional Scopes Aborted Per Sec attribute 142Transactional Scopes Committed attribute 142Transactional Scopes Committed Per Sec attribute 142Transactional Scopes Compensated attribute 143Transactional Scopes Compensated Per Sec attribute 143Transactional Scopes workspace 35Transport Address attribute 152Transport Type attribute 152, 160troubleshooting 253

agent-specific 268agent-specific workspaces 274installation 264problems and workarounds 264remote deployment 267situations 279Take Action commands 282Tivoli Common Reporting 282turn off trace 263turn on trace 262uninstallation 264workspaces 274

Type attribute 46

Uuser interface options 6

VVacuumer attribute group 179Vacuumer workspace 29views

Adapters workspace 23Availability workspace 27BAM Interceptor workspace 28BizTalk Group Topology workspace 29Business Activity Monitoring workspace 28Configuration and Status workspace 29Current Status workspace 30Databases workspace 30Dehydration Details workspace 34Dehydration Status workspace 34Delivery Channels and Event Providers workspace 28Distributors and Subscriptions workspace 28Document Transactions workspace 33Event Log workspace 30Events workspace 28File Receive Adapter - Data Received workspace 24File Send Adapter workspace 24FTP Receive Adapter workspace 24FTP Send Adapter workspace 24Generator workspace 29


views (continued)Host Throttling Thresholds workspace 31Host Throttling workspace 31HTTP Receive Adapter workspace 24HTTP Send Adapter workspace 25Human Workflow Services workspace 32MessageBox - Host Queue Messages workspace 32MessageBox - Host Queue Overview workspace 32MessageBox - Purge Jobs workspace 33MessageBox workspace 32Messages Overview workspace 31Messaging Details workspace 33Messaging Latency workspace 33Messaging workspace 33Microsoft BizTalk Server workspace 23MSMQ Receive Adapter workspace 25MSMQ Send Adapter workspace 25Notifications workspace 29Orchestration Details workspace 34Orchestration Messaging workspace 34Orchestration Processing workspace 35Orchestrations workspace 35Performance Object Status workspace 27POP3 Receive Adapter workspace 25RFID workspace 35Service Instance workspace 30SMTP Send Adapter workspace 26SOAP Receive Adapter workspace 26SOAP Send Adapter workspace 26SQL Receive Adapter workspace 26SQL Send Adapter workspace 26Subscribers workspace 29TDDS Details workspace 36TDDS workspace 36Throttling Details workspace 31Transactional Scopes workspace 35Vacuumer workspace 29Windows SharePoint Services Adapter workspace 27

Virtual Size attribute 46

WWeb Service Calls Per Sec attribute 184, 188wikis 332Windows SharePoint Services Adapter attribute group 185Windows SharePoint Services Adapter workspace 27Windows SharePoint Services attribute group 181workarounds 264Workflow Editor 241Working Set Size attribute 47workspaces

Adapters 23Availability 27BAM Interceptor 28BizTalk Group Topology 29Business Activity Monitoring 28Configuration and Status 29Current Status 30Databases 30Dehydration Details 34Dehydration Status 34Delivery Channels and Event Providers 28descriptions 23Distributors and Subscriptions 28Document Transactions 33Event Log 30Events 28

workspaces (continued)File Receive Adapter - Data Received 24File Send Adapter 24FTP Receive Adapter 24FTP Send Adapter 24Generator 29Host Throttling 31Host Throttling Thresholds 31HTTP Receive Adapter 24HTTP Send Adapter 25Human Workflow Services 32MessageBox 32MessageBox - Host Queue Messages 32MessageBox - Host Queue Overview 32MessageBox - Purge Jobs 33Messages Overview 31Messaging 33Messaging Details 33Messaging Latency 33Microsoft BizTalk Server 23MSMQ Receive Adapter 25MSMQ Send Adapter 25Notifications 29Orchestration Details 34Orchestration Messaging 34Orchestration Processing 35Orchestrations 34, 35Performance Object Status 27POP3 Receive Adapter 25predefined 21problems and workarounds 274RFID 35Service Instance 30SMTP Send Adapter 26SOAP Receive Adapter 26SOAP Send Adapter 26SQL Receive Adapter 26SQL Send Adapter 26Subscribers 29TDDS 36TDDS Details 36Throttling Details 31Transactional Scopes 35Vacuumer 29Windows SharePoint Services Adapter 27

Workspacesadditional information 21overview 21

Index 351

��

Printed in USA

SC23-9757-05

Microsoft BizTalk Server agent: User's Guide

Documents

Transcript of Microsoft BizTalk Server agent: User's Guide