Microsoft BizTalk Server agent Reference - IBM

210
IBM Tivoli Composite Application Manager for Microsoft Applications: Microsoft BizTalk Server Agent 6.3.1 Fix Pack 13 Reference IBM

Transcript of Microsoft BizTalk Server agent Reference - IBM

Page 1: Microsoft BizTalk Server agent Reference - IBM

IBM Tivoli Composite Application Manager for MicrosoftApplications: Microsoft BizTalk Server Agent6.3.1 Fix Pack 13

Reference

IBM

Page 2: Microsoft BizTalk Server agent Reference - IBM
Page 3: Microsoft BizTalk Server agent Reference - IBM

IBM Tivoli Composite Application Manager for MicrosoftApplications: Microsoft BizTalk Server Agent6.3.1 Fix Pack 13

Reference

IBM

Page 4: Microsoft BizTalk Server agent Reference - IBM

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

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

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

Page 5: Microsoft BizTalk Server agent Reference - IBM

Contents

Chapter 1. Workspaces . . . . . . . . 1Predefined workspaces . . . . . . . . . . . 1Workspace descriptions . . . . . . . . . . . 3

Microsoft BizTalk Server navigator item . . . . 3Adapters navigator item . . . . . . . . . 3Availability navigator item. . . . . . . . . 7Business Activity Monitoring navigator item. . . 8Configuration and Status navigator item. . . . 10Databases navigator item . . . . . . . . . 11Event Log navigator item . . . . . . . . . 11Host Throttling navigator item . . . . . . . 11Human Workflow Services navigator item . . . 12MessageBox navigator item . . . . . . . . 12Messaging navigator item . . . . . . . . 13Orchestrations navigator item . . . . . . . 14RFID navigator item . . . . . . . . . . 16TDDS navigator item . . . . . . . . . . 16

Chapter 2. Attributes . . . . . . . . . 17Attribute groups for the monitoring agent . . . . 18Attributes in each attribute group . . . . . . . 23

Application Status attribute group . . . . . . 23Availability attribute group . . . . . . . . 23BAM Database attribute group . . . . . . . 26BAM Interceptor attribute group . . . . . . 26BizTalk Group Server Host attribute group . . . 28BizTalk Host attribute group. . . . . . . . 28BizTalk NET Adapter for Oracle DB attributegroup . . . . . . . . . . . . . . . 29BizTalk NET Adapter for Oracle EBusiness Suiteattribute group . . . . . . . . . . . . 29BizTalk NET Adapter for SAP attribute group . . 30BizTalk NET Adapter for Siebel attribute group 31BizTalk NET Adapter for SQL attribute group . . 31BizTalk Server attribute group . . . . . . . 32Delivery Channels attribute group . . . . . . 32Distributors attribute group . . . . . . . . 33Event Log attribute group . . . . . . . . 34Event Providers attribute group . . . . . . 35Events attribute group. . . . . . . . . . 36File Receive Adapter attribute group . . . . . 37File Send Adapter attribute group . . . . . . 39FTP Receive Adapter attribute group . . . . . 40FTP Send Adapter attribute group . . . . . . 42Generator attribute group . . . . . . . . 43Host Throttling attribute group . . . . . . . 44HTTP Receive Adapter attribute group . . . . 50HTTP Send Adapter attribute group . . . . . 51Human Workflow Services attribute group . . . 52Management Database attribute group . . . . 53Message Box General Counters attribute group 53Message Box Host Counters attribute group . . 55Messagebox Database attribute group . . . . 56Messaging attribute group . . . . . . . . 57Messaging Latency attribute group . . . . . 59

MSMQ Receive Adapter attribute group . . . . 60MSMQ Send Adapter attribute group. . . . . 62Notifications attribute group. . . . . . . . 63Orchestration Status attribute group . . . . . 64Orchestrations attribute group . . . . . . . 65Performance Object Status attribute group . . . 70POP3 Receive Adapter attribute group . . . . 73Receive Location Status attribute group . . . . 74Receive Ports attribute group . . . . . . . 75RFID Devices attribute group . . . . . . . 76RFID Processes attribute group . . . . . . . 77Rule Engine Database attribute group . . . . 78Send Port Group Status attribute group . . . . 79Send Port Status attribute group . . . . . . 79Service Instance Status and Class attribute group 80SFTP Receive Adapter attribute group . . . . 81SFTP Send Adapter attribute group . . . . . 82Single Sign On Database attribute group. . . . 83SMTP Send Adapter attribute group . . . . . 84SOAP Receive Adapter attribute group . . . . 84SOAP Send Adapter attribute group . . . . . 85SQL Receive Adapter attribute group . . . . . 86SQL Send Adapter attribute group. . . . . . 86Subscribers attribute group . . . . . . . . 87Subscriptions attribute group . . . . . . . 88TDDS attribute group . . . . . . . . . . 88Tracking Database attribute group . . . . . . 91Vacuumer attribute group . . . . . . . . 91Windows SharePoint Services attribute group . . 92Windows SharePoint Services Adapter attributegroup . . . . . . . . . . . . . . . 94

Disk capacity planning for historical data . . . . 96

Chapter 3. Situations. . . . . . . . . 97Predefined situations . . . . . . . . . . . 97Situation descriptions . . . . . . . . . . . 99

Microsoft BizTalk Server navigator item . . . 100Adapters navigator item. . . . . . . . . 100Availability navigator item . . . . . . . . 100Business Activity Monitoring navigator item 103Configuration and Status navigator item . . . 103Databases navigator item . . . . . . . . 105Event Log navigator item . . . . . . . . 105Host Throttling navigator item . . . . . . 121Human Workflow Services navigator item. . . 124MessageBox navigator item. . . . . . . . 124Messaging navigator item . . . . . . . . 124Orchestrations navigator item . . . . . . . 124RFID navigator item . . . . . . . . . . 124TDDS navigator item . . . . . . . . . . 124

Chapter 4. Take Action commands 125Predefined Take Action commands . . . . . . 125Take Action command descriptions . . . . . . 126

Disable Receive Location action . . . . . . 126

© Copyright IBM Corp. 2009, 2017 iii

Page 6: Microsoft BizTalk Server agent Reference - IBM

Enable Receive Location action . . . . . . 127Enlist Orchestration action . . . . . . . . 128Enlist Send Port action . . . . . . . . . 130Enlist Send Port Group action . . . . . . . 131Start BizTalk Base EDI Service action . . . . 132Start BizTalk SharePoint Messaging AdapterService action . . . . . . . . . . . . 133Start Enterprise Single Sign-On Service action 134Start Host Instance Service action. . . . . . 135Start Microsoft BizTalk RFID Service action . . 136Start Orchestration action . . . . . . . . 137Start Rule Engine Update Service action . . . 139Start Send Port action . . . . . . . . . 140Start Send Port Group action . . . . . . . 141Stop BizTalk Base EDI Service action . . . . 142Stop BizTalk SharePoint Messaging AdapterService action . . . . . . . . . . . . 143Stop Enterprise Single Sign-On Service action 144Stop Host Instance Service action. . . . . . 144Stop Microsoft BizTalk RFID Service action . . 146Stop Orchestration action . . . . . . . . 146Stop Rule Engine Update Service action . . . 148Stop Send Port Group action . . . . . . . 148Unenlist Orchestration action . . . . . . . 150

Unenlist Send Port action . . . . . . . . 151Unenlist Send Port Group action . . . . . . 152

Chapter 5. Policies . . . . . . . . . 155Predefined policies . . . . . . . . . . . 155

Chapter 6. Event mapping . . . . . . 157

Appendix. Documentation library . . . 183Prerequisite documentation. . . . . . . . . 183Related documentation . . . . . . . . . . 183Tivoli Monitoring Community on ServiceManagement Connect . . . . . . . . . . 184Other sources of documentation . . . . . . . 184Conventions used in the documentation . . . . 184

Notices . . . . . . . . . . . . . . 187Trademarks . . . . . . . . . . . . . . 189Privacy policy considerations . . . . . . . . 189

Index . . . . . . . . . . . . . . . 191

iv Microsoft BizTalk Server agent Reference

Page 7: Microsoft BizTalk Server agent Reference - IBM

Chapter 1. Workspaces

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

About workspaces

Use the Navigator to select the workspace you want to see. As part of the application window, the statusbar shows the Tivoli Enterprise Portal Server name and port number to which the displayed informationapplies and the ID of the current user.

When you select an item in the Navigator, 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 18.

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

© Copyright IBM Corp. 2009, 2017 1

Page 8: Microsoft BizTalk Server agent Reference - IBM

– HTTP Receive Adapter workspace– HTTP Send Adapter workspace– MSMQ Receive Adapter workspace– MSMQ Send Adapter workspace– POP3 Receive Adapter workspace– SFTP Receive Adapter workspace– SFTP Send 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

2 Microsoft BizTalk Server agent Reference

Page 9: Microsoft BizTalk Server agent Reference - IBM

– 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.

Chapter 1. Workspaces 3

Page 10: Microsoft BizTalk Server agent Reference - IBM

Adapters workspaceThis workspace displays detailed information of the File Receive Adapter.

This workspace contains the following views:File Receive Adapter Details

This report shows the overall performance information of the File Receive Adapter.Delete Retries

This 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.

4 Microsoft BizTalk Server agent Reference

Page 11: Microsoft BizTalk Server agent Reference - IBM

Messages in Adapter QueueThis 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.

Chapter 1. Workspaces 5

Page 12: Microsoft BizTalk Server agent Reference - IBM

Kilobytes ReceivedThis 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.

SFTP Receive Adapter workspaceThis report shows the overall performance information of the SFTP receive adapter.

This workspace contains the following views:SFTP Receive Adapter Details

This report shows the overall performance information of the SFTP receive adapter.Kilobytes Received

This bar chart shows the total number of kilobytes received by the SFTP receive adapter.Messages Received

This bar chart shows the total number of messages received by the SFTP receive adapter.The counter increases after a message from the SFTP server is read by the SFTP receiveadapter.

SFTP Send Adapter workspaceThis workspace displays the SFTP send adapter performance measures.

This workspace contains the following views:SFTP Send Adapter Details

This report shows the overall performance information of the SFTP send adapter.Kilobytes Sent

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

This bar chart shows the total number of messages sent by the SFTP send adapter. Thecounter increases only for the messages that are written to the destination SFTP server.

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.

6 Microsoft BizTalk Server agent Reference

Page 13: Microsoft BizTalk Server agent Reference - IBM

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.

This workspace contains the following views:SQL Send Adapter Details

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

This 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,

Chapter 1. Workspaces 7

Page 14: Microsoft BizTalk Server agent Reference - IBM

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.

8 Microsoft BizTalk Server agent Reference

Page 15: Microsoft BizTalk Server agent Reference - IBM

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 Submitted

This line chart contains information about the event batches that are submitted.Events Details

This report contains information about the events.Generator workspace

This 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:

Chapter 1. Workspaces 9

Page 16: Microsoft BizTalk Server agent Reference - IBM

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

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

Subscribers DetailsThis report contains information about the subscribers.

Vacuumer workspaceThis 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.

Receive PortsThis report contains information about the Receive Ports.

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.

10 Microsoft BizTalk Server agent Reference

Page 17: Microsoft BizTalk Server agent Reference - IBM

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 theWindows 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.

Chapter 1. Workspaces 11

Page 18: Microsoft BizTalk Server agent Reference - IBM

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

This workspace contains the following views:Throttling State Duration

This 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.

12 Microsoft BizTalk Server agent Reference

Page 19: Microsoft BizTalk Server agent Reference - IBM

MessageBox workspaceThis 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.

Chapter 1. Workspaces 13

Page 20: Microsoft BizTalk Server agent Reference - IBM

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.

14 Microsoft BizTalk Server agent Reference

Page 21: Microsoft BizTalk Server agent Reference - IBM

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.

Chapter 1. Workspaces 15

Page 22: Microsoft BizTalk Server agent Reference - IBM

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 workspace

This 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.

16 Microsoft BizTalk Server agent Reference

Page 23: Microsoft BizTalk Server agent Reference - IBM

Chapter 2. Attributes

Attributes are the application properties that are being measured and reported by the IBM TivoliComposite Application Manager for Microsoft Applications: Microsoft BizTalk Server Agent. Attributesmake up the key performance indicators (KPIs) that are reported in the application dashboards, and youcan use them to create eventing thresholds for conditions that you want to monitor.

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:

Chart or table viewsAttributes are displayed in chart and table views. The chart and table views use queries tospecify which attribute values to request from a monitoring agent. You use the Properties editorto apply filters and set styles to define the content and appearance of a view based on an existingquery.

SituationsYou use attributes to create situations that monitor the state of your operating system, database,or application. A situation describes a condition you want to test. When you start a situation, thevalues you assign to the situation attributes are compared with the values collected by theMicrosoft BizTalk Server agent and registers an event if the condition is met. You are alerted toevents by indicator icons that are displayed in the Navigator.

Attributes are organized into attribute groups, the values of which can be selectively displayed indashboards or used to define a threshold. After the dashboard is opened, the threshold is started, or thehistorical data collection interval completes, data samples of the attributes in the attribute group aretaken.

DashboardsAttributes are displayed in the dashboards. The group widgets use queries to the dashboard dataprovider to specify which attribute values to request from a monitoring agent.

You can edit the Components group widgets that display in the Application PerformanceDashboard to control the group widgets that are displayed, their positioning, and to adjust thethresholds. After selecting an application to display in the Application Performance Dashboard,select the group named Components, and click Actions > Edit to open the editor.

ThresholdsAs well as the thresholds are reported in the dashboards, you can also define thresholds thatmonitor the state of your operating system, database, or application and open an event when thethreshold has been exceeded. You use attributes to define thresholds that describe a condition youwant to test. After the threshold is started, the values assigned to the attributes in the thresholddefinition are compared with the values collected by the Microsoft BizTalk Server agent. After thecondition is met, an event is registered. You alerted to events by indicator icons that aredisplayed in the Application Performance Dashboard navigator and the Events tab.

IBM Tivoli Composite Application Manager for Microsoft Applications: Microsoft BizTalk Server Agentprovides predefined dashboards, thresholds, and historical data collections that you can begin to useimmediately. When the sampled values for the attributes described in a threshold meet the condition

© Copyright IBM Corp. 2009, 2017 17

Page 24: Microsoft BizTalk Server agent Reference - IBM

(such as attribute A is greater than 80%), an event is opened. Note that when no data can be collected fora an attribute group, an empty result is returned (no rows of data), when a specific attribute cannot becollected the value 0 or “” is returned unless otherwise specified in a particular attribute (for example“N/A”), and any numeric attribute value that is greater than the largest (positive or negative) numberthat can be represented by that type returns the corresponding maximum or minimum value (forexample, for a 32-bit number, the maximum value is 2,147,483,647). These values are displayed as textvalues defined by the attribute group, such as “Value Exceeds Maximum” or “Value Exceeds Minimum”.For more information about using attributes in dashboards, thresholds, and historical data collection, seethe Application Performance Dashboard and SmartCloud Monitoring - Application Insight online help.

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 23.

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 23.

Attribute groups for the monitoring agentThe Microsoft BizTalk Server agent contains the following attribute groups. For agents that use IBM®

Tivoli Monitoring infrastructure, attributes are in attribute groups. For agents that use the lightweightinfrastructure, attributes are in data sets.

The table name depends on the maximum table name limits of the target database being used for thehistorical data collection. If the maximum name is 30 characters, any warehouse or historical table namelonger than 30 characters is shortened to 30 characters.

Note: Agents that use the Tivoli Monitoring infrastructure refer to the historical table name as thewarehouse table name.v Attribute group name: Application Status

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

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

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

v Attribute group name: BAM Interceptor– Table name: KQBBAMINTC– Warehouse or historical table name: KQB_BAM_INTERCEPTOR or KQBBAMINTC

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

v Attribute group name: BizTalk Host– Table name: KQBGRPHST

18 Microsoft BizTalk Server agent Reference

Page 25: Microsoft BizTalk Server agent Reference - IBM

– Warehouse or historical table name: KQB_BIZTALK_HOST or KQBGRPHSTv Attribute group name: BizTalk NET Adapter for Oracle DB

– Table name: KQBORADB– Warehouse or historical table name: KQB_BIZTALK_NET_ADAPTER_FOR_ORACLE_DB or

KQBORADBv Attribute group name: BizTalk NET Adapter for Oracle EBusiness Suite

– Table name: KQBORAEBIZ– Warehouse or historical table name:

KQB_BIZTALK_NET_ADAPTER_FOR_ORACLE_EBUSINESS_SUITE or KQBORAEBIZv Attribute group name: BizTalk NET Adapter for SAP

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

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

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

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

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

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

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

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

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

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

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

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

Chapter 2. Attributes 19

Page 26: Microsoft BizTalk Server agent Reference - IBM

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

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

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

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

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

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

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

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

KQBMSGBOXGv Attribute group name: Message Box Host Counters

– Table name: KQBMSGBOXH– Warehouse or historical table name: KQB_MESSAGE_BOX_HOST_COUNTERS or KQBMSGBOXH

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

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

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

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

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

v Attribute group name: Notifications– Table name: KQBNOTIFI

20 Microsoft BizTalk Server agent Reference

Page 27: Microsoft BizTalk Server agent Reference - IBM

– Warehouse or historical table name: KQB_NOTIFICATIONS or KQBNOTIFIv Attribute group name: Orchestration Status

– Table name: KQBMSBTSOS– Warehouse or historical table name: KQB_ORCHESTRATION_STATUS or KQBMSBTSOS

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

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

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

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

v Attribute group name: Receive Ports– Table name: KQBMSBTSRP– Warehouse or historical table name: KQB_RECEIVE_PORTS or KQBMSBTSRP

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

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

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

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

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

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

KQBMSBTSISv Attribute group name: SFTP Receive Adapter

– Table name: KQBSFTPREC– Warehouse or historical table name: KQB_SFTP_RECEIVE_ADAPTER or KQBSFTPREC

v Attribute group name: SFTP Send Adapter– Table name: KQBSFTPSND– Warehouse or historical table name: KQB_SFTP_SEND_ADAPTER or KQBSFTPSND

v Attribute group name: Single Sign On Database

Chapter 2. Attributes 21

Page 28: Microsoft BizTalk Server agent Reference - IBM

– Table name: KQBSSODB– Warehouse or historical table name: KQB_SINGLE_SIGN_ON_DATABASE or KQBSSODB

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

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

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

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

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

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

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

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

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

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

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

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

KQBWSADPTR

22 Microsoft BizTalk Server agent Reference

Page 29: Microsoft BizTalk Server agent Reference - IBM

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

The description of each attribute group contains the following details:v Whether the attribute group is a historical type that you can roll off to a data warehouse.v Information such as whether the attribute is a key attribute, type, verification method, warehouse name

(as applicable), and other names.A key attribute is an attribute that is used in warehouse aggregation to identify rows of data thatrepresent the same object.

Application Status attribute groupThe Application Status attribute group includes attributes that provide information about the name andstatus of BizTalk application. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Application Name attribute

This attribute displays the name of the BizTalk application. The type is string.

The following names are defined for this attribute: APPLICATION_NAME or APPNAME(warehouse name), Application Name (caption), Application_Name (attribute name), andAPPNAME (column name).

Application Status attributeThis attribute displays the status of the BizTalk application. The type is string.

The following names are defined for this attribute: APPLICATION_STATUS or APPSTATUS(warehouse name), Application Status (caption), Application_Status (attribute name), andAPPSTATUS (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Availability attribute groupThe Availability attribute group contains the availability data for all processes and services that make upthis application. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Application Component attribute

The descriptive name of a part of the application. This attribute is a key attribute. The type isstring.

The following names are defined for this attribute: APPLICATION_COMPONENT orCOMPONENT (warehouse name), Application Component (caption), Application_Component(attribute name), and COMPONENT (column name).

Chapter 2. Attributes 23

Page 30: Microsoft BizTalk Server agent Reference - IBM

Command Line attributeThe program name and any arguments specified on the command line when the process wasstarted. For Service or Functionality test, this attribute has the value N/A. The type is string withenumerated values. The following values are defined: N/A (N/A). Any value that does not havea definition here is displayed in the User Interface.

The following names are defined for this attribute: COMMAND_LINE or CMDLINE (warehousename), Command Line (caption), Command_Line (attribute name), and CMDLINE (columnname).

Full Name attributeThe full name of the process that includes the path. The type is string with enumerated values.The following values are defined: N/A (N/A). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: FULL_NAME or FULLNAME (warehousename), Full Name (caption), Full_Name (attribute name), and FULLNAME (column name).

Functionality Test Message attributeThe text message that corresponds to the Functionality Test Status. This attribute is only valid forfunctionality tests. The type is string with enumerated values. The following values are defined:N/A (N/A). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: FUNCTIONALITY_TEST_MESSAGE orFUNCMSG (warehouse name), Functionality Test Message (caption), Functionality_Test_Message(attribute name), and FUNCMSG (column name).

Functionality Test Status attributeThe return code of the functionality test. When the monitored application is running correctly,'SUCCESS' is displayed. 'NOT_RUNNING' is displayed when it is not running correctly. 'N/A' isdisplayed when the row does not represent a functionality test. The type is integer withenumerated values. The following values are defined: SUCCESS (0), N/A (1), GENERAL ERROR(2), WARNING (3), NOT RUNNING (4), DEPENDENT NOT RUNNING (5), ALREADYRUNNING (6), PREREQ NOT RUNNING (7), TIMED OUT (8), DOESNT EXIST (9), UNKNOWN(10), DEPENDENT STILL RUNNING (11), INSUFFICIENT USER AUTHORITY (12). Any valuethat does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: FUNCTIONALITY_TEST_STATUS orFUNCSTATUS (warehouse name), Functionality Test Status (caption), Functionality_Test_Status(attribute name), and FUNCSTATUS (column name).

Name attributeThe name of the process, service, or functionality test. This name matches the executable name ofthe process, the service short name or the name of the process used to test the application. Thetype is string with enumerated values. The following values are defined: N/A (N/A). Any valuethat does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Page Faults per Sec attributeThe rate of page faults for the process measured in faults per second. This attribute contains onlyvalid data for processes. The type is integer (32-bit gauge).

The following names are defined for this attribute: PAGE_FAULTS_PER_SEC or PAGEFAULTS(warehouse name), Page Faults per Sec (caption), Page_Faults_per_Sec (attribute name), andPAGEFAULTS (column name).

24 Microsoft BizTalk Server agent Reference

Page 31: Microsoft BizTalk Server agent Reference - IBM

Percent Privileged Time attributeThe percentage of the available CPU time being used by this process for privileged operation.The type is integer (32-bit gauge).

The following names are defined for this attribute: PERCENT_PRIVILEGED_TIME or PERCPRIV(warehouse name), Percent Privileged Time (caption), Percent_Privileged_Time (attribute name),and PERCPRIV (column name).

Percent Processor Time attributeThe percentage of the elapsed time that this process used the processor to execute instructions.The type is integer (32-bit gauge).

The following names are defined for this attribute: PERCENT_PROCESSOR_TIME or PERCPROC(warehouse name), Percent Processor Time (caption), Percent_Processor_Time (attribute name),and PERCPROC (column name).

Percent User Mode Time attributeThe percentage of the available CPU time being used by this process for user mode operation.The type is integer (32-bit gauge).

The following names are defined for this attribute: PERCENT_USER_MODE_TIME or PERCUSER(warehouse name), Percent User Mode Time (caption), Percent_User_Mode_Time (attribute name),and PERCUSER (column name).

PID attributeThe process ID associated with the process. This attribute contains only valid data for processes.The type is integer (32-bit gauge).

The following names are defined for this attribute: PID (warehouse name), PID (caption), PID(attribute name), and PID (column name).

Status attributeThe 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 isrunning but the resource use information cannot be collected for that process.

v For services 'UP', 'DOWN', or 'UNKNOWN': 'UNKNOWN' is displayed when the service is notinstalled.

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

The type is integer with enumerated values. The following values are defined: DOWN (0), UP (1),WARNING (2), UNKNOWN (3), PASSED (4), FAILED (5), PROCESS DATA NOT AVAILABLE (6).Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: STATUS (warehouse name), Status (caption),Status (attribute name), and STATUS (column name).

Thread Count attributeThe number of threads currently allocated by this process. This attribute contains only valid datafor processes. The type is integer (32-bit gauge).

The following names are defined for this attribute: THREAD_COUNT or THREADS (warehousename), Thread Count (caption), Thread_Count (attribute name), and THREADS (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Type attributeThe type of the application component. Components are processes, services, or functionality tests.The type is integer with enumerated values. The following values are defined: PROCESS (0),SERVICE (1), FUNCTIONALITY TEST (2). Any value that does not have a definition here isdisplayed in the User Interface.

Chapter 2. Attributes 25

Page 32: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: TYPE (warehouse name), Type (caption), Type(attribute name), and TYPE (column name).

Virtual Size attributeThe virtual size (in MB) of the process. The type is integer (32-bit gauge).

The following names are defined for this attribute: VIRTUAL_SIZE or VIRTSIZE (warehousename), Virtual Size (caption), Virtual_Size (attribute name), and VIRTSIZE (column name).

Working Set Size attributeThe working set size of the process in MB. This attribute contains only valid data for processes.The type is integer (32-bit gauge).

The following names are defined for this attribute: WORKING_SET_SIZE or WORKSET(warehouse name), Working Set Size (caption), Working_Set_Size (attribute name), andWORKSET (column name).

BAM Database attribute groupThe BAM Database attribute group includes attributes that provide information about the BizTalk BAMDatabase. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Database Name attribute

This attribute displays the BAM Database name. The type is string.

The following names are defined for this attribute: DATABASE_NAME or BAMDBNAME(warehouse name), Database Name (caption), Database_Name (attribute name), andBAMDBNAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the BAM Database server name. The type is string.

The following names are defined for this attribute: SERVER_NAME or BAMDBSERVE(warehouse name), Server Name (caption), Server_Name (attribute name), and BAMDBSERVE(column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

BAM Interceptor attribute groupThe BAM Interceptor attribute group includes attributes that provide information about Business ActivityMonitoring (BAM) events. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Avg Extraction sec per BAM Event attribute

This attribute displays the average amount of time (in seconds) currently spent in extracting theBAM events. The type is integer (32-bit gauge).

The following names are defined for this attribute: AVG_EXTRACTION_SEC_PER_BAM_EVENTor AVG_EXTRAC (warehouse name), Avg Extraction sec per BAM Event (caption),Avg_Extraction_Sec_Per_BAM_Event (attribute name), and AVG_EXTRAC (column name).

26 Microsoft BizTalk Server agent Reference

Page 33: Microsoft BizTalk Server agent Reference - IBM

Avg Failed BAM Events per Flush attributeThis attribute displays the average number of BAM events that currently failed during a dataflush to the primary import database since the Biztalk server was started. The type is integer(64-bit gauge).

The following names are defined for this attribute: AVG_FAILED_BAM_EVENTS_PER_FLUSH orAVGFABAME (warehouse name), Avg Failed BAM Events per Flush (caption),Avg_Failed_BAM_Events_Per_Flush (attribute name), and AVGFABAME (column name).

Avg Flush sec per BAM Event attributeThis attribute displays the average amount of time (in seconds) currently spent in flushing BAMevents. The type is integer (32-bit gauge).

The following names are defined for this attribute: AVG_FLUSH_SEC_PER_BAM_EVENT orAVGFLBMEV (warehouse name), Avg Flush sec per BAM Event (caption),Avg_Flush_Sec_Per_BAM_Event (attribute name), and AVGFLBMEV (column name).

Avg Successful BAM Events per Flush attributeThis attribute displays the average number of successful BAM events that occurred during a dataflush to the primary import database. The type is integer (64-bit gauge).

The following names are defined for this attribute:AVG_SUCCESSFUL_BAM_EVENTS_PER_FLUSH or AVGSUCBME (warehouse name), AvgSuccessful BAM Events per Flush (caption), Avg_Successful_BAM_Events_Per_Flush (attributename), and AVGSUCBME (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Total Failed BAM Events During Flush attributeThis attribute displays the total number of BAM events that failed during a data flush since theBizTalk Server was started. The type is integer (32-bit counter).

The following names are defined for this attribute:TOTAL_FAILED_BAM_EVENTS_DURING_FLUSH or TOTFABAME (warehouse name), TotalFailed BAM Events During Flush (caption), Total_Failed_BAM_Events_During_Flush (attributename), and TOTFABAME (column name).

Total Successful BAM Events During Flush attributeThis attribute displays the total number of successful BAM events that occurred during a dataflush operation to the primary import database since the BizTalk Server was started. The type isinteger (32-bit counter).

The following names are defined for this attribute:TOTAL_SUCCESSFUL_BAM_EVENTS_DURING_FLUSH or TOTSUCBME (warehouse name),Total Successful BAM Events During Flush (caption),Total_Successful_BAM_Events_During_Flush (attribute name), and TOTSUCBME (column name).

Chapter 2. Attributes 27

Page 34: Microsoft BizTalk Server agent Reference - IBM

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. This attribute group is eligiblefor use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Group Name attribute

This attribute displays the BizTalk group name. This attribute is a key attribute. The type isstring.

The following names are defined for this attribute: GROUP_NAME or GRPNAME (warehousename), Group Name (caption), Group_Name (attribute name), and GRPNAME (column name).

Host Instance attributeThis attribute displays the host instance name. The type is string.

The following names are defined for this attribute: HOST_INSTANCE or HOSTINST (warehousename), Host Instance (caption), Host_Instance (attribute name), and HOSTINST (column name).

Host Instance Status attributeThis attribute displays the host instance service status. The type is integer with enumeratedvalues. The following values are defined: Stopped (1), Start pending (2), Stop pending (3),Running (4), Continue pending (5), Pause pending (6), Paused (7), Unknown (8). Any value thatdoes not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: HOST_INSTANCE_STATUS or HSTINSTST(warehouse name), Host Instance Status (caption), Host_Instance_Status (attribute name), andHSTINSTST (column name).

Host Name attributeThis attribute displays the host name. The type is string.

The following names are defined for this attribute: HOST_NAME or HOSTNAME (warehousename), Host Name (caption), Host_Name (attribute name), and HOSTNAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

BizTalk Host attribute groupThe BizTalk Host attribute group includes attributes that provide information about the BizTalk groupand BizTalk hosts. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Group Name attribute

This attribute displays the BizTalk group name. This attribute is a key attribute. The type isstring.

The following names are defined for this attribute: GROUP_NAME or GRPNAME (warehousename), Group Name (caption), Group_Name (attribute name), and GRPNAME (column name).

28 Microsoft BizTalk Server agent Reference

Page 35: Microsoft BizTalk Server agent Reference - IBM

Host Name attributeThis attribute displays the host name. The type is string.

The following names are defined for this attribute: HOST_NAME or HOSTNAME (warehousename), Host Name (caption), Host_Name (attribute name), and HOSTNAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

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. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:LOB Time attribute

This attribute displays the total time spent in milliseconds in the LOB application for a specificaction type. The type is integer (32-bit gauge).

The following names are defined for this attribute: LOB_TIME_CUMULATIVE or LOB_TIME_C(warehouse name), LOB Time (caption), LOB_Time_Cumulative (attribute name), andLOB_TIME_C (column name).

LOB Time Delta attributeThis attribute displays the change in time spent in the LOB application for a specific action type.The type is integer (difference between successive values).

The following names are defined for this attribute: LOB_TIME_CUMULATIVE_DELTA orLOB_TIMECD (warehouse name), LOB Time Delta (caption), LOB_Time_Cumulative_Delta(attribute name), and LOB_TIMECD (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column 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. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:

Chapter 2. Attributes 29

Page 36: Microsoft BizTalk Server agent Reference - IBM

LOB Time attributeThis attribute displays the total time spent in milliseconds in the LOB application for a specificaction type. The type is integer (32-bit gauge).

The following names are defined for this attribute: LOB_TIME_CUMULATIVE or LOB_TIME_C(warehouse name), LOB Time (caption), LOB_Time_Cumulative (attribute name), andLOB_TIME_C (column name).

LOB Time Delta attributeThis attribute displays the change in time spent in the LOB application for a specific action type.The type is integer (difference between successive values).

The following names are defined for this attribute: LOB_TIME_CUMULATIVE_DELTA orLOB_TIMECD (warehouse name), LOB Time Delta (caption), LOB_Time_Cumulative_Delta(attribute name), and LOB_TIMECD (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column 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. Thisattribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:LOB Time attribute

This attribute displays the total time spent in milliseconds in the LOB application for a specificaction type. The type is integer (32-bit gauge).

The following names are defined for this attribute: LOB_TIME_CUMULATIVE or LOB_TIME_C(warehouse name), LOB Time (caption), LOB_Time_Cumulative (attribute name), andLOB_TIME_C (column name).

LOB Time Delta attributeThis attribute displays the change in time spent in the LOB application for a specific action type.The type is integer (difference between successive values).

The following names are defined for this attribute: LOB_TIME_CUMULATIVE_DELTA orLOB_TIMECD (warehouse name), LOB Time Delta (caption), LOB_Time_Cumulative_Delta(attribute name), and LOB_TIMECD (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

30 Microsoft BizTalk Server agent Reference

Page 37: Microsoft BizTalk Server agent Reference - IBM

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column 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.This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:LOB Time attribute

This attribute displays the total time spent in milliseconds in the LOB application for a specificaction type. The type is integer (32-bit gauge).

The following names are defined for this attribute: LOB_TIME_CUMULATIVE or LOB_TIME_C(warehouse name), LOB Time (caption), LOB_Time_Cumulative (attribute name), andLOB_TIME_C (column name).

LOB Time Delta attributeThis attribute displays the change in time spent in the LOB application for a specific action type.The type is integer (difference between successive values).

The following names are defined for this attribute: LOB_TIME_CUMULATIVE_DELTA orLOB_TIMECD (warehouse name), LOB Time Delta (caption), LOB_Time_Cumulative_Delta(attribute name), and LOB_TIMECD (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column 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. Thisattribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:LOB Time attribute

This attribute displays the total time spent in milliseconds in the LOB application for a specificaction type. The type is integer (32-bit gauge).

The following names are defined for this attribute: LOB_TIME_CUMULATIVE or LOB_TIME_C(warehouse name), LOB Time (caption), LOB_Time_Cumulative (attribute name), andLOB_TIME_C (column name).

LOB Time Delta attributeThis attribute displays the change in time spent in the LOB application for a specific action type.The type is integer (difference between successive values).

Chapter 2. Attributes 31

Page 38: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: LOB_TIME_CUMULATIVE_DELTA orLOB_TIMECD (warehouse name), LOB Time Delta (caption), LOB_Time_Cumulative_Delta(attribute name), and LOB_TIMECD (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

BizTalk Server attribute groupThe BizTalk Server attribute group includes attributes that provide information about the BizTalk groupand BizTalk servers. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Group Name attribute

This attribute displays the BizTalk group name. This attribute is a key attribute. The type isstring.

The following names are defined for this attribute: GROUP_NAME or GRPNAME (warehousename), Group Name (caption), Group_Name (attribute name), and GRPNAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Delivery Channels attribute groupThis attribute group includes attributes that provide information about the delivery channels object of aNotification Services instance for BAM. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:Messages Written To Transport attribute

This attribute displays the total number of messages written by the selected delivery channelsince the distributor was started. The type is integer (64-bit counter).

The following names are defined for this attribute: MESSAGES_WRITTEN_TO_TRANSPORT orMSGWTRN (warehouse name), Messages Written To Transport (caption),Messages_Written_To_Transport (attribute name), and MSGWTRN (column name).

32 Microsoft BizTalk Server agent Reference

Page 39: Microsoft BizTalk Server agent Reference - IBM

Messages Written To Transport Rate attributeThis attribute displays the number of messages currently written per second by the selecteddelivery channel. The type is integer (64-bit gauge).

The following names are defined for this attribute:MESSAGES_WRITTEN_TO_TRANSPORT_RATE or MSGWTRR (warehouse name), MessagesWritten To Transport Rate (caption), Messages_Written_To_Transport_Rate (attribute name), andMSGWTRR (column name).

Name attributeThis attribute displays the instance name for the delivery channels object. This attribute is a keyattribute. The type is string.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Distributors attribute groupThis attribute group includes attributes that provide information about the distributor components of aNotification Services instance for BAM. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:Delivery Requests Failed attribute

This attribute displays the total number of delivery requests that failed since the distributor wasstarted. The type is integer (32-bit counter).

The following names are defined for this attribute: DELIVERY_REQUESTS_FAILED orDELIVREQUF (warehouse name), Delivery Requests Failed (caption), Delivery_Requests_Failed(attribute name), and DELIVREQUF (column name).

Delivery Requests Succeeded attributeThis attribute displays the total number of delivery requests that succeeded since the distributorwas started. The type is integer (32-bit counter).

The following names are defined for this attribute: DELIVERY_REQUESTS_SUCCEEDED orDELIVREQUS (warehouse name), Delivery Requests Succeeded (caption),Delivery_Requests_Succeeded (attribute name), and DELIVREQUS (column name).

Format Requests Failed attributeThis attribute displays the total number of format requests that failed since the distributor wasstarted. The type is integer (32-bit counter).

The following names are defined for this attribute: FORMAT_REQUESTS_FAILED orFORMATREQF (warehouse name), Format Requests Failed (caption), Format_Requests_Failed(attribute name), and FORMATREQF (column name).

Chapter 2. Attributes 33

Page 40: Microsoft BizTalk Server agent Reference - IBM

Format Requests Succeeded attributeThis attribute displays the total number of format requests that succeeded since the distributorwas started. The type is integer (32-bit counter).

The following names are defined for this attribute: FORMAT_REQUESTS_SUCCEEDED orFORMATREQS (warehouse name), Format Requests Succeeded (caption),Format_Requests_Succeeded (attribute name), and FORMATREQS (column name).

Name attributeThis attribute displays the instance name for distributor components. This attribute is a keyattribute. The type is string.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Notification Bodies attributeThis attribute displays the total number of notification bodies that were processed by thedistributor since it was started. The type is integer (32-bit counter).

The following names are defined for this attribute: NOTIFICATION_BODIES or NOTIFIBODY(warehouse name), Notification Bodies (caption), Notification_Bodies (attribute name), andNOTIFIBODY (column name).

Notification Headers attributeThis attribute displays the total number of notification headers that were processed by thedistributor since it was started. The type is integer (32-bit counter).

The following names are defined for this attribute: NOTIFICATION_HEADERS or NOTIFIHEAD(warehouse name), Notification Headers (caption), Notification_Headers (attribute name), andNOTIFIHEAD (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Event Log attribute groupThe Event Log attribute group contains any event log entries that pertain to this application. Thisattribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Event Category attribute

The category of the event. The type is string with enumerated values. The following values aredefined: None (None). Any value that does not have a definition here is displayed in the UserInterface.

The following names are defined for this attribute: EVENT_CATEGORY or EVTCATEG(warehouse name), Event Category (caption), Event_Category (attribute name), and EVTCATEG(column name).

Event ID attributeThe ID of the event. The type is integer (32-bit counter).

34 Microsoft BizTalk Server agent Reference

Page 41: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: EVENT_ID or EVTID (warehouse name),Event ID (caption), Event_ID (attribute name), and EVTID (column name).

Event Source attributeThe event source defined by the application. The type is string.

The following names are defined for this attribute: EVENT_SOURCE or EVTSOURCE (warehousename), Event Source (caption), Event_Source (attribute name), and EVTSOURCE (column name).

Event Type attributeThe type of event, for example, Error(0), Warning(1), Informational(2), Audit_Success(3),Audit_Failure(4), and Unknown(5). The type is integer with enumerated values. The followingvalues are defined: Error (0), Warning (1), Informational (2), Audit Success (3), Audit Failure (4),Unknown (5). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: EVENT_TYPE or EVTTYPE (warehousename), Event Type (caption), Event_Type (attribute name), and EVTTYPE (column name).

Log Name attributeThe name of the event log, for example, Application, System, Security or an application-specificlog. The type is string.

The following names are defined for this attribute: LOG_NAME or LOGNAME (warehousename), Log Name (caption), Log_Name (attribute name), and LOGNAME (column name).

Message attributeThe event message. The type is string.

The following names are defined for this attribute: MESSAGE (warehouse name), Message(caption), Message (attribute name), and MESSAGE (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Time Generated attributeThe time the event was generated. The type is timestamp.

The following names are defined for this attribute: TIME_GENERATED or TIMESTAMP(warehouse name), Time Generated (caption), Time_Generated (attribute name), and TIMESTAMP(column name).

Event Providers attribute groupThis attribute group includes attributes that provide information about the event provider object of aNotification Services instance for BAM. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:Event Batches Aborted attribute

This attribute displays the total number of event batches that failed since the event provider wasstarted. The type is integer (64-bit counter).

The following names are defined for this attribute: EVENT_BATCHES_ABORTED or EVENABT(warehouse name), Event Batches Aborted (caption), Event_Batches_Aborted (attribute name),and EVENABT (column name).

Event Batches Committed attributeThis attribute displays the number of event batches committed since the event provider wasstarted. The type is integer (64-bit counter).

The following names are defined for this attribute: EVENT_BATCHES_COMMITTED orEVENBTCMTD (warehouse name), Event Batches Committed (caption),Event_Batches_Committed (attribute name), and EVENBTCMTD (column name).

Chapter 2. Attributes 35

Page 42: Microsoft BizTalk Server agent Reference - IBM

Events Per Batch attributeThis attribute displays the number of events per event batch for the selected event provider. Thetype is integer (32-bit gauge).

The following names are defined for this attribute: EVENTS_PER_BATCH or EVENPERBT(warehouse name), Events Per Batch (caption), Events_Per_Batch (attribute name), andEVENPERBT (column name).

Events Received attributeThis attribute displays the total number of events received since the event provider was started.The type is integer (64-bit counter).

The following names are defined for this attribute: EVENTS_RECEIVED or EVENTSRECD(warehouse name), Events Received (caption), Events_Received (attribute name), andEVENTSRECD (column name).

Events Received Per Second attributeThis attribute displays the number of input events received currently per second for the selectedevent provider. The type is integer (64-bit gauge).

The following names are defined for this attribute: EVENTS_RECEIVED_PER_SECOND orEVENRECPS (warehouse name), Events Received Per Second (caption),Events_Received_Per_Second (attribute name), and EVENRECPS (column name).

Name attributeThis attribute displays the instance name for the event provider object. This attribute is a keyattribute. The type is string.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Events attribute groupThis attribute group includes attributes that provide information about the events object of a NotificationServices instance for BAM. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Event Batches Awaiting Generation attribute

This attribute displays the number of event batches that are currently committed but not pickedup by the generator. The type is integer (32-bit gauge).

The following names are defined for this attribute:EVENT_BATCHES_AWAITING_GENERATION or EVENTBATCH (warehouse name), EventBatches Awaiting Generation (caption), Event_Batches_Awaiting_Generation (attribute name), andEVENTBATCH (column name).

Event Batches In Collection attributeThis attribute displays the number of event batches that are currently in process and notcommitted. The type is integer (32-bit gauge).

36 Microsoft BizTalk Server agent Reference

Page 43: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: EVENT_BATCHES_IN_COLLECTION orEVENTBATC0 (warehouse name), Event Batches In Collection (caption),Event_Batches_In_Collection (attribute name), and EVENTBATC0 (column name).

Event Batches Submitted attributeThis attribute displays the number of event batches currently submitted. The type is integer(32-bit gauge).

The following names are defined for this attribute: EVENT_BATCHES_SUBMITTED orEVENTBATC1 (warehouse name), Event Batches Submitted (caption), Event_Batches_Submitted(attribute name), and EVENTBATC1 (column name).

Name attributeThis attribute displays the instance name for events object. This attribute is a key attribute. Thetype is string.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Total Events attributeThis attribute displays the number of events that are received since the application was started.The type is integer (32-bit counter).

The following names are defined for this attribute: TOTAL_EVENTS or TOTALEVENT(warehouse name), Total Events (caption), Total_Events (attribute name), and TOTALEVENT(column name).

File Receive Adapter attribute groupThe File Receive Adapter attribute group includes attributes that provide information about bytes andmessages received by file adapter. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Bytes Received Per Sec attribute

This attribute displays the number of bytes currently received by the File Receive Adapter persecond. This attribute is the 64-bit version of the Bytes Received Per Sec (Superseded) attribute.The type is real number (64-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: BYTES_RECEIVED_PER_SEC_64 orFBREC0_64 (warehouse name), Bytes Received Per Sec (caption), Bytes_Received_Per_Sec_64(attribute name), and FBREC0_64 (column name).

Bytes Received Per Sec (Superseded) attributeThis attribute displays the number of bytes received by the File Receive Adapter per second. Thecounter applies only to messages that have been completely read by the file adapter from the filesystem. The type is real number (32-bit gauge) with two decimal places of precision.

Chapter 2. Attributes 37

Page 44: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: BYTES_RECEIVED_PER_SEC or BYTES_REC0(warehouse name), Bytes Received Per Sec (Superseded) (caption), Bytes_Received_Per_Sec(attribute name), and BYTES_REC0 (column name).

Delete Retries attributeThis attribute displays the number of times the File Receive Adapter attempts to delete a file thathas been read. The type is integer (32-bit gauge).

The following names are defined for this attribute: DELETE_RETRIES or DELETE_RET(warehouse name), Delete Retries (caption), Delete_Retries (attribute name), and DELETE_RET(column name).

Kilobytes Received attributeThis attribute displays the total number of kilobytes currently received by the File ReceiveAdapter BizTalk Server was started. This attribute is the 64-bit version of the Kilobytes Received(Superseded) attribute. The type is real number (64-bit counter).

The following names are defined for this attribute: KILOBYTES_RECEIVED_64 or FKBREC64(warehouse name), Kilobytes Received (caption), Kilobytes_Received_64 (attribute name), andFKBREC64 (column name).

Kilobytes Received (Superseded) attributeThis attribute displays the total number of kilobytes received by the File Receive Adapter sincethe application started. The counter is incremented after a message is read by the adapter fromthe file system. The type is real number (32-bit counter) with two decimal places of precision.

The following names are defined for this attribute: KILOBYTES_RECEIVED or BYTES_REC1(warehouse name), Kilobytes Received (Superseded) (caption), Kilobytes_Received (attributename), and BYTES_REC1 (column name).

Lock Failures attributeThis attribute displays the number of times the File Receive Adapter currently failed to lock thefile. This attribute is the 64-bit version of the Lock Failures (Superseded) attribute. The type isinteger (64-bit gauge).

The following names are defined for this attribute: LOCK_FAILURES_64 or LOCKFAIL64(warehouse name), Lock Failures (caption), Lock_Failures_64 (attribute name), and LOCKFAIL64(column name).

Lock Failures (Superseded) attributeThis attribute displays the number of times the File Receive Adapter failed to lock the file sincethe Biztalk server was started. The type is integer (32-bit gauge).

The following names are defined for this attribute: LOCK_FAILURES or LOCK_FAILU(warehouse name), Lock Failures (Superseded) (caption), Lock_Failures (attribute name), andLOCK_FAILU (column name).

Lock Failures Per Sec attributeThis attribute displays the number of times the File Receive Adapter currently failed to lock thefile per second. This attribute is the 64-bit version of the Lock Failures Per Sec (Superseded)attribute. The type is real number (64-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: LOCK_FAILURES_PER_SEC_64 or LCKFAIL64(warehouse name), Lock Failures Per Sec (caption), Lock_Failures_Per_Sec_64 (attribute name),and LCKFAIL64 (column name).

Lock Failures Per Sec (Superseded) attributeThis attribute displays the number of times the File Receive Adapter failed to lock the file persecond since the Biztalk server was started. The type is real number (32-bit gauge) with twodecimal places of precision.

The following names are defined for this attribute: LOCK_FAILURES_PER_SEC or LOCK_FAIL0(warehouse name), Lock Failures Per Sec (Superseded) (caption), Lock_Failures_Per_Sec (attributename), and LOCK_FAIL0 (column name).

Messages Received attributeThis attribute displays the total number of messages received by the File Receive Adapter since

38 Microsoft BizTalk Server agent Reference

Page 45: Microsoft BizTalk Server agent Reference - IBM

the application started. The counter is incremented after a message is read by the File ReceiveAdapter from the file system. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_RECEIVED or MESSAGES_R(warehouse name), Messages Received (caption), Messages_Received (attribute name), andMESSAGES_R (column name).

Messages Received Per Sec attributeThis attribute displays the number of messages received by the File Receive Adapter per second.The counter applies only to messages that have been completely read by the File Receive Adapterfrom the file system. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGES_RECEIVED_PER_SEC orMESSAGES_0 (warehouse name), Messages Received Per Sec (caption),Messages_Received_Per_Sec (attribute name), and MESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Time To Build Batch attributeThis attribute displays the average time taken by File Receive Adapter to build a batch. The typeis integer (32-bit gauge).

The following names are defined for this attribute: TIME_TO_BUILD_BATCH or TIME_TO_BU(warehouse name), Time To Build Batch (caption), Time_To_Build_Batch (attribute name), andTIME_TO_BU (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

File Send Adapter attribute groupThe File Send Adapter attribute group includes attributes that provide information about bytes andmessages sent by file adapter. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Bytes Sent Per Sec attribute

This attribute displays the number of bytes currently sent by the File Send Adapter per second.This attribute is the 64-bit version of the Bytes Sent Per Sec (Superseded) attribute. The type isreal number (64-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: BYTES_SENT_PER_SEC_64 or FBSEN0_64(warehouse name), Bytes Sent Per Sec (caption), Bytes_Sent_Per_Sec_64 (attribute name), andFBSEN0_64 (column name).

Bytes Sent Per Sec (Superseded) attributeThis attribute displays the number of bytes sent by the File Send Adapter per second. Thecounter applies only to messages that have been completely written to file system. The type isreal number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: BYTES_SENT_PER_SEC or BYTES_SEN0(warehouse name), Bytes Sent Per Sec (Superseded) (caption), Bytes_Sent_Per_Sec (attributename), and BYTES_SEN0 (column name).

Chapter 2. Attributes 39

Page 46: Microsoft BizTalk Server agent Reference - IBM

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

The following names are defined for this attribute: KILOBYTES_SENT_64 or FBSEN1_64(warehouse name), Kilobytes Sent (caption), Kilobytes_Sent_64 (attribute name), and FBSEN1_64(column name).

Kilobytes Sent (Superseded) attributeThis attribute displays the total number of kilobytes sent by the File Send Adapter since theapplication started since the application started. The counter is incremented only for messagesthat have been completely written to file system. The type is real number (32-bit counter) withtwo decimal places of precision.

The following names are defined for this attribute: KILOBYTES_SENT or BYTES_SEN1(warehouse name), Kilobytes Sent (Superseded) (caption), Kilobytes_Sent (attribute name), andBYTES_SEN1 (column name).

Messages Sent attributeThis attribute displays the total number of messages sent by the File Send Adapter since theapplication started. The counter is incremented only for messages that have been completelywritten to file system. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_SENT or MESSAGES_S(warehouse name), Messages Sent (caption), Messages_Sent (attribute name), and MESSAGES_S(column name).

Messages Sent Per Sec attributeThis attribute displays the number of messages sent by the File Send Adapter per second. Thecounter applies only to messages that have been completely written to file system. The type isreal number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGES_SENT_PER_SEC or MESSAGES_0(warehouse name), Messages Sent Per Sec (caption), Messages_Sent_Per_Sec (attribute name), andMESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

FTP Receive Adapter attribute groupThe FTP Receive Adapter attribute group includes attributes that provide information about bytes andmessages received by FTP adapter. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Bytes Received Per Sec attribute

This attribute displays the number of bytes currently received by the FTP Receive Adapter persecond. This attribute is the 64-bit version of the Bytes Received Per Sec (Superseded) attribute.The type is real number (64-bit gauge) with two decimal places of precision.

40 Microsoft BizTalk Server agent Reference

Page 47: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: BYTES_RECEIVED_PER_SEC_64 orFTPREC0_64 (warehouse name), Bytes Received Per Sec (caption), Bytes_Received_Per_Sec_64(attribute name), and FTPREC0_64 (column name).

Bytes Received Per Sec (Superseded) attributeThis attribute displays the number of bytes received by the FTP Receive Adapter per second. Thecounter applies only to messages that have been completely read by the FTP Receive Adapterfrom the FTP server. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: BYTES_RECEIVED_PER_SEC or BYTES_REC0(warehouse name), Bytes Received Per Sec (Superseded) (caption), Bytes_Received_Per_Sec(attribute name), and BYTES_REC0 (column name).

Kilobytes Received attributeThis attribute displays the total number of KB currently received by the FTP Receive Adapter.This attribute is the 64-bit version of the Kilobytes Received (Superseded) attribute. The type isreal number (64-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: KILOBYTES_RECEIVED_64 or FTPKBRE_64(warehouse name), Kilobytes Received (caption), Kilobytes_Received_64 (attribute name), andFTPKBRE_64 (column name).

Kilobytes Received (Superseded) attributeThis attribute displays the total number of kilobytes received by the FTP Receive Adapter sincethe Biztalk server was started. The counter is incremented after a message is read by the FTPReceive Adapter from the FTP server. The type is real number (32-bit counter) with two decimalplaces of precision.

The following names are defined for this attribute: KILOBYTES_RECEIVED or BYTES_REC1(warehouse name), Kilobytes Received (Superseded) (caption), Kilobytes_Received (attributename), and BYTES_REC1 (column name).

Messages Received attributeThis attribute displays the total number of messages received by the FTP Receive Adapter sincethe application started. The counter is incremented after a message is read by the FTP ReceiveAdapter from the FTP server. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_RECEIVED or MESSAGES_R(warehouse name), Messages Received (caption), Messages_Received (attribute name), andMESSAGES_R (column name).

Messages Received Per Sec attributeThis attribute displays the number of messages received by the FTP Receive Adapter per second.The counter applies only to messages that have been completely read by the FTP Receive Adapterfrom the FTP server. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGES_RECEIVED_PER_SEC orMESSAGES_0 (warehouse name), Messages Received Per Sec (caption),Messages_Received_Per_Sec (attribute name), and MESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Chapter 2. Attributes 41

Page 48: Microsoft BizTalk Server agent Reference - IBM

FTP Send Adapter attribute groupThe FTP Send Adapter attribute group includes attributes that provide information about bytes andmessages sent by FTP adapter. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Bytes Sent Per Sec attribute

This attribute displays the number of currently bytes sent by the FTP Send Adapter per second.This attribute is the 64-bit version of the Bytes Sent Per Sec (Superseded) attribute. The type isreal number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: BYTES_SENT_PER_SEC_64 or FTPSEN0_64(warehouse name), Bytes Sent Per Sec (caption), Bytes_Sent_Per_Sec_64 (attribute name), andFTPSEN0_64 (column name).

Bytes Sent Per Sec (Superseded) attributeThis attribute displays the number of bytes sent by the FTP Send Adapter per second. Thecounter applies only to messages that have been written to the destination FTP server. The type isreal number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: BYTES_SENT_PER_SEC or BYTES_SEN0(warehouse name), Bytes Sent Per Sec (Superseded) (caption), Bytes_Sent_Per_Sec (attributename), and BYTES_SEN0 (column name).

Kilobytes Sent attributeThis attribute displays the total number of kilobytes sent by the FTP Send Adapter since theBizTalk Server was started. This attribute is the 64-bit version of the Kilobytes Sent (Superseded)attribute. The type is real number (32-bit counter) with two decimal places of precision.

The following names are defined for this attribute: KILOBYTES_SENT_64 or FTPKBSE_64(warehouse name), Kilobytes Sent (caption), Kilobytes_Sent_64 (attribute name), and FTPKBSE_64(column name).

Kilobytes Sent (Superseded) attributeThis attribute displays the total number of kilobytes sent by the FTP Send Adapter since theBiztalk server was started. The counter is incremented only for messages that have been writtento the destination FTP server. The type is real number (32-bit counter) with two decimal places ofprecision.

The following names are defined for this attribute: KILOBYTES_SENT or BYTES_SEN1(warehouse name), Kilobytes Sent (Superseded) (caption), Kilobytes_Sent (attribute name), andBYTES_SEN1 (column name).

Messages Sent attributeThis attribute displays the total number of messages sent by the FTP Send Adapter since theapplication started. The counter is incremented only for messages that have been written to thedestination FTP server. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_SENT or MESSAGES_S(warehouse name), Messages Sent (caption), Messages_Sent (attribute name), and MESSAGES_S(column name).

Messages Sent Per Sec attributeThis attribute displays the number of messages sent by the FTP Send Adapter per second. Thecounter applies only to messages that have been written to destination FTP server. The type isreal number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGES_SENT_PER_SEC or MESSAGES_0(warehouse name), Messages Sent Per Sec (caption), Messages_Sent_Per_Sec (attribute name), andMESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

42 Microsoft BizTalk Server agent Reference

Page 49: Microsoft BizTalk Server agent Reference - IBM

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Generator attribute groupThis attribute group includes attributes that provide information about the generator object of aNotification Services instance for BAM. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:Name attribute

This attribute displays the instance name for the generator object. This attribute is a key attribute.The type is string.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Notifications Generated Per Second attributeThis attribute displays the number notifications that are currently created per second. The type isinteger (64-bit gauge).

The following names are defined for this attribute:NOTIFICATIONS_GENERATED_PER_SECOND or NOTIFGPS (warehouse name), NotificationsGenerated Per Second (caption), Notifications_Generated_Per_Second (attribute name), andNOTIFGPS (column name).

Quanta Behind attributeThis attribute displays the number of quanta that the generator is currently lagging. The type isinteger (32-bit gauge).

The following names are defined for this attribute: QUANTA_BEHIND or QNTABHND(warehouse name), Quanta Behind (caption), Quanta_Behind (attribute name), and QNTABHND(column name).

Quanta Failed attributeThis attribute displays the number of quanta that failed since the generator was started. Quantumfailure indicates that at least one of the rules in the quantum failed. The type is integer (64-bitcounter).

The following names are defined for this attribute: QUANTA_FAILED or QNTAFAIL (warehousename), Quanta Failed (caption), Quanta_Failed (attribute name), and QNTAFAIL (column name).

Quanta Processed attributeThis attribute displays the total number of quanta that were processed since the generator wasstarted. If the generator is trying to catch up, this number can be very high. The type is integer(64-bit counter).

The following names are defined for this attribute: QUANTA_PROCESSED or QUANTAPRC(warehouse name), Quanta Processed (caption), Quanta_Processed (attribute name), andQUANTAPRC (column name).

Chapter 2. Attributes 43

Page 50: Microsoft BizTalk Server agent Reference - IBM

Rule Firing Failures attributeThis attribute displays the total number of rule firings that failed since the generator was started.The type is integer (64-bit counter).

The following names are defined for this attribute: RULE_FIRING_FAILURES or RULEFIRFA(warehouse name), Rule Firing Failures (caption), Rule_Firing_Failures (attribute name), andRULEFIRFA (column name).

Rule Firings attributeThis attribute displays the total number of rule firings since the generator was started. The type isinteger (64-bit counter).

The following names are defined for this attribute: RULE_FIRINGS or RULEFIRNG (warehousename), Rule Firings (caption), Rule_Firings (attribute name), and RULEFIRNG (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Skipped Chronicle Rule Firings attributeThis attribute displays the total number of quanta that was skipped for chronicle rule firingssince the generator was started. The type is integer (64-bit counter).

The following names are defined for this attribute: SKIPPED_CHRONICLE_RULE_FIRINGS orSKCHRRUFR (warehouse name), Skipped Chronicle Rule Firings (caption),Skipped_Chronicle_Rule_Firings (attribute name), and SKCHRRUFR (column name).

Skipped Quanta attributeThis attribute displays the total number of quanta that the generator skipped since the generatorwas started. The type is integer (64-bit counter).

The following names are defined for this attribute: SKIPPED_QUANTA or SKIPEDQUN(warehouse name), Skipped Quanta (caption), Skipped_Quanta (attribute name), andSKIPEDQUN (column name).

Skipped Subscription Rule Firings attributeThis attribute displays the number of quanta that is currently skipped for subscription rulefirings. The type is integer (64-bit gauge).

The following names are defined for this attribute: SKIPPED_SUBSCRIPTION_RULE_FIRINGS orSKSUBRUFR (warehouse name), Skipped Subscription Rule Firings (caption),Skipped_Subscription_Rule_Firings (attribute name), and SKSUBRUFR (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

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. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:Active Instance Count attribute

This attribute displays the current number of active instances loaded in memory, including thestandby instances. The type is integer (32-bit gauge).

The following names are defined for this attribute: ACTIVE_INSTANCE_COUNT or ACTIVE_INS(warehouse name), Active Instance Count (caption), Active_Instance_Count (attribute name), andACTIVE_INS (column name).

44 Microsoft BizTalk Server agent Reference

Page 51: Microsoft BizTalk Server agent Reference - IBM

Database Session attributeThis attribute displays the number of open database connections to the MessageBox. The type isinteger (32-bit gauge).

The following names are defined for this attribute: DATABASE_SESSION or DATABASE_S(warehouse name), Database Session (caption), Database_Session (attribute name), andDATABASE_S (column name).

Database Session Threshold attributeThis attribute displays the current threshold for the number of open database connections to theMessageBox. The type is integer (32-bit gauge).

The following names are defined for this attribute: DATABASE_SESSION_THRESHOLD orDATABASE_0 (warehouse name), Database Session Threshold (caption),Database_Session_Threshold (attribute name), and DATABASE_0 (column name).

Database Size attributeThis attribute displays the number of messages in the database queues that this process haspublished. The type is integer (32-bit gauge).

The following names are defined for this attribute: DATABASE_SIZE or DATABASE_1(warehouse name), Database Size (caption), Database_Size (attribute name), and DATABASE_1(column name).

High Database Session attributeThis attribute indicates (in form of status codes) if the number of currently opened databasesessions exceeds the threshold. The type is integer with enumerated values. The following valuesare defined: Normal (0), Threshold exceeded (1). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: HIGH_DATABASE_SESSION orHIGH_DATAB (warehouse name), High Database Session (caption), High_Database_Session(attribute name), and HIGH_DATAB (column name).

High Database Size attributeThis attribute indicates (in form of status codes) whether the database size is normal or exceededthe threshold values. The type is integer with enumerated values. The following values aredefined: Normal (0), Threshold exceeded (1). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: HIGH_DATABASE_SIZE or HIGH_DATA0(warehouse name), High Database Size (caption), High_Database_Size (attribute name), andHIGH_DATA0 (column name).

High In Process Message Count attributeThis attribute indicates (in form of status codes) whether the In-Process message count is normalor exceeded the threshold values. The type is integer with enumerated values. The followingvalues are defined: Normal (0), Threshold exceeded (1). Any value that does not have a definitionhere is displayed in the User Interface.

The following names are defined for this attribute: HIGH_IN_PROCESS_MESSAGE_COUNT orHIGH_IN_PR (warehouse name), High In Process Message Count (caption),High_In_Process_Message_Count (attribute name), and HIGH_IN_PR (column name).

High Message Delivery Rate attributeThis attribute indicates (in form of status codes) if the message delivery rate is higher than themessage processing rate. The type is integer with enumerated values. The following values aredefined: Normal (0), Exceeded the message processing rate (1). Any value that does not have adefinition here is displayed in the User Interface.

The following names are defined for this attribute: HIGH_MESSAGE_DELIVERY_RATE orHIGH_MESSA (warehouse name), High Message Delivery Rate (caption),High_Message_Delivery_Rate (attribute name), and HIGH_MESSA (column name).

High Message Publishing Rate attributeThis attribute indicates (in form of status codes) if the message publishing request rate is higher

Chapter 2. Attributes 45

Page 52: Microsoft BizTalk Server agent Reference - IBM

than the message publishing completion rate. The type is integer with enumerated values. Thefollowing values are defined: Normal (0), Exceeded the message completion rate (1). Any valuethat does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: HIGH_MESSAGE_PUBLISHING_RATE orHIGH_MESS0 (warehouse name), High Message Publishing Rate (caption),High_Message_Publishing_Rate (attribute name), and HIGH_MESS0 (column name).

High Process Memory attributeThis attribute indicates (in form of status codes) if the process memory consumption exceeds thethreshold. The type is integer with enumerated values. The following values are defined: Normal(0), Threshold exceeded (1). Any value that does not have a definition here is displayed in theUser Interface.

The following names are defined for this attribute: HIGH_PROCESS_MEMORY or HIGH_PROCE(warehouse name), High Process Memory (caption), High_Process_Memory (attribute name), andHIGH_PROCE (column name).

High System Memory attributeThis attribute indicates (in form of status codes) if the system-wide physical memoryconsumption exceeds the threshold. The type is integer with enumerated values. The followingvalues are defined: Normal (0), Threshold exceeded (1). Any value that does not have a definitionhere is displayed in the User Interface.

The following names are defined for this attribute: HIGH_SYSTEM_MEMORY or HIGH_SYSTE(warehouse name), High System Memory (caption), High_System_Memory (attribute name), andHIGH_SYSTE (column name).

High Thread Count attributeThis attribute indicates (in form of status codes) if the thread count exceeds the threshold. Thetype is integer with enumerated values. The following values are defined: Normal (0), Thresholdexceeded (1). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: HIGH_THREAD_COUNT or HIGH_THREA(warehouse name), High Thread Count (caption), High_Thread_Count (attribute name), andHIGH_THREA (column name).

In Process Message Count attributeThis attribute displays the number of concurrent messages that the service class is processing.The type is integer (32-bit gauge).

The following names are defined for this attribute: IN_PROCESS_MESSAGE_COUNT orIN_PROCESS (warehouse name), In Process Message Count (caption), In_Process_Message_Count(attribute name), and IN_PROCESS (column name).

In Process Message Count Threshold attributeThis attribute displays the current threshold for the number of concurrent messages that theservice class is processing. The type is integer (32-bit gauge).

The following names are defined for this attribute:IN_PROCESS_MESSAGE_COUNT_THRESHOLD or IN_PROCES0 (warehouse name), In ProcessMessage Count Threshold (caption), In_Process_Message_Count_Threshold (attribute name), andIN_PROCES0 (column name).

Message Delivery Delay In Sec attributeThis attribute displays the current delay in seconds imposed on each message delivery batch.This is applicable if the message delivery is being throttled. The type is real number (32-bitgauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGE_DELIVERY_DELAY_IN_SEC orMESSAGE_D5 (warehouse name), Message Delivery Delay In Sec (caption),Message_Delivery_Delay_In_Sec (attribute name), and MESSAGE_D5 (column name).

46 Microsoft BizTalk Server agent Reference

Page 53: Microsoft BizTalk Server agent Reference - IBM

Message Delivery Incoming Rate attributeThis attribute displays the number of messages per second that are being delivered to theOrchestration engine or the Messaging engine in the given sample interval. The type is integer(32-bit gauge).

The following names are defined for this attribute: MESSAGE_DELIVERY_INCOMING_RATE orMESSAGE_D0 (warehouse name), Message Delivery Incoming Rate (caption),Message_Delivery_Incoming_Rate (attribute name), and MESSAGE_D0 (column name).

Message Delivery Outgoing Rate attributeThis attribute displays the number of messages per second that are being processed by theOrchestration engine or the Messaging engine in the given sample interval. The type is integer(32-bit gauge).

The following names are defined for this attribute: MESSAGE_DELIVERY_OUTGOING_RATE orMESSAGE_D1 (warehouse name), Message Delivery Outgoing Rate (caption),Message_Delivery_Outgoing_Rate (attribute name), and MESSAGE_D1 (column name).

Message Delivery Throttling State attributeThis attribute indicates the throttling state of the message delivery. A non-zero value indicatesthat the message delivery is being throttled. The type is integer with enumerated values. Thefollowing values are defined: Normal (0), Imbalanced message delivery rate (1), High in-processmessage count (3), High process memory (4), High system memory (5), High thread count (9),User override on delivery (10). Any value that does not have a definition here is displayed in theUser Interface.

The following names are defined for this attribute: MESSAGE_DELIVERY_THROTTLING_STATEor MESSAGE_D2 (warehouse name), Message Delivery Throttling State (caption),Message_Delivery_Throttling_State (attribute name), and MESSAGE_D2 (column name).

Message Delivery Throttling State Duration In Min attributeThis attribute displays the minutes spent in the current state (throttling or not throttling) ofmessage delivery throttling. The type is real number (32-bit gauge) with two decimal places ofprecision.

The following names are defined for this attribute:MESSAGE_DELIVERY_THROTTLING_STATE_DURATION_IN_MIN or MESSAGE_D6(warehouse name), Message Delivery Throttling State Duration In Min (caption),Message_Delivery_Throttling_State_Duration_In_Min (attribute name), and MESSAGE_D6(column name).

Message Delivery Throttling User Override attributeThis attribute displays the message publishing throttling user override that is monitored by theengine. The type is integer with enumerated values. The following values are defined: Normal(0), Always throttle message delivery (1), Do not throttle message delivery (2). Any value thatdoes not have a definition here is displayed in the User Interface.

The following names are defined for this attribute:MESSAGE_DELIVERY_THROTTLING_USER_OVERRIDE or MESSAGE_D4 (warehouse name),Message Delivery Throttling User Override (caption),Message_Delivery_Throttling_User_Override (attribute name), and MESSAGE_D4 (column name).

Message Publishing Delay In Sec attributeThis attribute displays the current delay in seconds imposed on each message publishing batch. Itis applicable if the message publishing is being throttled and if the batch is not exempted fromthrottling. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGE_PUBLISHING_DELAY_IN_SEC orMESSAGE_P5 (warehouse name), Message Publishing Delay In Sec (caption),Message_Publishing_Delay_In_Sec (attribute name), and MESSAGE_P5 (column name).

Message Publishing Incoming Rate attributeThis attribute displays the number of messages per second that are being sent to the database forpublishing in the given sample interval. The type is integer (32-bit gauge).

Chapter 2. Attributes 47

Page 54: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: MESSAGE_PUBLISHING_INCOMING_RATEor MESSAGE_P0 (warehouse name), Message Publishing Incoming Rate (caption),Message_Publishing_Incoming_Rate (attribute name), and MESSAGE_P0 (column name).

Message Publishing Outgoing Rate attributeThis attribute displays the number of messages per second that are actually published in thedatabase in the given sample interval. The type is integer (32-bit gauge).

The following names are defined for this attribute: MESSAGE_PUBLISHING_OUTGOING_RATEor MESSAGE_P1 (warehouse name), Message Publishing Outgoing Rate (caption),Message_Publishing_Outgoing_Rate (attribute name), and MESSAGE_P1 (column name).

Message Publishing Throttling State attributeThis attribute displays the throttling state of the message publishing. A non-zero value indicatesthat the message publishing is being throttled. The type is integer with enumerated values. Thefollowing values are defined: Normal (0), Imbalanced message publishing rate (2), High processmemory (4), High system memory (5), Database growth (6), High session count (8), High threadcount (9), User override on publishing (11). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute:MESSAGE_PUBLISHING_THROTTLING_STATE or MESSAGE_P2 (warehouse name), MessagePublishing Throttling State (caption), Message_Publishing_Throttling_State (attribute name), andMESSAGE_P2 (column name).

Message Publishing Throttling State Duration In Min attributeThis attribute displays the minutes spent in the current state (throttling or not throttling) ofmessage publish throttling. The type is real number (32-bit gauge) with two decimal places ofprecision.

The following names are defined for this attribute:MESSAGE_PUBLISHING_THROTTLING_STATE_DURATION_IN_MIN or MESSAGE_P6(warehouse name), Message Publishing Throttling State Duration In Min (caption),Message_Publishing_Throttling_State_Duration_In_Min (attribute name), and MESSAGE_P6(column name).

Message Publishing Throttling User Override attributeThis attribute displays the message delivery throttling user override that is monitored by theengine. The type is integer with enumerated values. The following values are defined: Normal(0), Always throttle message publishing (1), Do not throttle message publishing (2). Any valuethat does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute:MESSAGE_PUBLISHING_THROTTLING_USER_OVERRIDE or MESSAGE_P4 (warehouse name),Message Publishing Throttling User Override (caption),Message_Publishing_Throttling_User_Override (attribute name), and MESSAGE_P4 (columnname).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Physical Memory Usage In MB attributeThis attribute displays the amount of physical memory in megabytes being used on the machineby all processes. The type is integer (32-bit gauge).

48 Microsoft BizTalk Server agent Reference

Page 55: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: PHYSICAL_MEMORY_USAGE_IN_MB orPHYSICAL_M (warehouse name), Physical Memory Usage In MB (caption),Physical_Memory_Usage_In_MB (attribute name), and PHYSICAL_M (column name).

Process Memory Usage In MB attributeThis attribute displays the process memory consumption in megabytes. The type is integer (32-bitgauge).

The following names are defined for this attribute: PROCESS_MEMORY_USAGE_IN_MB orPROCESS_ME (warehouse name), Process Memory Usage In MB (caption),Process_Memory_Usage_In_MB (attribute name), and PROCESS_ME (column name).

Process Memory Usage Threshold In MB attributeThis attribute displays the current threshold for process memory consumption in megabytes. Thetype is integer (32-bit gauge).

The following names are defined for this attribute:PROCESS_MEMORY_USAGE_THRESHOLD_IN_MB or PROCESS_M0 (warehouse name),Process Memory Usage Threshold In MB (caption), Process_Memory_Usage_Threshold_In_MB(attribute name), and PROCESS_M0 (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Thread Count attributeThis attribute displays the number of threads being used within the process. The type is integer(32-bit gauge).

The following names are defined for this attribute: THREAD_COUNT or THREAD_COU(warehouse name), Thread Count (caption), Thread_Count (attribute name), and THREAD_COU(column name).

Thread Count Threshold attributeThis attribute displays the current threshold for the number of threads in the process. The type isinteger (32-bit gauge).

The following names are defined for this attribute: THREAD_COUNT_THRESHOLD orTHREAD_CO0 (warehouse name), Thread Count Threshold (caption), Thread_Count_Threshold(attribute name), and THREAD_CO0 (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Total Batches Committed attributeThis attribute displays the number of database batches that the service class has committed. Thetype is integer (32-bit gauge).

The following names are defined for this attribute: TOTAL_BATCHES_COMMITTED orTOTAL_BATC (warehouse name), Total Batches Committed (caption), Total_Batches_Committed(attribute name), and TOTAL_BATC (column name).

Total Messages Delivered attributeThis attribute displays the number of outbound messages delivered to the Orchestration engineor the End Point Manager (EPM). The type is integer (32-bit gauge).

The following names are defined for this attribute: TOTAL_MESSAGES_DELIVERED orTOTAL_MESS (warehouse name), Total Messages Delivered (caption), Total_Messages_Delivered(attribute name), and TOTAL_MESS (column name).

Total Messages Published attributeThis attribute displays the total number of messages published. The type is integer (32-bit gauge).

Chapter 2. Attributes 49

Page 56: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: TOTAL_MESSAGES_PUBLISHED orTOTAL_MES0 (warehouse name), Total Messages Published (caption), Total_Messages_Published(attribute name), and TOTAL_MES0 (column name).

HTTP Receive Adapter attribute groupThe HTTP Receive Adapter attribute group includes attributes that provide information about requestsreceived and acknowledgements sent by HTTP adapter. This attribute group is eligible for use with TivoliData Warehouse.

This attribute group contains the following attributes:Memory Queue Size attribute

This attribute displays the number of incoming messages in the HTTP Receive Adapter's internalmemory queue. The type is integer (32-bit gauge).

The following names are defined for this attribute: MEMORY_QUEUE_SIZE or MEMORY_QUE(warehouse name), Memory Queue Size (caption), Memory_Queue_Size (attribute name), andMEMORY_QUE (column name).

Messages Received attributeThis attribute displays the total number of HTTP requests received by the HTTP Receive Adaptersince the application started. The counter is incremented after a request message is read by theHTTP Receive Adapter from the HTTP client. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_RECEIVED or MESSAGES_R(warehouse name), Messages Received (caption), Messages_Received (attribute name), andMESSAGES_R (column name).

Messages Received Per Sec attributeThis attribute displays the number of HTTP requests received by the HTTP Receive Adapter persecond. The counter applies only to request messages that have been completely read by theHTTP Receive Adapter from the HTTP client. The type is real number (32-bit gauge) with twodecimal places of precision.

The following names are defined for this attribute: MESSAGES_RECEIVED_PER_SEC orMESSAGES_0 (warehouse name), Messages Received Per Sec (caption),Messages_Received_Per_Sec (attribute name), and MESSAGES_0 (column name).

Messages Sent attributeThis attribute displays the total number of HTTP responses sent by the HTTP Receive Adaptersince the application started. The counter is incremented only for response messages that havebeen successfully sent to HTTP clients. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_SENT or MESSAGES_S(warehouse name), Messages Sent (caption), Messages_Sent (attribute name), and MESSAGES_S(column name).

Messages Sent Per Sec attributeThis attribute displays the number of HTTP responses sent by the HTTP Receive Adapter persecond. The counter applies only to response messages that have been successfully sent to HTTPclients. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGES_SENT_PER_SEC or MESSAGES_1(warehouse name), Messages Sent Per Sec (caption), Messages_Sent_Per_Sec (attribute name), andMESSAGES_1 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

50 Microsoft BizTalk Server agent Reference

Page 57: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Time To Add Message To Batch attributeThis attribute displays the average time between when a message is given to the HTTP ReceiveAdapter by IIS and when the message is added to a batch. The type is real number (32-bit gauge)with two decimal places of precision.

The following names are defined for this attribute: TIME_TO_ADD_MESSAGE_TO_BATCH orTIME_TO_AD (warehouse name), Time To Add Message To Batch (caption),Time_To_Add_Message_To_Batch (attribute name), and TIME_TO_AD (column name).

Time To Build Batch attributeThis attribute displays the average time taken by the HTTP Receive Adapter to build a messagebatch. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: TIME_TO_BUILD_BATCH or TIME_TO_BU(warehouse name), Time To Build Batch (caption), Time_To_Build_Batch (attribute name), andTIME_TO_BU (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

HTTP Send Adapter attribute groupThe HTTP Send Adapter attribute group includes attributes that provide information about responsessent and acknowledgements received by HTTP adapter. This attribute group is eligible for use with TivoliData Warehouse.

This attribute group contains the following attributes:Memory Queue Size attribute

This attribute displays the number of outgoing messages in the HTTP Send Adapter's internalmemory queue. The type is integer (32-bit gauge).

The following names are defined for this attribute: MEMORY_QUEUE_SIZE or MEMORY_QUE(warehouse name), Memory Queue Size (caption), Memory_Queue_Size (attribute name), andMEMORY_QUE (column name).

Messages Received attributeThis attribute displays the total number of HTTP response messages received by the HTTP SendAdapter since the application started. The counter is incremented after a response message isread by the HTTP Send Adapter from HTTP servers. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_RECEIVED or MESSAGES_R(warehouse name), Messages Received (caption), Messages_Received (attribute name), andMESSAGES_R (column name).

Messages Received Per Sec attributeThis attribute displays the number of HTTP responses received by the HTTP Send Adapter persecond. The counter applies only to response messages that have been completely read by theHTTP Send Adapter from HTTP servers. The type is real number (32-bit gauge) with two decimalplaces of precision.

The following names are defined for this attribute: MESSAGES_RECEIVED_PER_SEC orMESSAGES_0 (warehouse name), Messages Received Per Sec (caption),Messages_Received_Per_Sec (attribute name), and MESSAGES_0 (column name).

Messages Sent attributeThis attribute displays the total number of HTTP requests sent by the HTTP Send Adapter sincethe application started. The counter is incremented only for request messages that have reachedthe destination URL. The type is integer (32-bit counter).

Chapter 2. Attributes 51

Page 58: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: MESSAGES_SENT or MESSAGES_S(warehouse name), Messages Sent (caption), Messages_Sent (attribute name), and MESSAGES_S(column name).

Messages Sent Per Sec attributeThis attribute displays the number of HTTP requests sent by the HTTP Send Adapter per second.The counter applies only to request messages that have reached the destination URL. The type isreal number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGES_SENT_PER_SEC or MESSAGES_1(warehouse name), Messages Sent Per Sec (caption), Messages_Sent_Per_Sec (attribute name), andMESSAGES_1 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Human Workflow Services attribute groupThe Human Workflow Services attribute group includes attributes that provide information about theactivities take place between people or processes. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:Activity Flows Retrieved attribute

This attribute displays the number of activity flows retrieved from tracking database. The type isinteger (32-bit gauge).

The following names are defined for this attribute: ACTIVITY_FLOWS_RETRIEVED orACTIVITY_F (warehouse name), Activity Flows Retrieved (caption), Activity_Flows_Retrieved(attribute name), and ACTIVITY_F (column name).

New Action Added attributeThis attribute displays the number of actions added to activity flows. The type is integer (32-bitgauge).

The following names are defined for this attribute: NEW_ACTION_ADDED or NEW_ACTION(warehouse name), New Action Added (caption), New_Action_Added (attribute name), andNEW_ACTION (column name).

New Activity Flows attributeThis attribute displays the number of new activity flows created. The type is integer (32-bitgauge).

The following names are defined for this attribute: NEW_ACTIVITY_FLOWS or NEW_ACTIVI(warehouse name), New Activity Flows (caption), New_Activity_Flows (attribute name), andNEW_ACTIVI (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

52 Microsoft BizTalk Server agent Reference

Page 59: Microsoft BizTalk Server agent Reference - IBM

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Steps Retrieved attributeThis attribute displays the number of actions retrieved from tracking database. The type is integer(32-bit gauge).

The following names are defined for this attribute: STEPS_RETRIEVED or STEPS_RETR(warehouse name), Steps Retrieved (caption), Steps_Retrieved (attribute name), and STEPS_RETR(column name).

Tasks Retrieved attributeThis attribute displays the number of tasks retrieved from tracking database. The type is integer(32-bit gauge).

The following names are defined for this attribute: TASKS_RETRIEVED or TASKS_RETR(warehouse name), Tasks Retrieved (caption), Tasks_Retrieved (attribute name), and TASKS_RETR(column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Management Database attribute groupThe Management Database attribute group includes attributes that provide information about the BizTalkManagement Database. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Database Name attribute

This attribute displays the Management Database name. The type is string.

The following names are defined for this attribute: DATABASE_NAME or MGMTDBNAME(warehouse name), Database Name (caption), Database_Name (attribute name), andMGMTDBNAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the Management Database server name. The type is string.

The following names are defined for this attribute: SERVER_NAME or MGMTDBSERV(warehouse name), Server Name (caption), Server_Name (attribute name), and MGMTDBSERV(column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Message Box General Counters attribute groupThe Message Box General Counters attribute group includes attributes that provide information aboutMessageBox database used by the BizTalk Server. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:

Chapter 2. Attributes 53

Page 60: Microsoft BizTalk Server agent Reference - IBM

Change in Tracking Data Size attributeThis attribute displays the change in 'Tracking Data Size'. The type is integer (difference betweensuccessive values).

The following names are defined for this attribute: CHANGE_IN_TRACKING_DATA_SIZE orTRACKING_0 (warehouse name), Change in Tracking Data Size (caption),Change_in_Tracking_Data_Size (attribute name), and TRACKING_0 (column name).

Instances Total Number attributeThis attribute tracks the sum of all the instances of each host, which exist within a particularMessage Box. The type is integer (32-bit gauge).

The following names are defined for this attribute: INSTANCES_TOTAL_NUMBER orINSTANCES_ (warehouse name), Instances Total Number (caption), Instances_Total_Number(attribute name), and INSTANCES_ (column name).

MsgBox Dead Processes Cleanup Purge Jobs attributeThis attribute displays time in seconds for the most recent run of the SQL agent job. This releasesthe database rows associated with dead BizTalk processes. The type is integer (32-bit gauge).

The following names are defined for this attribute:MSGBOX_DEAD_PROCESSES_CLEANUP_PURGE_JOBS or MSGBOX_DEA (warehouse name),MsgBox Dead Processes Cleanup Purge Jobs (caption),MsgBox_Dead_Processes_Cleanup_Purge_Jobs (attribute name), and MSGBOX_DEA (columnname).

MsgBox Msg Cleanup Purge Jobs attributeThis attribute displays time in seconds for the most recent run of the SQL agent job. This cleansup message box tables associated with removed messages. The type is integer (32-bit gauge).

The following names are defined for this attribute: MSGBOX_MSG_CLEANUP_PURGE_JOBS orMSGBOX_MSG (warehouse name), MsgBox Msg Cleanup Purge Jobs (caption),MsgBox_Msg_Cleanup_Purge_Jobs (attribute name), and MSGBOX_MSG (column name).

MsgBox Parts Cleanup Purge Jobs attributeThis attribute displays time in seconds for the most recent run of the SQL agent job. This cleanup message box tables associated with removed message parts. The type is integer (32-bit gauge).

The following names are defined for this attribute: MSGBOX_PARTS_CLEANUP_PURGE_JOBS orMSGBOX_PAR (warehouse name), MsgBox Parts Cleanup Purge Jobs (caption),MsgBox_Parts_Cleanup_Purge_Jobs (attribute name), and MSGBOX_PAR (column name).

MsgBox Purge Subscriptions Job Purge Jobs attributeThis attribute displays time in seconds for the most recent run of the SQL agent job. This purgessubscriptions which are no longer in use. The type is integer (32-bit gauge).

The following names are defined for this attribute:MSGBOX_PURGE_SUBSCRIPTIONS_JOB_PURGE_JOBS or MSGBOX_PUR (warehouse name),MsgBox Purge Subscriptions Job Purge Jobs (caption),MsgBox_Purge_Subscriptions_Job_Purge_Jobs (attribute name), and MSGBOX_PUR (columnname).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Spool Size attributeThis attribute tracks the size of the spool on a particular message box on a particular server. Thetype is integer (32-bit gauge).

54 Microsoft BizTalk Server agent Reference

Page 61: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: SPOOL_SIZE (warehouse name), Spool Size(caption), Spool_Size (attribute name), and SPOOL_SIZE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Tracked Msgs Copy Purge Jobs attributeThis attribute displays time in seconds for the most recent run of the SQL agent job. This copiestracked message bodies for tracked messages. The type is integer (32-bit gauge).

The following names are defined for this attribute: TRACKED_MSGS_COPY_PURGE_JOBS orTRACKED_MS (warehouse name), Tracked Msgs Copy Purge Jobs (caption),Tracked_Msgs_Copy_Purge_Jobs (attribute name), and TRACKED_MS (column name).

Tracking Data Size attributeThis attribute tracks the size of the tracking data table on a particular message box on a particularserver. The type is integer (32-bit gauge).

The following names are defined for this attribute: TRACKING_DATA_SIZE or TRACKING_D(warehouse name), Tracking Data Size (caption), Tracking_Data_Size (attribute name), andTRACKING_D (column name).

Tracking Spool Cleanup Purge Jobs attributeThis attribute displays time in seconds for the most recent run of the SQL agent job. This purgesthe inactive tracking spool tables. The type is integer (32-bit gauge).

The following names are defined for this attribute:TRACKING_SPOOL_CLEANUP_PURGE_JOBS or TRACKING_S (warehouse name), TrackingSpool Cleanup Purge Jobs (caption), Tracking_Spool_Cleanup_Purge_Jobs (attribute name), andTRACKING_S (column name).

Message Box Host Counters attribute groupThe Message Box Host Counters attribute group includes attributes that provide information about thehosts of the BizTalk Server. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Host Queue Instance State Msg Refs Length attribute

This attribute tracks the number of message references in the instance state queue for theparticular host. The type is integer (32-bit gauge).

The following names are defined for this attribute:HOST_QUEUE_INSTANCE_STATE_MSG_REFS_LENGTH or HOST_QUEUE (warehouse name),Host Queue Instance State Msg Refs Length (caption),Host_Queue_Instance_State_Msg_Refs_Length (attribute name), and HOST_QUEUE (columnname).

Host Queue Length attributeThis attribute tracks the total number of messages in the particular host. The type is integer(32-bit gauge).

The following names are defined for this attribute: HOST_QUEUE_LENGTH or HOST_QUEU0(warehouse name), Host Queue Length (caption), Host_Queue_Length (attribute name), andHOST_QUEU0 (column name).

Host Queue Number of Instances attributeThis attribute tracks the number of instances of the particular host. The type is integer (32-bitgauge).

The following names are defined for this attribute: HOST_QUEUE_NUMBER_OF_INSTANCES orHOST_QUEU1 (warehouse name), Host Queue Number of Instances (caption),Host_Queue_Number_of_Instances (attribute name), and HOST_QUEU1 (column name).

Chapter 2. Attributes 55

Page 62: Microsoft BizTalk Server agent Reference - IBM

Host Queue Suspended Msgs Length attributeThis attribute tracks the total number of suspended messages for the particular host. The type isinteger (32-bit gauge).

The following names are defined for this attribute:HOST_QUEUE_SUSPENDED_MSGS_LENGTH or HOST_QUEU2 (warehouse name), Host QueueSuspended Msgs Length (caption), Host_Queue_Suspended_Msgs_Length (attribute name), andHOST_QUEU2 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Messagebox Database attribute groupThe Messagebox Database attribute group includes attributes that provide information about the BizTalkMessagebox Database. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Database Name attribute

This attribute displays the Messagebox Database name. The type is string.

The following names are defined for this attribute: DATABASE_NAME or MSGBOXDBNA(warehouse name), Database Name (caption), Database_Name (attribute name), andMSGBOXDBNA (column name).

Disable New Message Publication attributeThis attribute displays whether the publication of new messages in the MessageBox database isenabled or disabled. The type is string.

The following names are defined for this attribute: DISABLE_NEW_MESSAGE_PUBLICATION orDISABLENEW (warehouse name), Disable New Message Publication (caption),Disable_New_Message_Publication (attribute name), and DISABLENEW (column name).

Is Master Message Box attributeThis attribute displays whether the MessageBox is the master MessageBox database. The type isstring.

The following names are defined for this attribute: IS_MASTER_MESSAGE_BOX orISMASTERMS (warehouse name), Is Master Message Box (caption), Is_Master_Message_Box(attribute name), and ISMASTERMS (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the Messagebox Database server name. The type is string.

The following names are defined for this attribute: SERVER_NAME or MSGBOXDBSE(warehouse name), Server Name (caption), Server_Name (attribute name), and MSGBOXDBSE(column name).

56 Microsoft BizTalk Server agent Reference

Page 63: Microsoft BizTalk Server agent Reference - IBM

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Messaging attribute groupThe Messaging attribute group includes attributes that provide information about documents processed,submitted. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Active Receive Locations attribute

This attribute displays the number of receive locations currently enabled in this host instance. Thetype is integer (32-bit gauge).

The following names are defined for this attribute: ACTIVE_RECEIVE_LOCATIONS orACTIVE_REC (warehouse name), Active Receive Locations (caption), Active_Receive_Locations(attribute name), and ACTIVE_REC (column name).

Active Receive Threads attributeThis attribute displays the number of threads in the Messaging Engine currently processingmessages received from adapters running in this host instance. These include messages that havebeen processed asynchronously by Send Adapters. The type is integer (32-bit gauge).

The following names are defined for this attribute: ACTIVE_RECEIVE_THREADS orACTIVE_RE0 (warehouse name), Active Receive Threads (caption), Active_Receive_Threads(attribute name), and ACTIVE_RE0 (column name).

Active Send Messages attributeThis attribute displays the number of messages the Messaging Engine has currently in sendprocessing. This includes messages currently in send pipeline processing as well as responsemessages for Receive Adapters. The type is integer (32-bit gauge).

The following names are defined for this attribute: ACTIVE_SEND_MESSAGES or ACTIVE_SEN(warehouse name), Active Send Messages (caption), Active_Send_Messages (attribute name), andACTIVE_SEN (column name).

Active Send Threads attributeThis attribute displays the number of threads in the Messaging Engine currently processingmessages to send to adapters. This includes response messages to Receive Adapters. The type isinteger (32-bit gauge).

The following names are defined for this attribute: ACTIVE_SEND_THREADS or ACTIVE_SE0(warehouse name), Active Send Threads (caption), Active_Send_Threads (attribute name), andACTIVE_SE0 (column name).

Documents Processed attributeThis attribute displays the documents processed since the application started. The type is integer(32-bit counter).

The following names are defined for this attribute: DOCUMENTS_PROCESSED orDOCUMENTS_ (warehouse name), Documents Processed (caption), Documents_Processed(attribute name), and DOCUMENTS_ (column name).

Documents Processed Per Sec attributeThis attribute displays the documents processed per second. The type is real number (32-bitgauge) with two decimal places of precision.

The following names are defined for this attribute: DOCUMENTS_PROCESSED_PER_SEC orDOCUMENTS0 (warehouse name), Documents Processed Per Sec (caption),Documents_Processed_Per_Sec (attribute name), and DOCUMENTS0 (column name).

Documents Received attributeThis attribute displays the documents received since the application started. The type is integer(32-bit counter).

Chapter 2. Attributes 57

Page 64: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: DOCUMENTS_RECEIVED or DOCUMENTS1(warehouse name), Documents Received (caption), Documents_Received (attribute name), andDOCUMENTS1 (column name).

Documents Received Per Sec attributeThis attribute displays the documents received per second. The type is real number (32-bit gauge)with two decimal places of precision.

The following names are defined for this attribute: DOCUMENTS_RECEIVED_PER_SEC orDOCUMENTS2 (warehouse name), Documents Received Per Sec (caption),Documents_Received_Per_Sec (attribute name), and DOCUMENTS2 (column name).

Documents Resubmitted attributeThis attribute displays the total number of documents resubmitted by Send Adapters since theapplication started. The type is integer (32-bit counter).

The following names are defined for this attribute: DOCUMENTS_RESUBMITTED orDOCUMENTS3 (warehouse name), Documents Resubmitted (caption), Documents_Resubmitted(attribute name), and DOCUMENTS3 (column name).

Documents Submitted Per Batch attributeThis attribute displays the average number of documents currently submitted per batch. Thisattribute is the 64-bit version of the Documents Submitted Per Batch (Superseded) attribute. Thetype is real number (64-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: DOCUMENTS_SUBMITTED_PER_BATCH_64or DOC4_64 (warehouse name), Documents Submitted Per Batch (caption),Documents_Submitted_Per_Batch_64 (attribute name), and DOC4_64 (column name).

Documents Submitted Per Batch (Superseded) attributeThis attribute displays the average number of documents submitted per batch. The type is realnumber (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: DOCUMENTS_SUBMITTED_PER_BATCH orDOCUMENTS4 (warehouse name), Documents Submitted Per Batch (Superseded) (caption),Documents_Submitted_Per_Batch (attribute name), and DOCUMENTS4 (column name).

Documents Suspended attributeThis attribute displays the documents suspended since the application started. The type is integer(32-bit counter).

The following names are defined for this attribute: DOCUMENTS_SUSPENDED orDOCUMENTS5 (warehouse name), Documents Suspended (caption), Documents_Suspended(attribute name), and DOCUMENTS5 (column name).

Documents Suspended Per Sec attributeThis attribute displays the documents suspended per second. The type is real number (32-bitgauge) with two decimal places of precision.

The following names are defined for this attribute: DOCUMENTS_SUSPENDED_PER_SEC orDOCUMENTS6 (warehouse name), Documents Suspended Per Sec (caption),Documents_Suspended_Per_Sec (attribute name), and DOCUMENTS6 (column name).

Documents Transmitted Per Batch attributeThis attribute displays the average number of documents currently transmitted per batch. Thisattribute is the 64-bit version of the Documents Transmitted Per Batch (Superseded) attribute. Thetype is real number (64-bit gauge) with two decimal places of precision.

The following names are defined for this attribute:DOCUMENTS_TRANSMITTED_PER_BATCH_64 or DOC7_64 (warehouse name), DocumentsTransmitted Per Batch (caption), Documents_Transmitted_Per_Batch_64 (attribute name), andDOC7_64 (column name).

Documents Transmitted Per Batch (Superseded) attributeThis attribute displays the average number of documents transmitted per batch. The type is realnumber (32-bit gauge) with two decimal places of precision.

58 Microsoft BizTalk Server agent Reference

Page 65: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: DOCUMENTS_TRANSMITTED_PER_BATCHor DOCUMENTS7 (warehouse name), Documents Transmitted Per Batch (Superseded) (caption),Documents_Transmitted_Per_Batch (attribute name), and DOCUMENTS7 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Pending Receive Batches attributeThis attribute displays the number of batches received by the Messaging Engine that have notcompleted processing. These include batches that have been processed asynchronously by SendAdapters. The type is integer (32-bit gauge).

The following names are defined for this attribute: PENDING_RECEIVE_BATCHES orPENDING_RE (warehouse name), Pending Receive Batches (caption), Pending_Receive_Batches(attribute name), and PENDING_RE (column name).

Pending Transmitted Messages attributeThis attribute displays the number of messages given by the Messaging Engine to Send Adaptersthat have not completed processing. This includes response messages for Receive Adapters. Thetype is integer (32-bit gauge).

The following names are defined for this attribute: PENDING_TRANSMITTED_MESSAGES orPENDING_TR (warehouse name), Pending Transmitted Messages (caption),Pending_Transmitted_Messages (attribute name), and PENDING_TR (column name).

Request Response Timeouts attributeThis attribute displays the number of request messages that have not received a responsemessage within the time limit specified by the adapter. The type is integer (32-bit gauge).

The following names are defined for this attribute: REQUEST_RESPONSE_TIMEOUTS orREQUEST_RE (warehouse name), Request Response Timeouts (caption),Request_Response_Timeouts (attribute name), and REQUEST_RE (column name).

Throttled Receive Batches attributeThis attribute displays the number of batches that have been blocked on receive by the MessagingEngine due to high service load. These batches contain new messages to be processed. The type isinteger (32-bit gauge).

The following names are defined for this attribute: THROTTLED_RECEIVE_BATCHES orTHROTTLED_ (warehouse name), Throttled Receive Batches (caption), Throttled_Receive_Batches(attribute name), and THROTTLED_ (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Messaging Latency attribute groupThe Messaging Latency attribute group includes attributes that provide information about latencies whileprocessing the documents. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Inbound Latency In MS attribute

This attribute displays the average latency in milliseconds from when the Messaging Enginereceives a document from the adapter until the time it is published to Message Box. The type isreal number (32-bit gauge) with two decimal places of precision.

Chapter 2. Attributes 59

Page 66: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: INBOUND_LATENCY_IN_MS orINBOUND_LA (warehouse name), Inbound Latency In MS (caption), Inbound_Latency_In_MS(attribute name), and INBOUND_LA (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Outbound Adapter Latency In MS attributeThis attribute displays the average latency in milliseconds from when the adapter gets adocument from the Messaging Engine until the time it is sent by the adapter. The type is realnumber (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: OUTBOUND_ADAPTER_LATENCY_IN_MSor OUTBOUND_A (warehouse name), Outbound Adapter Latency In MS (caption),Outbound_Adapter_Latency_In_MS (attribute name), and OUTBOUND_A (column name).

Outbound Latency In MS attributeThis attribute displays the average latency in milliseconds from when the Messaging Enginereceives a document from the Message Box until the time document is sent by the adapter. Thetype is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: OUTBOUND_LATENCY_IN_MS orOUTBOUND_L (warehouse name), Outbound Latency In MS (caption),Outbound_Latency_In_MS (attribute name), and OUTBOUND_L (column name).

Request Response Latency In MS attributeThis attribute displays the average latency in milliseconds from when the Messaging Enginereceives a request document from the adapter until the time a response document is given backto the adapter. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: REQUEST_RESPONSE_LATENCY_IN_MS orREQUEST_RE (warehouse name), Request Response Latency In MS (caption),Request_Response_Latency_In_MS (attribute name), and REQUEST_RE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

MSMQ Receive Adapter attribute groupThe MSMQ Receive Adapter attribute group includes attributes that provide information about bytes andmessages received by MSMQ adapter. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Bytes Received Per Sec attribute

This attribute displays the number of bytes currently received by the MSMQ Receive Adapter persecond since the Biztalk server was started. This attribute is the 64-bit version of the BytesReceived Per Sec (Superseded) attribute. The type is real number (64-bit gauge) with two decimalplaces of precision.

The following names are defined for this attribute: BYTES_RECEIVED_PER_SEC_64 orMSMQBR0_64 (warehouse name), Bytes Received Per Sec (caption), Bytes_Received_Per_Sec_64(attribute name), and MSMQBR0_64 (column name).

Bytes Received Per Sec (Superseded) attributeThis attribute displays the number of bytes received by the MSMQ Receive Adapter per second.

60 Microsoft BizTalk Server agent Reference

Page 67: Microsoft BizTalk Server agent Reference - IBM

The counter applies only to messages that have been completely read by the MSMQ ReceiveAdapter from the source queue. The type is real number (32-bit gauge) with two decimal placesof precision.

The following names are defined for this attribute: BYTES_RECEIVED_PER_SEC or BYTES_REC0(warehouse name), Bytes Received Per Sec (Superseded) (caption), Bytes_Received_Per_Sec(attribute name), and BYTES_REC0 (column name).

Kilobytes Received attributeThis attribute displays the total number of KB received by the MSMQ Receive Adapter since theBiztalk server was started. This attribute is the 64-bit version of the Kilobytes Received(Superseded) attribute. The type is real number (64-bit counter).

The following names are defined for this attribute: KILOBYTES_RECEIVED_64 or MSMQKBR_64(warehouse name), Kilobytes Received (caption), Kilobytes_Received_64 (attribute name), andMSMQKBR_64 (column name).

Kilobytes Received (Superseded) attributeThis attribute displays the total number of kilobytes received by the MSMQ Receive Adaptersince the application started. The counter is incremented after a message is read by the MSMQReceive Adapter from the source queue. The type is real number (32-bit counter) with twodecimal places of precision.

The following names are defined for this attribute: KILOBYTES_RECEIVED or BYTES_REC1(warehouse name), Kilobytes Received (Superseded) (caption), Kilobytes_Received (attributename), and BYTES_REC1 (column name).

Messages Received attributeThis attribute displays the total number of messages received by the MSMQ Receive Adaptersince the application started. The counter is incremented after a message is read by the MSMQReceive Adapter from the source queue. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_RECEIVED or MESSAGES_R(warehouse name), Messages Received (caption), Messages_Received (attribute name), andMESSAGES_R (column name).

Messages Received Per Sec attributeThis attribute displays the number of messages received by the MSMQ Receive Adapter persecond. The counter applies only to messages that have been completely read by the MSMQReceive Adapter from the source queue. The type is real number (32-bit gauge) with two decimalplaces of precision.

The following names are defined for this attribute: MESSAGES_RECEIVED_PER_SEC orMESSAGES_0 (warehouse name), Messages Received Per Sec (caption),Messages_Received_Per_Sec (attribute name), and MESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Chapter 2. Attributes 61

Page 68: Microsoft BizTalk Server agent Reference - IBM

MSMQ Send Adapter attribute groupThe MSMQ Send Adapter attribute group includes attributes that provide information about bytes andmessages sent by MSMQ adapter. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Bytes Sent Per Sec attribute

This attribute displays the number of bytes currently sent by the MSMQ Send Adapter persecond. This attribute is the 64-bit version of the Bytes Sent Per Sec (Superseded) attribute. Thetype is real number (64-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: BYTES_SENT_PER_SEC_64 or MSMQBS0_64(warehouse name), Bytes Sent Per Sec (caption), Bytes_Sent_Per_Sec_64 (attribute name), andMSMQBS0_64 (column name).

Bytes Sent Per Sec (Superseded) attributeThis attribute displays the number of bytes sent by the MSMQ Send Adapter per second. Thecounter applies only to messages that have reached the destination queue. The type is realnumber (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: BYTES_SENT_PER_SEC or BYTES_SEN0(warehouse name), Bytes Sent Per Sec (Superseded) (caption), Bytes_Sent_Per_Sec (attributename), and BYTES_SEN0 (column name).

Kilobytes Sent attributeThis attribute displays the total number of kilobytes sent by the MSMQ Send Adapter since theBizTalk Server was started. This attribute is the 64-bit version of the Kilobytes Sent (Superseded)attribute. The type is real number (64-bit counter).

The following names are defined for this attribute: KILOBYTES_SENT_64 or MSMQKBS_64(warehouse name), Kilobytes Sent (caption), Kilobytes_Sent_64 (attribute name), andMSMQKBS_64 (column name).

Kilobytes Sent (Superseded) attributeThis attribute displays the total number of kilobytes sent by the MSMQ Send Adapter since theapplication started. The counter is incremented only for messages that have reached thedestination queue. The type is real number (32-bit counter) with two decimal places of precision.

The following names are defined for this attribute: KILOBYTES_SENT or BYTES_SEN1(warehouse name), Kilobytes Sent (Superseded) (caption), Kilobytes_Sent (attribute name), andBYTES_SEN1 (column name).

Messages Sent attributeThis attribute displays the total number of messages sent by the MSMQ Send Adapter since theapplication started. The counter is incremented only for messages that have reached thedestination queue. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_SENT or MESSAGES_S(warehouse name), Messages Sent (caption), Messages_Sent (attribute name), and MESSAGES_S(column name).

Messages Sent Per Sec attributeThis attribute displays the number of messages sent by the MSMQ Send Adapter per second. Thecounter applies only to messages that have reached the destination queue. The type is realnumber (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGES_SENT_PER_SEC or MESSAGES_0(warehouse name), Messages Sent Per Sec (caption), Messages_Sent_Per_Sec (attribute name), andMESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

62 Microsoft BizTalk Server agent Reference

Page 69: Microsoft BizTalk Server agent Reference - IBM

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Notifications attribute groupThis attribute group includes attributes that provide information about the notifications component of aNotification Services instance for BAM. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:Batches attribute

This attribute displays the total number of notification batches that were generated since theapplication was started. The type is integer (64-bit counter).

The following names are defined for this attribute: BATCHES (warehouse name), Batches(caption), Batches (attribute name), and BATCHES (column name).

Batches Awaiting Distribution attributeThis attribute displays the number of notification batches that are currently waiting to be pickedup by the distributor. The type is integer (64-bit gauge).

The following names are defined for this attribute: BATCHES_AWAITING_DISTRIBUTION orBATAWTDIST (warehouse name), Batches Awaiting Distribution (caption),Batches_Awaiting_Distribution (attribute name), and BATAWTDIST (column name).

Batches Expired attributeThis attribute displays the total number of notification batches that contain expired notificationssince the application was started. The type is integer (64-bit counter).

The following names are defined for this attribute: BATCHES_EXPIRED or BATCHEXPD(warehouse name), Batches Expired (caption), Batches_Expired (attribute name), andBATCHEXPD (column name).

Batches Failed Delivery attributeThis attribute displays the total number of batches that contain failed notifications since theapplication was started. The type is integer (64-bit counter).

The following names are defined for this attribute: BATCHES_FAILED_DELIVERY orBATFAILDEL (warehouse name), Batches Failed Delivery (caption), Batches_Failed_Delivery(attribute name), and BATFAILDEL (column name).

Batches In Retry attributeThis attribute displays the total number of notification batches that are currently in the deliveryretry queue. The type is integer (64-bit gauge).

The following names are defined for this attribute: BATCHES_IN_RETRY or BATINRETY(warehouse name), Batches In Retry (caption), Batches_In_Retry (attribute name), andBATINRETY (column name).

Batches Successfully Delivered attributeThis attribute displays the total number of notification batches that were successfully deliveredsince the application was last started. The type is integer (64-bit counter).

The following names are defined for this attribute: BATCHES_SUCCESSFULLY_DELIVERED orBATSUCDELV (warehouse name), Batches Successfully Delivered (caption),Batches_Successfully_Delivered (attribute name), and BATSUCDELV (column name).

Chapter 2. Attributes 63

Page 70: Microsoft BizTalk Server agent Reference - IBM

Name attributeThis attribute displays the instance name for notifications component. This attribute is a keyattribute. The type is string.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Notifications attributeThis attribute displays the total number of notifications that were generated since the applicationwas started. The type is integer (64-bit counter).

The following names are defined for this attribute: NOTIFICATIONS or NOTIFICATI (warehousename), Notifications (caption), Notifications (attribute name), and NOTIFICATI (column name).

Notifications Failed Delivery attributeThis attribute displays the total number of notifications that have failed the delivery process sincethe application was last started. The type is integer (64-bit counter).

The following names are defined for this attribute: NOTIFICATIONS_FAILED_DELIVERY orNOTFAILDEL (warehouse name), Notifications Failed Delivery (caption),Notifications_Failed_Delivery (attribute name), and NOTFAILDEL (column name).

Notifications Successfully Delivered attributeThis attribute displays the total number of notifications that were successfully delivered since theapplication was last started. The type is integer (64-bit counter).

The following names are defined for this attribute:NOTIFICATIONS_SUCCESSFULLY_DELIVERED or NOTSUCDELV (warehouse name),Notifications Successfully Delivered (caption), Notifications_Successfully_Delivered (attributename), and NOTSUCDELV (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Orchestration Status attribute groupThe Orchestration Status attribute group includes attributes that provide information about theorchestration status. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Host Name attribute

This attribute displays the host name. The type is string.

The following names are defined for this attribute: HOST_NAME or HOSTNAME (warehousename), Host Name (caption), Host_Name (attribute name), and HOSTNAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Orchestration Name attributeThis attribute displays the orchestration name. This attribute is a key attribute. The type is string.

64 Microsoft BizTalk Server agent Reference

Page 71: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: ORCHESTRATION_NAME or NAME(warehouse name), Orchestration Name (caption), Orchestration_Name (attribute name), andNAME (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Status attributeThis attribute displays the orchestration status. The type is integer with enumerated values. Thefollowing values are defined: Unbound (1), Bound (2), Stopped (3), Started (4). Any value thatdoes not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: STATUS or ORCHSTAT (warehouse name),Status (caption), Status (attribute name), and ORCHSTAT (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Orchestrations attribute groupThe Orchestrations attribute group includes attributes that provide information about orchestrations andtransactions being processed. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Active Application Domains attribute

This attribute displays the number of loaded orchestration application domains in the process forhosting orchestrations. The type is integer (32-bit gauge).

The following names are defined for this attribute: ACTIVE_APPLICATION_DOMAINS orACTIVE_APP (warehouse name), Active Application Domains (caption),Active_Application_Domains (attribute name), and ACTIVE_APP (column name).

Allocated Private Memory In MB attributeThis attribute displays the allocated private memory in megabytes for the host instance. The typeis integer (32-bit gauge).

The following names are defined for this attribute: ALLOCATED_PRIVATE_MEMORY_IN_MB orMEGABYTES_ (warehouse name), Allocated Private Memory In MB (caption),Allocated_Private_Memory_In_MB (attribute name), and MEGABYTES_ (column name).

Allocated Virtual Memory In MB attributeThis attribute displays the reserved virtual memory in megabytes for the host instance. The typeis integer (32-bit gauge).

The following names are defined for this attribute: ALLOCATED_VIRTUAL_MEMORY_IN_MB orMEGABYTES0 (warehouse name), Allocated Virtual Memory In MB (caption),Allocated_Virtual_Memory_In_MB (attribute name), and MEGABYTES0 (column name).

Average Batch Factor attributeThis attribute displays the ratio between the number of persistence points committed andunderlying database transactions committed. The type is integer (32-bit gauge).

The following names are defined for this attribute: AVERAGE_BATCH_FACTOR orAVERAGE_BA (warehouse name), Average Batch Factor (caption), Average_Batch_Factor(attribute name), and AVERAGE_BA (column name).

Database Transactions attributeThis attribute displays the number of database transactions performed since the host instancestarted. The type is integer (32-bit counter).

Chapter 2. Attributes 65

Page 72: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: DATABASE_TRANSACTIONS orDATABASE_T (warehouse name), Database Transactions (caption), Database_Transactions(attribute name), and DATABASE_T (column name).

Database Transactions Per Sec attributeThis attribute displays the number of transaction performed per second. The type is real number(32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: DATABASE_TRANSACTIONS_PER_SEC orDATABASE_0 (warehouse name), Database Transactions Per Sec (caption),Database_Transactions_Per_Sec (attribute name), and DATABASE_0 (column name).

Dehydratable Orchestrations attributeThis attribute displays the total number of idle orchestrations currently hosted by the applicationinstance which may be dehydrated. The type is integer (32-bit gauge).

The following names are defined for this attribute: DEHYDRATABLE_ORCHESTRATIONS orDEHYDRATAB (warehouse name), Dehydratable Orchestrations (caption),Dehydratable_Orchestrations (attribute name), and DEHYDRATAB (column name).

Dehydrating Orchestrations attributeThis attribute displays the number of orchestrations that are in the process of dehydrating. Thetype is integer (32-bit gauge).

The following names are defined for this attribute: DEHYDRATING_ORCHESTRATIONS orDEHYDRATIN (warehouse name), Dehydrating Orchestrations (caption),Dehydrating_Orchestrations (attribute name), and DEHYDRATIN (column name).

Dehydration Cycle In Progress attributeThis attribute indicates whether there is a dehydration cycle currently in progress. The type isinteger (32-bit gauge).

The following names are defined for this attribute: DEHYDRATION_CYCLE_IN_PROGRESS orDEHYDRATIO (warehouse name), Dehydration Cycle In Progress (caption),Dehydration_Cycle_In_Progress (attribute name), and DEHYDRATIO (column name).

Dehydration Cycles attributeThis attribute displays the number of dehydration cycles completed. The type is integer (32-bitgauge).

The following names are defined for this attribute: DEHYDRATION_CYCLES or DEHYDRATI0(warehouse name), Dehydration Cycles (caption), Dehydration_Cycles (attribute name), andDEHYDRATI0 (column name).

Dehydration Threshold attributeThis attribute is a metric that controls how aggressively services are being dehydrated (measuredin milliseconds). The type is integer (32-bit gauge).

The following names are defined for this attribute: DEHYDRATION_THRESHOLD orDEHYDRATI1 (warehouse name), Dehydration Threshold (caption), Dehydration_Threshold(attribute name), and DEHYDRATI1 (column name).

Idle Orchestrations attributeThis attribute displays the number of idle orchestration instances currently hosted by the hostinstance. The type is integer (32-bit gauge).

The following names are defined for this attribute: IDLE_ORCHESTRATIONS or IDLE_ORCHE(warehouse name), Idle Orchestrations (caption), Idle_Orchestrations (attribute name), andIDLE_ORCHE (column name).

MessageBox Databases Connection Failures attributeThis attribute displays the number of attempted database connections that failed since the hostinstance started. The type is integer (32-bit counter).

The following names are defined for this attribute:MESSAGEBOX_DATABASES_CONNECTION_FAILURES or MESSAGEBOX (warehouse name),

66 Microsoft BizTalk Server agent Reference

Page 73: Microsoft BizTalk Server agent Reference - IBM

MessageBox Databases Connection Failures (caption),MessageBox_Databases_Connection_Failures (attribute name), and MESSAGEBOX (columnname).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Online MessageBox Databases attributeThis attribute displays the number of MessageBox databases currently available to theapplication. The type is integer (32-bit gauge).

The following names are defined for this attribute: ONLINE_MESSAGEBOX_DATABASES orONLINE_MES (warehouse name), Online MessageBox Databases (caption),Online_MessageBox_Databases (attribute name), and ONLINE_MES (column name).

Orchestrations Completed attributeThis attribute displays the number of orchestrations completed since host instance started. Thetype is integer (32-bit counter).

The following names are defined for this attribute: ORCHESTRATIONS_COMPLETED orORCHESTRAT (warehouse name), Orchestrations Completed (caption),Orchestrations_Completed (attribute name), and ORCHESTRAT (column name).

Orchestrations Completed Per Sec attributeThis attribute displays the average number of orchestrations completed per second. The type isreal number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: ORCHESTRATIONS_COMPLETED_PER_SECor ORCHESTRA0 (warehouse name), Orchestrations Completed Per Sec (caption),Orchestrations_Completed_Per_Sec (attribute name), and ORCHESTRA0 (column name).

Orchestrations Created attributeThis attribute displays the number of orchestrations created since host instance started. The typeis integer (32-bit counter).

The following names are defined for this attribute: ORCHESTRATIONS_CREATED orORCHESTRA1 (warehouse name), Orchestrations Created (caption), Orchestrations_Created(attribute name), and ORCHESTRA1 (column name).

Orchestrations Created Per Sec attributeThis attribute displays the average number of orchestrations created per second. The type is realnumber (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: ORCHESTRATIONS_CREATED_PER_SEC orORCHESTRA2 (warehouse name), Orchestrations Created Per Sec (caption),Orchestrations_Created_Per_Sec (attribute name), and ORCHESTRA2 (column name).

Orchestrations Dehydrated attributeThis attribute displays the number of orchestration instances dehydrated since the host instancestarted. The type is integer (32-bit counter).

The following names are defined for this attribute: ORCHESTRATIONS_DEHYDRATED orORCHESTRA3 (warehouse name), Orchestrations Dehydrated (caption),Orchestrations_Dehydrated (attribute name), and ORCHESTRA3 (column name).

Orchestrations Dehydrated Per Sec attributeThis attribute displays the average number of orchestration instances dehydrated per second. Thetype is real number (32-bit gauge) with two decimal places of precision.

Chapter 2. Attributes 67

Page 74: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute:ORCHESTRATIONS_DEHYDRATED_PER_SEC or ORCHESTRA4 (warehouse name),Orchestrations Dehydrated Per Sec (caption), Orchestrations_Dehydrated_Per_Sec (attributename), and ORCHESTRA4 (column name).

Orchestrations Discarded attributeThis attribute displays the number of orchestration instances discarded from memory since thehost instance started. The type is integer (32-bit counter).

The following names are defined for this attribute: ORCHESTRATIONS_DISCARDED orORCHESTRA5 (warehouse name), Orchestrations Discarded (caption), Orchestrations_Discarded(attribute name), and ORCHESTRA5 (column name).

Orchestrations Discarded Per Sec attributeThis attribute displays the average number of orchestration instances discarded from memory persecond. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: ORCHESTRATIONS_DISCARDED_PER_SECor ORCHESTRA6 (warehouse name), Orchestrations Discarded Per Sec (caption),Orchestrations_Discarded_Per_Sec (attribute name), and ORCHESTRA6 (column name).

Orchestrations Rehydrated attributeThis attribute displays the number of orchestration instances rehydrated since the host instancestarted. The type is integer (32-bit counter).

The following names are defined for this attribute: ORCHESTRATIONS_REHYDRATED orORCHESTRA7 (warehouse name), Orchestrations Rehydrated (caption),Orchestrations_Rehydrated (attribute name), and ORCHESTRA7 (column name).

Orchestrations Rehydrated Per Sec attributeThis attribute displays the average number of orchestration instances rehydrated per second. Thetype is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute:ORCHESTRATIONS_REHYDRATED_PER_SEC or ORCHESTRA8 (warehouse name),Orchestrations Rehydrated Per Sec (caption), Orchestrations_Rehydrated_Per_Sec (attributename), and ORCHESTRA8 (column name).

Orchestrations Resident In Memory attributeThis attribute displays the number of orchestration instances currently hosted by the hostinstance. The type is integer (32-bit gauge).

The following names are defined for this attribute:ORCHESTRATIONS_RESIDENT_IN_MEMORY or ORCHESTRA9 (warehouse name),Orchestrations Resident In Memory (caption), Orchestrations_Resident_In_Memory (attributename), and ORCHESTRA9 (column name).

Orchestrations Scheduled For Dehydration attributeThis attribute displays the number of dehydratable orchestrations for which there is dehydrationrequest pending. The type is integer (32-bit gauge).

The following names are defined for this attribute:ORCHESTRATIONS_SCHEDULED_FOR_DEHYDRATION or ORCHESTR10 (warehouse name),Orchestrations Scheduled For Dehydration (caption), Orchestrations_Scheduled_For_Dehydration(attribute name), and ORCHESTR10 (column name).

Orchestrations Suspended attributeThis attribute displays the number of orchestration instances suspended since the host instancestarted. The type is integer (32-bit counter).

The following names are defined for this attribute: ORCHESTRATIONS_SUSPENDED orORCHESTR11 (warehouse name), Orchestrations Suspended (caption), Orchestrations_Suspended(attribute name), and ORCHESTR11 (column name).

Orchestrations Suspended Per Sec attributeThis attribute displays the average number of orchestration instances suspended per second. Thetype is real number (32-bit gauge) with two decimal places of precision.

68 Microsoft BizTalk Server agent Reference

Page 75: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: ORCHESTRATIONS_SUSPENDED_PER_SECor ORCHESTR12 (warehouse name), Orchestrations Suspended Per Sec (caption),Orchestrations_Suspended_Per_Sec (attribute name), and ORCHESTR12 (column name).

Pending Messages attributeThis attribute displays the number of received messages for which receipt has not yet beenacknowledged to the MessageBox. The type is integer (32-bit gauge).

The following names are defined for this attribute: PENDING_MESSAGES or PENDING_ME(warehouse name), Pending Messages (caption), Pending_Messages (attribute name), andPENDING_ME (column name).

Pending Work Items attributeThis attribute displays the number of code execution blocks that are scheduled for execution. Thetype is integer (32-bit gauge).

The following names are defined for this attribute: PENDING_WORK_ITEMS or PENDING_WO(warehouse name), Pending Work Items (caption), Pending_Work_Items (attribute name), andPENDING_WO (column name).

Percent Used Physical Memory attributeThis attribute displays the percentage used of total physical memory on the machine. The type isinteger (32-bit gauge).

The following names are defined for this attribute: PERCENT_USED_PHYSICAL_MEMORY orUSED_PHYSI (warehouse name), Percent Used Physical Memory (caption),Percent_Used_Physical_Memory (attribute name), and USED_PHYSI (column name).

Persistence Points attributeThis attribute displays the number of times an orchestration instance has persisted its state to thedatabase since the host instance started. The type is integer (32-bit counter).

The following names are defined for this attribute: PERSISTENCE_POINTS or PERSISTENC(warehouse name), Persistence Points (caption), Persistence_Points (attribute name), andPERSISTENC (column name).

Persistence Points Per Sec attributeThis attribute displays the average number of orchestration instances persisted per second. Thetype is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: PERSISTENCE_POINTS_PER_SEC orPERSISTEN0 (warehouse name), Persistence Points Per Sec (caption), Persistence_Points_Per_Sec(attribute name), and PERSISTEN0 (column name).

Runnable Orchestrations attributeThis attribute displays the number of orchestration instances ready to execute. The type is integer(32-bit gauge).

The following names are defined for this attribute: RUNNABLE_ORCHESTRATIONS orRUNNABLE_O (warehouse name), Runnable Orchestrations (caption), Runnable_Orchestrations(attribute name), and RUNNABLE_O (column name).

Running Orchestrations attributeThis attribute displays the number of orchestration instances currently executing. The type isinteger (32-bit gauge).

The following names are defined for this attribute: RUNNING_ORCHESTRATIONS orRUNNING_OR (warehouse name), Running Orchestrations (caption), Running_Orchestrations(attribute name), and RUNNING_OR (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Transactional Scopes Aborted attributeThis attribute displays the number of long-running or atomic scopes that have been aborted sincethe host instance started. The type is integer (32-bit counter).

Chapter 2. Attributes 69

Page 76: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: TRANSACTIONAL_SCOPES_ABORTED orTRANSACTIO (warehouse name), Transactional Scopes Aborted (caption),Transactional_Scopes_Aborted (attribute name), and TRANSACTIO (column name).

Transactional Scopes Aborted Per Sec attributeThis attribute displays the average number of aborted scopes per second. The type is real number(32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute:TRANSACTIONAL_SCOPES_ABORTED_PER_SEC or TRANSACTI0 (warehouse name),Transactional Scopes Aborted Per Sec (caption), Transactional_Scopes_Aborted_Per_Sec (attributename), and TRANSACTI0 (column name).

Transactional Scopes Committed attributeThis attribute displays the number of long-running or atomic scopes that have successfullycompleted since the host instance started. The type is integer (32-bit counter).

The following names are defined for this attribute: TRANSACTIONAL_SCOPES_COMMITTED orTRANSACTI1 (warehouse name), Transactional Scopes Committed (caption),Transactional_Scopes_Committed (attribute name), and TRANSACTI1 (column name).

Transactional Scopes Committed Per Sec attributeThis attribute displays the average number of committed scopes per second. The type is realnumber (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute:TRANSACTIONAL_SCOPES_COMMITTED_PER_SEC or TRANSACTI2 (warehouse name),Transactional Scopes Committed Per Sec (caption), Transactional_Scopes_Committed_Per_Sec(attribute name), and TRANSACTI2 (column name).

Transactional Scopes Compensated attributeThis attribute displays the number of long-running or atomic scopes that have successfullycompleted compensation scopes since the application started. The type is integer (32-bit counter).

The following names are defined for this attribute:TRANSACTIONAL_SCOPES_COMPENSATED or TRANSACTI3 (warehouse name), TransactionalScopes Compensated (caption), Transactional_Scopes_Compensated (attribute name), andTRANSACTI3 (column name).

Transactional Scopes Compensated Per Sec attributeThis attribute displays the average number of transactional compensated scopes per second. Thetype is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute:TRANSACTIONAL_SCOPES_COMPENSATED_PER_SEC or TRANSACTI4 (warehouse name),Transactional Scopes Compensated Per Sec (caption), Transactional_Scopes_Compensated_Per_Sec(attribute name), and TRANSACTI4 (column 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 performance objects that make up this application all atonce. Each of these other performance attribute groups is represented by a row in this table (or other typeof view). The status for an attribute group reflects the result of the last attempt to collect data for thatattribute group, so you can see whether the agent is collecting data correctly. Unlike other attributegroups, 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. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Average Collection Duration attribute

The average duration of all data collections of this group in seconds. The type is real number

70 Microsoft BizTalk Server agent Reference

Page 77: Microsoft BizTalk Server agent Reference - IBM

(32-bit counter) with two decimal places of precision with enumerated values. The followingvalues are defined: NO DATA (-100). Any value that does not have a definition here is displayedin the User Interface.

The following names are defined for this attribute: AVERAGE_COLLECTION_DURATION orCOLAVGD (warehouse name), Average Collection Duration (caption),Average_Collection_Duration (attribute name), and COLAVGD (column name).

Cache Hit Percent attributeThe percentage of external data requests for this group that were satisfied from the cache. Thetype is real number (32-bit counter) with two decimal places of precision.

The following names are defined for this attribute: CACHE_HIT_PERCENT or CACHPCT(warehouse name), Cache Hit Percent (caption), Cache_Hit_Percent (attribute name), andCACHPCT (column name).

Cache Hits attributeThe number of times an external data request for this group was satisfied from the cache. Thetype is integer (32-bit counter).

The following names are defined for this attribute: CACHE_HITS or CACHEHT (warehousename), Cache Hits (caption), Cache_Hits (attribute name), and CACHEHT (column name).

Cache Misses attributeThe number of times an external data request for this group was not available in the cache. Thetype is integer (32-bit counter).

The following names are defined for this attribute: CACHE_MISSES or CACHEMS (warehousename), Cache Misses (caption), Cache_Misses (attribute name), and CACHEMS (column name).

Error Code attributeThe error code associated with the query. The type is integer with enumerated values. Thefollowing values are defined: NO ERROR (0), GENERAL ERROR (1), OBJECT NOT FOUND (2),COUNTER NOT FOUND (3), NAMESPACE ERROR (4), OBJECT CURRENTLY UNAVAILABLE(5), COM LIBRARY INIT FAILURE (6), SECURITY INIT FAILURE (7), PROXY SECURITYFAILURE (9), NO INSTANCES RETURNED (10), ASSOCIATOR QUERY FAILED (11),REFERENCE QUERY FAILED (12), NO RESPONSE RECEIVED (13), CANNOT FIND JOINEDQUERY (14), CANNOT FIND JOIN ATTRIBUTE IN QUERY 1 RESULTS (15), CANNOT FINDJOIN ATTRIBUTE IN QUERY 2 RESULTS (16), QUERY 1 NOT A SINGLETON (17), QUERY 2NOT A SINGLETON (18), NO INSTANCES RETURNED IN QUERY 1 (19), NO INSTANCESRETURNED IN QUERY 2 (20), CANNOT FIND ROLLUP QUERY (21), CANNOT FIND ROLLUPATTRIBUTE (22), FILE OFFLINE (23), NO HOSTNAME (24), MISSING LIBRARY (25),ATTRIBUTE COUNT MISMATCH (26), ATTRIBUTE NAME MISMATCH (27), COMMON DATAPROVIDER NOT STARTED (28), CALLBACK REGISTRATION ERROR (29), MDL LOAD ERROR(30), AUTHENTICATION FAILED (31), CANNOT RESOLVE HOST NAME (32), SUBNODEUNAVAILABLE (33), SUBNODE NOT FOUND IN CONFIG (34), ATTRIBUTE ERROR (35),CLASSPATH ERROR (36), CONNECTION FAILURE (37), FILTER SYNTAX ERROR (38), FILENAME MISSING (39), SQL QUERY ERROR (40), SQL FILTER QUERY ERROR (41), SQL DBQUERY ERROR (42), SQL DB FILTER QUERY ERROR (43), PORT OPEN FAILED (44), ACCESSDENIED (45), TIMEOUT (46), NOT IMPLEMENTED (47), REQUESTED A BAD VALUE (48),RESPONSE TOO BIG (49), GENERAL RESPONSE ERROR (50), SCRIPT NONZERO RETURN(51), SCRIPT NOT FOUND (52), SCRIPT LAUNCH ERROR (53), CONF FILE DOES NOT EXIST(54), CONF FILE ACCESS DENIED (55), INVALID CONF FILE (56), EIF INITIALIZATIONFAILED (57), CANNOT OPEN FORMAT FILE (58), FORMAT FILE SYNTAX ERROR (59),REMOTE HOST UNAVAILABLE (60), EVENT LOG DOES NOT EXIST (61), PING FILE DOESNOT EXIST (62), NO PING DEVICE FILES (63), PING DEVICE LIST FILE MISSING (64), SNMPMISSING PASSWORD (65), DISABLED (66), URLS FILE NOT FOUND (67), XML PARSE ERROR(68), NOT INITIALIZED (69), ICMP SOCKETS FAILED (70), DUPLICATE CONF FILE (71),DELETED CONFIGURATION (72). Any value that does not have a definition here is displayed inthe User Interface.

Chapter 2. Attributes 71

Page 78: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: ERROR_CODE or ERRCODE (warehousename), Error Code (caption), Error_Code (attribute name), and ERRCODE (column name).

Intervals Skipped attributeThe number of times a background data collection for this group was skipped because theprevious collection was still running when the next one was due to start. The type is integer(32-bit counter).

The following names are defined for this attribute: INTERVALS_SKIPPED or INTSKIP(warehouse name), Intervals Skipped (caption), Intervals_Skipped (attribute name), and INTSKIP(column name).

Last Collection Duration attributeThe duration of the most recently completed data collection of this group in seconds. The type isreal number (32-bit counter) with two decimal places of precision.

The following names are defined for this attribute: LAST_COLLECTION_DURATION orCOLDURA (warehouse name), Last Collection Duration (caption), Last_Collection_Duration(attribute name), and COLDURA (column name).

Last Collection Finished attributeThe most recent time a data collection of this group finished. The type is timestamp withenumerated values. The following values are defined: NOT COLLECTED (0691231190000000),NOT COLLECTED (0000000000000001). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: LAST_COLLECTION_FINISHED or COLFINI(warehouse name), Last Collection Finished (caption), Last_Collection_Finished (attribute name),and COLFINI (column name).

Last Collection Start attributeThe most recent time a data collection of this group started. The type is timestamp withenumerated values. The following values are defined: NOT COLLECTED (0691231190000000),NOT COLLECTED (0000000000000001). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: LAST_COLLECTION_START or COLSTRT(warehouse name), Last Collection Start (caption), Last_Collection_Start (attribute name), andCOLSTRT (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Number of Collections attributeThe number of data collections for this group since the agent started. The type is integer (32-bitcounter).

The following names are defined for this attribute: NUMBER_OF_COLLECTIONS or NUMCOLL(warehouse name), Number of Collections (caption), Number_of_Collections (attribute name), andNUMCOLL (column name).

Object Name attributeThe name of the performance object. The type is string.

The following names are defined for this attribute: OBJECT_NAME or OBJNAME (warehousename), Object Name (caption), Object_Name (attribute name), and OBJNAME (column name).

Object Status attributeThe status of the performance object. The type is integer with enumerated values. The followingvalues are defined: ACTIVE (0), INACTIVE (1). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: OBJECT_STATUS or OBJSTTS (warehousename), Object Status (caption), Object_Status (attribute name), and OBJSTTS (column name).

72 Microsoft BizTalk Server agent Reference

Page 79: Microsoft BizTalk Server agent Reference - IBM

Object Type attributeThe type of the performance object. The type is integer with enumerated values. The followingvalues are defined: WMI (0), PERFMON (1), WMI ASSOCIATION GROUP (2), JMX (3), SNMP(4), SHELL COMMAND (5), JOINED GROUPS (6), CIMOM (7), CUSTOM (8), ROLLUP DATA (9),WMI REMOTE DATA (10), LOG FILE (11), JDBC (12), CONFIG DISCOVERY (13), NT EVENTLOG (14), FILTER (15), SNMP EVENT (16), PING (17), DIRECTOR DATA (18), DIRECTOREVENT (19), SSH REMOTE SHELL COMMAND (20). Any value that does not have a definitionhere is displayed in the User Interface.

The following names are defined for this attribute: OBJECT_TYPE or OBJTYPE (warehousename), Object Type (caption), Object_Type (attribute name), and OBJTYPE (column name).

Query Name attributeThe name of the attribute group. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: QUERY_NAME or ATTRGRP (warehousename), Query Name (caption), Query_Name (attribute name), and ATTRGRP (column name).

Refresh Interval attributeThe interval at which this group is refreshed in seconds. The type is integer (32-bit counter).

The following names are defined for this attribute: REFRESH_INTERVAL or REFRINT(warehouse name), Refresh Interval (caption), Refresh_Interval (attribute name), and REFRINT(column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

POP3 Receive Adapter attribute groupThe POP3 Receive Adapter attribute group includes attributes that provide information about bytes andmessages received by POP3 adapter. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Active Sessions attribute

This attribute displays the number of open POP3 connections the POP3 adapter is managing at atime. The type is integer (32-bit gauge).

The following names are defined for this attribute: ACTIVE_SESSIONS or ACTIVE_SES(warehouse name), Active Sessions (caption), Active_Sessions (attribute name), and ACTIVE_SES(column name).

Bytes Received Per Sec attributeThis attribute displays the number of bytes currently downloaded by the POP3 adapter from amail server per second. This attribute is the 64-bit version of the Bytes Received Per Sec(Superseded) attribute. The type is real number (64-bit gauge) with two decimal places ofprecision.

The following names are defined for this attribute: BYTES_RECEIVED_PER_SEC_64 orPOPBRE0_64 (warehouse name), Bytes Received Per Sec (caption), Bytes_Received_Per_Sec_64(attribute name), and POPBRE0_64 (column name).

Bytes Received Per Sec (Superseded) attributeThis attribute displays the number of bytes downloaded by the POP3 adapter from a mail serverper second. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: BYTES_RECEIVED_PER_SEC or BYTES_REC0(warehouse name), Bytes Received Per Sec (Superseded) (caption), Bytes_Received_Per_Sec(attribute name), and BYTES_REC0 (column name).

Kilobytes Received attributeThis attribute displays the total number of kilobytes downloaded by the POP3 adapter from a

Chapter 2. Attributes 73

Page 80: Microsoft BizTalk Server agent Reference - IBM

mail server since the BizTalk Server was started. This attribute is the 64-bit version of theKilobytes Received (Superseded) attribute. The type is integer (64-bit counter).

The following names are defined for this attribute: KILOBYTES_RECEIVED_64 or POPKBRE_64(warehouse name), Kilobytes Received (caption), Kilobytes_Received_64 (attribute name), andPOPKBRE_64 (column name).

Kilobytes Received (Superseded) attributeThis attribute displays the total number of kilobytes downloaded by the POP3 adapter from amail server since the application started. The type is integer (32-bit counter).

The following names are defined for this attribute: KILOBYTES_RECEIVED or BYTES_REC1(warehouse name), Kilobytes Received (Superseded) (caption), Kilobytes_Received (attributename), and BYTES_REC1 (column name).

Messages Received attributeThis attribute displays the total number of e-mail messages downloaded by the POP3 adapterfrom a mail server since the application started. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_RECEIVED or MESSAGES_R(warehouse name), Messages Received (caption), Messages_Received (attribute name), andMESSAGES_R (column name).

Messages Received Per Sec attributeThis attribute displays the number of e-mail messages downloaded by the POP3 adapter frommail server per second. The type is real number (32-bit gauge) with two decimal places ofprecision.

The following names are defined for this attribute: MESSAGES_RECEIVED_PER_SEC orMESSAGES_0 (warehouse name), Messages Received Per Sec (caption),Messages_Received_Per_Sec (attribute name), and MESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Receive Location Status attribute groupThe Receive Location Status attribute group includes attributes that provide information about the receivelocation status. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Is Primary attribute

This attribute indicates whether the Receive Location is primary. The type is string.

The following names are defined for this attribute: IS_PRIMARY or ISPRIMARY (warehousename), Is Primary (caption), Is_Primary (attribute name), and ISPRIMARY (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

74 Microsoft BizTalk Server agent Reference

Page 81: Microsoft BizTalk Server agent Reference - IBM

Receive Handler attributeThis attribute displays the name of the Receive Handler that is used by the Receive Location. Thetype is string.

The following names are defined for this attribute: RECEIVE_HANDLER or RLHOST (warehousename), Receive Handler (caption), Receive_Handler (attribute name), and RLHOST (columnname).

Receive Location Name attributeThis attribute displays the receive location name. This attribute is a key attribute. The type isstring.

The following names are defined for this attribute: RECEIVE_LOCATION_NAME or NAME(warehouse name), Receive Location Name (caption), Receive_Location_Name (attribute name),and NAME (column name).

Receive Port Name attributeThis attribute displays the name of the Receive Port that is used by the Receive Location. Thetype is string.

The following names are defined for this attribute: RECEIVE_PORT_NAME or RLPORT(warehouse name), Receive Port Name (caption), Receive_Port_Name (attribute name), andRLPORT (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Status attributeThis attribute displays the current receive location status. The type is integer (32-bit gauge) withenumerated values. The following values are defined: Disabled (-1), Enabled (0). Any value thatdoes not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: STATUS or ISDISABLED (warehouse name),Status (caption), Status (attribute name), and ISDISABLED (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Transport Address attributeThis attribute displays the adapter-specific URL that is listened by the given instance of theReceive Location. The type is string.

The following names are defined for this attribute: TRANSPORT_ADDRESS or RLTRPURL(warehouse name), Transport Address (caption), Transport_Address (attribute name), andRLTRPURL (column name).

Transport Type attributeThis attribute displays the name of the adapter that is used by the Receive Location. The type isstring.

The following names are defined for this attribute: TRANSPORT_TYPE or RLTRPTY (warehousename), Transport Type (caption), Transport_Type (attribute name), and RLTRPTY (column name).

Receive Ports attribute groupThe Receive Ports attribute group includes attributes that provide information about the receive ports thatare configured for the BizTalk applications. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:

Chapter 2. Attributes 75

Page 82: Microsoft BizTalk Server agent Reference - IBM

Is Two Way attributeThis attribute indicates whether the communication through the port is unidirectional orbidirectional. The type is string.

The following names are defined for this attribute: IS_TWO_WAY or IS2WAY (warehouse name),Is Two Way (caption), Is_Two_Way (attribute name), and IS2WAY (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Primary Receive Location attributeThis attribute displays the name of the primary receive location for the receive port. The type isstring.

The following names are defined for this attribute: PRIMARY_RECEIVE_LOCATION or PRECL(warehouse name), Primary Receive Location (caption), Primary_Receive_Location (attributename), and PRECL (column name).

Receive Port Name attributeThis attribute displays the name of the receive port. This attribute is a key attribute. The type isstring.

The following names are defined for this attribute: RECEIVE_PORT_NAME or NAME(warehouse name), Receive Port Name (caption), Receive_Port_Name (attribute name), andNAME (column name).

Route Failed Messages attributeThis attribute indicates whether the failed messages are routed to the subscribers. The type isstring.

The following names are defined for this attribute: ROUTE_FAILED_MESSAGES or RTMSG(warehouse name), Route Failed Messages (caption), Route_Failed_Messages (attribute name), andRTMSG (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

RFID Devices attribute groupThe RFID Devices attribute group includes attributes that provide information about RFID devices. Thisattribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Downtime attribute

This attribute displays the duration for which a device is currently not working after a connectionerror. The type is integer (32-bit gauge).

The following names are defined for this attribute: DOWNTIME (warehouse name), Downtime(caption), Downtime (attribute name), and DOWNTIME (column name).

Errors Raised attributeThis attribute displays the number of errors that are currently raised by a device. The type isinteger (32-bit gauge).

The following names are defined for this attribute: ERRORS_RAISED or ERR_RS (warehousename), Errors Raised (caption), Errors_Raised (attribute name), and ERR_RS (column name).

76 Microsoft BizTalk Server agent Reference

Page 83: Microsoft BizTalk Server agent Reference - IBM

Errors Raised Per Sec attributeThis attribute displays the rate at which errors are currently raised by a device. The type isinteger (32-bit gauge).

The following names are defined for this attribute: ERRORS_RAISED_PER_SEC or ERR_RSPS(warehouse name), Errors Raised Per Sec (caption), Errors_Raised_Per_Sec (attribute name), andERR_RSPS (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Tags Read Per Sec attributeThis attribute displays the rate at which tags are currently received from a device instance. Thetype is integer (32-bit gauge).

The following names are defined for this attribute: TAGS_READ_PER_SEC or TAGS_RDPS(warehouse name), Tags Read Per Sec (caption), Tags_Read_Per_Sec (attribute name), andTAGS_RDPS (column name).

Tags Written Per Sec attributeThis attribute displays the rate at which tags are currently sent from a device instance. The typeis integer (32-bit gauge).

The following names are defined for this attribute: TAGS_WRITTEN_PER_SEC or TAGS_WRPS(warehouse name), Tags Written Per Sec (caption), Tags_Written_Per_Sec (attribute name), andTAGS_WRPS (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Total Tags Read attributeThis attribute displays the total number of tags that are currently received from a device instance.The type is integer (32-bit gauge).

The following names are defined for this attribute: TOTAL_TAGS_READ or TAGS_READ(warehouse name), Total Tags Read (caption), Total_Tags_Read (attribute name), and TAGS_READ(column name).

Total Tags Written attributeThis attribute displays the total number of tags that are currently sent from a device instance. Thetype is integer (32-bit gauge).

The following names are defined for this attribute: TOTAL_TAGS_WRITTEN or TAGS_WRIT(warehouse name), Total Tags Written (caption), Total_Tags_Written (attribute name), andTAGS_WRIT (column name).

RFID Processes attribute groupThe RFID Processes attribute group includes attributes that provide information about RFID processes.This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Name attribute

The name of the instance. This attribute is a key attribute. The type is String.

Chapter 2. Attributes 77

Page 84: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Process Uptime attributeThis attribute displays the amount of time that has currently elapsed after a process was started.The type is integer (32-bit gauge).

The following names are defined for this attribute: PROCESS_UPTIME or PROCESS_UP(warehouse name), Process Uptime (caption), Process_Uptime (attribute name), and PROCESS_UP(column name).

Tags Being Processed attributeThis attribute displays the number of tags that are currently being processed in the processpipeline. The type is integer (32-bit gauge).

The following names are defined for this attribute: TAGS_BEING_PROCESSED or TAGS_BEING(warehouse name), Tags Being Processed (caption), Tags_Being_Processed (attribute name), andTAGS_BEING (column name).

Tags In Queue attributeThis attribute displays the total number of tags that are currently queued for processing. The typeis integer (32-bit gauge).

The following names are defined for this attribute: TAGS_IN_QUEUE or TAGS_IN_QU(warehouse name), Tags In Queue (caption), Tags_In_Queue (attribute name), and TAGS_IN_QU(column name).

Tags Processed attributeThis attribute displays the total number of tags that are currently processed by a process. Thetype is integer (32-bit gauge).

The following names are defined for this attribute: TAGS_PROCESSED or TAGS_PROCE(warehouse name), Tags Processed (caption), Tags_Processed (attribute name), and TAGS_PROCE(column name).

Tags Suspended attributeThis attribute displays the number of tags (tags that caused failures) that are currently sent to thesuspended queue. The type is integer (32-bit gauge).

The following names are defined for this attribute: TAGS_SUSPENDED or TAGS_SUSPE(warehouse name), Tags Suspended (caption), Tags_Suspended (attribute name), andTAGS_SUSPE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Rule Engine Database attribute groupThe Rule Engine Database attribute group includes attributes that provide information about the BizTalkRule Engine Database. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Database Name attribute

This attribute displays the Rule Engine Database name. The type is string.

The following names are defined for this attribute: DATABASE_NAME or RULEENGINE(warehouse name), Database Name (caption), Database_Name (attribute name), andRULEENGINE (column name).

78 Microsoft BizTalk Server agent Reference

Page 85: Microsoft BizTalk Server agent Reference - IBM

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the Rule Engine Database server name. The type is string.

The following names are defined for this attribute: SERVER_NAME or RULEENGIN0 (warehousename), Server Name (caption), Server_Name (attribute name), and RULEENGIN0 (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Send Port Group Status attribute groupThe Send Port Group Status attribute group includes attributes that provide information about the SendPort Group status. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Node attribute

The managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Send Port Group Name attributeThis attribute displays the Send Port Group name. This attribute is a key attribute. The type isstring.

The following names are defined for this attribute: SEND_PORT_GROUP_NAME or NAME(warehouse name), Send Port Group Name (caption), Send_Port_Group_Name (attribute name),and NAME (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Status attributeThis attribute displays the Send Port Group status. The type is integer with enumerated values.The following values are defined: Bound (1), Stopped (2), Started (3). Any value that does nothave a definition here is displayed in the User Interface.

The following names are defined for this attribute: STATUS (warehouse name), Status (caption),Status (attribute name), and STATUS (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Send Port Status attribute groupThe Send Port Status attribute group includes attributes that provide information about the send portstatus. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Is Dynamic attribute

This attribute indicates whether the port is dynamic or static. The type is string.

Chapter 2. Attributes 79

Page 86: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: IS_DYNAMIC or ISDYNM (warehouse name),Is Dynamic (caption), Is_Dynamic (attribute name), and ISDYNM (column name).

Is TwoWay attributeThis attribute indicates whether the port is one way or two way. The type is string.

The following names are defined for this attribute: IS_TWOWAY or IS2WAY (warehouse name), IsTwoWay (caption), Is_TwoWay (attribute name), and IS2WAY (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Primary Transport Address attributeThis attribute displays the primary transport URL for the port. The type is string.

The following names are defined for this attribute: PRIMARY_TRANSPORT_ADDRESS orPRITRPURL (warehouse name), Primary Transport Address (caption),Primary_Transport_Address (attribute name), and PRITRPURL (column name).

Send Port Name attributeThis attribute displays the send port name. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: SEND_PORT_NAME or NAME (warehousename), Send Port Name (caption), Send_Port_Name (attribute name), and NAME (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Status attributeThis attribute displays the send port status. The type is integer with enumerated values. Thefollowing values are defined: Bound (1), Stopped (2), Started (3). Any value that does not have adefinition here is displayed in the User Interface.

The following names are defined for this attribute: STATUS (warehouse name), Status (caption),Status (attribute name), and STATUS (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Transport Type attributeThis attribute displays the transport type of the primary transport for the port. The type is string.

The following names are defined for this attribute: TRANSPORT_TYPE or PRITRPTY (warehousename), Transport Type (caption), Transport_Type (attribute name), and PRITRPTY (column name).

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. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:Error Description attribute

This attribute displays the error description for a service instance. The type is string.

The following names are defined for this attribute: ERROR_DESCRIPTION or ERRORDESC(warehouse name), Error Description (caption), Error_Description (attribute name), andERRORDESC (column name).

Host Name attributeThis attribute displays the host name. This attribute is a key attribute. The type is string.

80 Microsoft BizTalk Server agent Reference

Page 87: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: HOST_NAME or HOSTNAME (warehousename), Host Name (caption), Host_Name (attribute name), and HOSTNAME (column name).

Instance ID attributeThis attribute displays the service instance identifier. This attribute is a key attribute. The type isstring.

The following names are defined for this attribute: INSTANCE_ID or INSTID (warehouse name),Instance ID (caption), Instance_ID (attribute name), and INSTID (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Service Class attributeThis attribute displays the service class for a service instance. The type is integer withenumerated values. The following values are defined: Orchestration (1), Tracking (2), Messaging(4), MSMQT (8), Other (16), Isolated adapter (32), Routing failure report (64). Any value that doesnot have a definition here is displayed in the User Interface.

The following names are defined for this attribute: SERVICE_CLASS or SERVICECLA (warehousename), Service Class (caption), Service_Class (attribute name), and SERVICECLA (column name).

Service Name attributeThis attribute displays the service instance name. The type is string.

The following names are defined for this attribute: SERVICE_NAME or SERVICENAM(warehouse name), Service Name (caption), Service_Name (attribute name), and SERVICENAM(column name).

Service Status attributeThis attribute displays the service status of a service instance. The type is integer withenumerated values. The following values are defined: Ready to run (1), Active (2), Suspendedresumable (4), Dehydrated (8), Completed with discarded messages (16), Suspended notresumable (32), In breakpoint (64). Any value that does not have a definition here is displayed inthe User Interface.

The following names are defined for this attribute: SERVICE_STATUS or SERVICESTA(warehouse name), Service Status (caption), Service_Status (attribute name), and SERVICESTA(column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

SFTP Receive Adapter attribute groupThe SFTP receive adapter attribute group includes attributes that provide information about the size ofdata and the messages that are received by the SFTP adapter. This attribute group is eligible for use withTivoli Data Warehouse.

This attribute group contains the following attributes:Bytes Received Per Sec attribute

This attribute displays the total number of bytes that are currently received per second by theSFTP receive adapter. The counter applies only to the messages from the SFTP server that areread by the SFTP receive adapter. The type is real number (64-bit gauge) with two decimal placesof precision.

Chapter 2. Attributes 81

Page 88: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: BYTES_RECEIVED_PER_SEC or BYTES_REC0(warehouse name), Bytes Received Per Sec (caption), Bytes_Received_Per_Sec (attribute name),and BYTES_REC0 (column name).

Kilobytes Received attributeThis attribute displays the total size of data (in KB) that is received by the SFTP receive adaptersince the BizTalk applications were started. The counter increases after a message from the SFTPserver is read by the SFTP receive adapter. The type is real number (64-bit counter).

The following names are defined for this attribute: KILOBYTES_RECEIVED or BYTES_REC1(warehouse name), Kilobytes Received (caption), Kilobytes_Received (attribute name), andBYTES_REC1 (column name).

Messages Received attributeThis attribute displays the total number of messages that are received by the SFTP receiveadapter since the BizTalk applications were started. The counter increases after a message fromthe SFTP server is read by the SFTP receive adapter. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_RECEIVED or MESSAGES_R(warehouse name), Messages Received (caption), Messages_Received (attribute name), andMESSAGES_R (column name).

Messages Received Per Sec attributeThis attribute displays the number of messages that are currently received per second by theSFTP receive adapter. The counter applies only to the messages from the SFTP server that areread by the SFTP receive adapter. The type is real number (32-bit gauge) with two decimal placesof precision.

The following names are defined for this attribute: MESSAGES_RECEIVED_PER_SEC orMESSAGES_0 (warehouse name), Messages Received Per Sec (caption),Messages_Received_Per_Sec (attribute name), and MESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

SFTP Send Adapter attribute groupThe SFTP send adapter attribute group includes attributes that provide information about the size of dataand the messages that are sent by the SFTP adapter. This attribute group is eligible for use with TivoliData Warehouse.

This attribute group contains the following attributes:Bytes Sent Per Sec attribute

This attribute displays the total number of bytes that are currently sent per second by the SFTPsend adapter. The counter applies only to the messages that are written to the destination SFTPserver. The type is real number (64-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: BYTES_SENT_PER_SEC or BYTES_SEN0(warehouse name), Bytes Sent Per Sec (caption), Bytes_Sent_Per_Sec (attribute name), andBYTES_SEN0 (column name).

82 Microsoft BizTalk Server agent Reference

Page 89: Microsoft BizTalk Server agent Reference - IBM

Kilobytes Sent attributeThis attribute displays the total size of data (in KB) that is sent by the SFTP send adapter sincethe BizTalk applications were started. The counter increases only for the messages that are writtento the destination SFTP server. The type is real number (64-bit counter).

The following names are defined for this attribute: KILOBYTES_SENT or BYTES_SEN1(warehouse name), Kilobytes Sent (caption), Kilobytes_Sent (attribute name), and BYTES_SEN1(column name).

Messages Sent attributeThis attribute displays the number of messages that are sent per second by the SFTP sendadapter since the BizTalk applications were started. The counter applies only to the messages thatare written to destination SFTP server. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_SENT or MESSAGES_S(warehouse name), Messages Sent (caption), Messages_Sent (attribute name), and MESSAGES_S(column name).

Messages Sent Per Sec attributeThis attribute displays the number of messages that are currently sent per second by the SFTPsend adapter. The counter applies only to the messages that have been written to the destinationSFTP server. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGES_SENT_PER_SEC or MESSAGES_0(warehouse name), Messages Sent Per Sec (caption), Messages_Sent_Per_Sec (attribute name), andMESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Single Sign On Database attribute groupThe Single Sign-On Database attribute group includes attributes that provide information about the SingleSign-On Database. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Database Name attribute

This attribute displays the Single Sign-On Database name. The type is string.

The following names are defined for this attribute: DATABASE_NAME or SSODBNAM(warehouse name), Database Name (caption), Database_Name (attribute name), and SSODBNAM(column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the Single Sign-On Database server name. The type is string.

Chapter 2. Attributes 83

Page 90: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: SERVER_NAME or SERVERNAM (warehousename), Server Name (caption), Server_Name (attribute name), and SERVERNAM (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

SMTP Send Adapter attribute groupThe SMTP Send Adapter attribute group includes attributes that provide information about messages sentby SMTP adapter. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Messages Sent attribute

This attribute displays the total number of messages sent by the SMTP adapter since theapplication started. The counter is incremented only for messages that have been transmitted tothe SMTP server. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_SENT or MESSAGES_S(warehouse name), Messages Sent (caption), Messages_Sent (attribute name), and MESSAGES_S(column name).

Messages Sent Per Sec attributeThis attribute displays the number of messages sent by the SMTP adapter per second. Thecounter applies only to messages that have been transmitted to the SMTP server. The type is realnumber (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGES_SENT_PER_SEC or MESSAGES_0(warehouse name), Messages Sent Per Sec (caption), Messages_Sent_Per_Sec (attribute name), andMESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

SOAP Receive Adapter attribute groupThe SOAP Receive Adapter attribute group includes attributes that provide information about messagesreceived by SOAP adapter. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Messages Received attribute

This attribute displays the total number of messages received by the SOAP Receive Adapter sincethe application started. The counter is incremented after a request message is read by the adapterfrom the SOAP client. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_RECEIVED or MESSAGES_R(warehouse name), Messages Received (caption), Messages_Received (attribute name), andMESSAGES_R (column name).

84 Microsoft BizTalk Server agent Reference

Page 91: Microsoft BizTalk Server agent Reference - IBM

Messages Received Per Sec attributeThis attribute displays the number of messages received by the SOAP Receive Adapter. Thecounter applies only to request messages that have been completely read by the adapter from theSOAP client. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGES_RECEIVED_PER_SEC orMESSAGES_0 (warehouse name), Messages Received Per Sec (caption),Messages_Received_Per_Sec (attribute name), and MESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

SOAP Send Adapter attribute groupThe SOAP Send Adapter attribute group includes attributes that provide information about messages sentby SOAP adapter. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Messages Sent attribute

This attribute displays the total number of messages sent by the SOAP Send Adapter since theapplication started. The counter is incremented only for messages that have reached thedestination URL. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_SENT or MESSAGES_S(warehouse name), Messages Sent (caption), Messages_Sent (attribute name), and MESSAGES_S(column name).

Messages Sent Per Sec attributeThis attribute displays the number of messages sent by the SOAP Send Adapter per second. Thecounter applies only to messages that have reached the destination URL. The type is real number(32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGES_SENT_PER_SEC or MESSAGES_0(warehouse name), Messages Sent Per Sec (caption), Messages_Sent_Per_Sec (attribute name), andMESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Chapter 2. Attributes 85

Page 92: Microsoft BizTalk Server agent Reference - IBM

SQL Receive Adapter attribute groupThe SQL Receive Adapter attribute group includes attributes that provide information about messagesreceived by SQL adapter. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Messages Received attribute

This attribute displays the total number of messages read by the SQL Receive Adapter from aSQL server since the application started. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_RECEIVED or MESSAGES_R(warehouse name), Messages Received (caption), Messages_Received (attribute name), andMESSAGES_R (column name).

Messages Received Per Sec attributeThis attribute displays the number of messages read by the SQL Receive Adapter from a SQLserver per second. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGES_RECEIVED_PER_SEC orMESSAGES_0 (warehouse name), Messages Received Per Sec (caption),Messages_Received_Per_Sec (attribute name), and MESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

SQL Send Adapter attribute groupThe SQL Send Adapter attribute group includes attributes that provide information about messages sentby SQL adapter This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Messages Sent attribute

This attribute displays the total number of messages sent by the SQL Send Adapter since theapplication started. The counter is incremented only for messages that have been written to thedestination SQL table. The type is integer (32-bit counter).

The following names are defined for this attribute: MESSAGES_SENT or MESSAGES_S(warehouse name), Messages Sent (caption), Messages_Sent (attribute name), and MESSAGES_S(column name).

Messages Sent Per Sec attributeThis attribute displays the number of messages sent by the SQL Send Adapter per second. Thecounter applies only to messages that have been written to the destination SQL table. The type isreal number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: MESSAGES_SENT_PER_SEC or MESSAGES_0(warehouse name), Messages Sent Per Sec (caption), Messages_Sent_Per_Sec (attribute name), andMESSAGES_0 (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

86 Microsoft BizTalk Server agent Reference

Page 93: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Subscribers attribute groupThis attribute group includes attributes that provide information about the subscribers object of aNotification Services instance for BAM. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:Name attribute

This attribute displays the instance name for the subscribers object. This attribute is a keyattribute. The type is string.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Subscribers Added attributeThis attribute displays the number of subscribers that were added since the instance was laststarted. The type is integer (64-bit counter).

The following names are defined for this attribute: SUBSCRIBERS_ADDED or SUBSCADD(warehouse name), Subscribers Added (caption), Subscribers_Added (attribute name), andSUBSCADD (column name).

Subscribers Disabled attributeThis attribute displays the number of subscribers that are currently marked as disabled. The typeis integer (64-bit gauge).

The following names are defined for this attribute: SUBSCRIBERS_DISABLED or SUBSCDIS(warehouse name), Subscribers Disabled (caption), Subscribers_Disabled (attribute name), andSUBSCDIS (column name).

Subscribers Enabled attributeThis attribute displays the number of subscribers that are currently marked as enabled. The typeis integer (64-bit gauge).

The following names are defined for this attribute: SUBSCRIBERS_ENABLED or SUBSCEN(warehouse name), Subscribers Enabled (caption), Subscribers_Enabled (attribute name), andSUBSCEN (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

Chapter 2. Attributes 87

Page 94: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Subscriptions attribute groupThis attribute group includes the attributes that provide information about the subscriptions object of aNotification Services instance for BAM. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:Name attribute

This attribute displays the instance name for the subscription object. This attribute is a keyattribute. The type is string.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Subscriptions Added attributeThis attribute displays the number of subscriptions that were added since the application wasstarted. The type is integer (32-bit counter).

The following names are defined for this attribute: SUBSCRIPTIONS_ADDED or SUBSCRIPTI(warehouse name), Subscriptions Added (caption), Subscriptions_Added (attribute name), andSUBSCRIPTI (column name).

Subscriptions Disabled attributeThis attribute displays the number of subscriptions that are currently disabled. The type is integer(64-bit gauge).

The following names are defined for this attribute: SUBSCRIPTIONS_DISABLED or SUBSCRIPT0(warehouse name), Subscriptions Disabled (caption), Subscriptions_Disabled (attribute name), andSUBSCRIPT0 (column name).

Subscriptions Enabled attributeThis attribute displays the total number of subscriptions that are currently enabled. The type isinteger (64-bit gauge).

The following names are defined for this attribute: SUBSCRIPTIONS_ENABLED or SUBSCRIPT1(warehouse name), Subscriptions Enabled (caption), Subscriptions_Enabled (attribute name), andSUBSCRIPT1 (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

TDDS attribute groupThe TDDS attribute group includes attributes that provide information about the events, records, andbatches that are processed. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:

88 Microsoft BizTalk Server agent Reference

Page 95: Microsoft BizTalk Server agent Reference - IBM

Batches Being Processed attributeThis attribute displays the number of batches that are being processed inside the current SQLtransaction. The type is integer (32-bit gauge).

The following names are defined for this attribute: BATCHES_BEING_PROCESSED orBATCHES_BE (warehouse name), Batches Being Processed (caption), Batches_Being_Processed(attribute name), and BATCHES_BE (column name).

Batches Committed attributeThis attribute displays the number of batches that are currently committed to the destinationdatabase. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: BATCHES_COMMITTED or BATCHES_CO(warehouse name), Batches Committed (caption), Batches_Committed (attribute name), andBATCHES_CO (column name).

Events Being Processed attributeThis attribute displays the number of events that are being processed inside the current SQLtransaction. The type is integer (32-bit gauge).

The following names are defined for this attribute: EVENTS_BEING_PROCESSED orEVENTS_BEI (warehouse name), Events Being Processed (caption), Events_Being_Processed(attribute name), and EVENTS_BEI (column name).

Events Committed attributeThis attribute displays the number of events that are committed to the destination databasewithin this second. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: EVENTS_COMMITTED or EVENTS_COM(warehouse name), Events Committed (caption), Events_Committed (attribute name), andEVENTS_COM (column name).

Name attributeThe name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Records Being Processed attributeThis attribute displays the number of records that are being processed inside the current SQLtransaction. The type is integer (32-bit gauge).

The following names are defined for this attribute: RECORDS_BEING_PROCESSED orRECORDS_BE (warehouse name), Records Being Processed (caption), Records_Being_Processed(attribute name), and RECORDS_BE (column name).

Records Committed attributeThis attribute displays the number of records committed to the destination database during thissecond. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: RECORDS_COMMITTED or RECORDS_CO(warehouse name), Records Committed (caption), Records_Committed (attribute name), andRECORDS_CO (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Chapter 2. Attributes 89

Page 96: Microsoft BizTalk Server agent Reference - IBM

Total Batches attributeThis attribute displays total batches processed by TDDS since the BizTalk Server was started. Thisattribute is the 64 bit version of the Total Batches (Superseded) attribute. The type is integer(64-bit counter).

The following names are defined for this attribute: TOTAL_BATCHES_64 or T_BATC_64(warehouse name), Total Batches (caption), Total_Batches_64 (attribute name), and T_BATC_64(column name).

Total Batches (Superseded) attributeThis attribute displays the total number of batches the TDDS processed since the Biztalk serverwas started. The type is integer (32-bit counter).

The following names are defined for this attribute: TOTAL_BATCHES or TOTAL_BATC(warehouse name), Total Batches (Superseded) (caption), Total_Batches (attribute name), andTOTAL_BATC (column name).

Total Events attributeThis attribute displays total events processed by TDDS since the BizTalk Server was started. Thisattribute is the 64 bit version of the Total Events (Superseded) attribute. The type is integer (64-bitcounter).

The following names are defined for this attribute: TOTAL_EVENTS_64 or T_EVEN_64(warehouse name), Total Events (caption), Total_Events_64 (attribute name), and T_EVEN_64(column name).

Total Events (Superseded) attributeThis attribute displays the total number of events the TDDS processed since the Biztalk serverwas started. The type is integer (32-bit counter).

The following names are defined for this attribute: TOTAL_EVENTS or TOTAL_EVEN(warehouse name), Total Events (Superseded) (caption), Total_Events (attribute name), andTOTAL_EVEN (column name).

Total Failed Batches attributeThis attribute displays total batches failed to run by TDDS since the BizTalk Server was started.This attribute is the 64 bit version of the Total Failed Batches (Superseded) attribute. The type isinteger (64-bit counter).

The following names are defined for this attribute: TOTAL_FAILED_BATCHES_64 or T_FAIL_64(warehouse name), Total Failed Batches (caption), Total_Failed_Batches_64 (attribute name), andT_FAIL_64 (column name).

Total Failed Batches (Superseded) attributeThis attribute displays the total number of batches that the TDDS failed to run since the Biztalkserver was started. The type is integer (32-bit counter).

The following names are defined for this attribute: TOTAL_FAILED_BATCHES or TOTAL_FAIL(warehouse name), Total Failed Batches (Superseded) (caption), Total_Failed_Batches (attributename), and TOTAL_FAIL (column name).

Total Failed Events attributeThis attribute displays total events failed to run by TDDS since the BizTalk Server was started.This attribute is the 64 bit version of the Total Failed Events (Superseded) attribute. The type isinteger (64-bit counter).

The following names are defined for this attribute: TOTAL_FAILED_EVENTS_64 or T_FAI0_64(warehouse name), Total Failed Events (caption), Total_Failed_Events_64 (attribute name), andT_FAI0_64 (column name).

Total Failed Events (Superseded) attributeThis attribute displays the total number of events that the TDDS failed to run since the Biztalkserver was started. The type is integer (32-bit counter).

The following names are defined for this attribute: TOTAL_FAILED_EVENTS or TOTAL_FAI0(warehouse name), Total Failed Events (Superseded) (caption), Total_Failed_Events (attributename), and TOTAL_FAI0 (column name).

90 Microsoft BizTalk Server agent Reference

Page 97: Microsoft BizTalk Server agent Reference - IBM

Total Records attributeThis attribute displays total records that were processed by TDDS since the Biztalk Server wasstarted. This attribute is the 64 bit version of the Total Records (Superseded) attribute. The type isinteger (64-bit gauge).

The following names are defined for this attribute: TOTAL_RECORDS_64 or T_RECO_64(warehouse name), Total Records (caption), Total_Records_64 (attribute name), and T_RECO_64(column name).

Total Records (Superseded) attributeThis attribute displays the total number of records that the TDDS currently processed. The type isinteger (32-bit counter).

The following names are defined for this attribute: TOTAL_RECORDS or TOTAL_RECO(warehouse name), Total Records (Superseded) (caption), Total_Records (attribute name), andTOTAL_RECO (column name).

Tracking Database attribute groupThe Tracking Database attribute group includes attributes that provide information about the BizTalkTracking Database. This attribute group is eligible for use with Tivoli Data Warehouse.

This attribute group contains the following attributes:Database Name attribute

This attribute displays the Tracking Database name. The type is string.

The following names are defined for this attribute: DATABASE_NAME or TRACKINGDB(warehouse name), Database Name (caption), Database_Name (attribute name), andTRACKINGDB (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Server Name attributeThis attribute displays the Tracking Database server name. The type is string.

The following names are defined for this attribute: SERVER_NAME or TRACKINGD0 (warehousename), Server Name (caption), Server_Name (attribute name), and TRACKINGD0 (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Vacuumer attribute groupThis attribute group includes attributes that provide information about the vacuumer object of aNotification Services instance for BAM. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:Completed Periods attribute

This attribute displays the number of scheduled vacuuming periods (or intervals) that arecurrently completed successfully. The type is integer (64-bit gauge).

The following names are defined for this attribute: COMPLETED_PERIODS or COMPPERID(warehouse name), Completed Periods (caption), Completed_Periods (attribute name), andCOMPPERID (column name).

Chapter 2. Attributes 91

Page 98: Microsoft BizTalk Server agent Reference - IBM

Name attributeThis attribute displays the instance name for the vacuumer object. This attribute is a key attribute.The type is string.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Quanta Remaining attributeThis attribute displays the number of quanta that was considered for vacuuming at the start ofthe last vacuuming period, but were not vacuumed. The type is integer (64-bit gauge).

The following names are defined for this attribute: QUANTA_REMAINING or QUANREMAN(warehouse name), Quanta Remaining (caption), Quanta_Remaining (attribute name), andQUANREMAN (column name).

Quanta Vacuumed attributeThis attribute displays the number of quanta that was vacuumed during the last vacuumingperiod. The type is integer (64-bit gauge).

The following names are defined for this attribute: QUANTA_VACUUMED or QUANVACUU(warehouse name), Quanta Vacuumed (caption), Quanta_Vacuumed (attribute name), andQUANVACUU (column name).

Server Name attributeThis attribute displays the name of the BizTalk Server. The type is string.

The following names are defined for this attribute: SERVER_NAME or SRVRNME (warehousename), Server Name (caption), Server_Name (attribute name), and SRVRNME (column name).

Timeouts attributeThis attribute displays the number of vacuuming periods that currently ended due to the timelimit. The type is integer (64-bit gauge).

The following names are defined for this attribute: TIMEOUTS (warehouse name), Timeouts(caption), Timeouts (attribute name), and TIMEOUTS (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Windows SharePoint Services attribute groupThe Windows SharePoint Services attribute group includes attributes that provide information aboutmessages sent, received and message failures. This attribute group is eligible for use with Tivoli DataWarehouse.

This attribute group contains the following attributes:Node attribute

The managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Percent Receive Message Failures attributeThis attribute displays the percentage of Windows SharePoint Services files that have not beenprocessed by BizTalk Server due to receive errors. The type is real number (32-bit gauge) withtwo decimal places of precision.

92 Microsoft BizTalk Server agent Reference

Page 99: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: PERCENT_RECEIVE_MESSAGE_FAILURES orRECEIVE_ME (warehouse name), Percent Receive Message Failures (caption),Percent_Receive_Message_Failures (attribute name), and RECEIVE_ME (column name).

Percent Send Message Failures attributeThis attribute displays the percentage of failed messages BizTalk Server attempted to send toWindows SharePoint Services. The type is real number (32-bit gauge) with two decimal places ofprecision.

The following names are defined for this attribute: PERCENT_SEND_MESSAGE_FAILURES orSEND_MESSA (warehouse name), Percent Send Message Failures (caption),Percent_Send_Message_Failures (attribute name), and SEND_MESSA (column name).

Percent Web Service Call Failures attributeThis attribute displays the percentage of Windows SharePoint Services adapter Web service callsthat have failed. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: PERCENT_WEB_SERVICE_CALL_FAILURESor WEB_SERVIC (warehouse name), Percent Web Service Call Failures (caption),Percent_Web_Service_Call_Failures (attribute name), and WEB_SERVIC (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Total Receive Commit Failures attributeThis attribute displays the total number of Windows SharePoint Services errors that were raisedwhen updating the status of the SharePoint documents since the application started. The type isinteger (32-bit counter).

The following names are defined for this attribute: TOTAL_RECEIVE_COMMIT_FAILURES orTOTAL_RECE (warehouse name), Total Receive Commit Failures (caption),Total_Receive_Commit_Failures (attribute name), and TOTAL_RECE (column name).

Total Receive Message Failures attributeThis attribute displays the total number of Windows SharePoint Services files received by theWindows SharePoint Services adapter, including files that failed to process since the applicationstarted. The type is integer (32-bit counter).

The following names are defined for this attribute: TOTAL_RECEIVE_MESSAGE_FAILURES orTOTAL_REC1 (warehouse name), Total Receive Message Failures (caption),Total_Receive_Message_Failures (attribute name), and TOTAL_REC1 (column name).

Total Received Messages attributeThis attribute displays the total number of Windows SharePoint Services files received that havenot been processed by BizTalk Server due to errors since the application started. The type isinteger (32-bit counter).

The following names are defined for this attribute: TOTAL_RECEIVED_MESSAGES orTOTAL_REC0 (warehouse name), Total Received Messages (caption), Total_Received_Messages(attribute name), and TOTAL_REC0 (column name).

Total Send Message Failures attributeThis attribute displays the total number of failed messages BizTalk Server attempted to send toWindows SharePoint Services since the application started. The type is integer (32-bit counter).

The following names are defined for this attribute: TOTAL_SEND_MESSAGE_FAILURES orTOTAL_SEND (warehouse name), Total Send Message Failures (caption),Total_Send_Message_Failures (attribute name), and TOTAL_SEND (column name).

Total Sent Messages attributeThis attribute displays the total number of messages BizTalk Server sent to Windows SharePointServices, including files that failed to process since the application started. The type is integer(32-bit counter).

Chapter 2. Attributes 93

Page 100: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: TOTAL_SENT_MESSAGES or TOTAL_SENT(warehouse name), Total Sent Messages (caption), Total_Sent_Messages (attribute name), andTOTAL_SENT (column name).

Total Web Service Call Failures attributeThis attribute displays the total number of Windows SharePoint Services adapter Web servicecalls that have failed since the application started. The type is integer (32-bit counter).

The following names are defined for this attribute: TOTAL_WEB_SERVICE_CALL_FAILURES orTOTAL_WEB_ (warehouse name), Total Web Service Call Failures (caption),Total_Web_Service_Call_Failures (attribute name), and TOTAL_WEB_ (column name).

Web Service Calls Per Sec attributeThis attribute displays the number of Windows SharePoint Services adapter Web service calls persecond. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: WEB_SERVICE_CALLS_PER_SEC orWEB_SERVI0 (warehouse name), Web Service Calls Per Sec (caption), Web_Service_Calls_Per_Sec(attribute name), and WEB_SERVI0 (column name).

Windows SharePoint Services Adapter attribute groupThe Windows SharePoint Services Adapter attribute group includes attributes that provide informationabout messages sent, received and message failures. This attribute group is eligible for use with TivoliData Warehouse.

This attribute group contains the following attributes:Name attribute

The name of the instance. This attribute is a key attribute. The type is String.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Percent Receive Message Failures attributeThis attribute displays the percentage of Windows SharePoint Services files that have not beenprocessed by BizTalk Server due to receive errors. The type is real number (32-bit gauge) withtwo decimal places of precision.

The following names are defined for this attribute: PERCENT_RECEIVE_MESSAGE_FAILURES orRECEIVE_ME (warehouse name), Percent Receive Message Failures (caption),Percent_Receive_Message_Failures (attribute name), and RECEIVE_ME (column name).

Percent Send Message Failures attributeThis attribute displays the percentage of failed messages BizTalk Server attempted to send toWindows SharePoint Services. The type is real number (32-bit gauge) with two decimal places ofprecision.

The following names are defined for this attribute: PERCENT_SEND_MESSAGE_FAILURES orSEND_MESSA (warehouse name), Percent Send Message Failures (caption),Percent_Send_Message_Failures (attribute name), and SEND_MESSA (column name).

Percent Web Service Call Failures attributeThis attribute displays the percentage of Windows SharePoint Services adapter Web service callsthat have failed. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: PERCENT_WEB_SERVICE_CALL_FAILURESor WEB_SERVIC (warehouse name), Percent Web Service Call Failures (caption),Percent_Web_Service_Call_Failures (attribute name), and WEB_SERVIC (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

94 Microsoft BizTalk Server agent Reference

Page 101: Microsoft BizTalk Server agent Reference - IBM

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Total Receive Commit Failures attributeThis attribute displays the total number of Windows SharePoint Services errors that were raisedwhen updating the status of the SharePoint documents since the application started. The type isinteger (32-bit counter).

The following names are defined for this attribute: TOTAL_RECEIVE_COMMIT_FAILURES orTOTAL_RECE (warehouse name), Total Receive Commit Failures (caption),Total_Receive_Commit_Failures (attribute name), and TOTAL_RECE (column name).

Total Receive Message Failures attributeThis attribute displays the total number of Windows SharePoint Services files received by theWindows SharePoint Services adapter, including files that failed to process since the applicationstarted. The type is integer (32-bit counter).

The following names are defined for this attribute: TOTAL_RECEIVE_MESSAGE_FAILURES orTOTAL_REC1 (warehouse name), Total Receive Message Failures (caption),Total_Receive_Message_Failures (attribute name), and TOTAL_REC1 (column name).

Total Received Messages attributeThis attribute displays the total number of Windows SharePoint Services files received that havenot been processed by BizTalk Server due to errors since the application started. The type isinteger (32-bit counter).

The following names are defined for this attribute: TOTAL_RECEIVED_MESSAGES orTOTAL_REC0 (warehouse name), Total Received Messages (caption), Total_Received_Messages(attribute name), and TOTAL_REC0 (column name).

Total Send Message Failures attributeThis attribute displays the total number of failed messages BizTalk Server attempted to send toWindows SharePoint Services since the application started. The type is integer (32-bit counter).

The following names are defined for this attribute: TOTAL_SEND_MESSAGE_FAILURES orTOTAL_SEND (warehouse name), Total Send Message Failures (caption),Total_Send_Message_Failures (attribute name), and TOTAL_SEND (column name).

Total Sent Messages attributeThis attribute displays the total number of messages BizTalk Server sent to Windows SharePointServices, including files that failed to process since the application started. The type is integer(32-bit counter).

The following names are defined for this attribute: TOTAL_SENT_MESSAGES or TOTAL_SENT(warehouse name), Total Sent Messages (caption), Total_Sent_Messages (attribute name), andTOTAL_SENT (column name).

Total Web Service Call Failures attributeThis attribute displays the total number of Windows SharePoint Services adapter Web servicecalls that have failed since the application started. The type is integer (32-bit counter).

The following names are defined for this attribute: TOTAL_WEB_SERVICE_CALL_FAILURES orTOTAL_WEB_ (warehouse name), Total Web Service Call Failures (caption),Total_Web_Service_Call_Failures (attribute name), and TOTAL_WEB_ (column name).

Web Service Calls Per Sec attributeThis attribute displays the number of Windows SharePoint Services adapter Web service calls persecond. The type is real number (32-bit gauge) with two decimal places of precision.

The following names are defined for this attribute: WEB_SERVICE_CALLS_PER_SEC orWEB_SERVI0 (warehouse name), Web Service Calls Per Sec (caption), Web_Service_Calls_Per_Sec(attribute name), and WEB_SERVI0 (column name).

Chapter 2. Attributes 95

Page 102: Microsoft BizTalk Server agent Reference - IBM

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 are defining data collection rules and your strategy for historicaldata collection.

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 listed here corresponds to the table name in “Attributegroups for the monitoring agent” on page 18.

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 18.

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 1. Capacity planning for historical data logged by the Microsoft BizTalk Server agent

Table Attribute group

Bytes perrow(agent)

Databasebytes perrow(warehouse)

Aggregatebytes perrow(warehouse)

For more information about historical data collection, see “Managing historical data” in the IBM TivoliMonitoring Administrator's Guide.

96 Microsoft BizTalk Server agent Reference

Page 103: Microsoft BizTalk Server agent Reference - IBM

Chapter 3. Situations

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

© Copyright IBM Corp. 2009, 2017 97

Page 104: Microsoft BizTalk Server agent Reference - IBM

– Not applicablev Availability

– KQB_BizRuleEngine_Service_Down– KQB_Biz_Base_EDI_Service_Down– KQB_Biz_HostInstance_Srv_Down– KQB_Biz_SP_Msg_Adapter_Down– KQB_Biz_SSO_Service_Down– KQB_No_Host_Instance– KQB_RFID_Service_Down

v Business Activity Monitoring– Not applicable

v Configuration and Status– KQB_Orchestrn_Stopped_Warning– KQB_Rec_Loc_Stoped_Warning– KQB_Send_Port_Group_Stopped– KQB_Send_Port_Stopped_Warning– KQB_Srvc_Inst_Suspend_Warning

v Databases– Not applicable

v Event Log– KQB_Adapter_SuspendsInboundMsg– KQB_Adptr_Suspends_OutboundMsg– KQB_BAM_Config_Changed_Info– KQB_BizTalk_DBConnection_Fail– KQB_FileAdptr_FolderAccessFail– KQB_FILESendAdptr_OpenFileFail– KQB_HostInstance_ConfigDB_Fail– KQB_Host_Inst_Crashed– KQB_HTTPSendAdaptr_ConnectFail– KQB_Inbound_Msg_Proc_Failure– KQB_Invalid_FileRecieveLoc– KQB_Invalid_Receive_Loc_Config– KQB_MsgEngineFailToGetConfigDB– KQB_MsgEngine_FailToAddRecvLoc– KQB_MsgEngine_FailToInit– KQB_MsgEngine_FailToRegAdptr– KQB_MsgEngine_SSOSrverConnFail– KQB_Msg_Resp_WithoutReq– KQB_MSMQTSubserviceFail– KQB_POP3_Authentication_Fail– KQB_POP3_ServerConnection_Fail– KQB_ReceiveLoc_ShutDown– KQB_RecvFileAttr– KQB_RecvLoc_Disabled– KQB_RFID_DeviceName_Conflict

98 Microsoft BizTalk Server agent Reference

Page 105: Microsoft BizTalk Server agent Reference - IBM

– KQB_RFID_Device_Conn_Fail– KQB_RFID_Device_Disabled– KQB_RFID_Dev_StateSave_Fail– KQB_RFID_InsufPrivil_On_Dev– KQB_RFID_ProcessEngine_Fatal– KQB_RFID_ProcessEng_MaxRestart– KQB_RFID_Service_Auth_Fail– KQB_RFID_Service_StartUpFail– KQB_SendPipeline_ExecutionFail– KQB_Stored_ProcCall_Failure

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 3. Situations 99

Page 106: Microsoft BizTalk Server agent Reference - IBM

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_BizRuleEngine_Service_Down situation

DescriptionRule Engine Update Service is not running.

The situation is evaluated for each distinct value of Full_Name.Formula

*IF *VALUE KQB_AVAILABILITY.Name *EQ ’RuleEngineUpdateService’ *AND *VALUEKQB_AVAILABILITY.Status *EQ DOWN

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval15 minutes

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 is evaluated for each distinct value of Full_Name.

100 Microsoft BizTalk Server agent Reference

Page 107: Microsoft BizTalk Server agent Reference - IBM

Formula*IF *VALUE KQB_AVAILABILITY.Name *EQ ’EDI Subsystem’ *AND *VALUEKQB_AVAILABILITY.Status *EQ DOWN

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval15 minutes

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_HostInstance_Srv_Down situationDescription

BizTalk Server Application service is not running.

The situation is 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 23 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_SP_Msg_Adapter_Down situationDescription

BizTalk SharePoint Messaging Adapter Service is not running.

The situation is evaluated for each distinct value of Full_Name.Formula

*IF *VALUE KQB_AVAILABILITY.Name *EQ’Microsoft.BizTalk.KwTpm.StsBizTalkAdapter.StsBizTalkAdapterService’ *AND *VALUEKQB_AVAILABILITY.Status *EQ DOWN

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Chapter 3. Situations 101

Page 108: Microsoft BizTalk Server agent Reference - IBM

Run at startupNo

Sampling interval15 minutes

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_SSO_Service_Down situationDescription

Enterprise Single Sign-On service is not running.

The situation is evaluated for each distinct value of Full_Name.Formula

*IF *VALUE KQB_AVAILABILITY.Name *EQ ’ENTSSO’ *AND *VALUE KQB_AVAILABILITY.Status*EQ DOWN

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval1 minute

Situation persistenceThe number of times the conditions of the situation must occur for the situation to betrue is 1.

Error conditionsCritical

Clearing conditionsThe situation clears when the condition becomes false.

KQB_No_Host_Instance situationDescription

No Host Instance on the BizTalk Server.

The situation is evaluated for each distinct value of Full_Name.Formula

*IF ( ( *VALUE KQB_AVAILABILITY.Full_Name *EQ ’N/A’ *AND *VALUEKQB_AVAILABILITY.Name *EQ ’btssvc’ *AND *VALUE KQB_AVAILABILITY.Status *EQUNKNOWN ) *OR ( *VALUE KQB_AVAILABILITY.Full_Name *EQ ’N/A’ *AND *VALUEKQB_AVAILABILITY.Name *EQ ’BTSSvc’ *AND *VALUE KQB_AVAILABILITY.Status *EQUNKNOWN ) )

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval15 minutes

Situation persistenceThe number of times the conditions of the situation must occur for the situation to betrue is 1.

102 Microsoft BizTalk Server agent Reference

Page 109: Microsoft BizTalk Server agent Reference - IBM

Error conditionsWarning

Clearing conditionsThe situation clears when the condition becomes false.

KQB_RFID_Service_Down situationDescription

The Microsoft BizTalk RFID service is not running.

The situation is evaluated for each distinct value of Full_Name.Formula

*IF ( ( *VALUE KQB_AVAILABILITY.Name *EQ ’msbiztalkrfid’ *AND *VALUEKQB_AVAILABILITY.Status *EQ DOWN ) *OR ( *VALUE KQB_AVAILABILITY.Name *EQ’MSBizTalkRFID’ *AND *VALUE KQB_AVAILABILITY.Status *EQ DOWN ) )

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval15 minutes

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.

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_Orchestrn_Stopped_Warning situation

DescriptionOrchestration stopped

The situation is evaluated for each distinct value of the NAME attribute.Formula

*IF *VALUE KQB_ORCHESTRATION_STATUS.Status *EQ 3

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval1 hour

Situation persistenceThe number of times the conditions of the situation must occur for the situation to betrue is 1.

Error conditionsWarning

Chapter 3. Situations 103

Page 110: Microsoft BizTalk Server agent Reference - IBM

Clearing conditionsThe situation clears when the condition becomes false.

KQB_Rec_Loc_Stoped_Warning situationDescription

Receive location disabled

The situation is evaluated for each distinct value of the NAME attribute.Formula

*IF *VALUE KQB_RECEIVE_LOCATION_STATUS.Status *EQ Disabled

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval30 minutes

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_Send_Port_Group_Stopped situationDescription

The Send Port Group is stopped.

The situation is evaluated for each distinct value of Send_Port_Group_Name.Formula

*IF *VALUE KQB_SEND_PORT_GROUP_STATUS.Status *EQ 2

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval30 minutes

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_Send_Port_Stopped_Warning situationDescription

Send port stopped

The situation is evaluated for each distinct value of the NAME attribute.Formula

*IF *VALUE KQB_SEND_PORT_STATUS.Status *EQ 2

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

104 Microsoft BizTalk Server agent Reference

Page 111: Microsoft BizTalk Server agent Reference - IBM

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval30 minutes

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_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

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval30 minutes

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.

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_Adapter_SuspendsInboundMsg situation

DescriptionAn inbound receive message is suspended by an adapter.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5753 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5753 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’) *OR ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5753 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2009’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5753 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server’))

Chapter 3. Situations 105

Page 112: Microsoft BizTalk Server agent Reference - IBM

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_Adptr_Suspends_OutboundMsg situationDescription

An outbound message is being suspended by the adapter.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5754 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5754 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’) *OR ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5754 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2009’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5754 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_BAM_Config_Changed_Info situationDescription

BAM Alerts either showing no data or wrong data.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*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’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

106 Microsoft BizTalk Server agent Reference

Page 113: Microsoft BizTalk Server agent Reference - IBM

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsInformational

Clearing conditionsThe situation does not clear automatically.

KQB_BizTalk_DBConnection_Fail situationDescription

BTS Host instance failed to connect to one of its database.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*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’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_FileAdptr_FolderAccessFail situationDescription

The FILE adapter cannot access the folder. Not for BT2004.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 7195 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 7195 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2009’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Chapter 3. Situations 107

Page 114: Microsoft BizTalk Server agent Reference - IBM

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_FILESendAdptr_OpenFileFail situationDescription

The FILE Send Adapter cannot open file for writing.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 7184 *AND *VALUEKQB_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’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_HostInstance_ConfigDB_Fail situationDescription

Host Instance failed in BizTalk Configuration DB connection.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5439 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5439 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_Host_Inst_Crashed situationDescription

Failure occurred while executing a Windows service request.

108 Microsoft BizTalk Server agent Reference

Page 115: Microsoft BizTalk Server agent Reference - IBM

The situation is 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’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_HTTPSendAdaptr_ConnectFail situationDescription

HTTP Send Adapter can't connect to remote server. Not for BT2004

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF *VALUE KQB_EVENT_LOG.Event_ID *EQ 7221 *AND *VALUE KQB_EVENT_LOG.Event_Source*EQ ’BizTalk Server 2006’

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

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 *VALUE

Chapter 3. Situations 109

Page 116: Microsoft BizTalk Server agent Reference - IBM

KQB_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’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

KQB_Invalid_FileRecieveLoc situationDescription

The file receive location is not valid.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 7176 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 7176 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’) *OR ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 7176 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2009’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

KQB_Invalid_Receive_Loc_Config situationDescription

A 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’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

110 Microsoft BizTalk Server agent Reference

Page 117: Microsoft BizTalk Server agent Reference - IBM

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_MsgEngineFailToGetConfigDB situationDescription

Messaging engine failed to retrieve data from the SSO database.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5641 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5641 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_MsgEngine_FailToAddRecvLoc situationDescription

The Messaging Engine failed to add receive location.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*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’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Chapter 3. Situations 111

Page 118: Microsoft BizTalk Server agent Reference - IBM

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_MsgEngine_FailToInit situationDescription

The messaging engine failed to register an adapter.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5632 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5632 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

KQB_MsgEngine_FailToRegAdptr situationDescription

The messaging engine failed to initialize.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5787 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5787 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

KQB_MsgEngine_SSOSrverConnFail situation

112 Microsoft BizTalk Server agent Reference

Page 119: Microsoft BizTalk Server agent Reference - IBM

DescriptionThe messaging engine cannot contact the SSO Server.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5777 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5777 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

KQB_Msg_Resp_WithoutReq situationDescription

The messaging engine has suspended a message.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5813 *AND *VALUEKQB_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’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_MSMQTSubserviceFail situationDescription

MSMQT service failed to start because of Windows MSMQ service.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 7425 *AND *VALUE

Chapter 3. Situations 113

Page 120: Microsoft BizTalk Server agent Reference - IBM

KQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 7425 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

KQB_POP3_Authentication_Fail situationDescription

POP3 adapter could not authenticate server for credentials.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF *VALUE KQB_EVENT_LOG.Event_ID *EQ 6528 *AND *VALUE KQB_EVENT_LOG.Event_Source*EQ ’BizTalk Server 2006’

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_POP3_ServerConnection_Fail situationDescription

POP3 adapter could not establish connection with POP3 server.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF *VALUE KQB_EVENT_LOG.Event_ID *EQ 6535 *AND *VALUE KQB_EVENT_LOG.Event_Source*EQ ’BizTalk Server 2006’

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

114 Microsoft BizTalk Server agent Reference

Page 121: Microsoft BizTalk Server agent Reference - IBM

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_ReceiveLoc_ShutDown situationDescription

The receive location is being shut down.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5649 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5649 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’) *OR ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5649 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2009’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

KQB_RecvFileAttr situationDescription

The processed file is either a read-only file or a system file.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 7175 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 7175 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’) *OR ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 7175 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2009’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

Chapter 3. Situations 115

Page 122: Microsoft BizTalk Server agent Reference - IBM

KQB_RecvLoc_Disabled situationDescription

Receive locations disabled as MsgBox or Config DB not available.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5773 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5773 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’) *OR ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5773 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2009’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5773 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

KQB_RFID_DeviceName_Conflict situationDescription

The physical device name does not match the logical device name.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 1020 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’MSBizTalkRFID’)

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

KQB_RFID_Device_Conn_Fail situationDescription

RFID device failed to connect to the server.

The situation is evaluated for each distinct value of the LOGNAME attribute.

116 Microsoft BizTalk Server agent Reference

Page 123: Microsoft BizTalk Server agent Reference - IBM

Formula*IF ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 1013 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’MSBizTalkRFID’)

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

KQB_RFID_Device_Disabled situationDescription

The RFID device is in the disabled state.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 1014 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’MSBizTalkRFID’)

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

KQB_RFID_Dev_StateSave_Fail situationDescription

RFID process is unable to connect to the RFID logical device.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 1000 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’MSBizTalkRFID’)

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Chapter 3. Situations 117

Page 124: Microsoft BizTalk Server agent Reference - IBM

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

KQB_RFID_InsufPrivil_On_Dev situationDescription

The user has insufficient privileges for the RFID device.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 1032 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’MSBizTalkRFID’)

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_RFID_ProcessEngine_Fatal situationDescription

Microsoft BizTalk RFID process engine restarts automatically.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 3007 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’MSBizTalkRFID’)

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

KQB_RFID_ProcessEng_MaxRestart situationDescription

Microsoft BizTalk RFID process restarts for maximum times.

The situation is evaluated for each distinct value of the LOGNAME attribute.

118 Microsoft BizTalk Server agent Reference

Page 125: Microsoft BizTalk Server agent Reference - IBM

Formula*IF ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 3014 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’MSBizTalkRFID’)

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_RFID_Service_Auth_Fail situationDescription

The Microsoft BizTalk RFID Service failed to authorize the user.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 667 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’MSBizTalkRFID’)

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_RFID_Service_StartUpFail situationDescription

The Microsoft BizTalk RFID Service failed to start.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 1500 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’MSBizTalkRFID’)

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Chapter 3. Situations 119

Page 126: Microsoft BizTalk Server agent Reference - IBM

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_SendPipeline_ExecutionFail situationDescription

Execution of Send Pipeline failed.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5720 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5720 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’) *OR ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 5720 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2009’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 5720 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

Error conditionsCritical

Clearing conditionsThe situation does not clear automatically.

KQB_Stored_ProcCall_Failure situationDescription

A stored procedure call failed.

The situation is evaluated for each distinct value of the LOGNAME attribute.Formula

*IF ( ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 6912 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2006’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 6912 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server 2004’) *OR ( *VALUE KQB_EVENT_LOG.Event_ID *EQ 6912 *AND *VALUEKQB_EVENT_LOG.Event_Source *EQ ’BizTalk Server 2009’) *OR ( *VALUEKQB_EVENT_LOG.Event_ID *EQ 6912 *AND *VALUE KQB_EVENT_LOG.Event_Source *EQ’BizTalk Server’))

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is automatically distributed to instances of this agent.

Run at startupYes

Sampling intervalNone. Data is analyzed when it becomes available.

Situation persistenceNot Applicable

120 Microsoft BizTalk Server agent Reference

Page 127: Microsoft BizTalk Server agent Reference - IBM

Error conditionsWarning

Clearing conditionsThe situation does not clear automatically.

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

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval5 minutes

Situation persistenceThe number of times the conditions of the situation must occur for the situation to betrue is 1.

Error conditionsCritical

Clearing conditionsThe situation clears when the condition becomes false.

KQB_HT_High_Database_Size situationDescription

Database size 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_Size *EQ 1 *OR *VALUEKQB_HOST_THROTTLING.Message_Publishing_Throttling_State *EQ 6

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval5 minutes

Situation persistenceThe number of times the conditions of the situation must occur for the situation to betrue is 1.

Error conditionsCritical

Clearing conditionsThe situation clears when the condition becomes false.

KQB_HT_High_InProcMessageCount situation

Chapter 3. Situations 121

Page 128: Microsoft BizTalk Server agent Reference - IBM

DescriptionInProcess msg 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_In_Process_Message_Count *EQ 1 *OR *VALUEKQB_HOST_THROTTLING.Message_Delivery_Throttling_State *EQ 3

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval5 minutes

Situation persistenceThe number of times the conditions of the situation must occur for the situation to betrue is 1.

Error conditionsCritical

Clearing conditionsThe situation clears when the condition becomes false.

KQB_HT_High_MsgDelivery_Rate situationDescription

Msg delivery rate exceeds msg processing Rate. Not for BT2004.

The situation is evaluated for each distinct value of the NAME attribute.Formula

*IF *VALUE KQB_HOST_THROTTLING.High_Message_Delivery_Rate *EQ 1 *OR *VALUEKQB_HOST_THROTTLING.Message_Delivery_Throttling_State *EQ 1

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval5 minutes

Situation persistenceThe number of times the conditions of the situation must occur for the situation to betrue is 1.

Error conditionsCritical

Clearing conditionsThe situation clears when the condition becomes false.

KQB_HT_High_MsgPublishing_Rate situationDescription

Publishing request rate exceeds completion rate. Not for BT2004.

The situation is evaluated for each distinct value of the NAME attribute.Formula

*IF *VALUE KQB_HOST_THROTTLING.High_Message_Publishing_Rate *EQ 1 *OR *VALUEKQB_HOST_THROTTLING.Message_Publishing_Throttling_State *EQ 2

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

122 Microsoft BizTalk Server agent Reference

Page 129: Microsoft BizTalk Server agent Reference - IBM

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval5 minutes

Situation persistenceThe number of times the conditions of the situation must occur for the situation to betrue is 1.

Error conditionsCritical

Clearing conditionsThe situation clears when the condition becomes false.

KQB_HT_High_Process_Memory situationDescription

Process memory exceeds threshold. Not for BT2004.

The situation is evaluated for each distinct value of the NAME attribute.Formula

*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

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval5 minutes

Situation persistenceThe number of times the conditions of the situation must occur for the situation to betrue is 1.

Error conditionsCritical

Clearing conditionsThe situation clears when the condition becomes false.

KQB_HT_High_System_Memory situationDescription

System memory exceeds threshold. Not for BT2004.

The situation is evaluated for each distinct value of the NAME attribute.Formula

*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

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval5 minutes

Chapter 3. Situations 123

Page 130: Microsoft BizTalk Server agent Reference - IBM

Situation persistenceThe number of times the conditions of the situation must occur for the situation to betrue is 1.

Error conditionsCritical

Clearing conditionsThe situation clears when the condition becomes false.

KQB_HT_High_Thread_Count situationDescription

Thread 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_Thread_Count *EQ 1 *OR *VALUEKQB_HOST_THROTTLING.Message_Delivery_Throttling_State *EQ 9 *OR *VALUEKQB_HOST_THROTTLING.Message_Publishing_Throttling_State *EQ 9

See “Attributes in each attribute group” on page 23 for descriptions of the attributes inthis formula.

DistributionThis situation is available for distribution.

Run at startupNo

Sampling interval5 minutes

Situation persistenceThe number of times the conditions of the situation must occur for the situation to betrue is 1.

Error conditionsCritical

Clearing conditionsThe situation clears when the condition becomes false.

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.

124 Microsoft BizTalk Server agent Reference

Page 131: Microsoft BizTalk Server agent Reference - IBM

Chapter 4. Take Action commands

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 theTivoli Enterprise Portal User's Guide.

For a list of the Take Action commands for this monitoring agent and a description of each command, see“Predefined Take Action commands” and the information for each individual command.

Predefined Take Action commandsNot all agents have predefined Take Action commands. But you can create Take Action commands forany agent.

This monitoring agent contains the following Take Action commands:v Disable Receive Locationv Enable Receive Locationv Enlist Orchestrationv Enlist Send Portv Enlist Send Port Groupv Start BizTalk Base EDI Servicev Start BizTalk SharePoint Messaging Adapter Servicev Start Enterprise Single Sign-On Servicev Start Host Instance Servicev Start Microsoft BizTalk RFID Servicev Start Orchestrationv Start Rule Engine Update Servicev Start Send Portv Start Send Port Group

© Copyright IBM Corp. 2009, 2017 125

Page 132: Microsoft BizTalk Server agent Reference - IBM

v Stop BizTalk Base EDI Servicev Stop BizTalk SharePoint Messaging Adapter Servicev Stop Enterprise Single Sign-On Servicev Stop Host Instance Servicev Stop Microsoft BizTalk RFID Servicev Stop Orchestrationv Stop Rule Engine Update Servicev Stop Send Port Groupv Unenlist Orchestrationv Unenlist Send Portv Unenlist Send Port Group

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.

Disable Receive Location actionDisables 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:DISABLE_RECEIVE_LOCATION \

[KQB_RECEIVE_LOCATION_STATUS.Name]

You can use attribute substitution to supply the Take Action command arguments from thesituation, for example:DISABLE_RECEIVE_LOCATION \

[&{KQB_RECEIVE_LOCATION_STATUS.Name}]

You can also use attribute substitution in a workflow policy though the format is slightlydifferent:DISABLE_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

Return codes

126 Microsoft BizTalk Server agent Reference

Page 133: Microsoft BizTalk Server agent Reference - IBM

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: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4100I– Message: The Receive Location is disabled.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4101E– Message: An error occurred while disabling the Receive Location. Check the BizTalk Server

Administration Console.v Return Code: 1

– Return Code Type: NOT_APPLICABLE– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4102E– Message: The Receive Location name is not provided.

v Return Code: 6– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4103E– Message: The Receive Location is already disabled.

v Return Code: 9– Return Code Type: DOESNT_EXIST– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4104E– Message: The Receive Location does not exist.

v Return Code: 12– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4105E– Message: The Receive Location did not disable because of a logon failure.

Usage None.

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}]

Chapter 4. Take Action commands 127

Page 134: Microsoft BizTalk Server agent Reference - IBM

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

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.

Enlist Orchestration actionEnlists the orchestration that is selected by the user. If Take Action timeout error occurs, increase thetimeout interval by setting the CDP_DP_ACTION_TIMEOUT environment variable. The default intervalis 20 seconds.System command

To include the Take Action command in a situation or workflow policy, use the following syntaxfor the system command:ENLIST_ORCHESTRATION \

[KQB_ORCHESTRATION_STATUS.Orchestration_Name]

You can use attribute substitution to supply the Take Action command arguments from thesituation, for example:

128 Microsoft BizTalk Server agent Reference

Page 135: Microsoft BizTalk Server agent Reference - IBM

ENLIST_ORCHESTRATION \

[&{KQB_ORCHESTRATION_STATUS.Orchestration_Name}]

You can also use attribute substitution in a workflow policy though the format is slightlydifferent:ENLIST_ORCHESTRATION \

[&WaitOnSituation:KQB_ORCHESTRATION_STATUS.Orchestration_Name]Authorization

User must be a member of Administrators group.Command arguments

v Name: KQB_ORCHESTRATION_STATUS.Orchestration_Name– Description: Orchestration– Default: KQB_ORCHESTRATION_STATUS.Orchestration_Name

Return codesv 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: 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: 9– Return Code Type: DOESNT_EXIST– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4062E– Message: The orchestration does not exist.

v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4085I– Message: The orchestration is enlisted.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4086E– Message: An error occurred while enlisting the orchestration. Check the BizTalk Server

Administration Console.v Return Code: 6

– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4087E– Message: The orchestration is already enlisted.

v Return Code: 7– Return Code Type: PREREQ_NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4088E– Message: Could not enlist the orchestration because the state of the orchestration is

unbound.v Return Code: 12

– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4089E

Chapter 4. Take Action commands 129

Page 136: Microsoft BizTalk Server agent Reference - IBM

– Message: The orchestration did not enlist because of a logon failure.Usage None.

Enlist Send Port actionEnlists the send port that is selected by the user. If Take Action timeout error occurs, increase the timeoutinterval by setting the CDP_DP_ACTION_TIMEOUT environment variable. 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:ENLIST_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:ENLIST_SEND_PORT \

[&{KQB_SEND_PORT_STATUS.Send_Port_Name}]

You can also use attribute substitution in a workflow policy though the format is slightlydifferent:ENLIST_SEND_PORT \

[&WaitOnSituation:KQB_SEND_PORT_STATUS.Send_Port_Name]Authorization

User must be a member of Administrators group.Command arguments

v Name: KQB_SEND_PORT_STATUS.Send_Port_Name– Description: Send port– Default: KQB_SEND_PORT_STATUS.Send_Port_Name

Return codesv 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: 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: 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: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4077I– Message: The send port is enlisted.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4078E

130 Microsoft BizTalk Server agent Reference

Page 137: Microsoft BizTalk Server agent Reference - IBM

– Message: An error occurred while enlisting the send port. Check the BizTalk ServerAdministration Console.

v Return Code: 6– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4079E– Message: The send port is already enlisted.

v Return Code: 12– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4080E– Message: The send port did not enlist because of a logon failure.

Usage None.

Enlist Send Port Group actionEnlists the send port group selected by the user. If Take Action timeout error occurs, increase the timeoutinterval by setting the CDP_DP_ACTION_TIMEOUT environment variable. 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:ENLIST_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:ENLIST_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:ENLIST_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

Return codesv 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: 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: 9– Return Code Type: DOESNT_EXIST– Operating systems: Windows, Windows (64-bit)

Chapter 4. Take Action commands 131

Page 138: Microsoft BizTalk Server agent Reference - IBM

– Message ID: KQB4057E– Message: The Send Port Group does not exist.

v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4069I– Message: The send port group is enlisted.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4070E– Message: An error occurred while enlisting the send port group. Check the BizTalk Server

Administration Console.v Return Code: 6

– Return Code Type: NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4071E– Message: The send port group is already enlisted.

v Return Code: 12– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4072E– Message: The send port group did not enlist because of a logon failure.

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.Authorization

User must be a member of Administrators group.Return codes

v Return Code: 0– 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

132 Microsoft BizTalk Server agent Reference

Page 139: Microsoft BizTalk Server agent Reference - IBM

– 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).Authorization

User must be a member of Administrators group.Return codes

v Return Code: 0– 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.

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

Chapter 4. Take Action commands 133

Page 140: Microsoft BizTalk Server agent Reference - IBM

– 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 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.Return 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.

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)

134 Microsoft BizTalk Server agent Reference

Page 141: Microsoft BizTalk Server agent Reference - IBM

– 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 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

User must be a member of Administrators group.Command arguments

v Name: KQB_AVAILABILITY.Name– Description: Host Instance– Default: &KQB_AVAILABILITY.Name

Return codesv Return Code: 0

– 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)

Chapter 4. Take Action commands 135

Page 142: Microsoft BizTalk Server agent Reference - IBM

– 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.

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 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.Return codes

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.

136 Microsoft BizTalk Server agent Reference

Page 143: Microsoft BizTalk Server agent Reference - IBM

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.

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 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:

Chapter 4. Take Action commands 137

Page 144: Microsoft BizTalk Server agent Reference - IBM

START_ORCHESTRATION \

[&WaitOnSituation:KQB_ORCHESTRATION_STATUS.Orchestration_Name]Authorization

User must be a member of Administrators group.Command arguments

v Name: KQB_ORCHESTRATION_STATUS.Orchestration_Name– Description: Orchestration– Default: KQB_ORCHESTRATION_STATUS.Orchestration_Name

Return codesv 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: 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.

138 Microsoft BizTalk Server agent Reference

Page 145: Microsoft BizTalk Server agent Reference - IBM

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

User must be a member of Administrators group.Return codes

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.

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.

Chapter 4. Take Action commands 139

Page 146: Microsoft BizTalk Server agent Reference - IBM

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

User must be a member of Administrators group.Command arguments

v Name: KQB_SEND_PORT_STATUS.Send_Port_Name– Description: Send port– Default: KQB_SEND_PORT_STATUS.Send_Port_Name

Return codesv 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: 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

140 Microsoft BizTalk Server agent Reference

Page 147: Microsoft BizTalk Server agent Reference - IBM

– 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

Return codesv 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: 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

Chapter 4. Take Action commands 141

Page 148: Microsoft BizTalk Server agent Reference - IBM

– 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

User must be a member of Administrators group.Return codes

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!!!!!

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

142 Microsoft BizTalk Server agent Reference

Page 149: Microsoft BizTalk Server agent Reference - IBM

– 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

User must be a member of Administrators group.Return codes

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!!!!!

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: 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.

Chapter 4. Take Action commands 143

Page 150: Microsoft BizTalk Server agent Reference - IBM

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 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

User must be a member of Administrators group.Return codes

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!!!!!

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: 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.

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 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.

144 Microsoft BizTalk Server agent Reference

Page 151: Microsoft BizTalk Server agent Reference - IBM

System commandTo 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

User must be a member of Administrators group.Command arguments

v Name: KQB_AVAILABILITY.Name– Description: Host Instance– Default: &KQB_AVAILABILITY.Name

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: 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

Chapter 4. Take Action commands 145

Page 152: Microsoft BizTalk Server agent Reference - IBM

– 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.Return codes

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!!!!!

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: 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.

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 Orchestration actionStops the orchestration that is selected by the user. If Take Action timeout error occurs, increase thetimeout interval by setting the CDP_DP_ACTION_TIMEOUT environment variable. The default intervalis 20 seconds.System command

To include the Take Action command in a situation or workflow policy, use the following syntaxfor the system command:

146 Microsoft BizTalk Server agent Reference

Page 153: Microsoft BizTalk Server agent Reference - IBM

STOP_ORCHESTRATION \

[KQB_ORCHESTRATION_STATUS.Orchestration_Name]

You can use attribute substitution to supply the Take Action command arguments from thesituation, for example:STOP_ORCHESTRATION \

[&{KQB_ORCHESTRATION_STATUS.Orchestration_Name}]

You can also use attribute substitution in a workflow policy though the format is slightlydifferent:STOP_ORCHESTRATION \

[&WaitOnSituation:KQB_ORCHESTRATION_STATUS.Orchestration_Name]Authorization

User must be a member of Administrators group.Command arguments

v Name: KQB_ORCHESTRATION_STATUS.Orchestration_Name– Description: Orchestration– Default: KQB_ORCHESTRATION_STATUS.Orchestration_Name

Return codesv 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: 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: 9– Return Code Type: DOESNT_EXIST– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4062E– Message: The orchestration does not exist.

v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4095I– Message: The orchestration is stopped.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4096E– Message: An error occurred while stopping the orchestration. Check the BizTalk Server

Administration Console.v Return Code: 6

– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4097E– Message: The orchestration is already stopped.

v Return Code: 7– Return Code Type: PREREQ_NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4098E

Chapter 4. Take Action commands 147

Page 154: Microsoft BizTalk Server agent Reference - IBM

– Message: Could not stop the orchestration because the state of the orchestration is unbound.v Return Code: 12

– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4099E– Message: The orchestration did not stop because of a logon failure.

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.Return codes

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!!!!!

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: 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.

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 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.

148 Microsoft BizTalk Server agent Reference

Page 155: Microsoft BizTalk Server agent Reference - IBM

System commandTo 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

Return codesv 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: 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.

Chapter 4. Take Action commands 149

Page 156: Microsoft BizTalk Server agent Reference - IBM

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.

Unenlist Orchestration actionUnenlists the orchestration that is selected by the user. If Take Action timeout error occurs, increase thetimeout interval by setting the CDP_DP_ACTION_TIMEOUT environment variable. The default intervalis 20 seconds.System command

To include the Take Action command in a situation or workflow policy, use the following syntaxfor the system command:UNENLIST_ORCHESTRATION \

[KQB_ORCHESTRATION_STATUS.Orchestration_Name]

You can use attribute substitution to supply the Take Action command arguments from thesituation, for example:UNENLIST_ORCHESTRATION \

[&{KQB_ORCHESTRATION_STATUS.Orchestration_Name}]

You can also use attribute substitution in a workflow policy though the format is slightlydifferent:UNENLIST_ORCHESTRATION \

[&WaitOnSituation:KQB_ORCHESTRATION_STATUS.Orchestration_Name]Authorization

User must be a member of Administrators group.Command arguments

v Name: KQB_ORCHESTRATION_STATUS.Orchestration_Name– Description: Orchestration– Default: KQB_ORCHESTRATION_STATUS.Orchestration_Name

Return codesv 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: 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: 9– Return Code Type: DOESNT_EXIST– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4062E– Message: The orchestration does not exist.

150 Microsoft BizTalk Server agent Reference

Page 157: Microsoft BizTalk Server agent Reference - IBM

v Return Code: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4090I– Message: The orchestration is unenlisted.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4091E– Message: An error occurred while unenlisting the orchestration. Check the BizTalk Server

Administration Console.v Return Code: 6

– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4092E– Message: The orchestration is already unenlisted.

v Return Code: 7– Return Code Type: PREREQ_NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4093E– Message: Could not unenlist the orchestration because the state of the orchestration is

unbound.v Return Code: 12

– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4094E– Message: The orchestration did not unenlist because of a logon failure.

Usage None.

Unenlist Send Port actionUnenlists the send port that is selected by the user. If Take Action timeout error occurs, increase thetimeout interval by setting the CDP_DP_ACTION_TIMEOUT environment variable. The default intervalis 20 seconds.System command

To include the Take Action command in a situation or workflow policy, use the following syntaxfor the system command:UNENLIST_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:UNENLIST_SEND_PORT \

[&{KQB_SEND_PORT_STATUS.Send_Port_Name}]

You can also use attribute substitution in a workflow policy though the format is slightlydifferent:UNENLIST_SEND_PORT \

[&WaitOnSituation:KQB_SEND_PORT_STATUS.Send_Port_Name]Authorization

User must be a member of Administrators group.Command arguments

v Name: KQB_SEND_PORT_STATUS.Send_Port_Name– Description: Send port

Chapter 4. Take Action commands 151

Page 158: Microsoft BizTalk Server agent Reference - IBM

– Default: KQB_SEND_PORT_STATUS.Send_Port_NameReturn codes

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: 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: 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: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4081I– Message: The send port is unenlisted.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4082E– Message: An error occurred while unenlisting the send port. Check the BizTalk Server

Administration Console.v Return Code: 6

– Return Code Type: ALREADY_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4083E– Message: The send port is already unenlisted.

v Return Code: 12– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4084E– Message: The send port did not Unenlist because of a logon failure.

Usage None.

Unenlist Send Port Group actionUnenlists the send port group selected by the user. If Take Action timeout error occurs, increase thetimeout interval by setting the CDP_DP_ACTION_TIMEOUT environment variable. The default intervalis 20 seconds.System command

To include the Take Action command in a situation or workflow policy, use the following syntaxfor the system command:UNENLIST_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:UNENLIST_SEND_PORT_GROUP \

[&{KQB_SEND_PORT_GROUP_STATUS.Send_Port_Group_Name}]

152 Microsoft BizTalk Server agent Reference

Page 159: Microsoft BizTalk Server agent Reference - IBM

You can also use attribute substitution in a workflow policy though the format is slightlydifferent:UNENLIST_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

Return codesv 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: 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: 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: 0– Return Code Type: OK– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4073I– Message: The send port group is unenlisted.

v Return Code: 2– Return Code Type: GENERAL_ERROR– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4074E– Message: An error occurred while unenlisting the send port group. Check the BizTalk Server

Administration Console.v Return Code: 6

– Return Code Type: NOT_RUNNING– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4075E– Message: The send port group is already unenlisted.

v Return Code: 12– Return Code Type: INSUFFICIENT_USER_AUTHORITY– Operating systems: Windows, Windows (64-bit)– Message ID: KQB4076E– Message: The send port group did not Unenlist because of a logon failure.

Usage None.

Chapter 4. Take Action commands 153

Page 160: Microsoft BizTalk Server agent Reference - IBM

154 Microsoft BizTalk Server agent Reference

Page 161: Microsoft BizTalk Server agent Reference - IBM

Chapter 5. Policies

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.

© Copyright IBM Corp. 2009, 2017 155

Page 162: Microsoft BizTalk Server agent Reference - IBM

156 Microsoft BizTalk Server agent Reference

Page 163: Microsoft BizTalk Server agent Reference - IBM

Chapter 6. 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 06.3.1.13) file.The KQB_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 application_name: STRINGv application_status: STRINGv node: STRINGv server_name: STRINGv timestamp: 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 application_component: STRINGv command_line: STRINGv command_line_enum: STRINGv full_name: STRINGv full_name_enum: STRINGv functionality_test_message: STRINGv functionality_test_message_enum: STRINGv functionality_test_status: INTEGERv functionality_test_status_enum: STRINGv kqb_status: INTEGER

© Copyright IBM Corp. 2009, 2017 157

Page 164: Microsoft BizTalk Server agent Reference - IBM

v kqb_status_enum: STRINGv name: STRINGv name_enum: STRINGv node: STRINGv page_faults_per_sec: INTEGERv percent_privileged_time: INTEGERv percent_processor_time: INTEGERv percent_user_mode_time: INTEGERv pid: INTEGERv thread_count: INTEGERv timestamp: STRINGv type: INTEGERv type_enum: STRINGv virtual_size: INTEGERv working_set_size: INTEGER

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 database_name: STRINGv node: STRINGv server_name: STRINGv timestamp: 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 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 name: STRINGv node: STRINGv timestamp: 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: 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 group_name: STRINGv host_instance: STRINGv host_instance_status: INTEGER

158 Microsoft BizTalk Server agent Reference

Page 165: Microsoft BizTalk Server agent Reference - IBM

v host_instance_status_enum: STRINGv host_name: STRINGv node: STRINGv server_name: STRINGv timestamp: 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 group_name: STRINGv host_name: STRINGv node: STRINGv timestamp: 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 lob_time_cumulative: INTEGERv lob_time_cumulative_delta: INTEGERv lob_time_cumulative_delta_enum: STRINGv lob_time_cumulative_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 lob_time_cumulative: INTEGERv lob_time_cumulative_delta: INTEGERv lob_time_cumulative_delta_enum: STRINGv lob_time_cumulative_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 lob_time_cumulative: INTEGERv lob_time_cumulative_delta: INTEGERv lob_time_cumulative_delta_enum: STRINGv lob_time_cumulative_enum: STRINGv name: STRINGv node: STRINGv timestamp: STRING

Chapter 6. Event mapping 159

Page 166: Microsoft BizTalk Server agent Reference - IBM

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 lob_time_cumulative: INTEGERv lob_time_cumulative_delta: INTEGERv lob_time_cumulative_delta_enum: STRINGv lob_time_cumulative_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 lob_time_cumulative: INTEGERv lob_time_cumulative_delta: INTEGERv lob_time_cumulative_delta_enum: STRINGv lob_time_cumulative_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 group_name: STRINGv node: STRINGv server_name: STRINGv timestamp: 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 messages_written_to_transport: REALv messages_written_to_transport_enum: STRINGv messages_written_to_transport_rate: REALv messages_written_to_transport_rate_enum: STRINGv name: STRINGv node: STRINGv server_name: STRINGv timestamp: 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 delivery_requests_failed: INTEGERv delivery_requests_failed_enum: STRINGv delivery_requests_succeeded: INTEGERv delivery_requests_succeeded_enum: STRINGv format_requests_failed: INTEGERv format_requests_failed_enum: STRING

160 Microsoft BizTalk Server agent Reference

Page 167: Microsoft BizTalk Server agent Reference - IBM

v format_requests_succeeded: INTEGERv format_requests_succeeded_enum: STRINGv name: STRINGv node: STRINGv notification_bodies: INTEGERv notification_bodies_enum: STRINGv notification_headers: INTEGERv notification_headers_enum: STRINGv server_name: STRINGv timestamp: 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 event_category: STRINGv event_category_enum: STRINGv event_id: INTEGERv event_source: STRINGv event_type: INTEGERv event_type_enum: STRINGv log_name: STRINGv message: STRINGv node: 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 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 event_batches_aborted: REALv event_batches_aborted_enum: STRINGv event_batches_committed: REALv event_batches_committed_enum: STRINGv name: STRINGv node: STRINGv server_name: STRINGv timestamp: 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 event_batches_awaiting_generation: INTEGERv event_batches_awaiting_generation_enum: STRINGv event_batches_in_collection: INTEGERv event_batches_in_collection_enum: STRING

Chapter 6. Event mapping 161

Page 168: Microsoft BizTalk Server agent Reference - IBM

v event_batches_submitted: INTEGERv event_batches_submitted_enum: STRINGv name: STRINGv node: STRINGv server_name: STRINGv timestamp: STRINGv total_events: INTEGERv total_events_enum: 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 bytes_received_per_sec: REALv bytes_received_per_sec_64: REALv bytes_received_per_sec_64_enum: STRINGv bytes_received_per_sec_enum: STRINGv delete_retries: INTEGERv delete_retries_enum: STRINGv kilobytes_received: REALv kilobytes_received_64: REALv kilobytes_received_64_enum: STRINGv kilobytes_received_enum: STRINGv lock_failures: INTEGERv lock_failures_64: REALv lock_failures_64_enum: STRINGv lock_failures_enum: STRINGv lock_failures_per_sec: REALv lock_failures_per_sec_64: REALv lock_failures_per_sec_64_enum: STRINGv lock_failures_per_sec_enum: STRINGv messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv name: STRINGv node: STRINGv timestamp: STRINGv time_to_build_batch: INTEGERv time_to_build_batch_enum: 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 bytes_sent_per_sec: REALv bytes_sent_per_sec_64: REALv bytes_sent_per_sec_64_enum: STRINGv bytes_sent_per_sec_enum: STRINGv kilobytes_sent: REAL

162 Microsoft BizTalk Server agent Reference

Page 169: Microsoft BizTalk Server agent Reference - IBM

v kilobytes_sent_64: REALv kilobytes_sent_64_enum: STRINGv kilobytes_sent_enum: STRINGv messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 bytes_received_per_sec: REALv bytes_received_per_sec_64: REALv bytes_received_per_sec_64_enum: STRINGv bytes_received_per_sec_enum: STRINGv kilobytes_received: REALv kilobytes_received_64: REALv kilobytes_received_64_enum: STRINGv kilobytes_received_enum: STRINGv messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 bytes_sent_per_sec: REALv bytes_sent_per_sec_64: REALv bytes_sent_per_sec_64_enum: STRINGv bytes_sent_per_sec_enum: STRINGv kilobytes_sent: REALv kilobytes_sent_64: REALv kilobytes_sent_64_enum: STRINGv kilobytes_sent_enum: STRINGv messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv name: STRINGv node: STRINGv timestamp: STRING

Chapter 6. Event mapping 163

Page 170: Microsoft BizTalk Server agent Reference - IBM

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 name: STRINGv node: 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_firings: REALv rule_firings_enum: STRINGv rule_firing_failures: REALv rule_firing_failures_enum: STRINGv server_name: 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 timestamp: 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 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: INTEGERv high_message_publishing_rate_enum: STRINGv high_process_memory: INTEGER

164 Microsoft BizTalk Server agent Reference

Page 171: Microsoft BizTalk Server agent Reference - IBM

v 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_duration_in_min: REALv message_delivery_throttling_state_duration_in_min_enum: STRINGv message_delivery_throttling_state_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_duration_in_min: REALv message_publishing_throttling_state_duration_in_min_enum: STRINGv message_publishing_throttling_state_enum: STRINGv message_publishing_throttling_user_override: INTEGERv message_publishing_throttling_user_override_enum: STRINGv name: STRINGv node: 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 server_name: STRINGv thread_count: INTEGERv thread_count_enum: STRINGv thread_count_threshold: INTEGER

Chapter 6. Event mapping 165

Page 172: Microsoft BizTalk Server agent Reference - IBM

v thread_count_threshold_enum: STRINGv timestamp: STRINGv 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: 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 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: STRINGv node: STRINGv timestamp: 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: 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 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: STRINGv node: STRINGv timestamp: STRING

166 Microsoft BizTalk Server agent Reference

Page 173: Microsoft BizTalk Server agent Reference - IBM

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 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 node: STRINGv server_name: STRINGv steps_retrieved: INTEGERv steps_retrieved_enum: STRINGv tasks_retrieved: INTEGERv tasks_retrieved_enum: STRINGv timestamp: 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 database_name: STRINGv node: STRINGv server_name: STRINGv timestamp: 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 change_in_tracking_data_size: INTEGERv change_in_tracking_data_size_enum: 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 name: STRINGv node: STRINGv spool_size: INTEGERv spool_size_enum: STRINGv timestamp: STRINGv tracked_msgs_copy_purge_jobs: INTEGERv tracked_msgs_copy_purge_jobs_enum: STRING

Chapter 6. Event mapping 167

Page 174: Microsoft BizTalk Server agent Reference - IBM

v tracking_data_size: INTEGERv tracking_data_size_enum: STRINGv tracking_spool_cleanup_purge_jobs: INTEGERv tracking_spool_cleanup_purge_jobs_enum: 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 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: STRINGv node: STRINGv timestamp: 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 database_name: STRINGv disable_new_message_publication: STRINGv is_master_message_box: STRINGv node: STRINGv server_name: STRINGv timestamp: 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 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: INTEGERv documents_received_enum: STRINGv documents_received_per_sec: REAL

168 Microsoft BizTalk Server agent Reference

Page 175: Microsoft BizTalk Server agent Reference - IBM

v documents_received_per_sec_enum: STRINGv documents_resubmitted: INTEGERv documents_resubmitted_enum: STRINGv documents_submitted_per_batch: REALv documents_submitted_per_batch_64: REALv documents_submitted_per_batch_64_enum: STRINGv 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_64: REALv documents_transmitted_per_batch_64_enum: STRINGv documents_transmitted_per_batch_enum: STRINGv name: STRINGv node: 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 timestamp: 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 inbound_latency_in_ms: REALv inbound_latency_in_ms_enum: STRINGv name: STRINGv node: 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 timestamp: 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 bytes_received_per_sec: REALv bytes_received_per_sec_64: REAL

Chapter 6. Event mapping 169

Page 176: Microsoft BizTalk Server agent Reference - IBM

v bytes_received_per_sec_64_enum: STRINGv bytes_received_per_sec_enum: STRINGv kilobytes_received: REALv kilobytes_received_64: REALv kilobytes_received_64_enum: STRINGv kilobytes_received_enum: STRINGv messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 bytes_sent_per_sec: REALv bytes_sent_per_sec_64: REALv bytes_sent_per_sec_64_enum: STRINGv bytes_sent_per_sec_enum: STRINGv kilobytes_sent: REALv kilobytes_sent_64: REALv kilobytes_sent_64_enum: STRINGv kilobytes_sent_enum: STRINGv messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 batches: REALv batches_awaiting_distribution: REALv batches_awaiting_distribution_enum: STRINGv batches_enum: STRINGv batches_expired: REALv batches_expired_enum: STRINGv batches_failed_delivery: REALv batches_failed_delivery_enum: STRINGv batches_in_retry: REALv batches_in_retry_enum: STRINGv batches_successfully_delivered: REAL

170 Microsoft BizTalk Server agent Reference

Page 177: Microsoft BizTalk Server agent Reference - IBM

v batches_successfully_delivered_enum: STRINGv name: STRINGv node: 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: STRINGv timestamp: 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 host_name: STRINGv kqb_status: INTEGERv kqb_status_enum: STRINGv node: STRINGv orchestration_name: STRINGv server_name: STRINGv timestamp: 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 active_application_domains: INTEGERv active_application_domains_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 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_cycles: INTEGERv dehydration_cycles_enum: STRINGv dehydration_cycle_in_progress: INTEGERv dehydration_cycle_in_progress_enum: STRINGv dehydration_threshold: INTEGER

Chapter 6. Event mapping 171

Page 178: Microsoft BizTalk Server agent Reference - IBM

v dehydration_threshold_enum: STRINGv idle_orchestrations: INTEGERv idle_orchestrations_enum: STRINGv messagebox_databases_connection_failures: INTEGERv messagebox_databases_connection_failures_enum: STRINGv name: STRINGv node: 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 percent_used_physical_memory: INTEGERv percent_used_physical_memory_enum: STRINGv persistence_points: INTEGERv persistence_points_enum: STRING

172 Microsoft BizTalk Server agent Reference

Page 179: Microsoft BizTalk Server agent Reference - IBM

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 timestamp: 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: 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 average_collection_duration: REALv average_collection_duration_enum: STRINGv cache_hits: INTEGERv cache_hit_percent: REALv cache_misses: INTEGERv error_code: INTEGERv error_code_enum: STRINGv intervals_skipped: INTEGERv last_collection_duration: REALv last_collection_finished: STRINGv last_collection_finished_enum: STRINGv last_collection_start: STRINGv last_collection_start_enum: STRINGv node: STRINGv number_of_collections: INTEGERv object_name: STRINGv object_status: INTEGERv object_status_enum: STRINGv object_type: INTEGERv object_type_enum: STRINGv query_name: STRINGv refresh_interval: INTEGERv timestamp: STRING

Chapter 6. Event mapping 173

Page 180: Microsoft BizTalk Server agent Reference - IBM

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 active_sessions: INTEGERv active_sessions_enum: STRINGv bytes_received_per_sec: REALv bytes_received_per_sec_64: REALv bytes_received_per_sec_64_enum: STRINGv bytes_received_per_sec_enum: STRINGv kilobytes_received: INTEGERv kilobytes_received_64: REALv kilobytes_received_64_enum: STRINGv kilobytes_received_enum: STRINGv messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 is_primary: STRINGv kqb_status: INTEGERv kqb_status_enum: STRINGv node: STRINGv receive_handler: STRINGv receive_location_name: STRINGv receive_port_name: STRINGv server_name: STRINGv timestamp: STRINGv transport_address: STRINGv transport_type: STRING

For events that are generated by situations in the Receive Ports attribute group, events are sent by usingthe ITM_KQB_RECEIVE_PORTS event class. This event class contains the following slots:v is_two_way: STRINGv node: STRINGv primary_receive_location: STRINGv receive_port_name: STRINGv route_failed_messages: STRINGv server_name: STRINGv timestamp: STRING

174 Microsoft BizTalk Server agent Reference

Page 181: Microsoft BizTalk Server agent Reference - IBM

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 downtime: INTEGERv downtime_enum: STRINGv errors_raised: INTEGERv errors_raised_enum: STRINGv errors_raised_per_sec: INTEGERv errors_raised_per_sec_enum: STRINGv name: STRINGv node: STRINGv tags_read_per_sec: INTEGERv tags_read_per_sec_enum: STRINGv tags_written_per_sec: INTEGERv tags_written_per_sec_enum: STRINGv timestamp: STRINGv total_tags_read: INTEGERv total_tags_read_enum: STRINGv total_tags_written: INTEGERv total_tags_written_enum: 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 name: STRINGv node: 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 timestamp: 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 database_name: STRINGv node: STRINGv server_name: STRINGv timestamp: 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:

Chapter 6. Event mapping 175

Page 182: Microsoft BizTalk Server agent Reference - IBM

v kqb_status: INTEGERv kqb_status_enum: STRINGv node: STRINGv send_port_group_name: STRINGv server_name: STRINGv timestamp: 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 is_dynamic: STRINGv is_twoway: STRINGv kqb_status: INTEGERv kqb_status_enum: STRINGv node: STRINGv primary_transport_address: STRINGv send_port_name: STRINGv server_name: STRINGv timestamp: STRINGv transport_type: 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 error_description: STRINGv host_name: STRINGv instance_id: STRINGv node: STRINGv server_name: STRINGv service_class: INTEGERv service_class_enum: STRINGv service_name: STRINGv service_status: INTEGERv service_status_enum: STRINGv timestamp: STRING

For events that are generated by situations in the SFTP Receive Adapter attribute group, events are sentby using the ITM_KQB_SFTP_RECEIVE_ADAPTER event class. This event class contains the followingslots:v bytes_received_per_sec: REALv bytes_received_per_sec_enum: STRINGv kilobytes_received: REALv kilobytes_received_enum: STRINGv messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv name: STRING

176 Microsoft BizTalk Server agent Reference

Page 183: Microsoft BizTalk Server agent Reference - IBM

v node: STRINGv timestamp: STRING

For events that are generated by situations in the SFTP Send Adapter attribute group, events are sent byusing the ITM_KQB_SFTP_SEND_ADAPTER event class. This event class contains the following slots:v bytes_sent_per_sec: REALv bytes_sent_per_sec_enum: STRINGv kilobytes_sent: REALv kilobytes_sent_enum: STRINGv messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 database_name: STRINGv node: STRINGv server_name: STRINGv timestamp: 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 messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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:

Chapter 6. Event mapping 177

Page 184: Microsoft BizTalk Server agent Reference - IBM

v messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 messages_received: INTEGERv messages_received_enum: STRINGv messages_received_per_sec: REALv messages_received_per_sec_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 messages_sent: INTEGERv messages_sent_enum: STRINGv messages_sent_per_sec: REALv messages_sent_per_sec_enum: STRINGv name: STRINGv node: STRINGv timestamp: 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 name: STRINGv node: STRINGv server_name: STRINGv subscribers_added: REALv subscribers_added_enum: STRINGv subscribers_disabled: REALv subscribers_disabled_enum: STRINGv subscribers_enabled: REALv subscribers_enabled_enum: STRINGv timestamp: 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 name: STRINGv node: STRINGv server_name: STRINGv subscriptions_added: INTEGER

178 Microsoft BizTalk Server agent Reference

Page 185: Microsoft BizTalk Server agent Reference - IBM

v subscriptions_added_enum: STRINGv subscriptions_disabled: REALv subscriptions_disabled_enum: STRINGv subscriptions_enabled: REALv subscriptions_enabled_enum: STRINGv timestamp: 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 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 name: STRINGv node: STRINGv records_being_processed: INTEGERv records_being_processed_enum: STRINGv records_committed: REALv records_committed_enum: STRINGv timestamp: STRINGv total_batches: INTEGERv total_batches_64: REALv total_batches_64_enum: STRINGv total_batches_enum: STRINGv total_events: INTEGERv total_events_64: REALv total_events_64_enum: STRINGv total_events_enum: STRINGv total_failed_batches: INTEGERv total_failed_batches_64: REALv total_failed_batches_64_enum: STRINGv total_failed_batches_enum: STRINGv total_failed_events: INTEGERv total_failed_events_64: REALv total_failed_events_64_enum: STRINGv total_failed_events_enum: STRINGv total_records: INTEGERv total_records_64: REALv total_records_64_enum: STRINGv total_records_enum: STRING

Chapter 6. Event mapping 179

Page 186: Microsoft BizTalk Server agent Reference - IBM

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 database_name: STRINGv node: STRINGv server_name: STRINGv timestamp: 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 completed_periods: REALv completed_periods_enum: STRINGv name: STRINGv node: STRINGv quanta_remaining: REALv quanta_remaining_enum: STRINGv quanta_vacuumed: REALv quanta_vacuumed_enum: STRINGv server_name: STRINGv timeouts: REALv timeouts_enum: STRINGv timestamp: 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 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 timestamp: STRINGv total_received_messages: INTEGERv total_received_messages_enum: STRINGv total_receive_commit_failures: INTEGERv total_receive_commit_failures_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: REAL

180 Microsoft BizTalk Server agent Reference

Page 187: Microsoft BizTalk Server agent Reference - IBM

v 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 name: STRINGv node: 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 timestamp: STRINGv total_received_messages: INTEGERv total_received_messages_enum: STRINGv total_receive_commit_failures: INTEGERv total_receive_commit_failures_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: STRING

Chapter 6. Event mapping 181

Page 188: Microsoft BizTalk Server agent Reference - IBM

182 Microsoft BizTalk Server agent Reference

Page 189: Microsoft BizTalk Server agent Reference - IBM

Appendix. Documentation library

A variety of documentation is available for insert the short product name from the list.

IBM Knowledge Center contains topics of information for the product and links to relevant PDFs. In IBMKnowledge Center, you can create a custom PDF that contains only the topics in which you areinterested. See the directions for Creating your own set of topics (http://www.ibm.com/support/knowledgecenter/doc/kc_help.html#create).

Prerequisite documentationTo use the information about the components effectively, you must have some prerequisite knowledge.

The following information for Tivoli Monitoring is available in the IBM Knowledge Center(http://www.ibm.com/support/knowledgecenter) to gain prerequisite knowledge:v IBM Tivoli Monitoring Administrator's Guide

v IBM Tivoli Monitoring Installation and Setup Guide

v IBM Tivoli Monitoring High Availability Guide for Distributed Systems

v IBM Tivoli Monitoring: Installation and Configuration Guides for the following agents: OperatingSystem agents and Warehouse agents

v IBM Tivoli Monitoring: User's Guides for the following agents: Agentless OS monitors, Log File agent,System p agents, Systems Director base agent

v IBM Tivoli Monitoring Agent Builder User's Guide

v IBM Tivoli Monitoring Command Reference

v IBM Tivoli Monitoring: Messages

v IBM Tivoli Monitoring Troubleshooting Guide

v IBM Tivoli Monitoring: References for the following agents: Operating System agents and Warehouseagents

v IBM Tivoli Monitoring: Troubleshooting Guides for the following agents: Operating System agents andWarehouse agents

v Tivoli Enterprise Portal User's Guide

Related documentationThe documentation for related products provides useful information.

See the following products in IBM Knowledge Center (http://www.ibm.com/support/knowledgecenter/):v Tivoli Monitoringv Tivoli Application Dependency Discovery Managerv Tivoli Business Service Managerv Tivoli Common Reportingv Tivoli Enterprise Consolev Tivoli Netcool/OMNIbus

Terminology that is relevant to IBM products is consolidated in one convenient locations at the IBMTerminology website (http://www.ibm.com/software/globalization/terminology).

© Copyright IBM Corp. 2009, 2017 183

Page 190: Microsoft BizTalk Server agent Reference - IBM

Tivoli Monitoring Community on Service Management ConnectService Management Connect (SMC) is a repository of technical information that is organized bycommunities.

Access Service Management Connect at https://www.ibm.com/developerworks/servicemanagement.

For information about Tivoli products, see the Application Performance Management community(http://www.ibm.com/developerworks/servicemanagement/apm/index.html).

Connect, learn, and share with Service Management professionals. Get access to developers and productsupport technical experts who provide their perspectives and expertise. You can use SMC for thesepurposes:v Become involved with transparent development, an ongoing, open engagement between other users

and IBM developers of Tivoli products. You can access early designs, sprint demonstrations, productroadmaps, and prerelease code.

v Connect one-on-one with the experts to collaborate and network about Tivoli and the ApplicationPerformance Management community.

v Read blogs to benefit from the expertise and experience of others.v Use wikis and forums to collaborate with the broader user community.

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 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.

Conventions used in the documentationSeveral conventions are used in the documentation for special terms, actions, commands, and paths thatare dependent on your operating system.

Typeface conventions

The following typeface conventions are used in the documentation:

Bold

v Lowercase commands, mixed-case commands, parameters, and environment variables that areotherwise difficult to distinguish from the surrounding text

v Interface controls (check boxes, push buttons, radio buttons, spin buttons, fields, folders, icons,list boxes, items inside list boxes, multicolumn lists, containers, menu choices, menu names,tabs, property sheets), labels (such as Tip:)

v Keywords and parameters in text

Italic

184 Microsoft BizTalk Server agent Reference

Page 191: Microsoft BizTalk Server agent Reference - IBM

v Citations (examples: titles of publications, CDs, and DVDs)v Words and phrases defined in text (example: a nonswitched line is called a point-to-point line)v Emphasis of words and letters (example: The LUN address must start with the letter L.)v New terms in text , except in a definition list (example: a view is a frame in a workspace that

contains data.)v Variables and values you must provide (example: where myname represents...)

Monospace

v Examples and code examplesv File names, directory names, path names, programming keywords, properties, and other

elements that are difficult to distinguish from the surrounding textv Message text and promptsv Text that you must typev Values for arguments or command options

Bold monospace

v Command names, and names of macros and utilities that you can type as commandsv Environment variable names in textv Keywordsv Parameter names in text: API structure parameters, command parameters and arguments, and

configuration parametersv Process namesv Registry variable names in textv Script names

Operating system-dependent variables and paths

The direction of the slash for directory paths might vary in the documentation. Regardless of what yousee in the documentation, follow these guidelines:v For UNIX or Linux, use a forward slash (/).v For Windows, use a backslash (\).

The names of environment variables are not always the same in Windows and UNIX. For example,%TEMP% in Windows is equivalent to $TMPDIR in UNIX or Linux.

For environment variables, follow these guidelines:v For UNIX or Linux, use $variable.v For Windows, use %variable%.

If you are using the bash shell on a Windows system, you can use the UNIX conventions.

Appendix. Documentation library 185

Page 192: Microsoft BizTalk Server agent Reference - IBM

186 Microsoft BizTalk Server agent Reference

Page 193: Microsoft BizTalk Server agent Reference - IBM

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.

© Copyright IBM Corp. 2009, 2017 187

Page 194: Microsoft BizTalk Server agent Reference - IBM

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.

188 Microsoft BizTalk Server agent Reference

Page 195: Microsoft BizTalk Server agent Reference - IBM

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 atCopyright and trademark information (www.ibm.com/legal/copytrade.shtml).

Intel, Intel logo, and Intel Xeon, are trademarks or registered trademarks of Intel Corporation or itssubsidiaries in the United States and other countries.

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.

Other company, product, or service names may be trademarks or service marks of others.

Privacy policy considerationsIBM Software products, including software as a service solutions, (“Software Offerings”) may use cookiesor other technologies to collect product usage information, to help improve the end user experience, totailor interactions with the end user or for other purposes. In many cases no personally identifiableinformation is collected by the Software Offerings. Some of our Software Offerings can help enable you tocollect personally identifiable information. If this Software Offering uses cookies to collect personallyidentifiable information, specific information about this offering’s use of cookies is set forth below.

Depending upon the configurations deployed, this Software Offering may use session cookies that collecteach user’s user name for purposes of session management, authentication, and single sign-onconfiguration. These cookies cannot be disabled.

If the configurations deployed for this Software Offering provide you as customer the ability to collectpersonally identifiable information from end users via cookies and other technologies, you should seekyour own legal advice about any laws applicable to such data collection, including any requirements fornotice and consent.

Notices 189

Page 196: Microsoft BizTalk Server agent Reference - IBM

For more information about the use of various technologies, including cookies, for these purposes, SeeIBM’s Privacy Policy at http://www.ibm.com/privacy and IBM’s Online Privacy Statement athttp://www.ibm.com/privacy/details the section entitled “Cookies, Web Beacons and OtherTechnologies” and the “IBM Software Products and Software-as-a-Service Privacy Statement” athttp://www.ibm.com/software/info/product-privacy.

190 Microsoft BizTalk Server agent Reference

Page 197: Microsoft BizTalk Server agent Reference - IBM

Index

AActive Application Domains attribute 65Active Instance Count attribute 44Active Receive Locations attribute 57Active Receive Threads attribute 57Active Send Messages attribute 57Active Send Threads attribute 57Active Sessions attribute 73activities 155Activity Flows Retrieved attribute 52Adapters

situations 100workspaces

descriptions 4Adapters workspace 4additional information

attributes 17situations 97Take Action commands 125Workspaces 1

Allocated Private Memory In MB attribute 65Allocated Virtual Memory In MB attribute 65Application Component attribute 23Application Name attribute 23Application Performance Management community on

SMC 184Application Status attribute 23Application Status attribute group 23attribute group 23

attributes 23attribute groups

Application Status 23Availability 23BAM Database 26BAM Interceptor 26BizTalk Group Server Host 28BizTalk Host 28BizTalk NET Adapter for Oracle DB 29BizTalk NET Adapter for Oracle EBusiness Suite 29BizTalk NET Adapter for SAP 30BizTalk NET Adapter for Siebel 31BizTalk NET Adapter for SQL 31BizTalk Server 32Delivery Channels 32Distributors 33Event Log 34Event Providers 35Events 36File Receive Adapter 37File Send Adapter 39FTP Receive Adapter 40FTP Send Adapter 42Generator 43Host Throttling 44HTTP Receive Adapter 50HTTP Send Adapter 51Human Workflow Services 52list of all 18Management Database 53Message Box General Counters 53Message Box Host Counters 55

attribute groups (continued)Messagebox Database 56Messaging 57Messaging Latency 59MSMQ Receive Adapter 60MSMQ Send Adapter 62Notifications 63Orchestration Status 64Orchestrations 65overview 17Performance Object Status 70POP3 Receive Adapter 73Receive Location Status 74Receive Ports 75RFID Devices 76RFID Processes 77Rule Engine Database 78Send Port Group Status 79Send Port Status 79Service Instance Status and Class 80SFTP Receive Adapter 81SFTP Send Adapter 82Single Sign On Database 83SMTP Send Adapter 84SOAP Receive Adapter 84SOAP Send Adapter 85SQL Receive Adapter 86SQL Send Adapter 86Subscribers 87Subscriptions 88TDDS 88Tracking Database 91Vacuumer 91Windows SharePoint Services 92Windows SharePoint Services Adapter 94

attributes 23Active Application Domains 65Active Instance Count 44Active Receive Locations 57Active Receive Threads 57Active Send Messages 57Active Send Threads 57Active Sessions 73Activity Flows Retrieved 52additional information 17Allocated Private Memory In MB 65Allocated Virtual Memory In MB 65Application Component 23Application Name 23Application Status 23Availability 23Average Batch Factor 65Average Collection Duration 70Avg Extraction sec per BAM Event 26Avg Failed BAM Events per Flush 27Avg Flush sec per BAM Event 27Avg Successful BAM Events per Flush 27BAM Database 26BAM Interceptor 26Batches 63Batches Awaiting Distribution 63

© Copyright IBM Corp. 2009, 2017 191

Page 198: Microsoft BizTalk Server agent Reference - IBM

attributes (continued)Batches Being Processed 89Batches Committed 89Batches Expired 63Batches Failed Delivery 63Batches In Retry 63Batches Successfully Delivered 63BizTalk Group Server Host 28BizTalk Host 28BizTalk NET Adapter for Oracle DB 29BizTalk NET Adapter for Oracle EBusiness Suite 29BizTalk NET Adapter for SAP 30BizTalk NET Adapter for Siebel 31BizTalk NET Adapter for SQL 31BizTalk Server 32Bytes Received Per Sec 37, 40, 60, 73, 81Bytes Received Per Sec (Superseded) 37, 41, 60, 73Bytes Sent Per Sec 39, 42, 62, 82Bytes Sent Per Sec (Superseded) 39, 42, 62Cache Hit Percent 71Cache Hits 71Cache Misses 71Change in Tracking Data Size 54Command Line 24Completed Periods 91Database Name 26, 53, 56, 78, 83, 91Database Session 45Database Session Threshold 45Database Size 45Database Transactions 65Database Transactions Per Sec 66Dehydratable Orchestrations 66Dehydrating Orchestrations 66Dehydration Cycle In Progress 66Dehydration Cycles 66Dehydration Threshold 66Delete Retries 38Delivery Channels 32Delivery Requests Failed 33Delivery Requests Succeeded 33Disable New Message Publication 56Distributors 33Documents Processed 57Documents Processed Per Sec 57Documents Received 57Documents Received Per Sec 58Documents Resubmitted 58Documents Submitted Per Batch 58Documents Submitted Per Batch (Superseded) 58Documents Suspended 58Documents Suspended Per Sec 58Documents Transmitted Per Batch 58Documents Transmitted Per Batch (Superseded) 58Downtime 76Error Code 71Error Description 80Errors Raised 76Errors Raised Per Sec 77Event Batches Aborted 35Event Batches Awaiting Generation 36Event Batches Committed 35Event Batches In Collection 36Event Batches Submitted 37Event Category 34Event ID 34Event Log 34Event Providers 35

attributes (continued)Event Source 35Event Type 35Events 36Events Being Processed 89Events Committed 89Events Per Batch 36Events Received 36Events Received Per Second 36File Receive Adapter 37File Send Adapter 39Format Requests Failed 33Format Requests Succeeded 34FTP Receive Adapter 40FTP Send Adapter 42Full Name 24Functionality Test Message 24Functionality Test Status 24Generator 43Group Name 28, 32High Database Session 45High Database Size 45High In Process Message Count 45High Message Delivery Rate 45High Message Publishing Rate 45High Process Memory 46High System Memory 46High Thread Count 46Host Instance 28Host Instance Status 28Host Name 28, 29, 64, 80Host Queue Instance State Msg Refs Length 55Host Queue Length 55Host Queue Number of Instances 55Host Queue Suspended Msgs Length 56Host Throttling 44HTTP Receive Adapter 50HTTP Send Adapter 51Human Workflow Services 52Idle Orchestrations 66In Process Message Count 46In Process Message Count Threshold 46Inbound Latency In MS 59Instance ID 81Instances Total Number 54Intervals Skipped 72Is Dynamic 79Is Master Message Box 56Is Primary 74Is Two Way 76Is TwoWay 80Kilobytes Received 38, 41, 61, 73, 82Kilobytes Received (Superseded) 38, 41, 61, 74Kilobytes Sent 40, 42, 62, 83Kilobytes Sent (Superseded) 40, 42, 62Last Collection Duration 72Last Collection Finished 72Last Collection Start 72LOB Time 29, 30, 31LOB Time Delta 29, 30, 31Lock Failures 38Lock Failures (Superseded) 38Lock Failures Per Sec 38Lock Failures Per Sec (Superseded) 38Log Name 35Management Database 53Memory Queue Size 50, 51

192 Microsoft BizTalk Server agent Reference

Page 199: Microsoft BizTalk Server agent Reference - IBM

attributes (continued)Message 35Message Box General Counters 53Message Box Host Counters 55Message Delivery Delay In Sec 46Message Delivery Incoming Rate 47Message Delivery Outgoing Rate 47Message Delivery Throttling State 47Message Delivery Throttling State Duration In Min 47Message Delivery Throttling User Override 47Message Publishing Delay In Sec 47Message Publishing Incoming Rate 47Message Publishing Outgoing Rate 48Message Publishing Throttling State 48Message Publishing Throttling State Duration In Min 48Message Publishing Throttling User Override 48Messagebox Database 56MessageBox Databases Connection Failures 66Messages Received 38, 41, 50, 51, 61, 74, 82, 84, 86Messages Received Per Sec 39, 41, 50, 51, 61, 74, 82, 85, 86Messages Sent 40, 42, 50, 51, 62, 83, 84, 85, 86Messages Sent Per Sec 40, 42, 50, 52, 62, 83, 84, 85, 86Messages Written To Transport 32Messages Written To Transport Rate 33Messaging 57Messaging Latency 59MsgBox Dead Processes Cleanup Purge Jobs 54MsgBox Msg Cleanup Purge Jobs 54MsgBox Parts Cleanup Purge Jobs 54MsgBox Purge Subscriptions Job Purge Jobs 54MSMQ Receive Adapter 60MSMQ Send Adapter 62Name 24, 27, 29, 30, 31, 32, 33, 34, 36, 37, 39, 40, 41, 42,

43, 48, 50, 52, 54, 56, 59, 60, 61, 62, 64, 67, 74, 77, 82, 83,84, 85, 86, 87, 88, 89, 92, 94

New Action Added 52New Activity Flows 52Node 23, 24, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39,

40, 41, 43, 48, 50, 52, 53, 54, 56, 59, 60, 61, 63, 64, 67, 72,74, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 91,92, 94

Notification Bodies 34Notification Headers 34Notifications 63, 64Notifications Failed Delivery 64Notifications Generated Per Second 43Notifications Successfully Delivered 64Number of Collections 72Object Name 72Object Status 72Object Type 73Online MessageBox Databases 67Orchestration Name 64Orchestration Status 64Orchestrations 65Orchestrations Completed 67Orchestrations Completed Per Sec 67Orchestrations Created 67Orchestrations Created Per Sec 67Orchestrations Dehydrated 67Orchestrations Dehydrated Per Sec 67Orchestrations Discarded 68Orchestrations Discarded Per Sec 68Orchestrations Rehydrated 68Orchestrations Rehydrated Per Sec 68Orchestrations Resident In Memory 68Orchestrations Scheduled For Dehydration 68

attributes (continued)Orchestrations Suspended 68Orchestrations Suspended Per Sec 68Outbound Adapter Latency In MS 60Outbound Latency In MS 60overview 17Page Faults per Sec 24Pending Messages 69Pending Receive Batches 59Pending Transmitted Messages 59Pending Work Items 69Percent Privileged Time 25Percent Processor Time 25Percent Receive Message Failures 92, 94Percent Send Message Failures 93, 94Percent Used Physical Memory 69Percent User Mode Time 25Percent Web Service Call Failures 93, 94Performance Object Status 70Persistence Points 69Persistence Points Per Sec 69Physical Memory Usage In MB 48PID 25POP3 Receive Adapter 73Primary Receive Location 76Primary Transport Address 80Process Memory Usage In MB 49Process Memory Usage Threshold In MB 49Process Uptime 78Quanta Behind 43Quanta Failed 43Quanta Processed 43Quanta Remaining 92Quanta Vacuumed 92Query Name 73Receive Handler 75Receive Location Name 75Receive Location Status 74Receive Port Name 75, 76Receive Ports 75Records Being Processed 89Records Committed 89Refresh Interval 73Request Response Latency In MS 60Request Response Timeouts 59RFID Devices 76RFID Processes 77Route Failed Messages 76Rule Engine Database 78Rule Firing Failures 44Rule Firings 44Runnable Orchestrations 69Running Orchestrations 69Send Port Group Name 79Send Port Group Status 79Send Port Name 80Send Port Status 79Server Name 23, 26, 28, 32, 33, 34, 36, 37, 44, 49, 53, 56,

64, 65, 75, 76, 79, 80, 81, 83, 87, 88, 91, 92Service Class 81Service Instance Status and Class 80Service Name 81Service Status 81SFTP Receive Adapter 81SFTP Send Adapter 82Single Sign On Database 83Skipped Chronicle Rule Firings 44

Index 193

Page 200: Microsoft BizTalk Server agent Reference - IBM

attributes (continued)Skipped Quanta 44Skipped Subscription Rule Firings 44SMTP Send Adapter 84SOAP Receive Adapter 84SOAP Send Adapter 85Spool Size 54SQL Receive Adapter 86SQL Send Adapter 86Status 25, 65, 75, 79, 80Steps Retrieved 53Subscribers 87Subscribers Added 87Subscribers Disabled 87Subscribers Enabled 87Subscriptions 88Subscriptions Added 88Subscriptions Disabled 88Subscriptions Enabled 88Tags Being Processed 78Tags In Queue 78Tags Processed 78Tags Read Per Sec 77Tags Suspended 78Tags Written Per Sec 77Tasks Retrieved 53TDDS 88Thread Count 25, 49Thread Count Threshold 49Throttled Receive Batches 59Time Generated 35Time To Add Message To Batch 51Time To Build Batch 39, 51Timeouts 92Timestamp 23, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 36, 37,

39, 40, 41, 43, 44, 49, 51, 52, 53, 55, 56, 57, 59, 60, 61, 63,64, 65, 69, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85,86, 87, 88, 89, 91, 92, 93, 94

Total Batches 90Total Batches (Superseded) 90Total Batches Committed 49Total Events 37, 90Total Events (Superseded) 90Total Failed BAM Events During Flush 27Total Failed Batches 90Total Failed Batches (Superseded) 90Total Failed Events 90Total Failed Events (Superseded) 90Total Messages Delivered 49Total Messages Published 49Total Receive Commit Failures 93, 95Total Receive Message Failures 93, 95Total Received Messages 93, 95Total Records 91Total Records (Superseded) 91Total Send Message Failures 93, 95Total Sent Messages 93, 95Total Successful BAM Events During Flush 27Total Tags Read 77Total Tags Written 77Total Web Service Call Failures 94, 95Tracked Msgs Copy Purge Jobs 55Tracking Data Size 55Tracking Database 91Tracking Spool Cleanup Purge Jobs 55Transactional Scopes Aborted 69Transactional Scopes Aborted Per Sec 70

attributes (continued)Transactional Scopes Committed 70Transactional Scopes Committed Per Sec 70Transactional Scopes Compensated 70Transactional Scopes Compensated Per Sec 70Transport Address 75Transport Type 75, 80Type 25Vacuumer 91Virtual Size 26Web Service Calls Per Sec 94, 95Windows SharePoint Services 92Windows SharePoint Services Adapter 94Working Set Size 26

Availabilitysituations 100workspaces

descriptions 7Availability attribute group 23Availability workspace 7Average Batch Factor attribute 65Average Collection Duration attribute 70Avg Extraction sec per BAM Event attribute 26Avg Failed BAM Events per Flush attribute 27Avg Flush sec per BAM Event attribute 27Avg Successful BAM Events per Flush attribute 27

BBAM Database attribute group 26BAM Interceptor attribute group 26BAM Interceptor workspace 8Batches attribute 63Batches Awaiting Distribution attribute 63Batches Being Processed attribute 89Batches Committed attribute 89Batches Expired attribute 63Batches Failed Delivery attribute 63Batches In Retry attribute 63Batches Successfully Delivered attribute 63BizTalk Group Server Host attribute group 28BizTalk Group Topology workspace 10BizTalk Host attribute group 28BizTalk NET Adapter for Oracle DB attribute group 29BizTalk NET Adapter for Oracle EBusiness Suite attribute

group 29BizTalk NET Adapter for SAP attribute group 30BizTalk NET Adapter for Siebel attribute group 31BizTalk NET Adapter for SQL attribute group 31BizTalk Server attribute group 32Business Activity Monitoring

situations 103workspaces

descriptions 8Business Activity Monitoring workspace 8Bytes Received Per Sec (Superseded) attribute 37, 41, 60, 73Bytes Received Per Sec attribute 37, 40, 60, 73, 81Bytes Sent Per Sec (Superseded) attribute 39, 42, 62Bytes Sent Per Sec attribute 39, 42, 62, 82

CCache Hit Percent attribute 71Cache Hits attribute 71Cache Misses attribute 71calculate historical data disk space 96

194 Microsoft BizTalk Server agent Reference

Page 201: Microsoft BizTalk Server agent Reference - IBM

capacity planning for historical data 96Change in Tracking Data Size attribute 54Command Line attribute 24commands

Take Action 125Completed Periods attribute 91Configuration and Status

situations 103workspaces

descriptions 10Configuration and Status workspace 10conventions in documentation 184cookies 189create PDF 183Current Status workspace 10

DDatabase Name attribute 26, 53, 56, 78, 83, 91Database Session attribute 45Database Session Threshold attribute 45Database Size attribute 45Database Transactions attribute 65Database Transactions Per Sec attribute 66Databases

situations 105workspaces

descriptions 11Databases workspace 11Dehydratable Orchestrations attribute 66Dehydrating Orchestrations attribute 66Dehydration Cycle In Progress attribute 66Dehydration Cycles attribute 66Dehydration Details workspace 14Dehydration Status workspace 14Dehydration Threshold attribute 66Delete Retries attribute 38Delivery Channels and Event Providers workspace 8Delivery Channels attribute group 32Delivery Requests Failed attribute 33Delivery Requests Succeeded attribute 33descriptions 99Disable New Message Publication attribute 56Disable Receive Location action 126disk capacity planning for historical data 96Distributors and Subscriptions workspace 9Distributors attribute group 33Document Transactions workspace 13documentation 183

IBM Tivoli Monitoring 183Integrated Service Management Library 184prerequisite 183Redbooks 184related 183Technotes 184

Documents Processed attribute 57Documents Processed Per Sec attribute 57Documents Received attribute 57Documents Received Per Sec attribute 58Documents Resubmitted attribute 58Documents Submitted Per Batch (Superseded) attribute 58Documents Submitted Per Batch attribute 58Documents Suspended attribute 58Documents Suspended Per Sec attribute 58Documents Transmitted Per Batch (Superseded) attribute 58Documents Transmitted Per Batch attribute 58Downtime attribute 76

EEnable Receive Location action 127Enlist Orchestration action 128Enlist Send Port action 130Enlist Send Port Group action 131Error Code attribute 71Error Description attribute 80Errors Raised attribute 76Errors Raised Per Sec attribute 77event

mapping 157Event Batches Aborted attribute 35Event Batches Awaiting Generation attribute 36Event Batches Committed attribute 35Event Batches In Collection attribute 36Event Batches Submitted attribute 37Event Category attribute 34Event ID attribute 34Event Log

situations 105workspaces

descriptions 11Event Log attribute group 34Event Log workspace 11Event Providers attribute group 35Event Source attribute 35Event Type attribute 35eventing thresholds, using attributes 17Events attribute group 36Events Being Processed attribute 89Events Committed attribute 89Events Per Batch attribute 36Events Received attribute 36Events Received Per Second attribute 36Events workspace 9

FFile Receive Adapter - Data Received workspace 4File Receive Adapter attribute group 37File Send Adapter attribute group 39File Send Adapter workspace 4Format Requests Failed attribute 33Format Requests Succeeded attribute 34FTP Receive Adapter attribute group 40FTP Receive Adapter workspace 4FTP Send Adapter attribute group 42FTP Send Adapter workspace 4Full Name attribute 24Functionality Test Message attribute 24Functionality Test Status attribute 24

GGenerator attribute group 43Generator workspace 9Group Name attribute 28, 32

HHigh Database Session attribute 45High Database Size attribute 45High In Process Message Count attribute 45High Message Delivery Rate attribute 45High Message Publishing Rate attribute 45

Index 195

Page 202: Microsoft BizTalk Server agent Reference - IBM

High Process Memory attribute 46High System Memory attribute 46High Thread Count attribute 46historical data

calculate disk space 96disk capacity planning 96

Host Instance attribute 28Host Instance Status attribute 28Host Name attribute 28, 29, 64, 80Host Queue Instance State Msg Refs Length attribute 55Host Queue Length attribute 55Host Queue Number of Instances attribute 55Host Queue Suspended Msgs Length attribute 56Host Throttling

situations 121workspaces

descriptions 11Host Throttling attribute group 44Host Throttling Thresholds workspace 11Host Throttling workspace 11HTTP Receive Adapter attribute group 50HTTP Receive Adapter workspace 4HTTP Send Adapter attribute group 51HTTP Send Adapter workspace 5Human Workflow Services

situations 124workspaces

descriptions 12Human Workflow Services attribute group 52Human Workflow Services workspace 12

IIdle Orchestrations attribute 66In Process Message Count attribute 46In Process Message Count Threshold attribute 46Inbound Latency In MS attribute 59Instance ID attribute 81Instances Total Number attribute 54Integrated Service Management Library documentation 184Intervals Skipped attribute 72Is Dynamic attribute 79Is Master Message Box attribute 56Is Primary attribute 74Is Two Way attribute 76Is TwoWay attribute 80

KKilobytes Received (Superseded) attribute 38, 41, 61, 74Kilobytes Received attribute 38, 41, 61, 73, 82Kilobytes Sent (Superseded) attribute 40, 42, 62Kilobytes Sent attribute 40, 42, 62, 83KQB_Adapter_SuspendsInboundMsg situation 105KQB_Adptr_Suspends_OutboundMsg situation 106KQB_BAM_Config_Changed_Info situation 106KQB_Biz_Base_EDI_Service_Down situation 100KQB_Biz_HostInstance_Srv_Down situation 101KQB_Biz_SP_Msg_Adapter_Down situation 101KQB_Biz_SSO_Service_Down situation 102KQB_BizRuleEngine_Service_Down situation 100KQB_BizTalk_DBConnection_Fail situation 107KQB_FileAdptr_FolderAccessFail situation 107KQB_FILESendAdptr_OpenFileFail situation 108KQB_Host_Inst_Crashed situation 108KQB_HostInstance_ConfigDB_Fail situation 108

KQB_HT_High_Database_Session situation 121KQB_HT_High_Database_Size situation 121KQB_HT_High_InProcMessageCount situation 122KQB_HT_High_MsgDelivery_Rate situation 122KQB_HT_High_MsgPublishing_Rate situation 122KQB_HT_High_Process_Memory situation 123KQB_HT_High_System_Memory situation 123KQB_HT_High_Thread_Count situation 124KQB_HTTPSendAdaptr_ConnectFail situation 109KQB_Inbound_Msg_Proc_Failure situation 109KQB_Invalid_FileRecieveLoc situation 110KQB_Invalid_Receive_Loc_Config situation 110KQB_Msg_Resp_WithoutReq situation 113KQB_MsgEngine_FailToAddRecvLoc situation 111KQB_MsgEngine_FailToInit situation 112KQB_MsgEngine_FailToRegAdptr situation 112KQB_MsgEngine_SSOSrverConnFail situation 113KQB_MsgEngineFailToGetConfigDB situation 111KQB_MSMQTSubserviceFail situation 113KQB_No_Host_Instance situation 102KQB_Orchestrn_Stopped_Warning situation 103KQB_POP3_Authentication_Fail situation 114KQB_POP3_ServerConnection_Fail situation 114KQB_Rec_Loc_Stoped_Warning situation 104KQB_ReceiveLoc_ShutDown situation 115KQB_RecvFileAttr situation 115KQB_RecvLoc_Disabled situation 116KQB_RFID_Dev_StateSave_Fail situation 117KQB_RFID_Device_Conn_Fail situation 116KQB_RFID_Device_Disabled situation 117KQB_RFID_DeviceName_Conflict situation 116KQB_RFID_InsufPrivil_On_Dev situation 118KQB_RFID_ProcessEng_MaxRestart situation 118KQB_RFID_ProcessEngine_Fatal situation 118KQB_RFID_Service_Auth_Fail situation 119KQB_RFID_Service_Down situation 103KQB_RFID_Service_StartUpFail situation 119KQB_Send_Port_Group_Stopped situation 104KQB_Send_Port_Stopped_Warning situation 104KQB_SendPipeline_ExecutionFail situation 120KQB_Srvc_Inst_Suspend_Warning situation 105KQB_Stored_ProcCall_Failure situation 120

LLast Collection Duration attribute 72Last Collection Finished attribute 72Last Collection Start attribute 72LOB Time attribute 29, 30, 31LOB Time Delta attribute 29, 30, 31Lock Failures (Superseded) attribute 38Lock Failures attribute 38Lock Failures Per Sec (Superseded) attribute 38Lock Failures Per Sec attribute 38Log Name attribute 35

MManagement Database attribute group 53Memory Queue Size attribute 50, 51Message attribute 35Message Box General Counters attribute group 53Message Box Host Counters attribute group 55Message Delivery Delay In Sec attribute 46Message Delivery Incoming Rate attribute 47Message Delivery Outgoing Rate attribute 47

196 Microsoft BizTalk Server agent Reference

Page 203: Microsoft BizTalk Server agent Reference - IBM

Message Delivery Throttling State attribute 47Message Delivery Throttling State Duration In Min

attribute 47Message Delivery Throttling User Override attribute 47Message Publishing Delay In Sec attribute 47Message Publishing Incoming Rate attribute 47Message Publishing Outgoing Rate attribute 48Message Publishing Throttling State attribute 48Message Publishing Throttling State Duration In Min

attribute 48Message Publishing Throttling User Override attribute 48MessageBox

situations 124workspaces

descriptions 13MessageBox - Host Queue Messages workspace 13MessageBox - Host Queue Overview workspace 13MessageBox - Purge Jobs workspace 13Messagebox Database attribute group 56MessageBox Databases Connection Failures attribute 66MessageBox workspace 13Messages Overview workspace 12Messages Received attribute 38, 41, 50, 51, 61, 74, 82, 84, 86Messages Received Per Sec attribute 39, 41, 50, 51, 61, 74, 82,

85, 86Messages Sent attribute 40, 42, 50, 51, 62, 83, 84, 85, 86Messages Sent Per Sec attribute 40, 42, 50, 52, 62, 83, 84, 85,

86Messages Written To Transport attribute 32Messages Written To Transport Rate attribute 33Messaging

situations 124workspaces

descriptions 13Messaging attribute group 57Messaging Details workspace 14Messaging Latency attribute group 59Messaging Latency workspace 14Messaging workspace 13Microsoft BizTalk Server

situations 100workspaces

descriptions 3Microsoft BizTalk Server workspace 3MsgBox Dead Processes Cleanup Purge Jobs attribute 54MsgBox Msg Cleanup Purge Jobs attribute 54MsgBox Parts Cleanup Purge Jobs attribute 54MsgBox Purge Subscriptions Job Purge Jobs attribute 54MSMQ Receive Adapter attribute group 60MSMQ Receive Adapter workspace 5MSMQ Send Adapter attribute group 62MSMQ Send Adapter workspace 5

NName attribute 24, 27, 29, 30, 31, 32, 33, 34, 36, 37, 39, 40, 41,

42, 43, 48, 50, 52, 54, 56, 59, 60, 61, 62, 64, 67, 74, 77, 82, 83,84, 85, 86, 87, 88, 89, 92, 94

New Action Added attribute 52New Activity Flows attribute 52Node attribute 23, 24, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36,

37, 39, 40, 41, 43, 48, 50, 52, 53, 54, 56, 59, 60, 61, 63, 64, 67,72, 74, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 91,92, 94

Notification Bodies attribute 34Notification Headers attribute 34Notifications attribute 64

Notifications attribute group 63Notifications Failed Delivery attribute 64Notifications Generated Per Second attribute 43Notifications Successfully Delivered attribute 64Notifications workspace 9Number of Collections attribute 72

OObject Name attribute 72Object Status attribute 72Object Type attribute 73Online MessageBox Databases attribute 67Orchestration Details workspace 15Orchestration Messaging workspace 15Orchestration Name attribute 64Orchestration Processing workspace 15Orchestration Status attribute group 64Orchestrations

situations 124workspaces

descriptions 14Orchestrations attribute group 65Orchestrations Completed attribute 67Orchestrations Completed Per Sec attribute 67Orchestrations Created attribute 67Orchestrations Created Per Sec attribute 67Orchestrations Dehydrated attribute 67Orchestrations Dehydrated Per Sec attribute 67Orchestrations Discarded attribute 68Orchestrations Discarded Per Sec attribute 68Orchestrations Rehydrated attribute 68Orchestrations Rehydrated Per Sec attribute 68Orchestrations Resident In Memory attribute 68Orchestrations Scheduled For Dehydration attribute 68Orchestrations Suspended attribute 68Orchestrations Suspended Per Sec attribute 68Orchestrations workspace 15Outbound Adapter Latency In MS attribute 60Outbound Latency In MS attribute 60

PPage Faults per Sec attribute 24path conventions 184Pending Messages attribute 69Pending Receive Batches attribute 59Pending Transmitted Messages attribute 59Pending Work Items attribute 69Percent Privileged Time attribute 25Percent Processor Time attribute 25Percent Receive Message Failures attribute 92, 94Percent Send Message Failures attribute 93, 94Percent Used Physical Memory attribute 69Percent User Mode Time attribute 25Percent Web Service Call Failures attribute 93, 94Performance Object Status attribute group 70Performance Object Status workspace 8Persistence Points attribute 69Persistence Points Per Sec attribute 69Physical Memory Usage In MB attribute 48PID attribute 25policies 155POP3 Receive Adapter attribute group 73POP3 Receive Adapter workspace 5prerequisite documentation 183

Index 197

Page 204: Microsoft BizTalk Server agent Reference - IBM

Primary Receive Location attribute 76Primary Transport Address attribute 80privacy policy 189Process Memory Usage In MB attribute 49Process Memory Usage Threshold In MB attribute 49Process Uptime attribute 78publications

See also documentationService Management Connect 184SMC

See Service Management Connect

QQuanta Behind attribute 43Quanta Failed attribute 43Quanta Processed attribute 43Quanta Remaining attribute 92Quanta Vacuumed attribute 92queries, using attributes 17Query Name attribute 73

RReceive Handler attribute 75Receive Location Name attribute 75Receive Location Status attribute group 74Receive Port Name attribute 75, 76Receive Ports attribute group 75Records Being Processed attribute 89Records Committed attribute 89Redbooks 184Refresh Interval attribute 73Request Response Latency In MS attribute 60Request Response Timeouts attribute 59RFID

situations 124workspaces

descriptions 16RFID Devices attribute group 76RFID Processes attribute group 77RFID workspace 16Route Failed Messages attribute 76Rule Engine Database attribute group 78Rule Firing Failures attribute 44Rule Firings attribute 44Runnable Orchestrations attribute 69Running Orchestrations attribute 69

SSend Port Group Name attribute 79Send Port Group Status attribute group 79Send Port Name attribute 80Send Port Status attribute group 79Server Name attribute 23, 26, 28, 32, 33, 34, 36, 37, 44, 49, 53,

56, 64, 65, 75, 76, 79, 80, 81, 83, 87, 88, 91, 92Service Class attribute 81Service Instance Status and Class attribute group 80Service Instance workspace 10Service Management Connect 184Service Name attribute 81Service Status attribute 81SFTP Receive Adapter attribute group 81SFTP Receive Adapter workspace 6SFTP Send Adapter attribute group 82

SFTP Send Adapter workspace 6Single Sign On Database attribute group 83situations 99

additional informationpredefined, defined 97

KQB_Adapter_SuspendsInboundMsg 105KQB_Adptr_Suspends_OutboundMsg 106KQB_BAM_Config_Changed_Info 106KQB_Biz_Base_EDI_Service_Down 100KQB_Biz_HostInstance_Srv_Down 101KQB_Biz_SP_Msg_Adapter_Down 101KQB_Biz_SSO_Service_Down 102KQB_BizRuleEngine_Service_Down 100KQB_BizTalk_DBConnection_Fail 107KQB_FileAdptr_FolderAccessFail 107KQB_FILESendAdptr_OpenFileFail 108KQB_Host_Inst_Crashed 108KQB_HostInstance_ConfigDB_Fail 108KQB_HT_High_Database_Session 121KQB_HT_High_Database_Size 121KQB_HT_High_InProcMessageCount 122KQB_HT_High_MsgDelivery_Rate 122KQB_HT_High_MsgPublishing_Rate 122KQB_HT_High_Process_Memory 123KQB_HT_High_System_Memory 123KQB_HT_High_Thread_Count 124KQB_HTTPSendAdaptr_ConnectFail 109KQB_Inbound_Msg_Proc_Failure 109KQB_Invalid_FileRecieveLoc 110KQB_Invalid_Receive_Loc_Config 110KQB_Msg_Resp_WithoutReq 113KQB_MsgEngine_FailToAddRecvLoc 111KQB_MsgEngine_FailToInit 112KQB_MsgEngine_FailToRegAdptr 112KQB_MsgEngine_SSOSrverConnFail 113KQB_MsgEngineFailToGetConfigDB 111KQB_MSMQTSubserviceFail 113KQB_No_Host_Instance 102KQB_Orchestrn_Stopped_Warning 103KQB_POP3_Authentication_Fail 114KQB_POP3_ServerConnection_Fail 114KQB_Rec_Loc_Stoped_Warning 104KQB_ReceiveLoc_ShutDown 115KQB_RecvFileAttr 115KQB_RecvLoc_Disabled 116KQB_RFID_Dev_StateSave_Fail 117KQB_RFID_Device_Conn_Fail 116KQB_RFID_Device_Disabled 117KQB_RFID_DeviceName_Conflict 116KQB_RFID_InsufPrivil_On_Dev 118KQB_RFID_ProcessEng_MaxRestart 118KQB_RFID_ProcessEngine_Fatal 118KQB_RFID_Service_Auth_Fail 119KQB_RFID_Service_Down 103KQB_RFID_Service_StartUpFail 119KQB_Send_Port_Group_Stopped 104KQB_Send_Port_Stopped_Warning 104KQB_SendPipeline_ExecutionFail 120KQB_Srvc_Inst_Suspend_Warning 105KQB_Stored_ProcCall_Failure 120overview 97predefined 97Situation Editor 97

situations, using attributes 17Skipped Chronicle Rule Firings attribute 44Skipped Quanta attribute 44Skipped Subscription Rule Firings attribute 44

198 Microsoft BizTalk Server agent Reference

Page 205: Microsoft BizTalk Server agent Reference - IBM

SMCSee Service Management Connect

SMTP Send Adapter attribute group 84SMTP Send Adapter workspace 6SOAP Receive Adapter attribute group 84SOAP Receive Adapter workspace 6SOAP Send Adapter attribute group 85SOAP Send Adapter workspace 6Spool Size attribute 54SQL Receive Adapter attribute group 86SQL Receive Adapter workspace 7SQL Send Adapter attribute group 86SQL Send Adapter workspace 7Start BizTalk Base EDI Service action 132Start BizTalk SharePoint Messaging Adapter Service

action 133Start Enterprise Single Sign-On Service action 134Start Host Instance Service action 135Start Microsoft BizTalk RFID Service action 136Start Orchestration action 137Start Rule Engine Update Service action 139Start Send Port action 140Start Send Port Group action 141Status attribute 25, 65, 75, 79, 80Steps Retrieved attribute 53Stop BizTalk Base EDI Service action 142Stop BizTalk SharePoint Messaging Adapter Service

action 143Stop Enterprise Single Sign-On Service action 144Stop Host Instance Service action 145Stop Microsoft BizTalk RFID Service action 146Stop Orchestration action 146Stop Rule Engine Update Service action 148Stop Send Port Group action 149Subscribers Added attribute 87Subscribers attribute group 87Subscribers Disabled attribute 87Subscribers Enabled attribute 87Subscribers workspace 9Subscriptions Added attribute 88Subscriptions attribute group 88Subscriptions Disabled attribute 88Subscriptions Enabled attribute 88

TTags Being Processed attribute 78Tags In Queue attribute 78Tags Processed attribute 78Tags Read Per Sec attribute 77Tags Suspended attribute 78Tags Written Per Sec attribute 77Take Action commands

additional information 125Disable Receive Location 126Enable Receive Location 127Enlist Orchestration 128Enlist Send Port 130Enlist Send Port Group 131overview 125predefined 125, 155Start BizTalk Base EDI Service 132Start BizTalk SharePoint Messaging Adapter Service 133Start Enterprise Single Sign-On Service 134Start Host Instance Service 135Start Microsoft BizTalk RFID Service 136Start Orchestration 137

Take Action commands (continued)Start Rule Engine Update Service 139Start Send Port 140Start Send Port Group 141Stop BizTalk Base EDI Service 142Stop BizTalk SharePoint Messaging Adapter Service 143Stop Enterprise Single Sign-On Service 144Stop Host Instance Service 145Stop Microsoft BizTalk RFID Service 146Stop Orchestration 146Stop Rule Engine Update Service 148Stop Send Port Group 149Unenlist Orchestration 150Unenlist Send Port 151Unenlist Send Port Group 152

take actionsdescriptions 126

Tasks Retrieved attribute 53TDDS

situations 125workspaces

descriptions 16TDDS attribute group 88TDDS Details workspace 16TDDS workspace 16Technotes 184terms 183Thread Count attribute 25, 49Thread Count Threshold attribute 49Throttled Receive Batches attribute 59Throttling Details workspace 12Time Generated attribute 35Time To Add Message To Batch attribute 51Time To Build Batch attribute 39, 51Timeouts attribute 92Timestamp attribute 23, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34,

36, 37, 39, 40, 41, 43, 44, 49, 51, 52, 53, 55, 56, 57, 59, 60, 61,63, 64, 65, 69, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85,86, 87, 88, 89, 91, 92, 93, 94

Tivoli Enterprise Consoleevent mapping 157

Total Batches (Superseded) attribute 90Total Batches attribute 90Total Batches Committed attribute 49Total Events (Superseded) attribute 90Total Events attribute 37, 90Total Failed BAM Events During Flush attribute 27Total Failed Batches (Superseded) attribute 90Total Failed Batches attribute 90Total Failed Events (Superseded) attribute 90Total Failed Events attribute 90Total Messages Delivered attribute 49Total Messages Published attribute 49Total Receive Commit Failures attribute 93, 95Total Receive Message Failures attribute 93, 95Total Received Messages attribute 93, 95Total Records (Superseded) attribute 91Total Records attribute 91Total Send Message Failures attribute 93, 95Total Sent Messages attribute 93, 95Total Successful BAM Events During Flush attribute 27Total Tags Read attribute 77Total Tags Written attribute 77Total Web Service Call Failures attribute 94, 95Tracked Msgs Copy Purge Jobs attribute 55Tracking Data Size attribute 55Tracking Database attribute group 91

Index 199

Page 206: Microsoft BizTalk Server agent Reference - IBM

Tracking Spool Cleanup Purge Jobs attribute 55Transactional Scopes Aborted attribute 69Transactional Scopes Aborted Per Sec attribute 70Transactional Scopes Committed attribute 70Transactional Scopes Committed Per Sec attribute 70Transactional Scopes Compensated attribute 70Transactional Scopes Compensated Per Sec attribute 70Transactional Scopes workspace 15Transport Address attribute 75Transport Type attribute 75, 80Type attribute 25typeface conventions 184

UUnenlist Orchestration action 150Unenlist Send Port action 151Unenlist Send Port Group action 152

VVacuumer attribute group 91Vacuumer workspace 10variables conventions 184views

Adapters workspace 4Availability workspace 7BAM Interceptor workspace 8BizTalk Group Topology workspace 10Business Activity Monitoring workspace 8Configuration and Status workspace 10Current Status workspace 10Databases workspace 11Dehydration Details workspace 14Dehydration Status workspace 14Delivery Channels and Event Providers workspace 8Distributors and Subscriptions workspace 9Document Transactions workspace 13Event Log workspace 11Events workspace 9File Receive Adapter - Data Received workspace 4File Send Adapter workspace 4FTP Receive Adapter workspace 4FTP Send Adapter workspace 4Generator workspace 9Host Throttling Thresholds workspace 11Host Throttling workspace 11HTTP Receive Adapter workspace 4HTTP Send Adapter workspace 5Human Workflow Services workspace 12MessageBox - Host Queue Messages workspace 13MessageBox - Host Queue Overview workspace 13MessageBox - Purge Jobs workspace 13MessageBox workspace 13Messages Overview workspace 12Messaging Details workspace 14Messaging Latency workspace 14Messaging workspace 13Microsoft BizTalk Server workspace 3MSMQ Receive Adapter workspace 5MSMQ Send Adapter workspace 5Notifications workspace 9Orchestration Details workspace 15Orchestration Messaging workspace 15Orchestration Processing workspace 15Orchestrations workspace 15

views (continued)Performance Object Status workspace 8POP3 Receive Adapter workspace 5RFID workspace 16Service Instance workspace 10SFTP Receive Adapter workspace 6SFTP Send Adapter workspace 6SMTP Send Adapter workspace 6SOAP Receive Adapter workspace 6SOAP Send Adapter workspace 6SQL Receive Adapter workspace 7SQL Send Adapter workspace 7Subscribers workspace 9TDDS Details workspace 16TDDS workspace 16Throttling Details workspace 12Transactional Scopes workspace 15Vacuumer workspace 10Windows SharePoint Services Adapter workspace 7

Virtual Size attribute 26

WWeb Service Calls Per Sec attribute 94, 95Windows SharePoint Services Adapter attribute group 94Windows SharePoint Services Adapter workspace 7Windows SharePoint Services attribute group 92Workflow Editor 155Working Set Size attribute 26workspaces

Adapters 4Availability 7BAM Interceptor 8BizTalk Group Topology 10Business Activity Monitoring 8Configuration and Status 10Current Status 10Databases 11Dehydration Details 14Dehydration Status 14Delivery Channels and Event Providers 8descriptions 3Distributors and Subscriptions 9Document Transactions 13Event Log 11Events 9File Receive Adapter - Data Received 4File Send Adapter 4FTP Receive Adapter 4FTP Send Adapter 4Generator 9Host Throttling 11Host Throttling Thresholds 11HTTP Receive Adapter 4HTTP Send Adapter 5Human Workflow Services 12MessageBox 13MessageBox - Host Queue Messages 13MessageBox - Host Queue Overview 13MessageBox - Purge Jobs 13Messages Overview 12Messaging 13Messaging Details 14Messaging Latency 14Microsoft BizTalk Server 3MSMQ Receive Adapter 5MSMQ Send Adapter 5

200 Microsoft BizTalk Server agent Reference

Page 207: Microsoft BizTalk Server agent Reference - IBM

workspaces (continued)Notifications 9Orchestration Details 15Orchestration Messaging 15Orchestration Processing 15Orchestrations 14, 15Performance Object Status 8POP3 Receive Adapter 5predefined 1RFID 16Service Instance 10SFTP Receive Adapter 6SFTP Send Adapter 6SMTP Send Adapter 6SOAP Receive Adapter 6SOAP Send Adapter 6SQL Receive Adapter 7SQL Send Adapter 7Subscribers 9TDDS 16TDDS Details 16Throttling Details 12Transactional Scopes 15Vacuumer 10Windows SharePoint Services Adapter 7

Workspacesadditional information 1overview 1

Index 201

Page 208: Microsoft BizTalk Server agent Reference - IBM

202 Microsoft BizTalk Server agent Reference

Page 209: Microsoft BizTalk Server agent Reference - IBM
Page 210: Microsoft BizTalk Server agent Reference - IBM

IBM®

Printed in USA