Sie sind auf Seite 1von 376

Tivoli IBM Tivoli Monitoring for Microsoft Applications V6.2.

0 Interim Feature 1:
Microsoft SharePoint Server Agent V6.2.0.1



Users Guide

SC23-9758-02

Tivoli IBM Tivoli Monitoring for Microsoft Applications V6.2.0 Interim Feature 1:
Microsoft SharePoint Server Agent V6.2.0.1



Users Guide

SC23-9758-02

Note
Before using this information and the product it supports, read the information in Appendix D, Notices, on page 349.

This edition applies to version 6.2.0.1 of IBM Tivoli Monitoring for Microsoft Applications: Microsoft SharePoint
Server Agent (product number 5724-U17) and to all subsequent releases and modifications until otherwise indicated
in new editions.
Copyright International Business Machines Corporation 2008, 2009.
US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.

Contents
Tables . . . . . . . . . . . . . . . vii
Chapter 1. Overview of the Monitoring
Agent for Microsoft SharePoint Server . 1
IBM Tivoli Monitoring overview . . . .
Features of the monitoring agent . . .
Functions of the monitoring agent . . .
New in this release . . . . . . . .
Components of the IBM Tivoli Monitoring
environment . . . . . . . . . .
User interface options . . . . . . .

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

1
1
1
3

.
.

.
.

.
.

. 4
. 4

Chapter 2. Requirements and


agent-specific installation and
configuration information for the
monitoring agent . . . . . . . . . . . 7
Requirements for the monitoring agent . . . . . 7
Installing language packs . . . . . . . . . . 9
Windows systems. . . . . . . . . . . . 9
UNIX or Linux systems. . . . . . . . . . 9
Agent-specific installation and configuration . . . 10
Configuration values . . . . . . . . . . 10
Remote installation and configuration . . . . 11

Chapter 3. Workspaces reference . . . 13


About workspaces . . . . . . . . . .
More information about workspaces . . . .
Cross-linked workspaces . . . . . . . .
Predefined workspaces . . . . . . . .
Agent Navigator items . . . . . . . .
Microsoft SharePoint Server Navigator item
Alert Navigator item . . . . . . . .
ASP NET Applications Navigator item . .
Availability Navigator item . . . . . .
Database Navigator item . . . . . . .
Document Conversions Navigator item . .
Event Log Navigator item . . . . . .
Excel Services Navigator item . . . . .
InfoPath Forms Services Navigator item . .
MOSS Search Navigator item . . . . .
MSPS Search Navigator item . . . . .
Shared Service Provider Navigator item . .
SharePoint Publishing Navigator item . .
Web Server Navigator item . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

13
13
13
15
16
16
17
18
18
19
19
20
20
21
22
29
34
35
36

Chapter 4. Attributes reference . . . . 37


About attributes . . . . . . . . . . . .
More information about attributes . . . . . .
Attribute groups and attributes for the Monitoring
Agent for Microsoft SharePoint Server . . . .
ASP NET Applications attribute group . . . .
Availability attribute group . . . . . . . .
Database attribute group . . . . . . . . .
Document Conversions attribute group . . . .
Copyright IBM Corp. 2008, 2009

. 37
. 37
.
.
.
.
.

37
40
42
45
46

Event Log attribute group . . . . . . .


Excel Calculation Services attribute group . .
Excel Services Web Front End attribute group .
Excel Web Access attribute group . . . . .
InfoPath Forms Services attribute group . . .
Office Search Archival Plugin attribute group .
Office Search Gatherer attribute group . . .
Office Search Gatherer Projects attribute group
Office Search Indexer Catalogs attribute group
Office Search Schema Plugin attribute group .
Performance Object Status attribute group . .
Search attribute group . . . . . . . .
Search Archival Plugin attribute group . . .
Search Catalogs attribute group . . . . .
Search Gatherer attribute group . . . . .
Search Gatherer Projects attribute group . .
Search Indexer Catalogs attribute group . .
Search Schema Plugin attribute group . . .
Search Topic Assistant attribute group . . .
Shared Service Provider attribute group . .
SharePoint Components attribute group . .
SP Publishing Cache attribute group. . . .
SP Search Archival Plugin attribute group . .
SP Search Gatherer attribute group . . . .
SP Search Gatherer Projects attribute group .
SP Search Indexer Catalogs attribute group .
SP Search Schema Plugin attribute group . .
SPP Alerts Notification Service attribute group
SPP Server Alert Manager attribute group . .
SPP Server Alerts Plugin attribute group . .
Web Server attribute group . . . . . . .
Disk capacity planning for historical data . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

. 47
. 49
. 52
. 53
. 54
. 60
. 63
. 72
. 85
. 101
. 103
. 106
. 110
. 112
. 116
. 126
. 138
. 142
. 144
. 146
. 150
. 151
. 155
. 158
. 167
. 180
. 196
. 198
. 201
. 207
. 215
. 216

Chapter 5. Situations reference. . . . 219


About situations . . . . . . . . . .
More information about situations . . . .
Predefined situations . . . . . . . . .
Microsoft SharePoint Server Navigator item .
Alert Navigator item . . . . . . . . .
ASP NET Applications Navigator item . . .
Availability Navigator item . . . . . . .
KQP_SPP_Admin_Service_Down situation
KQP_SPP_Timer_Service_Down situation .
KQP_SPP_Alert_Service_Down situation .
KQP_Office_Search_Service_Down situation
KQP_SP_Search_Service_Down situation .
KQP_MSPS_Search_Service_Down situation
KQP_MS_SSO_Service_Down situation . .
KQP_WSS_Tracing_Service_Down situation
Database Navigator item . . . . . . .
Document Conversions Navigator item. . .
Event Log Navigator item . . . . . . .
KQP_InfoPath_Form_Actions situation . .
KQP_InfoPath_Session_State situation . .
KQP_SP_DB_Login_Failed situation . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

219
219
220
222
222
222
222
222
222
223
224
224
225
225
226
226
226
226
226
227
228

iii

KQP_Insufficient_DB_Permission situation .
KQP_Alert_Noti_NoMAILServerRes situation
KQP_Office_Protocol_Handler situation . .
KQP_WSS_Protocol_Handler situation . . .
KQP_Connection_To_SP_DB situation . . .
KQP_My_Site_Creation_Failure situation . .
KQP_Profile_Import_Failed situation . . .
KQP_User_Profile_Commit_Failed situation .
KQP_Membership_Import_Failed situation .
KQP_User_Profile_Sync_Failed situation . .
KQP_SSP_Admin_Site_Unavailable situation
KQP_Sync_Job_Scheduler_Failed situation. .
KQP_SSP_Provisioning_Failed situation . .
KQP_Last_Query_Server_Removed situation
KQP_SSP_DB_Sync_Failed situation . . . .
KQP_Alert_InvalidPortalSetting situation . .
Excel Services Navigator item . . . . . . .
KQP_ECS_Active_Sessions situation . . . .
KQP_ECS_Session_Time_Out situation . . .
InfoPath Forms Services Navigator item . . .
MOSS Search Navigator item . . . . . . .
KQP_SP_RTB_SystemIOTraffic situation . .
KQP_SP_Doc_Delayed_Retry situation . . .
KQP_SP_Active_Queue_Length situation . .
KQP_SP_Search_Index_Size situation . . .
KQP_Office_RTB_SystemIOTraffic situation .
KQP_Office_Doc_Delayed_Retry situation . .
KQP_Office_Active_Queue_Length situation .
KQP_Office_Retries_Rate situation . . . .
KQP_Office_Search_Index_Size situation . .
MSPS Search Navigator item . . . . . . .
KQP_MSPS_RBT_SystemIOTraffic situation .
KQP_MSPS_Search_DocDelayRetry situation
KQP_MSPS_ActiveQueueLength situation . .
KQP_MSPS_Retries_Rate situation . . . .
Shared Service Provider Navigator item . . .
SharePoint Publishing Navigator item . . . .
KQP_SP_Publish_CacheHitRatio situation . .
Web Server Navigator item . . . . . . . .

. 228
229
. 229
. 230
. 230
. 231
. 231
. 232
. 232
. 233
233
. 234
. 234
235
. 236
. 236
. 237
. 237
. 237
. 238
. 238
. 238
. 238
. 239
. 239
. 240
. 241
. 241
. 242
. 242
. 243
. 243
243
. 244
. 244
. 245
. 245
. 245
. 245

Chapter 6. Take Action commands


reference . . . . . . . . . . . . . 247
About Take Action commands. . . . . . . .
More information about Take Action commands
Predefined Take Action commands . . . . . .
Start Microsoft Single Sign-on Service action . . .
Start Office Document Conversions Launcher
Service action . . . . . . . . . . . . .
Start Office Document Conversions Load Balancer
Service action . . . . . . . . . . . . .
Start Office SharePoint Server Search Service action
Start SharePoint Portal Administration Service
action . . . . . . . . . . . . . . . .
Start SharePoint Portal Alert Service action . . .
Start SharePoint Portal Search Service action . . .
Start SharePoint Timer Service action . . . . .
Start Windows SharePoint Services Administration
Service action . . . . . . . . . . . . .
Start Windows SharePoint Services Search Service
action . . . . . . . . . . . . . . . .

iv

247
247
247
248
249
249
249
250
250
251
251
251
252

Start Windows SharePoint Services Timer Service


action . . . . . . . . . . . . . . . .
Start Windows SharePoint Services Tracing Service
action . . . . . . . . . . . . . . . .
Start Windows SharePoint Services VSS Writer
Service action . . . . . . . . . . . . .
Stop Microsoft Single Sign-on Service action . . .
Stop Office Document Conversions Launcher
Service action . . . . . . . . . . . . .
Stop Office Document Conversions Load Balancer
Service action . . . . . . . . . . . . .
Stop Office SharePoint Server Search Service action
Stop SharePoint Portal Administration Service
action . . . . . . . . . . . . . . . .
Stop SharePoint Portal Alert Service action . . .
Stop SharePoint Portal Search Service action . . .
Stop SharePoint Timer Service action . . . . .
Stop Windows SharePoint Services Administration
Service action . . . . . . . . . . . . .
Stop Windows SharePoint Services Search Service
action . . . . . . . . . . . . . . . .
Stop Windows SharePoint Services Timer Service
action . . . . . . . . . . . . . . . .
Stop Windows SharePoint Services Tracing Service
action . . . . . . . . . . . . . . . .
Stop Windows SharePoint Services VSS Writer
Service action . . . . . . . . . . . . .

252
253
253
253
254
254
255
255
255
256
256
257
257
257
258
258

Chapter 7. Policies reference. . . . . 259


About policies . . . . . . .
More information about policies .
Predefined policies . . . . .

.
.
.

.
.
.

.
.
.

.
.
.

.
.
.

. 259
. 259
. 259

Chapter 8. Tivoli Common Reporting


for the monitoring agent . . . . . . 261
Category 1: Performance reports . . . . .
Document Conversion Status report . . .
Document Conversion Status Subreport .
Excel Services Performance report . . .
Excel Services Performance Subreport . .
Shared Service Provider Performance report
Gatherer report . . . . . . . . . .
Indexer Catalogs report . . . . . . .
Archival Plug-in report . . . . . . .
Category 2: Alerts reports . . . . . . .
Alert Notification Status report . . . .
Alert Plug-in report . . . . . . . .
Alert Plug-in Subreport . . . . . . .
Category 3: Availability reports . . . . .
SharePoint Services Availability report . .
SharePoint Services Availability Subreport .
Category 4: Memory Utilization reports . .
Memory And Threads Usage report . . .
Memory And Threads Usage Subreport .
InfoPath Forms Memory Usage report . .
SharePoint Publishing Cache report . . .
SharePoint Publishing Cache Subreport. .
Category 5: Event Details reports . . . . .
SharePoint Event Details report . . . .

Monitoring Agent for Microsoft SharePoint Server: Users Guide

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

263
263
264
265
267
268
270
271
273
275
275
276
278
279
279
279
280
280
282
283
284
285
286
286

Chapter 9. Troubleshooting . . . . . 289


Gathering product information for IBM Software
Support . . . . . . . . . . . . . .
Built-in troubleshooting features . . . . . .
Problem classification. . . . . . . . . .
Trace logging . . . . . . . . . . . .
Overview of log file management . . . .
Principal trace log files . . . . . . . .
Setting RAS trace parameters . . . . . .
Problems and workarounds . . . . . . .
Installation and configuration troubleshooting
Remote deployment troubleshooting . . .
Agent troubleshooting . . . . . . . .
Workspace troubleshooting . . . . . . .
Situation troubleshooting . . . . . . .
Take Action commands troubleshooting . .
Tivoli Common Reporting troubleshooting .
Support information . . . . . . . . . .
Informational, warning, and error messages . .
Message format . . . . . . . . . .
Monitoring Agent for Microsoft SharePoint
Server messages . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

289
289
290
290
290
291
293
295
295
297
298
301
307
310
310
312
312
313

Appendix A. IBM Tivoli Enterprise


Console event mapping . . . . . . . 321
Appendix B. Documentation library

343

Monitoring Agent for Microsoft SharePoint Server


library . . . . . . . . . . . . . . . . 343
Prerequisite publications. . . . . . . . . . 343
Related publications . . . . . . . . . . . 344
Other sources of documentation . . . . . . . 344

Appendix C. Accessibility . . . . . . 347


Navigating the interface using the keyboard .
Magnifying what is displayed on the screen .

.
.

. 347
. 347

Appendix D. Notices . . . . . . . . 349


Trademarks .

. 351

Index . . . . . . . . . . . . . . . 353

. 313

Contents

vi

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Tables
1.
2.
3.

4.
5.
6.
7.
8.

Supported operating system and application


versions . . . . . . . . . . . . . . 7
Cross-linked workspaces . . . . . . . . 14
Capacity planning for historical data logged
by IBM Tivoli Monitoring for Microsoft
Applications: Microsoft SharePoint Server
Agent . . . . . . . . . . . . . . 217
Supported databases . . . . . . . . . 261
Information to gather before contacting IBM
Software Support . . . . . . . . . . 289
Trace log files for troubleshooting agents
291
Problems and solutions for installation and
configuration . . . . . . . . . . . 296
General problems and solutions for
uninstallation . . . . . . . . . . . 297

Copyright IBM Corp. 2008, 2009

9.
10.
11.
12.
13.
14.
15.
16.

Remote deployment problems and solutions


Agent problems and solutions . . . . . .
Workspace problems and solutions . . . .
General situation problems and solutions
Problems with configuring situations that you
solve in the Situation Editor . . . . . .
Problems with configuration of situations that
you solve in the Workspace area . . . . .
Take Action commands problems and
solutions . . . . . . . . . . . . .
Tivoli Common Reporting for Monitoring
Agent for Microsoft SharePoint Server
problems and solutions . . . . . . . .

298
298
301
307
308
309
310

310

vii

viii

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Chapter 1. Overview of the Monitoring Agent for Microsoft


SharePoint Server
The Monitoring Agent for Microsoft SharePoint Server provides you with the
capability to monitor Microsoft SharePoint Server, and to perform basic actions
with Microsoft SharePoint Server. This chapter provides a description of the
features, components, and interface options for the Monitoring Agent for Microsoft
SharePoint Server.

IBM Tivoli Monitoring overview


IBM Tivoli Monitoring is the base software for the Monitoring Agent for Microsoft
SharePoint Server. IBM Tivoli Monitoring provides a way to monitor the
availability and performance of all the systems in your enterprise from one or
several designated workstations. It also provides useful historical data that you can
use to track trends and to troubleshoot system problems.
You can use IBM Tivoli Monitoring to perform the following tasks:
v Monitor for alerts on the systems that you are managing by using predefined
situations or custom situations.
v Establish your own performance thresholds.
v Trace the causes leading to an alert.
v Gather comprehensive data about system conditions.
v Use policies to perform actions, schedule work, and automate manual tasks.
The Tivoli Enterprise Portal is the interface for IBM Tivoli Monitoring products. By
providing a consolidated view of your environment, the Tivoli Enterprise Portal
permits you to monitor and resolve performance issues throughout the enterprise.
See the IBM Tivoli Monitoring publications listed in Prerequisite publications on
page 343 for complete information about IBM Tivoli Monitoring and the Tivoli
Enterprise Portal.

Features of the monitoring agent


The Monitoring Agent for Microsoft SharePoint Server software can identify, notify
you of, and correct common problems with the application that it monitors. The
software includes the following features:
v Monitoring
v Data gathering
v Operations management

Functions of the monitoring agent


The Monitoring Agent for Microsoft SharePoint Server provides the following
functions:
Availability monitoring
Monitors the following services, indicating when down:
v SharePoint Portal Administration Service
Copyright IBM Corp. 2008, 2009

v
v
v
v
v

Microsoft Single Sign-on service


SharePoint Timer Service
SharePoint Portal Search Service
SharePoint Portal Alert Service
Office SharePoint Server Search Service

v
v
v
v
v
v
v

Office Document Conversions Load Balancer Service


Office Document Conversions Launcher Service
SharePoint Services VSS Writer Service
Windows SharePoint Services Tracing Service
Windows SharePoint Services Timer Service
Windows SharePoint Services Search Service
Windows SharePoint Services Administration Service.

Error and event log monitoring


Monitors for event sources affecting SharePoint Server availability or
performance.
The following MOSS event sources are monitored by the agent:
v Office Document Conversions Launcher Service
v Office Server Search
v Office SharePoint Server
v Office SharePoint Server Error Reporting
v SharePoint Products and Technologies Configuration Wizard
v
v
v
v
v

SPAdmin
Windows
Windows
Windows
Microsoft

SharePoint Services 3
SharePoint Services 3 Error Reporting
SharePoint Services 3 Search
Single Sign-on Service

The following MSPS event sources are monitored by the agent:


v SharePoint Portal Administration Service
v Microsoft Single Sign-on Service
v SHAREPOINTPORTAL
v SharePoint Portal Server
v SharePoint Portal Server Error Reporting
v Windows SharePoint Services 2.0
v Windows SharePoint Services 2.0 Error Reporting
v Microsoft SharePointPS Search Service
v SharePoint Portal Alert Service
v MSSQL$SHAREPOINTPORTAL
v SQLAgent$SHAREPOINTPORTAL
v SQLCTR$SHAREPOINTPORTAL
Performance monitoring
Collects performance attributes in the following areas, providing situations
where appropriate:
v Document Conversions
v Infopath Form Services
v Shared Service Provider

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v
v
v
v
v

Excel Services
SharePoint Publishing Cache
Database
Search
Alert

v Web Server
v ASP NET Applications
Actions
Provides stop and start actions for the following services:
v SharePoint Portal Administration Service
v SharePoint Timer Service
v SharePoint Portal Search Service
v
v
v
v
v
v

SharePoint Portal Alert Service


Office SharePoint Server Search
Office Document Conversions Launcher Service
Office Document Conversions Load Balancer Service
Microsoft Single Sign-on Service
SharePoint Services Search

v Windows SharePoint Services Timer Services


v Windows SharePoint Services Tracing
v Windows SharePoint Services VSS Writer
v Windows SharePoint Services Administration Service
Reporting
Provides a history enablement file that enables the ability to generate
reports for all attributes collected.

New in this release


For version 6.2.0.1 of the Monitoring Agent for Microsoft SharePoint Server, the
following enhancements have been made since version 6.2.0, including the fix
packs:
v Additional supported operating systems as listed in Requirements for the
monitoring agent on page 7
v New attribute groups
Web Server
ASP NET Applications
v New workspaces
Web Server
ASP NET Applications
v New views
Web Server
ASP NET Applications
v New situations
My_Site_Creation_Failure
Profile_Import_Failed
User_Profile_Commit_Failed
Chapter 1. Overview of the Monitoring Agent for Microsoft SharePoint Server

Membership_Import_Failed
User_Profile_Sync_Failed
SSP_Admin_Site_Unavailable
Sync_Job_Scheduler_Failed
SSP_Provisioning_Failed

Last_Query_Server_Removed
SSP_DB_Sync_Failed
MSPS_Retries_Rate
Office_Retries_Rate
Alert_InvalidPortalSettings
MS_SSO_Service_Down
WSS_Tracing_Service_Down

v Updated kqp.baroc file to support TEC event mapping


v Integration with the Tivoli Common Reporting infrastructure to create historical
reports from the data that is collected in the Tivoli Data Warehouse.

Components of the IBM Tivoli Monitoring environment


After you install and set up the Monitoring Agent for Microsoft SharePoint Server,
you have an environment that contains the client, server, and monitoring agent
implementation for IBM Tivoli Monitoring that contains the following components:
v Tivoli Enterprise Portal client with a Java-based user interface for viewing and
monitoring your enterprise.
v Tivoli Enterprise Portal Server that is placed between the client and the Tivoli
Enterprise Monitoring Server and enables retrieval, manipulation, and analysis
of data from the monitoring agents. The Tivoli Enterprise Portal Server is the
central repository for all user data.
v Tivoli Enterprise Monitoring Server that acts as a collection and control point for
alerts received from the monitoring agents, and collects their performance and
availability data. The Tivoli Enterprise Monitoring Server is also a repository for
historical data.
v IBM Tivoli Enterprise Console is an optional component, which acts as a central
collection point for events from a variety of sources, including those from other
Tivoli software applications, Tivoli partner applications, custom applications,
network management platforms, and relational database systems. You can view
these events through the Tivoli Enterprise Portal (using the event viewer), and
you can forward events from IBM Tivoli Monitoring situations to the IBM Tivoli
Enterprise Console component.
v Tivoli Common Reporting is a separately installable feature available to users of
Tivoli software that provides a consistent approach to generating and
customizing reports. Some individual products provide reports that are designed
for use with Tivoli Common Reporting, and have a consistent look and feel.

User interface options


Installation of the base software and other integrated applications provides the
following interfaces that you can use to work with your resources and data:
Tivoli Enterprise Portal browser client interface
The browser client interface is automatically installed with the Tivoli
Enterprise Portal Server. To start the Tivoli Enterprise Portal browser client

Monitoring Agent for Microsoft SharePoint Server: Users Guide

in your Internet browser, enter the URL for a specific Tivoli Enterprise
Portal browser client installed on your Web server.
Tivoli Enterprise Portal desktop client interface
The desktop client interface is a Java-based graphical user interface (GUI)
on a Windows or Linux workstation.
IBM Tivoli Enterprise Console
An event management application that integrates system, network,
database, and application management to help ensure the optimal
availability of an IT services for an organization.
Manage Tivoli Enterprise Monitoring Services window
The window for the Manage Tivoli Enterprise Monitoring Services utility is
used for configuring the agent and starting Tivoli services not already
designated to start automatically.
Tivoli Common Reporting
A Web user interface for specifying report parameters and other report
properties, generating formatted reports, scheduling reports, and viewing
reports. The user interface is based on the Tivoli Integrated Portal.

Chapter 1. Overview of the Monitoring Agent for Microsoft SharePoint Server

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Chapter 2. Requirements and agent-specific installation and


configuration information for the monitoring agent
This chapter contains information about the requirements for the Monitoring Agent
for Microsoft SharePoint Server, and agent-specific information related to
installation and configuration of the agent.
To install and configure the Monitoring Agent for Microsoft SharePoint Server, use
the procedures for installing monitoring agents in the IBM Tivoli Monitoring
Installation and Setup Guide along with the information in this chapter.
If you are performing a silent installation using a response file, see the information
about performing a silent installation in the IBM Tivoli Monitoring Installation and
Setup Guide.

Requirements for the monitoring agent


In addition to the requirements described in the IBM Tivoli Monitoring Installation
and Setup Guide, the Monitoring Agent for Microsoft SharePoint Server has the
following requirements:
v The monitoring agent runs on any of these operating systems:
Table 1. Supported operating system and application versions
Microsoft SharePoint Server
Operating system versions

SharePoint 2007
SP 2

SharePoint 2003
SP 3
32 bit

32 bit

64 bit

Windows Server 2003 Web


Edition (32 bit)

Yes

Yes

No

Windows Server 2003 SE (32 bit)

Yes

Yes

No

Windows Server 2003 EE (32 bit)


with Service Pack 1 or Service
Pack 2

Yes

Yes

No

Windows Server 2003 Datacenter


Edition (32 bit)

Yes

Yes

No

Windows Server 2003 Web


Edition (64 bit)

Yes

No

No

Windows Server 2003 SE (64 bit)

Yes

No

No

Windows Server 2003 EE (64 bit)

Yes

No

No

Windows Server 2003 Datacenter


Edition (64 bit)

Yes

No

No

Windows Server 2008 Web


Edition (32 bit)

No

Yes

No

Windows Server 2008 SE (32 bit)

No

Yes

No

Windows Server 2008 EE (32 bit)

No

Yes

No

Windows Server 2008 Datacenter


Edition (32 bit)

No

Yes

No

Copyright IBM Corp. 2008, 2009

Table 1. Supported operating system and application versions (continued)


Microsoft SharePoint Server
Operating system versions

SharePoint 2003
SP 3

SharePoint 2007
SP 2

32 bit

32 bit

64 bit

Windows Server 2008 Web


Edition (64 bit)

No

No

No

Windows Server 2008 SE (64 bit)

No

No

No

Windows Server 2008 EE (64 bit)

No

No

No

Windows Server 2008 Datacenter


Edition (64 bit)

No

No

No

Windows Server 2008 on


Itanium2 (IA64)

No

No

No

Windows Server 2008 Datacenter


on Itanium2 (IA64)

No

No

No

Virtual machine (Windows 2003,


All editions, 32 bit) that are
created on Hyper-V Server 2008

Yes

Yes

No

Virtual machine (Windows 2003,


All editions, 64 bit) that are
created on Hyper-V Server 2008

Yes

No

No

Virtual machine (Windows 2008,


All editions, 32 bit) that are
created on Hyper-V Server 2008

No

Yes

No

Virtual machine (Windows 2008,


All editions, 64 bit) that are
created on Hyper-V Server 2008

No

No

No

The operating system user account must have administrative privileges. The
agent service runs under the operating system user account.
Note: For the most current information about the operating systems that are
supported, see http://www-306.ibm.com/software/sysmgmt/products/
support/Tivoli_Supported_Platforms.html.
v This agent monitors the following versions:
Microsoft SharePoint Server 2003, 2007
v A single computer that hosts the hub monitoring server, portal server, and a
monitoring agent requires approximately 300 MB of space. A computer that
hosts only the monitoring agent requires approximately 30 MB of space,
including the specific enablement code for the monitoring agent. More space is
required for each additional monitoring agent that you deploy on the
monitoring computer.
v The monitoring agent must be connected to the following software:
IBM Tivoli Monitoring V6.2.0 Fix Pack 1 or later.
After you install the prerequisite software, install the following software, which
is required for the Monitoring Agent for Microsoft SharePoint Server to operate:
Monitoring Agent for Microsoft SharePoint Server
Monitoring Agent for Microsoft SharePoint Server for Tivoli Enterprise
Monitoring Server support

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Monitoring Agent for Microsoft SharePoint Server for Tivoli Enterprise Portal
Server support
Monitoring Agent for Microsoft SharePoint Server for Tivoli Enterprise Portal
Desktop Client support
Monitoring Agent for Microsoft SharePoint Server for Tivoli Enterprise Portal
Browser Client support

Installing language packs


To install a language pack for the agent support files on the Tivoli Enterprise
Monitoring Server, the Tivoli Enterprise Monitoring Agent, and the Tivoli
Enterprise Portal Server, first make sure that you have already installed the
product in English, then perform the following steps depending on which
operating system you are using.

Windows systems
1. Double-click lpinstaller.bat in the language pack CD to launch the installation
program.
2.
3.
4.
5.

Select the language of the installer and click OK.


Click Next on the Introduction panel.
Click Add/Update and click Next.
Select the folder in which the National Language Support package
(NLSPackage) files are located.

Note: Usually the NLSPackage files are located in the nlspackage folder
where the installer executable is located.
6. Select the language support for the agent of your choice and click Next.

7.
8.
9.
10.

Note: Hold down the Ctrl key for multiple selections.


Select the languages that you want to install and click Next.
Examine the installation summary page and click Next to begin installation.
Click Finish after installation completes to exit the installer.
Restart Tivoli Enterprise Portal Desktop Client, Tivoli Enterprise Portal Server,
and Eclipse Help Server if any of these components are installed.

UNIX or Linux systems


1. Run the following command to create a temporary directory on the computer.
Make sure that the full path of the directory does not contain any spaces:
mkdir dir_name

2. Mount the language pack CD to the temporary directory you just created.
3. Run the following command to launch the installation program:
cd dir_name
lpinstaller.sh -c ITM Home Directory

Where ITM Home Directory is where you installed IBM Tivoli Monitoring.
Usually it is /opt/IBM/ITM for AIX and Linux.
4. Select the language of the installer and click OK.
5. Click Next on the Introduction panel.
6. Click Add/Update and click Next.

Chapter 2. Requirements and agent-specific installation and configuration information for the monitoring agent

7. Select the folder in which the National Language Support package


(NLSPackage) files are located.
Note: Usually, the NLSPackage files are located in the nlspackage folder
where the installer executable is located.
8. Select the language support for the agent of your choice and click Next.
Note: Hold down the Ctrl key for multiple selections.
9. Select the languages that you want to install and click Next.
10. Examine the installation summary page and click Next to begin installation.
11. Click Finish after installation completes to exit the installer.
12. Restart Tivoli Enterprise Portal Desktop Client, Tivoli Enterprise Portal Server,
and Eclipse Help Server if any of these components are installed.

Agent-specific installation and configuration


In addition to the installation and configuration information in the IBM Tivoli
Monitoring Installation and Setup Guide, use the information in this section to install
and configure the Monitoring Agent for Microsoft SharePoint Server.
No special setup is necessary to manage this application.

Configuration values
For both local and remote configuration, provide the configuration values for the
agent to operate. When configuring an agent, a panel is displayed so you can enter
each value. When there is a default value, this value is pre-entered into the field. If
a field represents a password, two entry fields are displayed. You must enter the
same value in each field. The values you type are not displayed to help maintain
the security of these values.
The configuration for this agent is organized into the following groups:
SharePoint Database Configuration for MOSS
(MOSS_APPLICATION_CONFIGURATION)
The configuration elements defined in this group are always present in the
agents configuration.
This group defines information that applies to the entire agent.
Database Password
Database Password
The type is password.
This value is optional.
Database User ID
Database User ID
The type is string.
This value is optional.
SharePoint Configuration Database DSN Name
SharePoint Configuration Database DSN Name
The type is string.
This value is optional.

10

Monitoring Agent for Microsoft SharePoint Server: Users Guide

SharePoint Database Configuration for MSPS


(SPS_APPLICATION_CONFIGURATION)
The configuration elements defined in this group are always present in the
agents configuration.
This group defines information that applies to the entire agent.
Database Password
Database Password
The type is password.
This value is optional.
Database User ID
Database User ID
The type is string.
This value is optional.
SharePoint Configuration Database DSN Name
SharePoint Configuration Database DSN Name
The type is string.
This value is optional.

Remote installation and configuration


When installing the agent remotely, you must provide the configuration values for
the agent to operate. See Configuration values on page 10.
See the tacmd describeSystemType section in the IBM Tivoli Monitoring Command
Reference for information on displaying the configuration options that are available
to use with the configureSystem or addSystem commands.
You can install the monitoring agent remotely from the Tivoli Enterprise Portal or
from the command line. To install from the portal, see the IBM Tivoli Monitoring
Installation and Setup Guide.
If using the command line, the following command is an example of remote
installation and configuration for Windows operating systems:
tacmd addSystem -t QP -n Primary:sample.node.name:NT
-p MOSS_APPLICATION_CONFIGURATION.KQP_MOSS_DB_PWD=value
MOSS_APPLICATION_CONFIGURATION.KQP_MOSS_DB_USER=value
MOSS_APPLICATION_CONFIGURATION.KQP_MOSS_DSN=value
SPS_APPLICATION_CONFIGURATION.KQP_SPS_DB_PWD=value
SPS_APPLICATION_CONFIGURATION.KQP_SPS_DB_USER=value
SPS_APPLICATION_CONFIGURATION.KQP_SPS_DSN=value

Chapter 2. Requirements and agent-specific installation and configuration information for the monitoring agent

11

12

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Chapter 3. Workspaces reference


This chapter contains an overview of workspaces, references for detailed
information about workspaces, and descriptions of the predefined workspaces
included in this monitoring agent.

About workspaces
A workspace is the working area of the Tivoli Enterprise Portal application
window. At the left of the workspace is a Navigator that you use to select the
workspace you want to see. As part of the application window, the right side of
the status bar shows the Tivoli Enterprise Portal server name and port number to
which the displayed information applies, and the ID of the current user.
When you select an item in the Navigator tree, a default workspace is displayed.
When you right-click a Navigator item, a menu that includes a Workspace item is
displayed. The Workspace item contains a list of workspaces for that Navigator
item. Each workspace has at least one view. Some views have links to other
workspaces.
This monitoring agent provides predefined workspaces. You cannot modify or
delete the predefined workspaces, but you can create new workspaces by editing
them and saving the changes with a different name.
A table view within a workspace corresponds to a group of attributes; the columns
in the table view show some or all of the attributes available in the attribute group.

More information about workspaces


For more information about creating, customizing, and working with workspaces,
see the IBM Tivoli Monitoring Users Guide.
For a list of the predefined workspaces for this monitoring agent and a description
of each workspace, refer to the Predefined workspaces section in this chapter and
the information in that section for each individual workspace.
Some attribute groups for this monitoring agent might not be represented in the
predefined workspaces or views for this agent. For a full list of the attribute
groups, see the Attributes reference section.

Cross-linked workspaces
This section contains cross-links from the SharePoint Server agent workspaces to
the .NET Framework agent, the IIS Agent, and the SQL Server Agent workspaces.
The table 2 contains source, target, and filtering criteria for the cross-linked
workspaces.

Copyright IBM Corp. 2008, 2009

13

Table 2. Cross-linked workspaces


Source
Navigator
Item

Source
Workspaces
Name

Source View
Name

Target
Navigator
Item

Target
Workspace
Name

Filter

Target Agent Name: Microsoft IIS Agent


Web Server

Web Server
Details

Web Server

Web Server

Data and File Site Name


Transfer
Statistics

Web Server

Web Server
Details

Web Server

Web Server

Error
Statistics

Site Name

Web Server

Web Server
Details

Web Server

Web Server

Connection
and Logon
Attempt
Statistics

Site Name

Target Agent Name: .Net Framework Agent


ASP NET
Applications

ASP NET
Applications
Details

ASP NET
Applications

ASP NET
Applications

ASP NET
Applications

Instance
Name

ASP NET
Applications

ASP NET
Applications
Details

ASP NET
Applications

ASP NET
Applications

ASP.NET
Applications
v1.1

Instance
Name

Target Agent Name : Microsoft SQL Server Agent


Database

Database
Details

SharePoint
Database
Information

Databases

Databases
Information

Database
Name*

Database

Database
Details

SharePoint
Database
Information

Databases

Log and
Space
Information

Database
Name*

Database

Database
Details

SharePoint
Database
Information

Processes

Processes
Information

Database
Name*

Database

Database
Details

SharePoint
Database
Information

Servers

Server
Summary

N.A.

Database

Database
Details

SharePoint
Database
Information

Servers

Server
N.A.
Configuration

Database

Database
Details

SharePoint
Database
Information

Servers

Server
Statistics

N.A.

Database

Database
Details

SharePoint
Database
Information

Errorlog
Alerts

Errorlog
Alerts

N.A.

Database

Database
Details

SharePoint
Database
Information

Databases

Device Detail Database


Name

Note: * indicates that the filter is added for SharePoint Server agent V6.2.0.1.

14

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Predefined workspaces
The Monitoring Agent for Microsoft SharePoint Server provides the following
predefined workspaces, which are organized by Navigator item.
v Microsoft SharePoint Server Navigator item
Microsoft SharePoint Server workspace
v Alert Navigator item
Alert workspace
Alert Plugin Details workspace
Alerts API Details workspace
Alerts Manager Details workspace
Alerts Notification Service E-mail Status workspace
v ASP NET Applications Navigator item
ASP NET Applications workspace
v Availability Navigator item
Availability workspace
Performance Object Status workspace
v Database Navigator item
Database workspace
v Document Conversions Navigator item
Document Conversions workspace
v Event Log Navigator item
Event Log workspace
v Excel Services Navigator item
Excel Calculation Services Session Status workspace
Excel Services workspace
Excel Web Access Request Status workspace
Excel Web Front End Request Status workspace
v InfoPath Forms Services Navigator item
InfoPath Forms Data Connection Status workspace
InfoPath Forms Services workspace
v MOSS Search Navigator item
MOSS Search workspace
Office Search Archival Plugin Details workspace
Office Search Gatherer Documents Status workspace
Office Search Gatherer Projects Details workspace
Office Search Gatherer Projects Documents Crawl Status workspace
Office Search Gatherer Projects Documents Delayed Status workspace

Office Search Gatherer Projects Documents Details workspace


Office Search Indexer Catalog Details workspace
Office Search Indexer Catalog Merge Status workspace
Office Search Schema Plugin Details workspace
SharePoint Search Archival Plugin Details workspace
SharePoint Search Gatherer Details workspace
SharePoint Search Gatherer Documents Status workspace
Chapter 3. Workspaces reference

15

SharePoint
SharePoint
SharePoint
SharePoint
SharePoint

Search
Search
Search
Search
Search

Gatherer Projects Details workspace


Gatherer Projects Documents Crawl Status workspace
Gatherer Projects Documents Delayed Status workspace
Gatherer Projects Documents Details workspace
Indexer Catalog Details workspace

SharePoint Search Indexer Catalog Merge Status workspace


SharePoint Search Schema Plugin Details workspace
v MSPS Search Navigator item
MSPS Search workspace
Search Archival Plugin Details workspace
Search Catalogs Details workspace
Search Catalogs Query Status workspace

Search
Search
Search
Search
Search
Search

Gatherer
Gatherer
Gatherer
Gatherer
Gatherer
Gatherer

Details workspace
Documents Status workspace
Projects Adaptive Crawl Status workspace
Projects Details workspace
Projects Documents Crawl Status workspace
Projects Documents Delayed Status workspace

Search Gatherer Projects Documents Details workspace


Search Indexer Catalogs Details workspace
Search Indexer Catalogs Document Status workspace

Search
Search
Search
Search

Indexer Catalogs Status workspace


Query Details workspace
Schema Plugin Details workspace
Topic Assistant Details workspace

v Shared Service Provider Navigator item


Shared Service Provider workspace
SSP Site Latency and Throughput workspace
SSP User Profiles and Profile Synchronization workspace
v SharePoint Publishing Navigator item
SharePoint Publishing workspace
SharePoint Publishing Cache workspace
SharePoint Publishing Cache Hit Miss Status workspace
v Web Server Navigator item
Web Server workspace

Agent Navigator items


This section contains descriptions of predefined workspaces. The workspaces are
organized by the Navigator item to which the workspaces are relevant.

Microsoft SharePoint Server Navigator item


Microsoft SharePoint Server workspace
This workspace provides information about Microsoft Office SharePoint
Server 2007 (or MOSS 2007) and Microsoft SharePoint Portal Server 2003
(or MSPS 2003), including installation and availability of services and
processes.

16

Monitoring Agent for Microsoft SharePoint Server: Users Guide

This workspace contains the following views:


SharePoint Information
This report shows the information of the SharePoint Server
Versions, mode of installations, different roles, account information,
log path, and central URL path.
Availability
This report shows the state of each component in the application.
Each process is displayed using a descriptive name, the name of
the running process, and the state of the process (UP, DOWN, or
PROCESS_DATA_NOT_AVAILABLE). Each service is displayed
using a descriptive name, the short name of the service, and the
state of the service (UP, DOWN, or UNKNOWN).

Alert Navigator item


Alert workspace
This workspace provides an overview of notifications that are processed
and sent by the alert notification service. The following report and charts
are included in the workspace.
This workspace contains the following views:
Notification Per Sec
This plot chart shows the number of notifications sent per second
to users if the document has changed or search results for a
particular query have changed.
Notifications Sent Status
This bar chart shows the number of notifications sent.
Notifications Currently Processed
This bar chart shows the notifications currently processed.
Notifications
This report gives detailed information of notifications sent.
Alert Plugin Details workspace
This workspace provides overview of Alert Plugin. It shows the alerts
status and documents status processed by Alert Plugin. The following
report and charts are included in the workspace.
This workspace contains the following views:
Documents Status
This bar chart shows the total documents processed by the Alert
Plugin and total failed documents.
Alerts Status
This bar chart shows the total alerts loaded, added, deactivated
and deleted by the Alert Plugin.
Alert Plugin Report
This report gives the detailed information about the Alert Plugin.
Alerts API Details workspace
This workspace provides overview of Alert APIs. It shows the status of
calls to Alert APIs. The following chart is included in the workspace.
This workspace contains the following view:

Chapter 3. Workspaces reference

17

Alerts API Calls


This bar chart shows the number of calls to Alert APIs for
activating, deactivating, deleting, manipulating and editing alerts.
Alerts Manager Details workspace
This workspace provides overview of Alert Manager. It shows the status of
calls to Alert APIs. The following report and charts are included in the
workspace.
This workspace contains the following views:
Activate Alert
This plot chart shows the frequency of calls to ActivateAlert.
Activate User Alerts
This plot chart shows the frequency of calls to ActivateUserAlerts.
Alerts Manager Report
This report shows the details of APIs related to Alert Manager.
Alerts Notification Service E-mail Status workspace
This workspace provides an overview of notifications sent through e-mail.
This workspace contains the following views:
E-mail Sent Per Sec
This plot chart shows the e-mails sent per second.
E-mail Size
This bar chart shows the average size of e-mails and the size of the
largest e-mail sent.
Total E-mails Sent
This bar chart shows the total number of e-mails sent as
notification.

ASP NET Applications Navigator item


ASP NET Applications workspace
This workspace lists all the SharePoint sites that are hosted on IIS and their
properties. These properties include Site ID, Site Name, Port, SSL Port,
Name, and Host Name. Click the links that are available for the selected
site to get the data from the .NET agent.
This workspace contains the following view:
ASP NET Applications
This report shows the properties of all the SharePoint sites. These
properties include Site ID, Site Name, Port, SSL Port, Name, and
Host Name.

Availability Navigator item


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 a descriptive name, the short name of
the service, and the state of the service (UP, DOWN, or
UNKNOWN). The state is UP if the service is running, DOWN if

18

Monitoring Agent for Microsoft SharePoint Server: Users Guide

the service exists but is not running. UNKNOWN indicates that the
service is not installed, so these elements are filtered from the view.
When the state of the component is DOWN (for a process, or
service) it is highlighted with a red background.
Processor
Displays 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 spent in
the kernel on behalf of the process and user mode time, which is
the time spent running the process code.
Threads
Displays the number of threads used by each process that is a
component of the application.
Memory
Displays the amount of memory being consumed by each process
that is a component of the application. This total (virtual) size of
the process and the size of the process in memory (working set)
are displayed.
Performance Object Status workspace
This 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. Normally this will display NO ERROR indicating that
the agent is collecting application data correctly. If some of the
agents other views are empty this view will help isolate the cause
of the failure. PerfMon objects will display the object class name.

Database Navigator item


Database workspace
SharePoint DB Information found on the managed node. This includes
SharePoint Database, database type, host name, version, and SQL Server
instance.
This workspace contains the following view:
SharePoint Database Information
SharePoint DB Information found on the managed node. This
includes SharePoint Database, database type, host name, version,
and instance information.

Document Conversions Navigator item


Document Conversions workspace
This workspace provides an overview of document conversions process.
The following report and charts are included in the workspace.
This workspace contains the following views:
Pending Conversions
This bar chart shows the number of pending document
conversions. Too many pending documents can degrade the
performance of the current site, resulting in slower response.

Chapter 3. Workspaces reference

19

Incoming E-mails Processed


This plot chart shows the rate at which e-mail messages have been
received and processed by the SharePoint Server.
Document Conversions Report
This report shows the details of the Document Conversions
Activity.

Event Log Navigator item


Event Log workspace
The Event Log workspace shows the details for the recent events logged by
the application to the Windows Event Log. By default, the agent only
displays events that occur after the agent is started. 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 SharePoint Server.

Excel Services Navigator item


Excel Calculation Services Session Status workspace
This workspace provides an overview of the Excel Calculation Services
sessions including the number of active sessions, average session time and
number of sessions per second. The following report and charts are
included in the workspace.
This workspace contains the following views:
Active Sessions
This bar chart shows the number of active sessions. Excel service
stops responding when number of active sessions per user exceeds
default value of Active Sessions.
Sessions Per Sec
This plot chart shows the average number of sessions opened per
second. Large value of this degrades performance of Excel
Calculation Services.
Session Report
This report gives detailed information of Excel Calculation Service
sessions. Sessions are opened for user to interact with workbook.
Excel Services workspace
This workspace provides an overview of the Excel Calculation Service. The
following report and charts are included in the workspace.
This workspace contains the following views:
Workbook Cache Size
This bar chart shows the total size of Excel Calculation Services
workbook cache in megabytes.
Requests with Errors
This plot chart shows number of requests that are returned with
errors. Higher rate of errors indicate unexpected behavior of an
Excel Calculation Services that directly affects the performance.
Excel Services Report
This report shows the Excel Calculation Services details.

20

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Excel Web Access Request Status workspace


This workspace provides an overview of the Excel Web Access component
of Excel Calculation Services.
This workspace contains the following views:
Excel Web Access Request Time
This bar chart shows the Excel Web Access average request time
between the last two samples.
Average Chart Image Requests Time
This bar chart shows the average time taken between the request
for a chart image and the issuance of the response to the Web
browser by Excel Web Access.
Chart Image Requests
This plot chart shows the number of requests for chart images
served by Excel Web Access per second.
Excel Web Front End Request Status workspace
This workspace provides an overview of the Excel Web Front End
component of Excel Calculation Services.
This workspace contains the following views:
Active Requests
This bar chart shows total number of active requests, which are
being processed by Excel Calculation Services.
Request Processing Time
This bar chart shows average processing time for a request to Excel
Web Front End component. Large value indicates high response
time.
Requests Per Sec
This plot chart shows total number of requests per second to Excel
Web Front End component.

InfoPath Forms Services Navigator item


InfoPath Forms Data Connection Status workspace
This workspace provides an overview of data connection. Data connection
is dynamic link between a form and a data source that stores or provides
data for that form. The following report and charts are included in the
workspace.
This workspace contains the following views:
Query Status
This plot chart shows data connection queries failure and started
rate. If there is rise in the value of Data Connection Query Started
rate and Data Connection Query Failure rate, user wait time will
increase to get the data from data source. If more than one query
runs on form load, initial form load time will be slow. Failure rate
can be due to one of three reasons: the user cancels the query if it
is taking too long to execute, an issue occurs on the back-end
implementation of the data connection, or a network issue occurs
between the end users computer and the server.
Submit Status
This plot chart shows the rate at which data connection of type
submit started to store or process form data and rate at which it
Chapter 3. Workspaces reference

21

failed to store or process the form data. Failure rate can be due to
one of three reasons: there are issues in a submit event handler, an
issue occurs on the back-end implementation of the data
connection, or a network issue occurs between the end users
computer and the server.
Data Connection Report
This report shows the overall health of data connection of the type
query and submit. 1. Data connection I/O operations are made
synchronously, which means that while they are running, the end
user is unable to interact with the form. 2. Queries that
automatically run when the form is opened execute sequentially, so
the total time it takes to query multiple data sources is the sum of
calling each individually.
InfoPath Forms Services workspace
This workspace provides an overview of InfoPath forms, which are
published to SharePoint sites. The following report and chart are included
in the workspace.
This workspace contains the following views:
Memory Usage
This bar chart shows the memory consumed by form templates
and forms, which are opened by user for filling the data.
InfoPath Forms Report
This report shows the status of InfoPath forms, which are open by
user for filling the data, in terms of memory used by forms,
session and transaction rate.

MOSS Search Navigator item


MOSS Search workspace
This workspace provides overview of the state of the crawling/indexing
activity and an overview of the performance of the Gatherer. The following
report and charts are included in the workspace.
This workspace contains the following views:
System IO Traffic Rate
This plot chart shows the disk traffic rate in megabytes per second
detected by back-off logic. Traffic rate indicates the load on the
server. High traffic rate can be seen when activities such as
crawling are performed.
Filtering Threads Status
This bar chart shows the status of the filtering threads, which is
useful at the time of crawling activity.
Active Queue Length
This bar chart shows the number of documents waiting to get
filtered by the filtering process. A low value indicates a healthy
server, which is able to process documents efficiently.
Search Gatherer Report
This report gives detailed information of the Search gatherer.
Office Search Archival Plugin Details workspace
This workspace provides overview of status of the Search Archival plugin,
which is an internal component of SharePoint.

22

Monitoring Agent for Microsoft SharePoint Server: Users Guide

This workspace contains the following views:


Active Documents
This bar chart shows the number of documents using the active
queues of Search Archival plug-in of SharePoint.
Total Documents
This bar chart shows the number of documents that have used the
active queues of Search Archival plug-in of SharePoint.
Documents Status
This bar chart shows the number of documents that were returned
with error, blocked, or retried by the archival plug-in. Error
Documents is a counter used to track documents whose metadata
failed to process in the plug-in.
Archival Plugin Report
This report gives detailed information of the Archival plug-in.
Office Search Gatherer Documents Status workspace
This workspace shows the current status of the documents with respect to
the filtering process. It is helpful in tracking the number of documents that
have been delayed and those that returned errors after filtering.
This workspace contains the following views:
Documents Filtered Status
This bar chart shows a comparative view of the documents
successfully filtered as opposed to the total crawled documents.
The values of both should be more or less equal, which indicates
successful crawling.
Documents Delayed Status
This bar chart shows the number of documents that were delayed
because of site hit frequency rules (Delayed Documents) and the
number of documents that would be retried after time-out
(Documents Delayed Retry).
Documents Filtered Unsuccessfully
This bar chart shows the percentage of documents that were not
filtered successfully. A high percentage indicates a problem with
the filtering process.
Office Search Gatherer Projects Details workspace
This workspace provides overview of the performance of the ongoing
crawling activity and helps to track the errors that may occur in the
process.
This workspace contains the following views:
Errors This bar chart shows all different types of errors received by the
gatherer for a crawl. A large number of errors indicates a problem
with the crawling of documents.
Crawls in Progress
This plot chart shows the number of content sources that are being
crawled currently. It shows the total time taken by the crawling
activity to complete.
Incremental Crawls in Progress
This plot chart shows the number of incremental crawls currently
in progress.

Chapter 3. Workspaces reference

23

Gatherer activity
This bar chart shows the number of documents that are currently
being crawled.
Office Search Gatherer Projects Documents Crawl Status workspace
This workspace shows the status of the crawling activity by displaying
how many documents were added, deleted, modified or renamed during
crawling. It also shows the number of successfully filtered documents.
This workspace contains the following views:
Documents Status
This bar chart shows the number of add, delete, modify and
move/rename notifications received by the server.
Processed Documents
This bar chart shows how many documents have been successfully
processed.
Office Search Gatherer Projects Documents Delayed Status workspace
This workspace shows the status of pending and filtered documents with
errors.
This workspace contains the following views:
Documents Filtered with Error
This bar chart shows the documents that returned error from the
filtering process of the SharePoint Search Service.
Pending Documents
This bar chart shows the number of documents that are waiting to
be processed. Waiting Documents indicates the total queue size of
unprocessed documents.
Office Search Gatherer Projects Documents Details workspace
This workspace gives overview of the status of crawling of documents, and
helps identify the errors and track the performance of the gatherer and
indexer. The following report and chart are included in the workspace.
This workspace contains the following views:
Documents Retries
This bar chart shows the total number of times a document access
has been retried. Having this number high may indicate a problem
with accessing the data.
Documents Status Report
This report shows the numerical values of the counters related to a
documents status from Sharepoint search gatherer projects
performance object.
Office Search Indexer Catalog Details workspace
This workspace provides health of Indexer catalogs in terms of Index size,
unique keys generated for entities of catalogs, which are searchable and
failed queries. The following report and charts are included in the
workspace.
This workspace contains the following views:
Disk Space Usage
This bar chart shows index size in megabytes. It shows the disk
space usage by indexer catalog.

24

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Percent Failed Queries


This bar chart shows the percent of failed queries.
Unique Keys Generated
This bar chart shows the number of unique keys generated. Unique
keys are the lists of IDs for the entities which are searchable.
Indexer Catalog Report
This report shows the progress of indexing process and health of
indexer catalog.
Office Search Indexer Catalog Merge Status workspace
This workspace provides progress of indexing process.
This workspace contains the following views:
Documents Filtered
This bar chart shows number of documents filtered.
Memory Usage
This bar chart shows the memory consumed by wordlists.
Wordlists are temporary, in-memory indexes used to cache data for
a small number of documents.
Merge Status
This bar chart shows the number of merges since the catalog was
loaded for different level of indexing process.
Office Search Schema Plugin Details workspace
This workspace provides overview of status of the Office Search Schema
plugin, which is an internal component of SharePoint. The following report
and charts are included in the workspace.
This workspace contains the following views:
Error Documents
This bar chart shows the number of documents that returned errors
from the plugin. A high value of this counter indicates a problem
with the Schema plugin component of SharePoint.
Documents Processed
This bar chart shows the total number of documents processed by
the Schema plugin.
Documents Processed Per Sec
This plot chart shows the rate of documents being processed by the
Schema plug-in of SharePoint.
Schema Plugin Report
This report detailed information of Schema plugin.
SharePoint Search Archival Plugin Details workspace
This workspace provides overview of status of the SharePoint Search
Archival plugin, which is an internal component of SharePoint.
This workspace contains the following views:
Active Documents
This bar chart shows the number of documents using the active
queues of Search Archival plug-in of SharePoint.
Total Documents
This bar chart shows the number of documents that have used the
active queues of Search Archival plug-in of SharePoint.
Chapter 3. Workspaces reference

25

Documents Status
This bar chart shows the number of documents that were returned
with error, blocked, or retried by the archival plug-in. Error
Documents is a counter used to track documents whose metadata
failed to process in the plug-in.
Archival Plugin Report
This report gives detailed information of the Archival plug-in.
SharePoint Search Gatherer Details workspace
This workspace provides overview of the state of the crawling/indexing
activity and an overview of the performance of the Gatherer. The following
report and charts are included in the workspace.
This workspace contains the following views:
System IO Traffic Rate
This plot chart shows the disk traffic rate in megabytes per second
detected by back-off logic. Traffic rate indicates the load on the
server. High traffic rate can be seen when activities such as
crawling are performed.
Filtering Threads Status
This bar chart shows the status of the filtering threads, which is
useful at the time of crawling activity. The threads may be idle,
accessing network, inside plug-ins or blocked when the gatherer
service backs off.
Active Queue Length
This bar chart shows the number of documents waiting to get
filtered by the filtering process. A low value indicates a healthy
server, which is able to process documents efficiently.
Search Gatherer Report
This report gives detailed information of the Search gatherer.
SharePoint Search Gatherer Documents Status workspace
This workspace shows the current status of the documents with respect to
the filtering process. It is helpful in tracking the number of documents that
have been delayed and those that returned errors after filtering.
This workspace contains the following views:
Documents Filtered Status
This bar chart shows a comparative view of the documents
successfully filtered as opposed to the total crawled documents.
The values of both should be more or less equal, which indicates
successful crawling.
Documents Delayed Status
This bar chart shows the number of documents that were delayed
because of site hit frequency rules (Delayed Documents) and the
number of documents that would be retried after time-out
(Documents Delayed Retry).
Documents Filtered Unsuccessfully
This bar chart shows the percentage of documents that were not
filtered successfully. A high percentage indicates a problem with
the filtering process.

26

Monitoring Agent for Microsoft SharePoint Server: Users Guide

SharePoint Search Gatherer Projects Details workspace


This workspace provides overview of the performance of the ongoing
crawling activity and helps to track the errors that may occur in the
process.
This workspace contains the following views:
Errors This bar chart shows all different types of errors received by the
Gatherer for a crawl. A large number of errors indicates a problem
with the crawling of documents.
Crawls in Progress
This plot chart shows the number of content sources that are being
crawled currently. It shows the total time taken by the crawling
activity to complete.
Incremental Crawls in Progress
This plot chart shows the number of incremental crawls currently
in progress.
Gatherer activity
This bar chart shows the number of documents that are currently
being crawled.
SharePoint Search Gatherer Projects Documents Crawl Status workspace
This workspace shows the status of the crawling activity by displaying
how many documents were added, deleted, modified or renamed during
crawling. It also shows the number of successfully filtered documents.
This workspace contains the following views:
Documents Status
This bar chart shows the number of add, delete, modify and
move/rename notifications received by the server.
Processed Documents
This bar chart shows how many documents have been successfully
processed.
SharePoint Search Gatherer Projects Documents Delayed Status workspace
This workspace shows the status of pending and filtered documents with
errors.
This workspace contains the following views:
Documents Filtered with Error
This bar chart shows the documents that returned error from the
filtering process of the SharePoint Search Service.
Pending Documents
This bar chart shows the number of documents that are waiting to
be processed. Waiting Documents indicates the total queue size of
unprocessed documents.
SharePoint Search Gatherer Projects Documents Details workspace
This workspace gives overview of the status of crawling of documents, and
helps identify the errors and track the performance of the gatherer and
indexer. The following report and chart are included in the workspace.
This workspace contains the following views:

Chapter 3. Workspaces reference

27

Documents Retries
This bar chart shows the total number of times a document access
has been retried. Having this number high may indicate a problem
with accessing the data.
Documents Status Report
This report shows the numerical values of the counters related to
documents status from Sharepoint search gatherer projects
performance object.
SharePoint Search Indexer Catalog Details workspace
This workspace provides health of Indexer catalogs in terms of Index size,
unique keys generated for entities of catalogs, which are searchable and
failed queries. The following report and charts are included in the
workspace.
This workspace contains the following views:
Disk Space Usage
This bar chart shows index size in megabytes. It shows the disk
space usage by indexer catalog.
Percent Failed Queries
This bar chart shows the percent of failed queries.
Unique Keys Generated
This bar chart shows the number of unique keys generated. Unique
keys are the lists of IDs for the entities which are searchable.
Indexer Catalog Report
This report shows the progress of indexing process and health of
indexer catalog.
SharePoint Search Indexer Catalog Merge Status workspace
This workspace provides progress of indexing process.
This workspace contains the following views:
Documents Filtered
This bar chart shows number of documents filtered.
Memory Usage
This bar chart shows the memory consumed by wordlists.
Wordlists are temporary, in-memory indexes used to cache data for
a small number of documents.
Merge Status
This bar chart shows the number of merges since the catalog was
loaded for different level of indexing process.
SharePoint Search Schema Plugin Details workspace
This workspace provides overview of status of the SharePoint Search
Schema plugin, which is an internal component of SharePoint. The
following report and charts are included in the workspace.
This workspace contains the following views:
Error Documents
This bar chart shows the number of documents that returned errors
from the plugin. A high value of this counter indicates a problem
with the Schema plugin component of SharePoint.

28

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Documents Processed
This bar chart shows the total number of documents processed by
the Schema plugin.
Documents Processed Per Sec
This plot chart shows the rate of documents being processed by the
Schema plug-in of SharePoint.
Schema Plugin Report
This report detailed information of Schema plugin.

MSPS Search Navigator item


MSPS Search workspace
This workspace provides overview of information about important
parameters with regards to the Search service, such as current connections
and threads that process search queries.
This workspace contains the following views:
Current Connections
This bar chart shows the number of connections that are currently
established between the Search service and its clients.
Threads Status
This bar chart shows the comparative view of threads that are
actually servicing queries and the total currently available threads
for servicing queries from the clients. This gives an idea of the
usage of the Search service by the users.
Search Archival Plugin Details workspace
This workspace provides an overview of status of the Search Archival
plugin, which is an internal component of SharePoint.
This workspace contains the following views:
Active Documents
This bar chart shows the number of documents using the active
queues of Search Archival plug-in of SharePoint.
Total Documents
This bar chart shows the number of documents that have used the
active queues of Search Archival plug-in of SharePoint.
Documents Status
This bar chart shows the number of documents that were returned
with error, blocked, or retried by the archival plug-in. Error
Documents is a counter used to track documents whose metadata
failed to process in the plug-in.
Archival Plugin Report
This report gives detailed information of the Archival plug-in.
Search Catalogs Details workspace
This workspace provides the health of Search catalogs in terms of catalog
size, unique keys generated for entities of catalogs which are searchable
and persistent indexes.
This workspace contains the following views:
Disk Space Usage
This bar chart shows catalog size in megabytes. It shows the disk
space usage by catalog.
Chapter 3. Workspaces reference

29

Persistent Indexes
This bar chart shows the number of persistent indexes. A persistent
index is a shadow index created by merging word lists and
sometimes other shadow indexes into a single index.
Unique Keys Generated
This bar chart shows the number of unique keys generated. Unique
keys are the lists of IDs for the entities which are searchable.
Search Catalogs Query Status workspace
This workspace provides the performance of queries posted to Search
Catalogs.
This workspace contains the following views:
Failed Queries Status
This bar chart shows the number of failed queries. If there is rise in
value of failed queries there will be performance issue in terms of
throughput. Throughput is defined as how many queries the
catalog can process per second.
Percent Failed Queries
This bar chart shows the percent of failed queries.
Failed Queries Per Sec
This plot chart shows the rate of queries failed. If there is rise in
value of failed queries per second there will be performance issue
in terms of throughput. Throughput is defined as how many
queries the catalog can process per second.
Query Report
This report shows performance of queries in terms of queries
posted to Search catalogs, failed queries and succeeded queries.
Search Gatherer Details workspace
This workspace provides overview of the state of the crawling and
indexing activities and an overview of the performance of the Gatherer.
The following report and charts are included in the workspace.
This workspace contains the following views:
System IO Traffic Rate
This plot chart shows the disk traffic rate in megabytes per second
detected by back-off logic. Traffic rate indicates the load on the
server. High traffic rate can be seen when activities such as
crawling are performed.
Filtering Threads Status
This bar chart shows the status of the filtering threads, which is
useful at the time of crawling activity. The threads may be idle,
accessing network, inside plug-ins or blocked when the gatherer
service backs off.
Active Queue Length
This bar chart shows the number of documents waiting to get
filtered by the filtering process. A low value indicates a healthy
server, which is able to process documents efficiently.
Gatherer Report
This report gives the detailed information of the Search gatherer.
Search Gatherer Documents Status workspace
This workspace shows the current status of the documents with respect to

30

Monitoring Agent for Microsoft SharePoint Server: Users Guide

the filtering process. It is helpful in tracking the number of documents that


have been delayed and those that returned errors after filtering.
This workspace contains the following views:
Documents Filtered Status
This bar chart shows a comparative view of the documents
successfully filtered as opposed to the total crawled documents.
The bars should be more or less equal in length, which indicates
successful crawling.
Documents Delayed Status
This bar chart shows the number of documents that were delayed
because of site hit frequency rules (Delayed Documents) and the
number of documents that would be retried after time-out
(Documents Delayed Retry).
Documents Filtered Unsuccessfully
This bar chart shows the percentage of documents that were not
filtered successfully. A high percentage indicates a problem with
the filtering process.
Search Gatherer Projects Adaptive Crawl Status workspace
This workspace provides overview of the adaptive crawl of SPS 2003. The
following graphs are included in the workspace.
This workspace contains the following views:
Adaptive crawl status
This bar chart shows the status of the adaptive crawl.
Incorrect Adaptive crawl behavior
This bar chart shows how many documents are incorrectly
accepted or rejected by adaptive crawl.
Search Gatherer Projects Details workspace
This workspace provides an overview of the performance of the ongoing
crawling activity and helps to track the errors that may occur in the
process.
This workspace contains the following views:
Errors This bar chart shows all different types of errors received by the
gatherer for a crawl. A large number of errors indicates a problem
with the crawling of documents.
Crawls in Progress
This plot chart shows the number of content sources that are being
crawled currently. It shows the total time taken by the crawling
activity to complete.
Incremental Crawls in Progress
This plot chart shows the number of incremental crawls currently
in progress.
Gatherer activity
This bar chart shows the number of documents that are currently
being crawled.
Search Gatherer Projects Documents Crawl Status workspace
This workspace shows the status of the crawling activity by displaying
how many documents were added, deleted, modified or renamed during
crawling. It also shows the number of successfully filtered documents.
Chapter 3. Workspaces reference

31

This workspace contains the following views:


Documents Status
This bar chart shows the number of add, delete, modify and
move/rename notifications received by the server.
Processed Documents
This bar chart shows how many documents have been successfully
processed.
Search Gatherer Projects Documents Delayed Status workspace
This workspace shows the status of the pending and filtered documents
with errors.
This workspace contains the following views:
Documents Filtered with Error
This bar chart shows the documents that returned error from the
filtering process of the SharePoint Search Service.
Pending Documents
This bar chart shows the number of documents that are waiting to
be processed. Waiting Documents indicates the total queue size of
unprocessed documents.
Search Gatherer Projects Documents Details workspace
This workspace gives overview of the status of crawling of documents, and
helps identify the errors and track the performance of the gatherer and
indexer. The following report and chart are included in the workspace.
This workspace contains the following views:
Documents Retries
This bar chart shows the total number of times a document access
has been retried. A high number indicates a problem with
accessing the data.
Documents Status Report
This report gives detailed information of Sharepoint Search
Gatherer Projects.
Search Indexer Catalogs Details workspace
This workspace provides the index size and progress of the indexing
process.
This workspace contains the following views:
Disk Space Usage
This bar chart shows index size in megabytes. It shows the disk
space used by index.
Resource Intensive Process
This bar chart shows the number of propagations in progress.
Unique Keys Generated
This bar chart shows the number of unique keys generated. Unique
keys are the lists of IDs for the entities which are searchable.
Search Indexer Catalogs Document Status workspace
This workspace provides information of filtered documents, documents in
progress, files to be filtered and number of documents.
This workspace contains the following views:

32

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Indexing Process Status


This bar chart shows the progress of indexing process in terms of
document filtered, documents in progress and files to be filtered.
Number of Documents
This bar chart shows the number of documents in Search Indexer
Catalogs.
Search Indexer Catalogs Status workspace
This workspace provides the progress of the indexing process.
This workspace contains the following views:
Wordlists
This bar chart shows the number of wordlists. Word lists are
temporary, in-memory indexes used to cache data for a small
number of documents.
Persistent Indexes
This bar chart shows the number of persistent indexes. A persistent
index is a shadow index created by merging word lists and
sometimes other shadow indexes into a single index.
Active Documents
This bar chart shows the number of documents currently active in
content index. The collection of the word lists, the persistent
indexes, and the master index is referred to as the content index.
Search Query Details workspace
This workspace helps to measure the efficiency of the Search service to
respond to user queries. The following report and charts are included in
the workspace.
This workspace contains the following views:
Failed Query Rate
This plot chart shows the rate of queries that have failed. It should
be low in value to indicate a healthy Search service.
Failed Queries
This bar chart shows the number of queries that have failed.
Percent Failed Queries
This plot chart shows the percent of failed queries.
Query Report
This report gives detailed information of search queries.
Search Schema Plugin Details workspace
This workspace provides an overview of the status of the Search Schema
plugin, which is an internal component of SharePoint. The following report
and charts are included in the workspace.
This workspace contains the following views:
Error Documents
This bar chart shows the number of documents that returned errors
from the plugin. A high value of this counter indicates a problem
with the Schema plugin component of SharePoint.
Documents Processed
This bar chart shows the total number of documents processed by
the Schema plugin.

Chapter 3. Workspaces reference

33

Documents Processed Per Sec


This plot chart shows the rate of documents being processed by the
Schema plug-in of SharePoint.
Schema Plugin Report
This report gives detailed information of Schema plugin.
Search Topic Assistant Details workspace
This workspace provides information about the performance of the Search
Topic Assistant. The Topic assistant is a component used to simplify the
process of categorizing and organizing documents. The following report
and charts are included in the workspace.
This workspace contains the following views:
Categories Found
This bar chart shows the number of keywords found by the
learning plug-in of topic assistant.
Documents Processed
This bar chart shows the total number of documents that have
been processed by the learning plug-in.
Keywords Found
This bar chart shows the number of categories found by the
learning plug-in of topic assistant.
Topic Assistant Report
This report gives detailed information of Search Topic Assistant.

Shared Service Provider Navigator item


Shared Service Provider workspace
This workspace provides an overview of the Shared Service Providers for
MOSS 2007. An SSP represents a set of services that can be configured a
single time and shared across many different MOSS portal sites and WSS
sites. The following report and chart are included in the workspace.
This workspace contains the following views:
Job Execution
This plot chart shows the rate of job execution of a SSP job using
the attribute SSP Job Execution Rate. This view shows the rate as a
cumulative value of all SSP instances. The higher the value of this
attribute the better the efficiency.
Shared Service Provider Report
This report gives status of the distribution lists, user profiles, sites,
job execution and data processing time for an SSP.
SSP Site Latency and Throughput workspace
This workspace shows the overview of SSP Site Latency and Throughput.
This workspace contains the following views:
Site Throughput
This plot chart displays the rate at which personal and public sites
are rendered. It shows the throughput rates as cumulative value of
all the SSP instances. A high throughput rate indicates faster
rendering of sites.
Site Latency
This bar chart shows the latencies of personal and public sites for a

34

Monitoring Agent for Microsoft SharePoint Server: Users Guide

given SSP. It shows the time taken for rendering a site. A high
value of latency indicates poor efficiency or SSP configuration
problems.
SSP User Profiles and Profile Synchronization workspace
This workspace provides an overview of the User Profiles and Profile
Synchronization process.
This workspace contains the following views:
User Profiles Import
This bar chart shows the number of user profiles imported during
profile import. It uses the Number of Users Imported attribute.
This counter can be used to check how many profiles have been
imported so far.
Profile Synchronization Status
This bar chart shows the details of Profile Synchronization process.

SharePoint Publishing Navigator item


SharePoint Publishing workspace
This workspace provides an overview of SharePoint Publishing Cache. The
following report and chart are included in the workspace.
This workspace contains the following views:
Cache Flushes Rate
This plot chart shows the rate at which the SharePoint user has
updated the cache due to site changes. A high value indicates a
high response time for the requested object.
Publishing Cache Report
This report gives the detail information about the SharePoint
Publishing Cache.
SharePoint Publishing Cache workspace
This workspace provides detailed information about the number of objects
added and discarded from cache and the number of times cache is
updated.
This workspace contains the following views:
Cache Objects
This bar chart shows the total number of objects that have ever
been added to the cache and the total number of items that have
been removed from the publishing cache due to cache compaction.
A high value of total discarded objects indicates more required
cache size.
Total Cache Flushes
This bar chart shows the total number of times cache is updated
due to site changes.
SharePoint Publishing Cache Hit Miss Status workspace
This workspace provides an overview of SharePoint Publishing Cache hit
miss count and cache hit miss ratio. The following report and chart are
included in the workspace.
This workspace contains the following views:

Chapter 3. Workspaces reference

35

Cache Hit Ratio


This bar chart shows the hits to misses on the publishing cache. A
high cache hit ratio indicates a quick response to end user.
Cache Hit and Miss Report
This report gives detailed information of SharePoint Publishing
Cache Hit Miss.

Web Server Navigator item


Web Server workspace
This workspace lists all the SharePoint sites that are hosted on IIS and their
properties. These properties include Site ID, Site Name, Port, SSL Port,
Name, and Host Name. Click the links that are available for each site to
get the data from the IIS agent.
This workspace contains the following view:
Web Server
This report shows the properties of all the SharePoint sites. These
properties include Site ID, Site Name, Port, SSL Port, Name, and
Host Name.

36

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Chapter 4. Attributes reference


This chapter contains an overview of attributes, references for detailed information
about attributes, and descriptions of the attributes for each attribute group
included in this monitoring agent.

About attributes
Attributes are the application properties being measured and reported by the
Monitoring Agent for Microsoft SharePoint Server.
Attributes are organized into groups according to their purpose. The attributes in a
group can be used in the following two ways:
v Chart or table views
Attributes are displayed in chart and table views. The chart and table views use
queries to specify which attribute values to request from a monitoring agent.
You use the Query editor to create a new query, modify an existing query, or
apply filters and set styles to define the content and appearance of a view based
on an existing query.
v Situations
You 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, the Tivoli Enterprise Portal compares the values
you have assigned to the situation attributes with the values collected by the
Monitoring Agent for Microsoft SharePoint Server and registers an event if the
condition is met. You are alerted to events by indicator icons that are displayed
in the Navigator.

More information about attributes


For more information about using attributes and attribute groups, see the IBM
Tivoli Monitoring Users Guide.
For a list of the attributes groups, a list of the attributes in each attribute group,
and descriptions of the attributes for this monitoring agent, see the Attribute
groups and attributes section in this chapter.

Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server
This monitoring agent contains the following attribute groups. The table name
depends on the maximum table name limits of the target database being used for
the Tivoli Data Warehouse. If the maximum name is 30 characters, then any
warehouse table name longer than 30 characters is shortened to the table name.
v Attribute group name: ASP NET Applications
Table name: KQPASPNET
Warehouse table name: KQP_ASP_NET_APPLICATIONS or KQPASPNET
v Attribute group name: Availability
Table name: KQPAVAIL
Warehouse table name: KQP_AVAILABILITY or KQPAVAIL
Copyright IBM Corp. 2008, 2009

37

v Attribute group name: Database


Table name: KQPSHAREP8
Warehouse table name: KQP_DATABASE or KQPSHAREP8
v Attribute group name: Document Conversions
Table name: KQPDOCUMEN
Warehouse table name: KQP_DOCUMENT_CONVERSIONS or
KQPDOCUMEN
v Attribute group name: Event Log
Table name: KQPEVTLOG
Warehouse table name: KQP_EVENT_LOG or KQPEVTLOG
v Attribute group name: Excel Calculation Services
Table name: KQPEXCELCA
Warehouse table name: KQP_EXCEL_CALCULATION_SERVICES or
KQPEXCELCA
v Attribute group name: Excel Services Web Front End
Table name: KQPEXCELSE
Warehouse table name: KQP_EXCEL_SERVICES_WEB_FRONT_END or
KQPEXCELSE
v Attribute group name: Excel Web Access
Table name: KQPEXCELWE
Warehouse table name: KQP_EXCEL_WEB_ACCESS or KQPEXCELWE
v Attribute group name: InfoPath Forms Services
Table name: KQPINFOPAT
Warehouse table name: KQP_INFOPATH_FORMS_SERVICES or
KQPINFOPAT
v Attribute group name: Office Search Archival Plugin
Table name: KQPOFFICE4
Warehouse table name: KQP_OFFICE_SEARCH_ARCHIVAL_PLUGIN or
KQPOFFICE4
v Attribute group name: Office Search Gatherer
Table name: KQPOFFICE5
Warehouse table name: KQP_OFFICE_SEARCH_GATHERER or KQPOFFICE5
v Attribute group name: Office Search Gatherer Projects
Table name: KQPOFFICE6
Warehouse table name: KQP_OFFICE_SEARCH_GATHERER_PROJECTS or
KQPOFFICE6
v Attribute group name: Office Search Indexer Catalogs
Table name: KQPOFFICE7
Warehouse table name: KQP_OFFICE_SEARCH_INDEXER_CATALOGS or
KQPOFFICE7
v Attribute group name: Office Search Schema Plugin
Table name: KQPOFFICE8
Warehouse table name: KQP_OFFICE_SEARCH_SCHEMA_PLUGIN or
KQPOFFICE8
v Attribute group name: Performance Object Status
Table name: KQPPOBJST

38

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Warehouse table name: KQP_PERFORMANCE_OBJECT_STATUS or


KQPPOBJST
v Attribute group name: Search
Table name: KQPSEARC0
Warehouse table name: KQP_SEARCH or KQPSEARC0
v Attribute group name: Search Archival Plugin
Table name: KQPSEARCHA
Warehouse table name: KQP_SEARCH_ARCHIVAL_PLUGIN or
KQPSEARCHA
v Attribute group name: Search Catalogs
Table name: KQPSEARCHC
Warehouse table name: KQP_SEARCH_CATALOGS or KQPSEARCHC
v Attribute group name: Search Gatherer
Table name: KQPSEARCHG
Warehouse table name: KQP_SEARCH_GATHERER or KQPSEARCHG
v Attribute group name: Search Gatherer Projects
Table name: KQPSEARCH0
Warehouse table name: KQP_SEARCH_GATHERER_PROJECTS or
KQPSEARCH0
v Attribute group name: Search Indexer Catalogs
Table name: KQPSEARCHI
Warehouse table name: KQP_SEARCH_INDEXER_CATALOGS or
KQPSEARCHI
v Attribute group name: Search Schema Plugin
Table name: KQPSEARCHS
Warehouse table name: KQP_SEARCH_SCHEMA_PLUGIN or KQPSEARCHS
v Attribute group name: Search Topic Assistant
Table name: KQPSEARCHT
Warehouse table name: KQP_SEARCH_TOPIC_ASSISTANT or KQPSEARCHT
v Attribute group name: Shared Service Provider
Table name: KQPSHAREDS
Warehouse table name: KQP_SHARED_SERVICE_PROVIDER or
KQPSHAREDS
v Attribute group name: SharePoint Components
Table name: KQPSPPVER
Warehouse table name: KQP_SHAREPOINT_COMPONENTS or KQPSPPVER
v Attribute group name: SP Publishing Cache
Table name: KQPSHAREP0
Warehouse table name: KQP_SP_PUBLISHING_CACHE or KQPSHAREP0
v Attribute group name: SP Search Archival Plugin
Table name: KQPSHARE10
Warehouse table name: KQP_SP_SEARCH_ARCHIVAL_PLUGIN or
KQPSHARE10
v Attribute group name: SP Search Gatherer
Table name: KQPSHAREP9
Warehouse table name: KQP_SP_SEARCH_GATHERER or KQPSHAREP9
Chapter 4. Attributes reference

39

v Attribute group name: SP Search Gatherer Projects


Table name: KQPSHARE11
Warehouse table name: KQP_SP_SEARCH_GATHERER_PROJECTS or
KQPSHARE11
v Attribute group name: SP Search Indexer Catalogs
Table name: KQPSHARE12
Warehouse table name: KQP_SP_SEARCH_INDEXER_CATALOGS or
KQPSHARE12
v Attribute group name: SP Search Schema Plugin
Table name: KQPSHARE13
Warehouse table name: KQP_SP_SEARCH_SCHEMA_PLUGIN or
KQPSHARE13
v Attribute group name: SPP Alerts Notification Service
Table name: KQPSHAREP1
Warehouse table name: KQP_SPP_ALERTS_NOTIFICATION_SERVICE or
KQPSHAREP1
v Attribute group name: SPP Server Alert Manager
Table name: KQPSHAREP2
Warehouse table name: KQP_SPP_SERVER_ALERT_MANAGER or
KQPSHAREP2
v Attribute group name: SPP Server Alerts Plugin
Table name: KQPSHAREP3
Warehouse table name: KQP_SPP_SERVER_ALERTS_PLUGIN or
KQPSHAREP3
v Attribute group name: Web Server
Table name: KQPWEBSERV
Warehouse table name: KQP_WEB_SERVER or KQPWEBSERV
The remaining sections of this chapter contain descriptions of these attribute
groups, which are listed alphabetically. The following information is provided for
each attribute group:
Historical group
Whether the attribute group is a historical type that you can roll off to a
data warehouse
Attribute descriptions
Description and type for each attribute in the attribute group
Some attributes are designated as key attributes. A key attribute is an
attribute that is used in warehouse aggregation to identify rows of data
that represent the same object.

ASP NET Applications attribute group


This attribute group displays the server bindings for the SharePoint sites that are
running on Microsoft IIS Server. This data is used for cross linkages with .Net
agent. If the warehouse default setting is enabled, data for this attribute group is
not stored in Tivoli Data Warehouse.

40

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Historical group
This attribute group is not part of the default historical group, and is eligible for
use with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the ASP NET
Applications attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Site ID attribute
Description
Shows the Site ID as a worker process and an identifier.
Type

String

Site Name attribute - This attribute is a key attribute.


Description
Shows the name of the Web site.
Type

String

Port attribute
Description
Shows the port on which the site is running.
Type

String

SSL Port attribute


Description
Shows the SSL port (if any).
Type

String

Name attribute
Description
Shows the instance name of the site in the following format:
_LM_WorkerProcess_Identifier_Root.
Type

String

Host Name attribute


Description
Shows name of the IIS server on which the site is hosted.
Type

String

Chapter 4. Attributes reference

41

Availability attribute group


The Availability attribute group contains the availability data for all processes and
services that make up this application. If the warehouse default setting is enabled,
data for this attribute group is stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Availability
attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Application Component attribute - This attribute is a key attribute.


Description
The descriptive name of a part of the application.
Type

String

Name attribute
Description
The name of the process, service, or functionality test. This name
matches the executable name of the process, the service short name
or the name of the process used to test the application.
Type

String with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v N/A (N/A)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Status attribute
Description
The status of the application component.
v For processes UP, DOWN, WARNING, or
PROCESS_DATA_NOT_AVAILABLE:
PROCESS_DATA_NOT_AVAILABLE is displayed for a process
when the matching process is running but the resource use
information cannot be collected for that process.
v For services UP, DOWN, or UNKNOWN: UNKNOWN is
displayed when the service is not installed.

42

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v For functionality tests: PASSED or FAILED is displayed.


Type

Integer with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v DOWN (0)
v UP (1)
v WARNING (2)
v UNKNOWN (3)
v PASSED (4)
v FAILED (5)
v PROCESS_DATA_NOT_AVAILABLE (6)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Full Name attribute


Description
The full name of the process including the path.
Type

String with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v N/A (N/A)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Type attribute
Description
The type of the application component. Components are processes,
services, or functionality tests.
Type

Integer with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v PROCESS (0)
v SERVICE (1)
v FUNCTIONALITY_TEST (2)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Virtual Size attribute


Description
The virtual size (in MB) of the process.
Type

Integer (Gauge)

Page Faults per Sec attribute


Description
The rate of page faults for the process measured in faults per
second. This attribute only contains valid data for processes.
Type

Integer (Gauge)

Working Set Size attribute


Chapter 4. Attributes reference

43

Description
The working set size of the process in MB. This attribute only
contains valid data for processes.
Type

Integer (Gauge)

Thread Count attribute


Description
The number of threads currently allocated by this process. This
attribute only contains valid data for processes.
Type

Integer (Gauge)

PID attribute
Description
The process ID associated with the process. This attribute only
contains valid data for processes.
Type

Integer (Gauge)

Percent Privileged Time attribute


Description
The percentage of the available CPU time that is being used by this
process for privileged operation.
Type

Integer (Gauge)

Percent User Mode Time attribute


Description
The percentage of the available CPU time that is being used by this
process for user mode operation.
Type

Integer (Gauge)

Percent Processor Time attribute


Description
The percentage of the elapsed time that this process used the
processor to execute instructions.
Type

Integer (Gauge)

Command Line attribute


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

String with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v N/A (N/A)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Functionality Test Status attribute


Description
The return code of the functionality test. When the monitored
application is running correctly, SUCCESS is displayed.

44

Monitoring Agent for Microsoft SharePoint Server: Users Guide

NOT_RUNNING is displayed when it is not running correctly.


N/A is displayed when the row does not represent a
functionality test.
Type

Integer with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v
v
v
v
v
v

SUCCESS (0)
N/A (1)
GENERAL_ERROR (2)
WARNING (3)
NOT_RUNNING (4)
DEPENDENT_NOT_RUNNING (5)

v ALREADY_RUNNING (6)
v PREREQ_NOT_RUNNING (7)
v
v
v
v
v

TIMED_OUT (8)
DOESNT_EXIST (9)
UNKNOWN (10)
DEPENDENT_STILL_RUNNING (11)
INSUFFICIENT_USER_AUTHORITY (12)

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Functionality Test Message attribute
Description
The text message that corresponds to the Functionality Test Status.
This is only valid for functionality tests.
Type

String with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v N/A (N/A)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Database attribute group


SharePoint DB Information found on the managed node. This includes SharePoint
Database, database type, machine name on which SQL server is installed,
SharePoint version, and SQL Server instance. If the warehouse default setting is
enabled, data for this attribute group is stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Database
attribute group:
Node attribute - This attribute is a key attribute.
Chapter 4. Attributes reference

45

Description
The managed system name of the agent.
Type

String

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

String

HostName attribute
Description
Shows the SQL database machine name used by SharePoint Server.
Type

String

Databases attribute
Description
Shows the name of SharePoint Databases.
Type

String

Database Type attribute


Description
Shows all types of SharePoint Databases like Configuration,
Content, Search and SSP.
Type

String

Instance Name attribute


Description
Shows the SQL Server instance name used by SharePoint Server.
Type

String

Version Name attribute


Description
Shows the SharePoint version installed.
Type

String

Document Conversions attribute group


This attribute group monitors document conversions activity; it is available for
MOSS 2007. If the warehouse default setting is enabled, data for this attribute
group is stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Document
Conversions attribute group:
Node attribute - This attribute is a key attribute.

46

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
The managed system name of the agent.
Type

String

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

String

Incoming E Mail Messages Processed attribute


Description
Shows the rate at which e-mail messages have been received and
processed by the SharePoint Server.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Pending Conversions attribute


Description
Shows the number of pending document conversions.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Event Log attribute group


The Event Log attribute group contains any event log entries that pertain to this
application. If the warehouse default setting is enabled, data for this attribute
group is stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Event Log
attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Chapter 4. Attributes reference

47

Type

String

Log Name attribute


Description
The name of the event log - Application, System, Security or an
application-specific log
Type

String

Event Source attribute


Description
The event source defined by the application
Type

String

Event Type attribute


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

Integer with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v Error (0)
v Warning (1)
v Informational (2)
v Audit_Success (3)
v Audit_Failure (4)
v Unknown (5)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Event ID attribute
Description
The ID of the event
Type

Integer (Counter)

Event Category attribute


Description
The Category of the event
Type

String with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v None (None)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Message attribute
Description
The event message
Type

String

Time Generated attribute

48

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
The time the event was generated
Type

Timestamp

Excel Calculation Services attribute group


This attribute group monitors Excel Calculation Services; it is available for MOSS
2007. If the warehouse default setting is enabled, data for this attribute group is
stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Excel
Calculation Services attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Active Requests attribute


Description
Shows total number of active requests being processed by Excel
Calculation Services at sampling time.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Active Sessions attribute


Description
Shows number of active sessions by Excel Calculation Services at
sampling time.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Chapter 4. Attributes reference

49

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Average Request Processing Time attribute
Description
Shows average processing time for a request by Excel Calculation
Services between sampling times.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Average Session Time attribute


Description
Shows average Session time(User interaction time with workbook)
between the last two samples in seconds.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Cached Charts Requested Per Sec attribute


Description
Shows number of charts that are provided by a cached image.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Rendered Charts Requested Per Sec attribute


Description
Shows number of charts that are requested per second by Excel
calculation services, out of those rendered.
Type

50

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Requests Received Per Sec attribute
Description
Shows number of requests received per second by Excel
Calculation Services between sampling times.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Requests with Errors Per Sec attribute


Description
Shows number of requests that are returned with errors per second
by Excel Calculation Services between sampling times.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Sessions Per Sec attribute


Description
Shows average number of sessions opened per second between the
last two samples.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Unused Items Manager in MB attribute


Description
Shows total size of unused items manager in MB.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
Chapter 4. Attributes reference

51

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Workbook Cache Size in MB attribute
Description
Shows total size of Excel Calculation Services workbook cache in
MB.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Excel Services Web Front End attribute group


This attribute group monitors Excel Services Web Front End; it is available for
MOSS 2007. If the warehouse default setting is enabled, data for this attribute
group is stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Excel Services
Web Front End attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Active Requests attribute


Description
Shows total number of active requests which are being processed
at sampling time.
Type

52

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Average Request Processing Time attribute
Description
Shows average request processing time between sampling period.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Requests Per Sec attribute


Description
Shows total number of requests per second at sampling time.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Excel Web Access attribute group


This attribute group monitors Excel Web Access; it is available for MOSS 2007. If
the warehouse default setting is enabled, data for this attribute group is not stored
in Tivoli Data Warehouse.

Historical group
This attribute group is not part of the default historical group, and is eligible for
use with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Excel Web
Access attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

Timestamp attribute

Chapter 4. Attributes reference

53

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

String

Average Chart Image Request Time attribute


Description
Shows the average time it takes between the request for a chart
image and the issuance of the response, to the web browser by
excel web access.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Chart Image Requests Per Sec attribute


Description
Shows the number of requests for chart images served by excel
web access per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Excel Web Access Request Time attribute


Description
Shows the excel web access average request time between the last
two samples.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

InfoPath Forms Services attribute group


This attribute group monitors InfoPath Forms Services; it is available for MOSS
2007. If the warehouse default setting is enabled, data for this attribute group is
stored in Tivoli Data Warehouse.

54

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the InfoPath Forms
Services attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Business Logic Assemblies in Memory attribute


Description
Shows the number of business logic assemblies currently loaded in
memory.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Cached Form Templates attribute


Description
Shows the number of form templates that have been added to, and
not yet expired out of, the ASP.NET object cache.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Forms in Memory attribute


Description
Shows the number of forms that are currently loaded in memory.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Chapter 4. Attributes reference

55

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Form Templates in Memory attribute
Description
Shows the number of form template objects that are currently
loaded in memory.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Average Data Adapter Query Duration attribute


Description
Shows average time to complete a data connection query in form
filling sessions.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Average Data Connection Submit Duration attribute


Description
Shows average time to complete a data connection submit in form
filling sessions.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Average Session Duration attribute


Description
Shows average time to complete a form filling session, summed up
over all transactions in the session.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

56

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Average Transaction Duration attribute


Description
Shows average time to complete a transaction in form filling
sessions.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Data Connection Query Completed Rate attribute


Description
Shows the rate at which data connection queries completed in form
filling sessions.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Data Connection Query Failure Rate attribute


Description
Shows the rate of failures for data connection queries in form
filling sessions.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Data Connection Query Started Rate attribute


Description
Shows the rate at which data connection queries started in form
filling sessions.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Chapter 4. Attributes reference

57

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Data Connection Submit Completed Rate attribute
Description
Shows the rate at which data connection submits completed in
form filling sessions.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Data Connection Submit Failure Rate attribute


Description
Shows the rate of failures for data connection submits in form
filling sessions.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Data Connection Submit Started Rate attribute


Description
Shows the rate at which data connection submits started in form
filling sessions.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Session Completed Rate attribute


Description
Shows the rate at which form filling sessions completed.
Type

58

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Session Started Rate attribute
Description
Shows the rate at which form filling sessions started.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Transactions Completed Rate attribute


Description
Shows the rate at which transactions completed in form filling
sessions.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Transactions Started Rate attribute


Description
Shows the rate at which transactions started in form filling
sessions.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

Chapter 4. Attributes reference

59

Office Search Archival Plugin attribute group


This attribute group monitors Office Server Search Archival Plugin (internal
component of Search Engine); it is available for MOSS 2007. If the warehouse
default setting is enabled, data for this attribute group is not stored in Tivoli Data
Warehouse.

Historical group
This attribute group is not part of the default historical group, and is eligible for
use with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Office Search
Archival Plugin attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Active Documents in First Queue attribute


Description
Shows the number of documents actively using the first queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Active Documents in Second Queue attribute


Description
Shows the number of documents actively using the second queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Active Queue attribute


Description
Shows currently active queue.

60

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Blocked Documents attribute


Description
Shows the number of documents waiting for a queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Bulk Insert Sessions attribute


Description
Shows the number of active bulk insert sessions to the database
server.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Error Documents attribute


Description
Shows the number of documents which returned errors from the
plugin.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Retried Documents attribute


Description
Shows the number of documents which were marked for retry
from the plugin.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
Chapter 4. Attributes reference

61

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Total Documents in First Queue attribute
Description
Shows the total number of documents which have used the first
queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents in Second Queue attribute


Description
Shows the total number of documents which have used the second
queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents attribute


Description
Shows the number of documents processed.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

62

String

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Office Search Gatherer attribute group


This attribute group monitors Office Server Search Gatherer; it is available for
MOSS 2007. If the warehouse default setting is enabled, data for this attribute
group is stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Office Search
Gatherer attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Accessing Robots Text File attribute


Description
Shows the number of current requests for robots.txt, robots.txt is
requested by the SharePoint system implicitly, for every web site,
through HTTP.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Active Queue Length attribute


Description
Shows the number of documents waiting for robot threads.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Admin Clients attribute

Chapter 4. Attributes reference

63

Description
Shows the number of currently connected administrative clients.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

All Notifications Received attribute


Description
Shows the total number of notifications received from all
notification sources including file system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Delayed Documents attribute


Description
Shows the total number of documents delayed due to site hit
frequency rules.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Entries attribute


Description
Shows the number of document entries currently in memory.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Delayed Retry attribute


Description
Shows the number of documents that will be retried after timeout.
Type

64

Integer (Gauge) with enumerated values. The strings are displayed

Monitoring Agent for Microsoft SharePoint Server: Users Guide

in the Tivoli Enterprise Portal. The warehouse and queries return


the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Total Documents Filtered attribute
Description
Shows the number of times a filter object was created.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Filtered Rate attribute


Description
Shows the number of documents filtered per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Successfully Filtered attribute


Description
Shows the number of documents successfully filtered.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Successfully Filtered Rate attribute


Description
Shows the number of successfully filtered documents per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
Chapter 4. Attributes reference

65

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
External Notifications Rate attribute
Description
Shows the rate of external notifications received per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

External Notifications Received attribute


Description
Shows the total number of notifications received from all
notification sources excluding file system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtering Threads attribute


Description
Shows the total number of filtering threads in the system,
calculated based on system resources.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filter Objects attribute


Description
Shows the number of filter objects in the system.
Type

66

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Filter Process Created attribute
Description
Shows the total number of times a filter process was created or
restarted.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filter Processes attribute


Description
Shows the number of filtering processes in the system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filter Processes Max attribute


Description
Shows the maximum number of filtering processes that have
existed in the system since startup.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Heartbeats attribute
Description
Shows the total number of heartbeats counted since startup.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Chapter 4. Attributes reference

67

Idle Threads attribute


Description
Shows the number of threads waiting for documents.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Notification Sources attribute


Description
Shows currently connected external notification sources.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Notifications Rate attribute


Description
Shows the rate of external notifications received per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Performance Level attribute


Description
Shows the level of the amount of system resources that the
Gatherer service is allowed to use.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Reason to Back Off attribute

68

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the code describing why the Gatherer service went into
back off state.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Robots Text Requests attribute


Description
Shows the total number of requests for robots.txt.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Server Objects attribute


Description
Shows the number of servers recently accessed by the system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Server Objects Created attribute


Description
Shows the number of times a new server object had to be created.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Servers Currently Unavailable attribute


Description
Shows a server that becomes unavailable when a number of
requests to that server time out.
Type

Integer (Gauge) with enumerated values. The strings are displayed


Chapter 4. Attributes reference

69

in the Tivoli Enterprise Portal. The warehouse and queries return


the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Servers Unavailable attribute
Description
Shows a server that becomes unavailable when a number of
requests to that server time out.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Stemmers Cached attribute


Description
Shows the number of available cached stemmer instances.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Threads Accessing Network attribute


Description
Shows the number of available filtering threads that are currently
accessing the network.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Threads Blocked due to Back Off attribute


Description
Shows the number of threads blocked due to back-off event.
Type

70

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Threads in Plugins attribute
Description
Shows the number of threads waiting for Plugins to complete an
operation.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Time Outs attribute


Description
Shows the total number of timeouts detected by the system since
startup.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Word Breakers Cached attribute


Description
Shows the number of available cached word breakers instances.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

System IO Traffic Rate in MB attribute


Description
Shows the system IO disk traffic rate in megabytes per second
detected by back-off logic.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Chapter 4. Attributes reference

71

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Back Off Reason attribute
Description
Shows the reason for why the Gatherer service went into back-off
state.
Type

Integer with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v Up and running (0)
v High system IO traffic (1)
v High notifications rate (2)
v Delayed recovery in progress (3)
v
v
v
v

User activity (4)


Battery Low (5)
Memory Low (6)
Some internal reason (forced by Search itself) (99)

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Percent Documents Filtered Unsuccessfully attribute
Description
Shows the percentage of total documents which returned error
from filtering process.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Office Search Gatherer Projects attribute group


This attribute group monitors Office Server Search Gatherer Projects; it is available
for MOSS 2007. If the warehouse default setting is enabled, data for this attribute
group is stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Office Search
Gatherer Projects attribute group:
Node attribute - This attribute is a key attribute.

72

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
The managed system name of the agent.
Type

String

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

String

Accessed File Rate attribute


Description
Shows the number of documents accessed via file system per
second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Accessed Files attribute


Description
Shows the number of documents accessed via file system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Accessed HTTP attribute


Description
Shows the number of documents accessed via HTTP.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Accessed HTTP Rate attribute


Description
Shows the number of documents accessed via HTTP per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli

Chapter 4. Attributes reference

73

Enterprise Portal. The warehouse and queries return the values


shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Adaptive Crawl Accepts attribute
Description
Shows the documents accepted by adaptive crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Errors attribute


Description
Shows the documents incorrectly rejected by adaptive crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Error Samples attribute


Description
Shows the documents accessed for error sampling.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Excludes attribute


Description
Shows the documents excluded by adaptive crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

74

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Adaptive Crawl False Positives attribute
Description
Shows the documents incorrectly accepted by adaptive crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Total attribute


Description
Shows the documents to which adaptive crawl logic was applied.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Changed Documents attribute


Description
Shows the documents which have changed since the last crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Crawls in Progress attribute


Description
Shows the number of crawls in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Delayed Documents attribute

Chapter 4. Attributes reference

75

Description
Shows the number of documents delayed due to site hit frequency
rules.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Additions attribute


Description
Shows the number of add notifications.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Add Rate attribute


Description
Shows the number of document additions per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Delete Rate attribute


Description
Shows the number of document deletes per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Deletes attribute


Description
Shows the number of delete notifications.

76

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Modifies attribute


Description
Shows the number of modify notifications.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Modifies Rate attribute


Description
Shows the number of modify notifications per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Move and Rename Rate attribute


Description
Shows the number of document Moves and Renames per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Moves or Renames attribute


Description
Shows the number of Move or Rename notifications.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
Chapter 4. Attributes reference

77

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Documents in Progress attribute
Description
Shows the number of documents in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents on Hold attribute


Description
Shows the number of documents on hold because a document with
the same URL is currently in process.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Error Rate attribute


Description
Shows the number of filtered documents which returned an error
per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

File Errors attribute


Description
Shows the number of file protocol errors received while getting
documents.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

78

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
File Errors Rate attribute
Description
Shows the number of file protocol errors received per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered HTML attribute


Description
Shows the number of HTML documents filtered.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered HTML Rate attribute


Description
Shows the number of HTML documents filtered per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered Office attribute


Description
Shows the number of office documents filtered.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered Office Rate attribute


Chapter 4. Attributes reference

79

Description
Shows the number of office documents filtered per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered Text attribute


Description
Shows the number of text documents filtered.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered Text Rate attribute


Description
Shows the number of text documents filtered per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtering Documents attribute


Description
Shows the number of documents currently being filtered.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Gatherer Paused Flag attribute


Description
Shows if the Gatherer has been paused.
Type

80

Integer (Gauge) with enumerated values. The strings are displayed

Monitoring Agent for Microsoft SharePoint Server: Users Guide

in the Tivoli Enterprise Portal. The warehouse and queries return


the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
History Recovery Progress attribute
Description
Shows percentage of the history recovery completed.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

HTTP Errors attribute


Description
Shows the number of HTTP errors received.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

HTTP Errors Rate attribute


Description
Shows the number of HTTP errors received per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Incremental Crawls attribute


Description
Shows the number of incremental crawls in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Chapter 4. Attributes reference

81

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Iterating History in Progress Flag attribute
Description
Shows if the Gatherer is currently iterating over the URL history.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Not Modified Documents attribute


Description
Shows the number of documents which were not filtered because
no modification was detected since the last crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Processed Documents attribute


Description
Shows the number of documents processed since the history has
been reset.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Processed Documents Rate attribute


Description
Shows the number of documents processed per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

82

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Recovery in Progress Flag attribute


Description
Shows if recovery is currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Retries attribute
Description
Shows the total number of times a document access has been
retried.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Retries Rate attribute


Description
Shows the number of retries per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Started Documents attribute


Description
Shows the number of documents initiated into the Gatherer
service, it includes the number of documents on hold, in the active
queue, and currently filtered.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Filtered with Error attribute


Chapter 4. Attributes reference

83

Description
Shows the number of filtered documents which returned an error.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Successfully Filtered Documents attribute


Description
Shows the number of successfully filtered documents.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Success Rate attribute


Description
Shows the number of successfully filtered documents per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Unique Documents attribute


Description
Shows the number of unique documents in the system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

URLs in History attribute


Description
Shows the number of files URLs in the history list, it indicates the
total size of document corpus that was indexed.

84

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Waiting Documents attribute


Description
Shows the number of documents waiting to be processed.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

Office Search Indexer Catalogs attribute group


This attribute group monitors Office Server Search Indexer Catalog; it is available
for MOSS 2007. If the warehouse default setting is enabled, data for this attribute
group is stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Office Search
Indexer Catalogs attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Active Connections attribute

Chapter 4. Attributes reference

85

Description
Shows the active connections.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Filtered attribute


Description
Shows the number of documents filtered since the catalog was
mounted.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Index Size attribute


Description
Shows the current size of Index data in megabytes.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L0 Indexes Wordlists attribute


Description
Shows the number of L0 Indexes (wordlists). Wordlists are
temporary in-memory indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L0 Merge Flush Count attribute

86

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the number of L0 merges (flushes) since the catalog was
loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L0 Merge Flush Speed Average attribute


Description
Shows the average speed of L0 merges (flushes) since the catalog
was loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L0 Merge Flush Speed Last attribute


Description
Shows the speed of the most recent L0 merge (flush) in documents
per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L0 Merges Flushes Now attribute


Description
Shows the number of L0 merges (flushes) currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L1 Merge Count attribute


Description
Shows the number of L1 merges since the catalog was loaded.

Chapter 4. Attributes reference

87

Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L1 Merges Now attribute


Description
Shows the number of L1 merges currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L1 Merge Speed Average attribute


Description
Shows the average speed of L1 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L1 Merge Speed Last attribute


Description
Shows the speed of the most recent L1 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L2 Merge Count attribute


Description
Shows the number of L2 merges since the catalog was loaded.
Type

88

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
L2 Merges Now attribute
Description
Shows the number of L2 merges currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L2 Merge Speed Average attribute


Description
Shows the average speed of L2 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L2 Merge Speed Last attribute


Description
Shows the speed of the most recent L2 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L3 Merge Count attribute


Description
Shows the number of L3 merges since the catalog was loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Chapter 4. Attributes reference

89

L3 Merges Now attribute


Description
Shows the number of L3 merges currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L3 Merge Speed Average attribute


Description
Shows the average speed of L3 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L3 Merge Speed Last attribute


Description
Shows the speed of the most recent L3 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L4 Merge Count attribute


Description
Shows the number of L4 merges since the catalog was loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L4 Merges Now attribute


Description
Shows the number of L4 merges currently in progress.

90

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L4 Merge Speed Average attribute


Description
Shows the average speed of L4 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L4 Merge Speed Last attribute


Description
Shows the speed of the most recent L4 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L5 Merge Count attribute


Description
Shows the number of L5 merges since the catalog was loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L5 Merges Now attribute


Description
Shows the number of L5 merges currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
Chapter 4. Attributes reference

91

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
L5 Merge Speed Average attribute
Description
Shows the average speed of L5 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L5 Merge Speed Last attribute


Description
Shows the speed of the most recent L5 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L6 Merge Count attribute


Description
Shows the number of L6 merges since the catalog was loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L6 Merges Now attribute


Description
Shows the number of L6 merges currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

92

Monitoring Agent for Microsoft SharePoint Server: Users Guide

L6 Merge Speed Average attribute


Description
Shows the average speed of L6 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L6 Merge Speed Last attribute


Description
Shows the speed of the most recent L6 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L7 Merge Count attribute


Description
Shows the number of L7 merges since the catalog was loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L7 Merges Now attribute


Description
Shows the number of L7 merges currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L7 Merge Speed Average attribute

Chapter 4. Attributes reference

93

Description
Shows the average speed of L7 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L7 Merge Speed Last attribute


Description
Shows the speed of the most recent L7 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L8 Merge Count attribute


Description
Shows the number of L8 merges since the catalog was loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L8 Merges Now attribute


Description
Shows the number of L8 merges currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L8 Merge Speed Average attribute


Description
Shows the average speed of L8 merges since the catalog was
loaded in documents per hour.

94

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L8 Merge Speed Last attribute


Description
Shows the speed of the most recent L8 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Master Index Level attribute


Description
Shows the level of the master index.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Master Merge Progress attribute


Description
Shows master merge progress, merging is time intensive and Disk
I/O intensive process.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Master Merges Now attribute


Description
Shows whether a master merge in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
Chapter 4. Attributes reference

95

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Master Merges To Date attribute
Description
Shows the number of master merges to date.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Out of Date Document ID Files attribute


Description
Shows number of document ID files with outstanding work items.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes attribute


Description
Shows number of persistent indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L1 attribute


Description
Shows the number of L1 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L2 attribute

96

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the number of L2 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L3 attribute


Description
Shows the number of L3 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L4 attribute


Description
Shows the number of L4 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L5 attribute


Description
Shows the number of L5 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L6 attribute


Description
Shows the number of L6 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
Chapter 4. Attributes reference

97

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Persistent Indexes L7 attribute
Description
Shows the number of L7 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L8 attribute


Description
Shows the number of L8 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Queries attribute
Description
Shows the cumulative number of queries posted to the server.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Queries Failed attribute


Description
Shows the number of queries failed.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Queries Succeeded attribute

98

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the number of queries succeeded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Shadow Merge Levels attribute


Description
Shows the shadow merge levels.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Shadow Merge Levels Threshold attribute


Description
Shows the shadow merge levels threshold.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Unique Keys attribute


Description
Shows the number of unique keys.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Up to Date Document ID Files attribute


Description
Shows the number of document ID files with no outstanding work
items.
Type

Integer (Gauge) with enumerated values. The strings are displayed


Chapter 4. Attributes reference

99

in the Tivoli Enterprise Portal. The warehouse and queries return


the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Work Items Created attribute
Description
Shows the number of work items created for updating indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Work Items Deleted attribute


Description
Shows the number of work items completed for updating indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Percent of Failed Queries attribute


Description
Shows the percent of failed queries.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

100

String

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Office Search Schema Plugin attribute group


This attribute group monitors Office Server Search Schema Plugin (internal
component of Search Engine); it is available for MOSS 2007. If the warehouse
default setting is enabled, data for this attribute group is not stored in Tivoli Data
Warehouse.

Historical group
This attribute group is not part of the default historical group, and is eligible for
use with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Office Search
Schema Plugin attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Aliases Loaded attribute


Description
Shows the total number of aliases currently loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Aliases Mapped attribute


Description
Shows the total number of aliases which have been mapped.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Duplicate Aliases attribute


Description
Shows the number of aliases ignored since they are duplicates.
Chapter 4. Attributes reference

101

Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Error Documents attribute


Description
Shows the number of documents which returned errors from the
plugin.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Refresh Count attribute


Description
Shows the number of aliases refreshes done from the database.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents Processed attribute


Description
Shows the number of documents processed.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Properties Processed attribute


Description
Shows the number of properties processed by the plugin.
Type

102

Integer (Counter) with enumerated values. The strings are

Monitoring Agent for Microsoft SharePoint Server: Users Guide

displayed in the Tivoli Enterprise Portal. The warehouse and


queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Documents Processed Per Sec attribute
Description
Shows the number of documents processed per second.
Type

Real number (rate of change between successive values) with 2


decimal places of precision with enumerated values. The strings
are displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

Performance Object Status attribute group


The Performance Object Status attribute group contains information that reflects
the status of other attribute groups so you can see the status of all of the
performance objects that make up this application all at once. Each of these other
performance attribute groups is represented by a row in this table (or other type of
view). The status for an attribute group reflects the result of the last attempt to
collect data for that attribute group, which allows you to see whether the agent is
performing correctly. Unlike other attribute groups, the Performance Object Status
attribute group does not reflect the state of the monitored application. This
attribute group is most often used to determine why data is not available for one
of the performance attribute groups. If the warehouse default setting is enabled,
data for this attribute group is stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Performance
Object Status attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Chapter 4. Attributes reference

103

Type

String

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

String

Query Name attribute - This attribute is a key attribute.


Description
The name of the attribute group.
Type

String

Object Name attribute


Description
The name of the performance object.
Type

String

Object Type attribute


Description
The type of the performance object.
Type

Integer with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v WMI (0)
v PERFMON (1)
v WMI_ASSOCIATION_GROUP (2)
v JMX (3)
v SNMP (4)
v SHELL_COMMAND (5)
v JOINED_GROUPS (6)
v
v
v
v
v

CIMOM (7)
CUSTOM (8)
ROLLUP_DATA (9)
WMI_REMOTE_DATA (10)
LOG_FILE (11)

v JDBC (12)
v CONFIG_DISCOVERY (13)
v
v
v
v
v
v

NT_EVENT_LOG (14)
FILTER (15)
SNMP_EVENT (16)
PING (17)
DIRECTOR_DATA (18)
DIRECTOR_EVENT (19)

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Object Status attribute

104

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
The status of the performance object.
Type

Integer with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v ACTIVE (0)
v INACTIVE (1)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Error Code attribute


Description
The error code associated with the query
Type

Integer with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v NO_ERROR (0)
v GENERAL_ERROR (1)
v OBJECT_NOT_FOUND (2)
v COUNTER_NOT_FOUND (3)
v NAMESPACE_ERROR (4)
v OBJECT_CURRENTLY_UNAVAILABLE (5)
v COM_LIBRARY_INIT_FAILURE (6)
v SECURITY_INIT_FAILURE (7)
v PROXY_SECURITY_FAILURE (9)
v
v
v
v

NO_INSTANCES_RETURNED (10)
ASSOCIATOR_QUERY_FAILED (11)
REFERENCE_QUERY_FAILED (12)
NO_RESPONSE_RECEIVED (13)

v CANNOT_FIND_JOINED_QUERY (14)
v CANNOT_FIND_JOIN_ATTRIBUTE_IN_QUERY_1_RESULTS
(15)
v CANNOT_FIND_JOIN_ATTRIBUTE_IN_QUERY_2_RESULTS
(16)
v QUERY_1_NOT_A_SINGLETON (17)
v
v
v
v
v
v

QUERY_2_NOT_A_SINGLETON (18)
NO_INSTANCES_RETURNED_IN_QUERY_1 (19)
NO_INSTANCES_RETURNED_IN_QUERY_2 (20)
CANNOT_FIND_ROLLUP_QUERY (21)
CANNOT_FIND_ROLLUP_ATTRIBUTE (22)
FILE_OFFLINE (23)

v
v
v
v
v
v

NO_HOSTNAME (24)
MISSING_LIBRARY (25)
ATTRIBUTE_COUNT_MISMATCH (26)
ATTRIBUTE_NAME_MISMATCH (27)
COMMON_DATA_PROVIDER_NOT_STARTED (28)
CALLBACK_REGISTRATION_ERROR (29)
Chapter 4. Attributes reference

105

v
v
v
v
v

MDL_LOAD_ERROR (30)
AUTHENTICATION_FAILED (31)
CANNOT_RESOLVE_HOST_NAME (32)
SUBNODE_UNAVAILABLE (33)
SUBNODE_NOT_FOUND_IN_CONFIG (34)

v
v
v
v
v
v
v

ATTRIBUTE_ERROR (35)
CLASSPATH_ERROR (36)
CONNECTION_FAILURE (37)
FILTER_SYNTAX_ERROR (38)
FILE_NAME_MISSING (39)
SQL_QUERY_ERROR (40)
SQL_FILTER_QUERY_ERROR (41)

v
v
v
v
v
v

SQL_DB_QUERY_ERROR (42)
SQL_DB_FILTER_QUERY_ERROR (43)
PORT_OPEN_FAILED (44)
ACCESS_DENIED (45)
TIMEOUT (46)
NOT_IMPLEMENTED (47)

v REQUESTED_A_BAD_VALUE (48)
v RESPONSE_TOO_BIG (49)
v GENERAL_RESPONSE_ERROR (50)
v SCRIPT_NONZERO_RETURN (51)
v SCRIPT_NOT_FOUND (52)
v SCRIPT_LAUNCH_ERROR (53)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Search attribute group


This attribute group monitors Search; it is available for MSPS 2003. If the
warehouse default setting is enabled, data for this attribute group is stored in
Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Search attribute
group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

Timestamp attribute

106

Monitoring Agent for Microsoft SharePoint Server: Users Guide

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

String

Active Threads attribute


Description
Shows the total number of threads currently servicing queries.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Current Connections attribute


Description
Shows the number of currently established connections between
the Search service and all clients.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Failed Queries attribute


Description
Shows the number of queries that have failed.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Failed Query Rate attribute


Description
Shows the number of failed queries per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Chapter 4. Attributes reference

107

Queries attribute
Description
Shows the cumulative number of queries posted to the server.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Query Rate attribute


Description
Shows the number of queries posted to the server per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Result Rate attribute


Description
Shows the number of results returned to the client per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Results attribute
Description
Shows the cumulative number of results returned to clients.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Succeeded Queries attribute

108

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the number of queries that produce successful searches.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Succeeded Query Rate attribute


Description
Shows the number of queries per second that produce successful
searches.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Threads attribute
Description
Shows the total number of threads available for servicing queries.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Percent of Failed Queries attribute


Description
Shows the percent of failed queries.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Chapter 4. Attributes reference

109

Search Archival Plugin attribute group


This attribute group monitors Search Archival Plugin (internal component of
Search Engine); it is available for MSPS 2003. If the warehouse default setting is
enabled, data for this attribute group is not stored in Tivoli Data Warehouse.

Historical group
This attribute group is not part of the default historical group, and is eligible for
use with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Search Archival
Plugin attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Active Documents in First Queue attribute


Description
Shows the number of documents actively using the first queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Active Documents in Second Queue attribute


Description
Shows the number of documents actively using the second queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Active Queue attribute


Description
Shows the currently active queue.
Type

110

Integer (Gauge) with enumerated values. The strings are displayed

Monitoring Agent for Microsoft SharePoint Server: Users Guide

in the Tivoli Enterprise Portal. The warehouse and queries return


the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Blocked Documents attribute
Description
Shows the number of documents waiting for a queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Bulk Insert Sessions attribute


Description
Shows the number of active bulk insert sessions to the database
server.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Error Documents attribute


Description
Shows the number of documents which returned errors from the
plugin.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Retried Documents attribute


Description
Shows the number of documents which were marked for retry
from the plugin.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
Chapter 4. Attributes reference

111

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Total Documents in First Queue attribute
Description
Shows the total number of documents which have used the first
queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents in Second Queue attribute


Description
Shows the total number of documents which have used the second
queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents attribute


Description
Shows the number of documents processed.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

Search Catalogs attribute group


This attribute group monitors Search catalog; it is available for MSPS 2003. If the
warehouse default setting is enabled, data for this attribute group is stored in
Tivoli Data Warehouse.

112

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Search Catalogs
attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Catalog Size in MB attribute


Description
Shows the size of catalog data in megabytes.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Failed Queries attribute


Description
Shows the number of queries that have failed.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Failed Queries Rate attribute


Description
Shows the number of failed queries per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Chapter 4. Attributes reference

113

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Number of Documents attribute
Description
Shows the total number of documents in the catalog.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes attribute


Description
Shows the number of persistent indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Queries attribute
Description
Shows the cumulative number of queries posted to the catalog.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Queries Rate attribute


Description
Shows the number of queries posted to the catalog per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Results attribute

114

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the cumulative number of results returned to clients.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Results Rate attribute


Description
Shows the number of results returned to the client per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Successful Queries attribute


Description
Shows the number of queries that produce successful searches.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Successful Queries Rate attribute


Description
Shows the number of queries per second that produce successful
searches.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Unique Keys attribute


Description
Shows the number of unique words and properties in the catalog.

Chapter 4. Attributes reference

115

Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Percent of Failed Queries attribute


Description
Shows the percent of failed queries.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

Search Gatherer attribute group


This attribute group monitors Search Gatherer; it is available for MSPS 2003. If the
warehouse default setting is enabled, data for this attribute group is stored in
Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Search Gatherer
attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Accessing Robots Text File attribute

116

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the number of current requests for robots.txt; robots.txt is
requested by the SharePoint system implicitly for every website
through HTTP.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Active Queue Length attribute


Description
Shows the number of documents waiting for robot threads.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Admin Clients attribute


Description
Shows the number of currently connected administrative clients.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

All Notifications Received attribute


Description
Shows the total number of notifications received from all
notification sources including file system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Delayed Documents attribute


Description
Shows the total number of documents delayed due to site hit
frequency rules.
Chapter 4. Attributes reference

117

Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Entries attribute


Description
Shows the number of document entries currently in memory.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Delayed Retry attribute


Description
Shows the number of documents that will be retried after time-out.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents Filtered attribute


Description
Shows the number of times a filter object was created.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Filtered Rate attribute


Description
Shows the number of documents filtered per second.
Type

118

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Documents Successfully Filtered attribute
Description
Shows the number of documents successfully filtered.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Successfully Filtered Rate attribute


Description
Shows the number of successfully filtered documents per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

External Notifications Rate attribute


Description
Shows the rate of external notifications received per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

External Notifications Received attribute


Description
Shows the total number of notifications received from all
notification sources excluding file system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Chapter 4. Attributes reference

119

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Filtering Threads attribute
Description
Shows the total number of filtering threads in the system,
calculated based on system resources.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filter Objects attribute


Description
Shows the number of filter objects in the system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filter Process Created attribute


Description
Shows the total number of times a filter process was created or
restarted.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filter Processes attribute


Description
Shows the number of filtering processes in the system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filter Processes Max attribute

120

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the maximum number of filtering processes that have
existed in the system since startup.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Heartbeats attribute
Description
Shows the total number of heartbeats counted since startup.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Idle Threads attribute


Description
Shows the number of threads waiting for documents.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Notification Sources attribute


Description
Shows the currently connected external notification sources.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Notifications Rate attribute


Description
Shows the rate of external notifications received per second.
Type

Real number (Gauge) with 2 decimal places of precision with


Chapter 4. Attributes reference

121

enumerated values. The strings are displayed in the Tivoli


Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Performance Level attribute
Description
Shows the level of the amount of system resources that the
Gatherer service is allowed to use.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Reason To Back Off attribute


Description
Shows the code describing why the Gatherer service went into
back off state.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Robots Text Requests attribute


Description
Shows the total number of requests for robots.txt.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Server Objects attribute


Description
Shows the number of servers recently accessed by the system.
Type

122

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Server Objects Created attribute
Description
Shows the number of times a new server object had to be created.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Servers Currently Unavailable attribute


Description
Shows a server becomes unavailable when a number of requests to
that server time out.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Servers Unavailable attribute


Description
Shows a server that becomes unavailable when a number of
requests to that server time out.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Stemmers Cached attribute


Description
Shows the number of available cached stemmer instances.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Chapter 4. Attributes reference

123

Threads Accessing Network attribute


Description
Shows the number of available filtering threads that are currently
accessing the network.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Threads Blocked Due To Back Off attribute


Description
Shows the number of threads blocked due to back off event.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Threads in Plugins attribute


Description
Shows the number of threads waiting for plugins to complete an
operation.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Time Outs attribute


Description
Shows the total number of timeouts detected by the system since
startup.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Word Breakers Cached attribute

124

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the number of available cached word breakers instances.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

System IO Traffic Rate in MB attribute


Description
Shows the system IO disk traffic rate in megabytes per second
detected by back-off logic.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Back Off Reason attribute


Description
Shows the reason for why the gatherer service went into back-off
state.
Type

Integer with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v Up and running (0)
v High system IO traffic (1)
v High notifications rate (2)
v Delayed recovery in progress (3)
v
v
v
v

User activity (4)


Battery Low (5)
Memory Low (6)
Some internal reason (forced by Search itself) (99)

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Percent Documents Filtered Unsuccessfully attribute
Description
Shows the percentage of total documents which returned error
from filtering process.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
Chapter 4. Attributes reference

125

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Search Gatherer Projects attribute group


This attribute group monitors Search Gatherer Projects; it is available for MSPS
2003. If the warehouse default setting is enabled, data for this attribute group is
stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Search Gatherer
Projects attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Accessed File Rate attribute


Description
Shows the number of documents accessed via file system per
second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Accessed Files attribute


Description
Shows the number of documents accessed via file system.
Type

126

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Accessed HTTP attribute
Description
Shows the number of documents accessed via HTTP.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Accessed HTTP Rate attribute


Description
Shows the number of documents accessed via HTTP per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Accepts attribute


Description
Shows the documents accepted by adaptive crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Errors attribute


Description
Shows the documents incorrectly rejected by adaptive crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Error Samples attribute

Chapter 4. Attributes reference

127

Description
Shows the documents accessed for error sampling.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Excludes attribute


Description
Shows the documents excluded by adaptive crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl False Positives attribute


Description
Shows the documents incorrectly accepted by adaptive crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Total attribute


Description
Shows the documents to which adaptive crawl logic was applied.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Changed Documents attribute


Description
Shows the documents which have changed since the last crawl.
Type

128

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Crawls in Progress attribute
Description
Shows the number of crawls in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Delayed Documents attribute


Description
Shows the number of documents delayed due to site hit frequency
rules.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Additions attribute


Description
Shows the number of add notifications.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Add Rate attribute


Description
Shows the number of document additions per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Chapter 4. Attributes reference

129

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Document Delete Rate attribute
Description
Shows the number of document deletes per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Deletes attribute


Description
Shows the number of delete notifications.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Modifies attribute


Description
Shows the number of modify notifications.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Modifies Rate attribute


Description
Shows the number of modify notifications per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Move and Rename Rate attribute

130

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the number of document Moves and Renames per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Moves or Renames attribute


Description
Shows the number of Move or Rename notifications.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents in Progress attribute


Description
Shows the number of documents in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents on Hold attribute


Description
Shows the number of documents on hold because a document with
the same URL is currently in process.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Error Rate attribute


Description
Shows the number of filtered documents which returned an error
per second.

Chapter 4. Attributes reference

131

Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

File Errors attribute


Description
Shows the number of file protocol errors received while getting
documents.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

File Errors Rate attribute


Description
Shows the number of file protocol errors received per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered HTML attribute


Description
Shows the number of HTML documents filtered.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered HTML Rate attribute


Description
Shows the number of HTML documents filtered per second.
Type

132

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Enterprise Portal. The warehouse and queries return the values


shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Filtered Office attribute
Description
Shows the number of office documents filtered.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered Office Rate attribute


Description
Shows the number of office documents filtered per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered Text attribute


Description
Shows the number of text documents filtered.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered Text Rate attribute


Description
Shows the number of text documents filtered per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
Chapter 4. Attributes reference

133

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Filtering Documents attribute
Description
Shows the number of documents currently being filtered.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Gatherer Paused Flag attribute


Description
Shows if the Gatherer has been paused.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

History Recovery Progress attribute


Description
Shows the percentage of the history recovery completed.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

HTTP Errors attribute


Description
Shows the number of HTTP errors received.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

HTTP Errors Rate attribute

134

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the number of HTTP errors received per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Incremental Crawls attribute


Description
Shows the number of incremental crawls in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Iterating History in Progress Flag attribute


Description
Shows if the Gatherer is currently iterating over the URL history.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Not Modified Documents attribute


Description
Shows the number of documents which were not filtered because
no modification was detected since the last crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Processed Documents attribute


Description
Shows the number of documents processed since the history has
been reset.

Chapter 4. Attributes reference

135

Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Processed Documents Rate attribute


Description
Shows the number of documents processed per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Recovery in Progress Flag attribute


Description
Shows if recovery is currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Retries attribute
Description
Shows the total number of times a document access has been
retried.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Retries Rate attribute


Description
Shows the number of retries per second.
Type

136

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Enterprise Portal. The warehouse and queries return the values


shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Started Documents attribute
Description
Shows the number of documents initiated into the Gatherer
service.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Filtered with Errors attribute


Description
Shows the number of filtered documents which returned an error.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Successfully Filtered Documents attribute


Description
Shows the number of successfully filtered documents.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Success Rate attribute


Description
Shows the number of successfully filtered documents per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
Chapter 4. Attributes reference

137

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Unique Documents attribute
Description
Shows the number of unique documents in the system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

URLs in History attribute


Description
Shows the number of files (URLs) in the history list. It indicates the
total size of document corpus that was indexed.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Waiting Documents attribute


Description
Shows the number of documents waiting to be processed.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

Search Indexer Catalogs attribute group


This attribute group monitors Search Indexer Catalogs; it is available for MSPS
2003. If the warehouse default setting is enabled, data for this attribute group is
stored in Tivoli Data Warehouse.

138

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Search Indexer
Catalogs attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Active Documents attribute


Description
Shows the number of documents currently active in Content Index.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Build in Progress attribute


Description
Shows that an index build is in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Filtered attribute


Description
Shows the number of documents filtered since the catalog was
mounted.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Chapter 4. Attributes reference

139

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Documents in Progress attribute
Description
Shows the number of documents for which data is being added.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Files to be Filtered attribute


Description
Shows the number of files waiting to be filtered and added to the
catalog.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Index Size in MB attribute


Description
Shows the current size of Index data in megabytes.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Merge Progress attribute


Description
Shows the percentage of merge complete for the current merge.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Number of Documents attribute

140

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the number of documents in the catalog.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Number of Propagations attribute


Description
Shows the number of propagations in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes attribute


Description
Shows the number of persistent indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Unique Keys attribute


Description
Shows the number of unique words and properties in the catalog.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Wordlists attribute
Description
Shows the total number of wordlists.
Type

Integer (Gauge) with enumerated values. The strings are displayed


Chapter 4. Attributes reference

141

in the Tivoli Enterprise Portal. The warehouse and queries return


the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Name attribute - This attribute is a key attribute.
Description
The name of the instance.
Type

String

Search Schema Plugin attribute group


This attribute group monitors Search Schema Plugin (internal component of Search
Engine); it is available for MSPS 2003. If the warehouse default setting is enabled,
data for this attribute group is not stored in Tivoli Data Warehouse.

Historical group
This attribute group is not part of the default historical group, and is eligible for
use with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Search Schema
Plugin attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Aliases Loaded attribute


Description
Shows the total number of aliases currently loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Aliases Mapped attribute


Description
Shows the total number of aliases which have been mapped.

142

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Duplicate Aliases attribute


Description
Shows the number of aliases ignored since they are duplicates.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Error Documents attribute


Description
Shows the number of documents which returned errors from the
plugin.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Refresh Count attribute


Description
Shows the number of aliases refreshes done from the database.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents Processed attribute


Description
Shows the number of documents processed.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
Chapter 4. Attributes reference

143

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Total Properties Processed attribute
Description
Shows the number of properties processed by the plugin.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Processed Per Sec attribute


Description
Shows the number of documents processed per second.
Type

Real number (rate of change between successive values) with 2


decimal places of precision with enumerated values. The strings
are displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

Search Topic Assistant attribute group


This attribute group monitors Search Topic Assistant; it is available for MSPS 2003.
If the warehouse default setting is enabled, data for this attribute group is not
stored in Tivoli Data Warehouse.

Historical group
This attribute group is not part of the default historical group, and is eligible for
use with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Search Topic
Assistant attribute group:
Node attribute - This attribute is a key attribute.

144

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
The managed system name of the agent.
Type

String

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

String

Total Categories Found attribute


Description
Shows the total number of categories that the learning plugin has
encountered.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents Processed attribute


Description
Shows the total number of documents that the learning plugin has
processed.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents Processed Per Sec attribute


Description
Shows the rate at which the learning plugin processes documents.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Example Documents Found attribute

Chapter 4. Attributes reference

145

Description
Shows the total number of example documents that the learning
plugin has encountered.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Keywords Found attribute


Description
Shows the total number of keywords that the learning plugin has
encountered.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

Shared Service Provider attribute group


This attribute group monitors Shared Service Provider; it is available for MOSS
2007. If the warehouse default setting is enabled, data for this attribute group is
not stored in Tivoli Data Warehouse.

Historical group
This attribute group is not part of the default historical group, and is eligible for
use with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the Shared Service
Provider attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

Timestamp attribute

146

Monitoring Agent for Microsoft SharePoint Server: Users Guide

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

String

Distribution List Import Rate attribute


Description
Shows the rate at which DLs (Distribution Lists) are imported.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Distribution Lists Imported attribute


Description
Shows the number of DLs that have been imported.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Users Imported attribute


Description
Shows the number of user profiles that have been imported.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Personal Site Latency attribute


Description
Shows the total time needed to render a personal site.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Chapter 4. Attributes reference

147

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Personal Site Throughput attribute
Description
Shows the rate at which personal sites are rendered.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Profile Sync Change Process Rate attribute


Description
Shows the number of changes processed per second during profile
synchronization.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Profile Sync Content Database Process Count attribute


Description
Shows the number of Content Databases processed during profile
synchronization.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Profile Sync Copy Rate attribute


Description
Shows the number of profiles copied per second during profile
synchronization.
Type

148

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Profile Sync Count Columns Created attribute
Description
Shows the number of columns created in UserInfo List for
replicated profile properties during profile synchronization.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Profile Sync Site Collection Process Count attribute


Description
Shows the number of site collections processed during profile
synchronization.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Public Site Latency attribute


Description
Shows the total time needed to render a public site.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Public Site Throughput attribute


Description
Shows the rate at which public sites are rendered.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Chapter 4. Attributes reference

149

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
SSP Job Execution Rate attribute
Description
Shows the number of SSP jobs scheduled per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Usage Data Processing Time in Milliseconds attribute


Description
Shows the duration of the most recent usage data processing job
measured in milliseconds.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

User Profile Import Rate attribute


Description
Shows the rate at which user profiles are imported.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

SharePoint Components attribute group


SharePoint components found on the managed node. This includes SharePoint
version, server roles (Query and index), log directory location, and so on. If the
warehouse default setting is enabled, data for this attribute group is stored in
Tivoli Data Warehouse.

150

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the SharePoint
Components attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Property attribute
Description
Shows property name.
Type

String

Value attribute
Description
Shows the value of corresponding property.
Type

String

SP Publishing Cache attribute group


This attribute group monitors SharePoint Publishing Cache; it is available for
MOSS 2007. If the warehouse default setting is enabled, data for this attribute
group is stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the SP Publishing
Cache attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

Timestamp attribute
Description
The local time at the agent when the data was collected.

Chapter 4. Attributes reference

151

Type

String

Publishing Cache Flushes Per Sec attribute


Description
Shows the rate at which SharePoint user are updating the cache
due to site changes.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Publishing Cache Hit Count attribute


Description
Shows the total number of hits on the Publishing cache.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Publishing Cache Hit Ratio attribute


Description
Shows the ratio of hits to misses on the Publishing cache.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Publishing Cache Hits Per Sec attribute


Description
Shows the hit rate on the Publishing cache.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

152

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Publishing Cache Miss Count attribute


Description
Shows the total number of misses on the Publishing cache.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Publishing Cache Misses Per Sec attribute


Description
Shows the miss rate on the Publishing cache.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Blob Index Writes attribute


Description
Shows the total number of times the SharePoint users have written
the disk based cache index to disk (if applicable).
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Cache Compactions attribute


Description
Shows the total number of times the SharePoint user have
compacted the cache due to size.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Chapter 4. Attributes reference

153

Total Cache Flushes attribute


Description
Shows the total number of times the SharePoint user have updated
the cache due to site changes.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Objects Added attribute


Description
Shows the total number of objects that have ever been added to the
cache.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Object Discards attribute


Description
Shows the total number of items that have been removed from the
Publishing cache due to cache compaction.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Objects attribute


Description
Shows the total number of objects in the publishing cache.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

154

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Total Blob Disk Size in MB attribute


Description
Shows the total size that this cache takes on disk (if applicable) in
megabytes.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

SP Search Archival Plugin attribute group


This attribute group monitors SharePoint Search Archival Plugin (internal
component of Search Engine); it is available for MOSS 2007. If the warehouse
default setting is enabled, data for this attribute group is not stored in Tivoli Data
Warehouse.

Historical group
This attribute group is not part of the default historical group, and is eligible for
use with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the SP Search
Archival Plugin attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Active Documents in First Queue attribute


Description
Shows the number of documents actively using the first queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
Chapter 4. Attributes reference

155

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Active Documents in Second Queue attribute
Description
Shows the number of documents actively using the second queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Active Queue attribute


Description
Shows currently active queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Blocked Documents attribute


Description
Shows number of documents waiting for a queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Bulk Insert Sessions attribute


Description
Shows the number of active bulk insert sessions to the database
server.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Error Documents attribute

156

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the number of documents which returned errors from the
plugin.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Retried Documents attribute


Description
Shows the number of documents which were marked for retry
from the plugin.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents in First Queue attribute


Description
Shows the total number of documents which have used the first
queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents in Second Queue attribute


Description
Shows the total number of documents which have used the second
queue.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents attribute

Chapter 4. Attributes reference

157

Description
Shows the number of documents processed by the SharePoint
Search Archival Plugin.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

SP Search Gatherer attribute group


This attribute group monitors SharePoint Search Gatherer; it is available for MOSS
2007. If the warehouse default setting is enabled, data for this attribute group is
stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the SP Search
Gatherer attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Accessing Robots Text File attribute


Description
Shows the number of current requests for robots.txt, robots.txt is
requested by the system implicitly, for every host, through HTTP.
Type

158

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Active Queue Length attribute
Description
Shows the number of documents waiting for robot threads.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Admin Clients attribute


Description
Shows the number of currently connected administrative clients.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

All Notifications Received attribute


Description
Shows the total number of notifications received from all
notification sources including file system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Delayed Documents attribute


Description
Shows the total number of documents delayed due to site hit
frequency rules.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Entries attribute


Chapter 4. Attributes reference

159

Description
Shows the number of document entries currently in memory.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Delayed Retry attribute


Description
Shows the number of documents that will be retried after time-out.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents Filtered attribute


Description
Shows the number of times a filter object was created.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Filtered Rate attribute


Description
Shows the number of documents filtered per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Successfully Filtered attribute


Description
Shows the number of documents successfully filtered.
Type

160

Integer (Counter) with enumerated values. The strings are

Monitoring Agent for Microsoft SharePoint Server: Users Guide

displayed in the Tivoli Enterprise Portal. The warehouse and


queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Documents Successfully Filtered Rate attribute
Description
Shows the number of successfully filtered documents per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

External Notifications Rate attribute


Description
Shows the rate of external notifications received per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

External Notifications Received attribute


Description
Shows the total number of notifications received from all
notification sources excluding file system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtering Threads attribute


Description
Shows the total number of filtering threads in the system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
Chapter 4. Attributes reference

161

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Filter Objects attribute
Description
Shows the number of filter objects in the system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filter Process Created attribute


Description
Shows the total number of times a filter process was created or
restarted.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filter Processes attribute


Description
Shows the number of filtering processes in the system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filter Processes Max attribute


Description
Shows the maximum number of filtering processes that have
existed in the system since startup.
Type

162

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Heartbeats attribute
Description
Shows the total number of heartbeats counted since startup.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Idle Threads attribute


Description
Shows the number of threads waiting for documents.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Notification Sources attribute


Description
Shows currently connected external notification sources.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Notifications Rate attribute


Description
Shows the rate of external notifications received per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Performance Level attribute


Chapter 4. Attributes reference

163

Description
Shows the level of the amount of system resources that the
Gatherer service is allowed to use.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Reason to Back Off attribute


Description
Shows the code describing why the Gatherer service went into
back off state.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Robots Text Requests attribute


Description
Shows the total number of requests for robots.txt.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Server Objects attribute


Description
Shows the number of servers recently accessed by the system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Server Objects Created attribute


Description
Shows the number of times a new server object had to be created.
Type

164

Integer (Gauge) with enumerated values. The strings are displayed

Monitoring Agent for Microsoft SharePoint Server: Users Guide

in the Tivoli Enterprise Portal. The warehouse and queries return


the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Servers Currently Unavailable attribute
Description
Shows a server becomes unavailable when a number of requests to
that server time out.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Servers Unavailable attribute


Description
Shows a server that becomes unavailable when a number of
requests to that server time out.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Stemmers Cached attribute


Description
Shows the number of available cached stemmer instances.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Threads Accessing Network attribute


Description
Shows the number of threads waiting for a response from the filter
process.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
Chapter 4. Attributes reference

165

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Threads Blocked Due To Back Off attribute
Description
Shows the number of threads blocked due to back off event.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Threads in Plugins attribute


Description
Shows the number of threads waiting for plug-ins to complete an
operation.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Time Outs attribute


Description
Shows the total number of timeouts detected by the system since
startup.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Word Breakers Cached attribute


Description
Shows the number of available cached word breakers instances.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

166

Monitoring Agent for Microsoft SharePoint Server: Users Guide

System IO Traffic Rate in MB attribute


Description
Shows the system IO disk traffic rate in MB per second detected by
back off logic.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Back Off Reason attribute


Description
Shows the reason for why the Gatherer service went into back-off
state.
Type

Integer with enumerated values. The strings are displayed in the


Tivoli Enterprise Portal. The warehouse and queries return the
values shown in parentheses. The following values are defined:
v Up and running (0)
v High system IO traffic (1)
v
v
v
v

High notifications rate (2)


Delayed recovery in progress (3)
User activity (4)
Battery Low (5)

v Memory Low (6)


v Some internal reason (forced by Search itself) (99)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Percent Documents Filtered Unsuccessfully attribute
Description
Shows the percentage of total documents which returned error
from filtering process.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

SP Search Gatherer Projects attribute group


This attribute group monitors SharePoint Search Gatherer Projects; it is available
for MOSS 2007. If the warehouse default setting is enabled, data for this attribute
group is stored in Tivoli Data Warehouse.
Chapter 4. Attributes reference

167

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the SP Search
Gatherer Projects attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Accessed File Rate attribute


Description
Shows the number of documents accessed via file system per
second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Accessed Files attribute


Description
Shows the number of documents accessed via file system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Accessed HTTP attribute


Description
Shows the number of documents accessed via HTTP.
Type

168

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Accessed HTTP Rate attribute
Description
Shows the number of documents accessed via HTTP per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Accepts attribute


Description
Shows the documents accepted by adaptive crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Errors attribute


Description
Shows the documents incorrectly rejected by adaptive crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Error Samples attribute


Description
Shows the documents accessed for error sampling.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Excludes attribute

Chapter 4. Attributes reference

169

Description
Shows the documents excluded by adaptive crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl False Positives attribute


Description
Shows the documents incorrectly accepted by adaptive crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Adaptive Crawl Total attribute


Description
Shows the documents to which adaptive crawl logic was applied.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Changed Documents attribute


Description
Shows the documents which have changed since the last crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Crawls in Progress attribute


Description
Shows the number of crawls in progress.
Type

170

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Delayed Documents attribute
Description
Shows the number of documents delayed due to site hit frequency
rules.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Additions attribute


Description
Shows the number of add notifications.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Add Rate attribute


Description
Shows the number of document additions per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Delete Rate attribute


Description
Shows the number of document deletes per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Chapter 4. Attributes reference

171

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Document Deletes attribute
Description
Shows the number of delete notifications.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Modifies attribute


Description
Shows the number of modify notifications.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Modifies Rate attribute


Description
Shows the number of modify notifications per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Move and Rename Rate attribute


Description
Shows the number of document Moves and Renames per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Document Moves or Renames attribute

172

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the number of Move or Rename notifications.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents in Progress attribute


Description
Shows the number of documents in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents on Hold attribute


Description
Shows the number of documents on hold because a document with
the same URL is currently in process.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Error Rate attribute


Description
Shows the number of filtered documents which returned an error,
per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

File Errors attribute


Description
Shows the number of file protocol errors received while retrieving
documents.
Chapter 4. Attributes reference

173

Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

File Errors Rate attribute


Description
Shows the number of file protocol errors received while retrieving
documents per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered HTML attribute


Description
Shows the number of HTML documents filtered.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered HTML Rate attribute


Description
Shows the number of HTML documents filtered per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered Office attribute


Description
Shows the number of office documents filtered.
Type

174

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Filtered Office Rate attribute
Description
Shows the number of office documents filtered per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered Text attribute


Description
Shows the number of text documents filtered.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtered Text Rate attribute


Description
Shows the number of text documents filtered per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Filtering Documents attribute


Description
Shows the number of documents currently being filtered.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Chapter 4. Attributes reference

175

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Gatherer Paused Flag attribute
Description
Shows if the Gatherer has been paused.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

History Recovery Progress attribute


Description
Shows the percentage of the history recovery completed.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

HTTP Errors attribute


Description
Shows the number of HTTP errors received.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

HTTP Errors Rate attribute


Description
Shows the number of HTTP errors received per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Incremental Crawls attribute

176

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows number of incremental crawls in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Iterating History in Progress Flag attribute


Description
Shows if the Gatherer is currently iterating over the URL history.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Not Modified Documents attribute


Description
Shows the number of documents which were not filtered because
no modification was detected since the last crawl.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Processed Documents attribute


Description
Shows the number of documents processed since the history has
been reset.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Processed Documents Rate attribute


Description
Shows the number of documents processed per second.
Type

Real number (Gauge) with 2 decimal places of precision with


Chapter 4. Attributes reference

177

enumerated values. The strings are displayed in the Tivoli


Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Recovery in Progress Flag attribute
Description
Shows if recovery is currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Retries attribute
Description
Shows the total number of times a document access has been
retried.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Retries Rate attribute


Description
Shows the number of retries per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Started Documents attribute


Description
Shows the number of documents initiated into the Gatherer
service.
Type

178

Integer (Gauge) with enumerated values. The strings are displayed

Monitoring Agent for Microsoft SharePoint Server: Users Guide

in the Tivoli Enterprise Portal. The warehouse and queries return


the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Documents Filtered with Error attribute
Description
Shows the number of filtered documents which returned an error.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Successfully Filtered Documents attribute


Description
Shows the number of successfully filtered documents.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Success Rate attribute


Description
Shows the number of successfully filtered documents per second.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Unique Documents attribute


Description
Shows the number of unique documents in the system.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
Chapter 4. Attributes reference

179

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
URLs in History attribute
Description
Shows the number of files (URLs) in the history list, it indicates the
total size of document corpus that was indexed.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Waiting Documents attribute


Description
Shows the number of documents waiting to be processed.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

SP Search Indexer Catalogs attribute group


This attribute group monitors SharePoint Search Indexer Catalog; it is available for
MOSS 2007. If the warehouse default setting is enabled, data for this attribute
group is stored in Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the SP Search
Indexer Catalogs attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

180

String

Monitoring Agent for Microsoft SharePoint Server: Users Guide

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

String

Active Connections attribute


Description
Shows the active connections.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Filtered attribute


Description
Shows the number of documents filtered since the catalog was
mounted.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Index Size attribute


Description
Shows the current size of index data in megabytes.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L0 Indexes Wordlists attribute


Description
Shows the number of L0 Indexes (Wordlists). Wordlists are
temporary in-memory indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
Chapter 4. Attributes reference

181

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
L0 Merge Flush Count attribute
Description
Shows the number of L0 merges (flushes) since the catalog was
loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L0 Merge Flush Speed Average attribute


Description
Shows the average speed of L0 merges (flushes) since the catalog
was loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L0 Merge Flush Speed Last attribute


Description
Shows the speed of the most recent L0 merge (flush) in documents
per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L0 Merges Flushes Now attribute


Description
Shows the number of L0 merges (flushes) currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

182

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
L1 Merge Count attribute
Description
Shows the number of L1 merges since the catalog was loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L1 Merges Now attribute


Description
Shows the number of L1 merges currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L1 Merge Speed Average attribute


Description
Shows the average speed of L1 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L1 Merge Speed Last attribute


Description
Shows the speed of the most recent L1 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L2 Merge Count attribute


Chapter 4. Attributes reference

183

Description
Shows the number of L2 merges since the catalog was loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L2 Merges Now attribute


Description
Shows the number of L2 merges currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L2 Merge Speed Average attribute


Description
Shows the average speed of L2 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L2 Merge Speed Last attribute


Description
Shows the speed of the most recent L2 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L3 Merge Count attribute


Description
Shows the number of L3 merges since the catalog was loaded.
Type

184

Integer (Gauge) with enumerated values. The strings are displayed

Monitoring Agent for Microsoft SharePoint Server: Users Guide

in the Tivoli Enterprise Portal. The warehouse and queries return


the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
L3 Merges Now attribute
Description
Shows the number of L3 merges currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L3 Merge Speed Average attribute


Description
Shows the average speed of L3 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L3 Merge Speed Last attribute


Description
Shows the speed of the most recent L3 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L4 Merge Count attribute


Description
Shows the number of L4 merges since the catalog was loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
Chapter 4. Attributes reference

185

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
L4 Merges Now attribute
Description
Shows the number of L4 merges currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L4 Merge Speed Average attribute


Description
Shows the average speed of L4 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L4 Merge Speed Last attribute


Description
Shows the speed of the most recent L4 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L5 Merge Count attribute


Description
Shows the number of L5 merges since the catalog was loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

186

Monitoring Agent for Microsoft SharePoint Server: Users Guide

L5 Merges Now attribute


Description
Shows the number of L5 merges currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L5 Merge Speed Average attribute


Description
Shows the average speed of L5 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L5 Merge Speed Last attribute


Description
Shows the speed of the most recent L5 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L6 Merge Count attribute


Description
Shows the number of L6 merges since the catalog was loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L6 Merges Now attribute


Description
Shows the number of L6 merges currently in progress.
Chapter 4. Attributes reference

187

Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L6 Merge Speed Average attribute


Description
Shows the average speed of L6 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L6 Merge Speed Last attribute


Description
Shows the speed of the most recent L6 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L7 Merge Count attribute


Description
Shows the number of L7 merges since the catalog was loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L7 Merges Now attribute


Description
Shows the number of L7 merges currently in progress.
Type

188

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
L7 Merge Speed Average attribute
Description
Shows the average speed of L7 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L7 Merge Speed Last attribute


Description
Shows the speed of the most recent L7 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L8 Merge Count attribute


Description
Shows the number of L8 merges since the catalog was loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L8 Merges Now attribute


Description
Shows the number of L8 merges currently in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Chapter 4. Attributes reference

189

L8 Merge Speed Average attribute


Description
Shows the average speed of L8 merges since the catalog was
loaded in documents per hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

L8 Merge Speed Last attribute


Description
Shows the speed of the most recent L8 merge in documents per
hour.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Master Index Level attribute


Description
Shows the level of the master index.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Master Merge Progress attribute


Description
Shows master merge progress, merging is time intensive and Disk
I/O intensive process.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Master Merges Now attribute

190

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
This attribute indicates whether a master merge in progress.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Master Merges To Date attribute


Description
Shows the number of master merges to date.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Out of Date Document ID Files attribute


Description
Shows number of document ID files with outstanding work items.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes attribute


Description
Shows number of persistent indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L1 attribute


Description
Shows the number of L1 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
Chapter 4. Attributes reference

191

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Persistent Indexes L2 attribute
Description
Shows the number of L2 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L3 attribute


Description
Shows the number of L3 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L4 attribute


Description
Shows the number of L4 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L5 attribute


Description
Shows the number of L5 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L6 attribute

192

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the number of L6 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L7 attribute


Description
Shows the number of L7 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Persistent Indexes L8 attribute


Description
Shows the number of L8 indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Queries attribute
Description
Shows the cumulative number of queries posted to the server.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Queries Failed attribute


Description
Shows the number of queries failed.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
Chapter 4. Attributes reference

193

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Queries Succeeded attribute
Description
Shows the number of queries succeeded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Shadow Merge Levels attribute


Description
Shows the shadow merge levels.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Shadow Merge Levels Threshold attribute


Description
Shows the shadow merge levels threshold.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Unique Keys attribute


Description
Shows the number of unique keys.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

194

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Up to Date Document ID Files attribute


Description
Shows the number of document ID files with no outstanding work
items.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Work Items Created attribute


Description
Shows the number of work items created for updating indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Work Items Deleted attribute


Description
Shows the number of work items completed for updating indexes.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Percent of Failed Queries attribute


Description
Shows the percent of failed queries.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Chapter 4. Attributes reference

195

Type

String

SP Search Schema Plugin attribute group


This attribute group monitors SharePoint Search Schema Plugin (internal
component of Search Engine); it is available for MOSS 2007. If the warehouse
default setting is enabled, data for this attribute group is not stored in Tivoli Data
Warehouse.

Historical group
This attribute group is not part of the default historical group, and is eligible for
use with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the SP Search
Schema Plugin attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Aliases Loaded attribute


Description
Shows the total number of aliases currently loaded.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Aliases Mapped attribute


Description
Shows the total number of aliases which have been mapped.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Duplicate Aliases attribute

196

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the number of aliases ignored since they are duplicates.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Error Documents attribute


Description
Shows the number of documents which returned errors from the
plugin.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Refresh Count attribute


Description
Shows the number of aliases refreshes done from the database.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents Processed attribute


Description
Shows the number of documents processed.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Properties Processed attribute


Description
Shows the number of properties processed by the plugin.

Chapter 4. Attributes reference

197

Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Documents Processed Per Sec attribute


Description
Shows the number of documents processed per second.
Type

Real number (rate of change between successive values) with 2


decimal places of precision with enumerated values. The strings
are displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

SPP Alerts Notification Service attribute group


This attribute group monitors Alert Notification Service, it is available for MSPS. If
the warehouse default setting is enabled, data for this attribute group is stored in
Tivoli Data Warehouse.

Historical group
This attribute group is part of the default historical group, and is eligible for use
with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the SPP Alerts
Notification Service attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

198

String

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Percent of Non Empty Sets of Notifications attribute


Description
Shows the percent of non empty sets of notifications that are
retrieved by the notification service every sample time.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Average Email Size attribute


Description
Shows the average size of email notification sent (in kilo bytes).
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Emails Sent Per Sec attribute


Description
Shows the e-mail send frequency of the notification service.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Max Email Size attribute


Description
Shows the size of the largest e-mail sent (in kilobytes).
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Notifications Sent Per Sec attribute

Chapter 4. Attributes reference

199

Description
Shows the notification send frequency of the notification service.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Daily Notifications Sent attribute


Description
Shows the total number of daily notifications sent by the
notification service.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Immediate Notifications Sent attribute


Description
Shows the total number of immediate notifications sent by the
notification service.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Notifications Currently Processed attribute


Description
Shows the number of notifications that are currently being
processed by the notification service.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Weekly Notifications Sent attribute

200

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description
Shows the total number of weekly notifications sent by the
notification service.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Email Notifications Sent attribute


Description
Shows the total number of e-mail notifications sent by the
notification service until now.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Notifications Sent attribute


Description
Shows the total number of notifications sent by the notification
service until now.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

SPP Server Alert Manager attribute group


This attribute group monitors Alert Manager; it is available for MSPS. If the
warehouse default setting is enabled, data for this attribute group is not stored in
Tivoli Data Warehouse.

Chapter 4. Attributes reference

201

Historical group
This attribute group is not part of the default historical group, and is eligible for
use with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the SPP Server Alert
Manager attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Average Notifications Returned from GetResults APIs attribute


Description
Shows the average number of notifications in a set returned from
GetResults APIs.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to ActivateAlert Per Sec attribute


Description
Shows the frequency of calls to ActivateAlert.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to ActivateUserAlerts Per Sec attribute


Description
Shows the frequency of calls to ActivateUserAlerts.
Type

202

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Calls to DeactivateAlert Per Sec attribute
Description
Shows the frequency of calls to DeactivateAlert.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to DeactivateUserAlerts Per Sec attribute


Description
Shows the frequency of calls to DeactivateUserAlerts.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to DeleteAlert Per Sec attribute


Description
Shows the frequency of calls to DeleteAlert.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to DeleteUserAlerts Per Sec attribute


Description
Shows the frequency of calls to DeleteUserAlerts.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Chapter 4. Attributes reference

203

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Calls to EditAlert Per Sec attribute
Description
Shows the frequency of calls to EditAlert.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to GetResults from Management Web Part Per Sec attribute


Description
Shows the frequency of calls to GetResults from Management Web
Part.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to GetResults from Summary Web Part Per Sec attribute


Description
Shows the frequency of calls to GetResults From Summary Web
Part.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to ManipulateAlert Per Sec attribute


Description
Shows the frequency of calls to ManipulateAlert.
Type

204

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Calls to ActivateAlert attribute
Description
Shows the total number of calls to ActivateAlert.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to ActivateUserAlerts attribute


Description
Shows the total number of calls to ActivateUserAlerts.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to DeactivateUserAlerts attribute


Description
Shows the total number of calls to DeactivateUserAlerts.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to DectivateAlert attribute


Description
Shows the total number of calls to DectivateAlert.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to DeleteAlert attribute


Description
Shows the total number of calls to DeleteAlert.
Chapter 4. Attributes reference

205

Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to DeleteUserAlerts attribute


Description
Shows the total number of calls to DeleteUserAlerts.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to EditAlert attribute


Description
Shows the total number of calls to EditAlert.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to GetResults from Management Web Part attribute


Description
Shows the total number of calls to GetResults from Management
Web Part.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Calls to GetResults from Summary Web Part attribute


Description
Shows the total number of calls to GetResults from Summary Web
Part.
Type

206

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Calls to ManipulateAlert attribute
Description
Shows the total number of calls to ManipulateAlert.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

SPP Server Alerts Plugin attribute group


This attribute group monitors Alerts Archival Plugin (internal component of Alert
Service), it is available for MSPS. If the warehouse default setting is enabled, data
for this attribute group is not stored in Tivoli Data Warehouse.

Historical group
This attribute group is not part of the default historical group, and is eligible for
use with Tivoli Data Warehouse.

Attribute descriptions
The following list contains information about each attribute in the SPP Server
Alerts Plugin attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Current Documents Processed attribute


Description
Shows the number of documents currently processed by the alert
engine.
Type

Integer (Gauge) with enumerated values. The strings are displayed

Chapter 4. Attributes reference

207

in the Tivoli Enterprise Portal. The warehouse and queries return


the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Current Quota Processing Processed attribute
Description
Shows the number of quota processing actions currently processed.
Type

Integer (Gauge) with enumerated values. The strings are displayed


in the Tivoli Enterprise Portal. The warehouse and queries return
the values shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Alerts attribute


Description
Shows the total number of alerts loaded.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Alerts Added attribute


Description
Shows the total number of alerts added.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Alerts Deactivated attribute


Description
Shows the total number of deactivated alerts.
Type

208

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Total Alerts Deleted attribute
Description
Shows the total number of alerts deleted.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Boolean Immediate Alerts attribute


Description
Shows the total number of immediate boolean alerts loaded.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Boolean Immediate Hits Received attribute


Description
Shows the total number of boolean immediate hits that the alert
engine has generated.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Boolean Immediate Hits Received Per Sec attribute


Description
Shows the rate at which the alert engine generate boolean
immediate hits.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
Chapter 4. Attributes reference

209

v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Total Boolean Quota Processing attribute
Description
Shows the number of times that boolean quota processing was
done in the alert engine.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Boolean Quota Processing Per Sec attribute


Description
Shows the rate at which the alert engine performs boolean quota
processing.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Boolean Scheduled Alerts attribute


Description
Shows the total number of scheduled boolean alerts loaded.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Boolean Scheduled Hits Received attribute


Description
Shows the total number of boolean scheduled hits that the alert
engine has generated.
Type

210

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Total Boolean Scheduled Hits Received Per Sec attribute
Description
Shows the rate at which the alert engine generates boolean
scheduled hits.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents Failed attribute


Description
Shows the number of documents that failed.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents Processed attribute


Description
Shows the total number of documents that the alert engine has
processed.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Documents Processed Per Sec attribute


Description
Shows the rate at which the alert engine process documents.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
Chapter 4. Attributes reference

211

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Total Hits Received attribute
Description
Shows the total number of hits that the alert engine has generated.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Hits Received Per Sec attribute


Description
Shows the rate at which the alert engine generates hits.
Type

Real number (Counter) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Quota Processing attribute


Description
Shows the number of times that quota processing was done in the
alert engine.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Quota Processing Per Sec attribute


Description
Shows the rate at which the alert engine performs quota
processing.
Type

212

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Total Rank Immediate Alerts attribute
Description
Shows the total number of immediate rank alerts loaded.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Rank Immediate Hits Received Per Sec attribute


Description
Shows the rate at which the alert engine generates rank immediate
hits.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Rank Immediate Hits Received attribute


Description
Shows the total number of rank immediate hits that the alert
engine has generated.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Rank Quota Processing attribute


Description
Shows the number of times that rank quota processing was done
in the alert engine.
Type

Integer (Counter) with enumerated values. The strings are

Chapter 4. Attributes reference

213

displayed in the Tivoli Enterprise Portal. The warehouse and


queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.
Total Rank Quota Processing Per Sec attribute
Description
Shows the rate at which the alert engine performs rank quota
processing.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Rank Scheduled Alerts attribute


Description
Shows the total number of scheduled rank alerts loaded.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Rank Scheduled Hits Received attribute


Description
Shows the total number of rank scheduled hits that the alert engine
has generated.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Rank Scheduled Hits Received Per Sec attribute


Description
Shows the rate at which the alert engine generates rank scheduled
hits.

214

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Security Checks attribute


Description
Shows the number of times security checks was done by the alert
engine.
Type

Integer (Counter) with enumerated values. The strings are


displayed in the Tivoli Enterprise Portal. The warehouse and
queries return the values shown in parentheses. The following
values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Total Security Checks Per Sec attribute


Description
Shows the rate at which the alert engine performs security checks.
Type

Real number (Gauge) with 2 decimal places of precision with


enumerated values. The strings are displayed in the Tivoli
Enterprise Portal. The warehouse and queries return the values
shown in parentheses. The following values are defined:
v Value_Exceeds_Maximum (2147483647)
v Value_Exceeds_Minimum (-2147483648)
Any other values will display the actual value returned by the
agent in the Tivoli Enterprise Portal.

Name attribute - This attribute is a key attribute.


Description
The name of the instance.
Type

String

Web Server attribute group


This attribute group displays the server bindings for the SharePoint sites that are
running on Microsoft IIS Server. This data is used for cross linkages with IIS agent.
If the warehouse default setting is enabled, data for this attribute group is not
stored in Tivoli Data Warehouse.

Historical group
This attribute group is not part of the default historical group, and is eligible for
use with Tivoli Data Warehouse.

Chapter 4. Attributes reference

215

Attribute descriptions
The following list contains information about each attribute in the Web Server
attribute group:
Node attribute - This attribute is a key attribute.
Description
The managed system name of the agent.
Type

String

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

String

Site ID attribute
Description
Shows the Site ID as a worker process and an identifier.
Type

String

Site Name attribute - This attribute is a key attribute.


Description
Shows the name of the Web site.
Type

String

Port attribute
Description
Shows the port on which the site is running.
Type

String

SSL Port attribute


Description
Shows the SSL port (if any).
Type

String

Name attribute
Description
Shows the instance name of the site in the following format:
_LM_WorkerProcess_Identifier_Root.
Type

String

Host Name attribute


Description
Shows name of the IIS server on which the site is hosted.
Type

String

Disk capacity planning for historical data


Disk capacity planning for a monitoring agent is a prediction of the amount of disk
space to be consumed for each attribute group whose historical data is being
collected. Required disk storage is an important factor to consider when you are
defining data collection rules and your strategy for historical data collection.

216

Monitoring Agent for Microsoft SharePoint Server: Users Guide

The table in this chapter provides the following information required to calculate
disk space for this monitoring agent:
v Table is the table name as it is displayed in the warehouse database, if the
attribute group is configured to be written to the warehouse. The table name
listed here corresponds to the Table name in Attribute groups and attributes for
the Monitoring Agent for Microsoft SharePoint Server on page 37
v Attribute group is the name of the attribute group used to create the table in the
warehouse database if it is short enough to fit in the table naming constraints of
the database being used for the warehouse. The attribute group name listed here
corresponds to the Warehouse table name in Attribute groups and attributes for
the Monitoring Agent for Microsoft SharePoint Server on page 37.
v Bytes per instance (agent) is an estimate of the record length for each row or
instance written to the agent disk for historical data collection. This estimate can
be used for agent disk space planning purposes.
v Database bytes per instance (warehouse) is an estimate of the record length for
detailed records written to the warehouse database, if the attribute group is
configured to be written to the warehouse. Detailed records are those that have
been uploaded from the agent for long-term historical data collection. This
estimate can be used for warehouse disk space planning purposes.
v Aggregate bytes per instance (warehouse) is an estimate of the record length for
aggregate records written to the warehouse database, if the attribute group is
configured to be written to the warehouse. Aggregate records are created by the
Summarization agent for attribute groups that have been configured for
summarization. This estimate can be used for warehouse disk space planning
purposes.
In addition to the information in the tables, you must know the number of
instances of data that you plan to collect. An attribute group can have single or
multiple instances of data depending on the application environment that is being
monitored. For example, if your attribute group is monitoring each processor in
your computer and you have a dual processor computer, the number of instances
is two.
The following table contains capacity planning information for the data logged by
IBM Tivoli Monitoring for Microsoft Applications: Microsoft SharePoint Server
Agent.
Table 3. Capacity planning for historical data logged by IBM Tivoli Monitoring for Microsoft Applications: Microsoft
SharePoint Server Agent
Database
bytes per
instance
(warehouse)

Aggregate
bytes per
instance
(warehouse)

Table

Attribute group

Bytes per
instance
(agent)

KQPASPNET

KQP_ASP_NET_APPLICATIONS

460

462

499

KQPAVAIL

KQP_AVAILABILITY

3272

3296

3606

KQPSHAREP8

KQP_DATABASE

576

577

614

KQPDOCUMEN

KQP_DOCUMENT_CONVERSIONS

84

94

221

KQPEVTLOG

KQP_EVENT_LOG

2240

2246

2283

KQPEXCELCA

KQP_EXCEL_CALCULATION_SERVICES

120

235

785

KQPEXCELSE

KQP_EXCEL_SERVICES_WEB_FRONT_END

88

111

265

KQPEXCELWE

KQP_EXCEL_WEB_ACCESS

88

123

313

KQPINFOPAT

KQP_INFOPATH_FORMS_SERVICES

248

383

1242

Chapter 4. Attributes reference

217

Table 3. Capacity planning for historical data logged by IBM Tivoli Monitoring for Microsoft Applications: Microsoft
SharePoint Server Agent (continued)
Database
bytes per
instance
(warehouse)

Aggregate
bytes per
instance
(warehouse)

Table

Attribute group

Bytes per
instance
(agent)

KQPOFFICE4

KQP_OFFICE_SEARCH_ARCHIVAL_PLUGIN

216

223

626

KQPOFFICE5

KQP_OFFICE_SEARCH_GATHERER

228

334

1814

KQPOFFICE6

KQP_OFFICE_SEARCH_GATHERER_PROJECTS

384

613

2810

KQPOFFICE7

KQP_OFFICE_SEARCH_INDEXER_CATALOGS

432

505

2978

KQPOFFICE8

KQP_OFFICE_SEARCH_SCHEMA_PLUGIN

208

225

514

KQPPOBJST

KQP_PERFORMANCE_OBJECT_STATUS

288

289

326

KQPSEARC0

KQP_SEARCH

124

192

709

KQPSEARCHA

KQP_SEARCH_ARCHIVAL_PLUGIN

216

223

626

KQPSEARCHC

KQP_SEARCH_CATALOGS

228

298

830

KQPSEARCHG

KQP_SEARCH_GATHERER

228

334

1814

KQPSEARCH0

KQP_SEARCH_GATHERER_PROJECTS

384

613

2810

KQPSEARCHI

KQP_SEARCH_INDEXER_CATALOGS

224

233

666

KQPSEARCHS

KQP_SEARCH_SCHEMA_PLUGIN

208

225

514

KQPSEARCHT

KQP_SEARCH_TOPIC_ASSISTANT

196

210

358

KQPSHAREDS

KQP_SHARED_SERVICE_PROVIDER

236

332

942

KQPSPPVER

KQP_SHAREPOINT_COMPONENTS

276

274

311

KQPSHAREP1

KQP_SPP_ALERTS_NOTIFICATION_SERVICE

220

264

646

KQPSHAREP3

KQP_SPP_SERVER_ALERTS_PLUGIN

300

448

1358

KQPSHAREP2

KQP_SPP_SERVER_ALERT_MANAGER

260

398

1374

KQPSHAREP0

KQP_SP_PUBLISHING_CACHE

228

298

734

KQPSHARE10

KQP_SP_SEARCH_ARCHIVAL_PLUGIN

216

223

626

KQPSHAREP9

KQP_SP_SEARCH_GATHERER

228

334

1814

KQPSHARE11

KQP_SP_SEARCH_GATHERER_PROJECTS

384

613

2810

KQPSHARE12

KQP_SP_SEARCH_INDEXER_CATALOGS

432

505

2978

KQPSHARE13

KQP_SP_SEARCH_SCHEMA_PLUGIN

208

225

514

KQPWEBSERV

KQP_WEB_SERVER

460

462

499

For more information about historical data collection, see the IBM Tivoli Monitoring
Administrators Guide.

218

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Chapter 5. Situations reference


This chapter contains an overview of situations, references for detailed information
about situations, and descriptions of the predefined situations included in this
monitoring agent.

About situations
A situation is a logical expression involving one or more system conditions.
Situations are used to monitor the condition of systems in your network. You can
manage situations from Tivoli Enterprise Portal by using the Situation Editor.
The monitoring agents that you use to monitor your system environment are
delivered with a set of predefined situations that you can use as-is or you can
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 Monitoring Agent for Microsoft SharePoint Server. You can examine and,
if necessary, change the conditions or values being monitored by a predefined
situation to those best suited to your enterprise.
You can display predefined situations and create your own situations using the
Situation Editor. The left frame of the Situation editor initially lists the situations
associated with the Navigator item that you selected. When you click a situation
name or create a new situation, the right frame opens with the following tabs:
Formula
Formula describing condition being tested
Distribution
List of managed systems (operating systems, subsystems, or applications)
to which the situation can be distributed. All of the Monitoring Agent for
Microsoft SharePoint Server managed systems are assigned by default.
Expert advice
Comments and instructions to be read in the event workspace
Action
Command to be sent to the system
Until

Options to close the event after a period of time, or when another situation
becomes true

More information about situations


IBM Tivoli Monitoring Users Guide contains more information about predefined and
custom situations and how to use them to respond to alerts.
For a list of the predefined situations for this monitoring agent and a description
of each situation, see the Predefined situations section in this chapter and the
information in that section for each individual situation.

Copyright IBM Corp. 2008, 2009

219

Predefined situations
This monitoring agent contains the following predefined situations, which are
organized by Navigator item.
v Microsoft SharePoint Server
Not applicable
v Alert
Not applicable
v ASP NET Applications
Not applicable
v Availability
KQP_SPP_Admin_Service_Down
KQP_SPP_Timer_Service_Down
KQP_SPP_Alert_Service_Down
KQP_Office_Search_Service_Down
KQP_SP_Search_Service_Down
KQP_MSPS_Search_Service_Down
KQP_MS_SSO_Service_Down
KQP_WSS_Tracing_Service_Down
v Database
Not applicable
v Document Conversions
Not applicable
v Event Log
KQP_InfoPath_Form_Actions
KQP_InfoPath_Session_State
KQP_SP_DB_Login_Failed
KQP_Insufficient_DB_Permission
KQP_Alert_Noti_NoMAILServerRes
KQP_Office_Protocol_Handler
KQP_WSS_Protocol_Handler
KQP_Connection_To_SP_DB

KQP_My_Site_Creation_Failure
KQP_Profile_Import_Failed
KQP_User_Profile_Commit_Failed
KQP_Membership_Import_Failed
KQP_User_Profile_Sync_Failed
KQP_SSP_Admin_Site_Unavailable

KQP_Sync_Job_Scheduler_Failed
KQP_SSP_Provisioning_Failed
KQP_Last_Query_Server_Removed
KQP_SSP_DB_Sync_Failed
KQP_Alert_InvalidPortalSetting
v Excel Services
KQP_ECS_Active_Sessions

220

Monitoring Agent for Microsoft SharePoint Server: Users Guide

KQP_ECS_Session_Time_Out
v InfoPath Forms Services
Not applicable
v MOSS Search
KQP_SP_RTB_SystemIOTraffic

KQP_SP_Doc_Delayed_Retry
KQP_SP_Active_Queue_Length
KQP_SP_Search_Index_Size
KQP_Office_RTB_SystemIOTraffic
KQP_Office_Doc_Delayed_Retry
KQP_Office_Active_Queue_Length
KQP_Office_Retries_Rate

KQP_Office_Search_Index_Size
v MSPS Search
KQP_MSPS_RBT_SystemIOTraffic
KQP_MSPS_Search_DocDelayRetry
KQP_MSPS_ActiveQueueLength
KQP_MSPS_Retries_Rate
v Shared Service Provider
Not applicable
v SharePoint Publishing
KQP_SP_Publish_CacheHitRatio
v Web Server
Not applicable
The remaining sections of this chapter contain descriptions of each of these
situations. The situations are organized by Navigator item. The following
information is provided about each situation:
Description
Information about the conditions that the situation tests
Formula
Syntax that contains one or more logical expressions describing the
conditions for the situation to monitor
Run at startup
Whether the situation is automatically distributed to instances of the agent
or is available for manual distribution
Sampling interval
Number of seconds that elapses between one sample of data that the
monitoring agent collects for the server and the next sample
Situation persistence
Whether the conditions specified in the situation evaluate to true for the
defined number of occurrences in a row before the situation is raised. The
default of 1 means no persistence checking takes place.
Severity
Severity of the predefined events: Warning, Informational, or Critical

Chapter 5. Situations reference

221

Clearing conditions
Controls when a true situation closes: after a period of time, when another
situation is true, or whichever occurs first if both are selected.

Microsoft SharePoint Server Navigator item


There are no predefined situations for this Navigator item.

Alert Navigator item


There are no predefined situations for this Navigator item.

ASP NET Applications Navigator item


There are no predefined situations for this Navigator item.

Availability Navigator item


KQP_SPP_Admin_Service_Down situation
Description
SPP Administration service is not running.
The situation is evaluated for each distinct value of the COMPONENT attribute.

Formula
*IF *SCAN KQP_AVAILABILITY.Name *EQ SPSAdmin *AND
KQP_AVAILABILITY.Status *EQ DOWN

*VALUE

See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
15 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

KQP_SPP_Timer_Service_Down situation
Description
SharePoint Timer service is not running.
The situation is evaluated for each distinct value of the COMPONENT attribute.

222

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Formula
*IF *SCAN KQP_AVAILABILITY.Name *EQ SPTimer *AND
KQP_AVAILABILITY.Status *EQ DOWN

*VALUE

See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
15 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

KQP_SPP_Alert_Service_Down situation
Description
SharePoint Portal Server Alert service is not running.
The situation is evaluated for each distinct value of the COMPONENT attribute.

Formula
*IF *SCAN KQP_AVAILABILITY.Name *EQ spsalert *AND
KQP_AVAILABILITY.Status *EQ DOWN

*VALUE

See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
15 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

Chapter 5. Situations reference

223

KQP_Office_Search_Service_Down situation
Description
Office SharePoint Server Search service is not running.
The situation is evaluated for each distinct value of the COMPONENT attribute.

Formula
*IF *SCAN KQP_AVAILABILITY.Name *EQ OSearch *AND
KQP_AVAILABILITY.Status *EQ DOWN

*VALUE

See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
15 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

KQP_SP_Search_Service_Down situation
Description
Windows SharePoint Services Help Search service is not running.
The situation is evaluated for each distinct value of the COMPONENT attribute.

Formula
*IF *SCAN KQP_AVAILABILITY.Name *EQ SPSearch *AND
KQP_AVAILABILITY.Status *EQ DOWN

*VALUE

See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
15 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

224

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Clearing conditions
The situation clears when the condition becomes false.

KQP_MSPS_Search_Service_Down situation
Description
Microsoft SharePointPS Search service is not running.
The situation is evaluated for each distinct value of the COMPONENT attribute.

Formula
*IF *SCAN KQP_AVAILABILITY.Name *EQ SharePointPSSearch *AND *VALUE
KQP_AVAILABILITY.Status *EQ DOWN
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
15 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

KQP_MS_SSO_Service_Down situation
Description
The Microsoft Single Sign-on service is not running.
The situation will be evaluated for each distinct value of Name.

Formula
*IF (*SCAN KQP_AVAILABILITY.Name *EQ ssosrv *OR *SCAN KQP_AVAILABILITY.Name
*EQ SSOSrv) *AND *VALUE KQP_AVAILABILITY.Status *EQ DOWN
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
30 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.
Chapter 5. Situations reference

225

Severity
Warning

Clearing conditions
The situation clears when the condition becomes false.

KQP_WSS_Tracing_Service_Down situation
Description
The Windows SharePoint Services Tracing service is not running.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *SCAN KQP_AVAILABILITY.Name *EQ SPTrace *AND
KQP_AVAILABILITY.Status *EQ DOWN

*VALUE

See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
30 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Warning

Clearing conditions
The situation clears when the condition becomes false.

Database Navigator item


There are no predefined situations for this Navigator item.

Document Conversions Navigator item


There are no predefined situations for this Navigator item.

Event Log Navigator item


KQP_InfoPath_Form_Actions situation
Description
Form actions exceeded Number of actions per postback value.
The situation is evaluated for each distinct value of the LOGNAME attribute.

226

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Office SharePoint Server' *AND
*VALUE KQP_EVENT_LOG.Event_ID *EQ 5737 *AND *VALUE
KQP_EVENT_LOG.Event_Category *EQ 'Forms Services Runtime'
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Critical

Clearing conditions
The situation does not clear automatically.

KQP_InfoPath_Session_State situation
Description
Session state size exceeded the Form session state value.
The situation is evaluated for each distinct value of the LOGNAME attribute.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Office SharePoint Server' *AND
*VALUE KQP_EVENT_LOG.Event_ID *EQ 7083 *AND *VALUE
KQP_EVENT_LOG.Event_Category *EQ 'Forms Services Runtime - Session State'
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Critical

Clearing conditions
The situation does not clear automatically.

Chapter 5. Situations reference

227

KQP_SP_DB_Login_Failed situation
Description
SharePoint database login failed.
The situation is evaluated for each distinct value of the LOGNAME attribute.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Windows SharePoint Services 3'
*AND *VALUE KQP_EVENT_LOG.Event_ID *EQ 3351
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Critical

Clearing conditions
The situation does not clear automatically.

KQP_Insufficient_DB_Permission situation
Description
Insufficient SQL Server database permissions.
The situation is evaluated for each distinct value of the LOGNAME attribute.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Windows SharePoint Services 3'
*AND *VALUE KQP_EVENT_LOG.Event_ID *EQ 5214
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Warning

228

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Clearing conditions
The situation does not clear automatically.

KQP_Alert_Noti_NoMAILServerRes situation
Description
The SMTP Server is not functioning correctly.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'SharePoint Portal Alert Service'
*AND *VALUE KQP_EVENT_LOG.Event_ID *EQ 151
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Warning

Clearing conditions
The situation does not clear automatically.

KQP_Office_Protocol_Handler situation
Description
Protocol handler is not loaded.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Office Server Search' *AND
*VALUE KQP_EVENT_LOG.Event_ID *EQ 2484 *AND *VALUE
KQP_EVENT_LOG.Event_Category *EQ 'Gatherer'
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Chapter 5. Situations reference

229

Severity
Critical

Clearing conditions
The situation does not clear automatically.

KQP_WSS_Protocol_Handler situation
Description
Protocol handler is not loaded.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Windows SharePoint Services 3
Search' *AND *VALUE KQP_EVENT_LOG.Event_ID *EQ 2483 *AND *VALUE
KQP_EVENT_LOG.Event_Category *EQ 'Gatherer'
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Critical

Clearing conditions
The situation does not clear automatically.

KQP_Connection_To_SP_DB situation
Description
Unable to connect SharePoint database.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Windows SharePoint Services 3'
*AND *VALUE KQP_EVENT_LOG.Event_ID *EQ 3355
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

230

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Situation persistence
Not Applicable

Severity
Critical

Clearing conditions
The situation does not clear automatically.

KQP_My_Site_Creation_Failure situation
Description
My Site cannot be created.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Office SharePoint Server' *AND
*VALUE KQP_EVENT_LOG.Event_ID *EQ 5187
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is automatically distributed to instances of this agent.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Critical

Clearing conditions
The situation does not clear automatically.

KQP_Profile_Import_Failed situation
Description
An error was encountered while importing user profiles.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Office SharePoint Server' *AND
*VALUE KQP_EVENT_LOG.Event_ID *EQ 5707
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Chapter 5. Situations reference

231

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Warning

Clearing conditions
The situation does not clear automatically.

KQP_User_Profile_Commit_Failed situation
Description
A user profile is not saved to the SSP database.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Office SharePoint Server' *AND
*VALUE KQP_EVENT_LOG.Event_ID *EQ 5188
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Warning

Clearing conditions
The situation does not clear automatically.

KQP_Membership_Import_Failed situation
Description
The membership information cannot be imported.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Office SharePoint Server' *AND
*VALUE KQP_EVENT_LOG.Event_ID *EQ 5708
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

232

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Warning

Clearing conditions
The situation does not clear automatically.

KQP_User_Profile_Sync_Failed situation
Description
The user profile synchronization failed.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Office SharePoint Server' *AND
*VALUE KQP_EVENT_LOG.Event_ID *EQ 5554
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Warning

Clearing conditions
The situation does not clear automatically.

KQP_SSP_Admin_Site_Unavailable situation
Description
The SSP administration site is not available.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Office SharePoint Server' *AND
*VALUE KQP_EVENT_LOG.Event_ID *EQ 5290

Chapter 5. Situations reference

233

See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is automatically distributed to instances of this agent.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Critical

Clearing conditions
The situation does not clear automatically.

KQP_Sync_Job_Scheduler_Failed situation
Description
The synchronization job scheduler failed.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Office SharePoint Server' *AND
*VALUE KQP_EVENT_LOG.Event_ID *EQ 5556
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Warning

Clearing conditions
The situation does not clear automatically.

KQP_SSP_Provisioning_Failed situation
Description
The Shared Services Provider (SSP) creation failed.
The situation will be evaluated for each distinct value of Name.

234

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Office SharePoint Server' *AND
*VALUE KQP_EVENT_LOG.Event_ID *EQ 5162
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is automatically distributed to instances of this agent.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Critical

Clearing conditions
The situation does not clear automatically.

KQP_Last_Query_Server_Removed situation
Description
The last query server is removed from rotation.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Office SharePoint Server' *AND
*VALUE KQP_EVENT_LOG.Event_ID *EQ 10040
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Warning

Clearing conditions
The situation does not clear automatically.

Chapter 5. Situations reference

235

KQP_SSP_DB_Sync_Failed situation
Description
The SSP synchronization with the configuration database failed.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'Office SharePoint Server' *AND
*VALUE KQP_EVENT_LOG.Event_ID *EQ 5783
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Warning

Clearing conditions
The situation does not clear automatically.

KQP_Alert_InvalidPortalSetting situation
Description
Invalid portal settings.
The situation will be evaluated for each distinct value of Name.

Formula
*IF *VALUE KQP_EVENT_LOG.Event_Source *EQ 'SharePoint Portal Alert Service'
*AND *VALUE KQP_EVENT_LOG.Event_ID *EQ 155
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
None. Data is analyzed when it becomes available.

Situation persistence
Not Applicable

Severity
Warning

236

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Clearing conditions
The situation does not clear automatically.

Excel Services Navigator item


KQP_ECS_Active_Sessions situation
Description
Sessions exceed 80 percent of maximum sessions per user value.
The situation will be evaluated for the table.

Formula
*IF *VALUE KQP_EXCEL_CALCULATION_SERVICES.Active_Sessions *GT 20
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
2 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Warning

Clearing conditions
The situation clears when the condition becomes false.

KQP_ECS_Session_Time_Out situation
Description
Inactive session or workbook includes non supported features.
The situation will be evaluated for the table.

Formula
*IF *VALUE KQP_EXCEL_CALCULATION_SERVICES.Requests_with_Errors_Per_Sec *GE
1
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
5 minutes

Chapter 5. Situations reference

237

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Warning

Clearing conditions
The situation clears when the condition becomes false.

InfoPath Forms Services Navigator item


There are no predefined situations for this Navigator item.

MOSS Search Navigator item


KQP_SP_RTB_SystemIOTraffic situation
Description
Crawling has been paused because of high System IO traffic.
The situation will be evaluated for the table.

Formula
*IF *VALUE KQP_SP_SEARCH_GATHERER.Reason_to_Back_Off *EQ 1
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
5 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

KQP_SP_Doc_Delayed_Retry situation
Description
SharePoint is unable to crawl SharePoint contents.
The situation will be evaluated for the table.

Formula
*IF *VALUE KQP_SP_SEARCH_GATHERER.Documents_Delayed_Retry *GT 0

238

Monitoring Agent for Microsoft SharePoint Server: Users Guide

See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
10 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

KQP_SP_Active_Queue_Length situation
Description
A large number of documents are waiting to be processed.
The situation will be evaluated for the table.

Formula
*IF *VALUE KQP_SP_SEARCH_GATHERER.Active_Queue_Length *GT 100
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
15 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

KQP_SP_Search_Index_Size situation
Description
The current size of index is increasing.
The situation is evaluated for each distinct value of the NAME attribute.

Chapter 5. Situations reference

239

Formula
*IF *VALUE KQP_SP_SEARCH_INDEXER_CATALOGS.Index_Size *GT 200
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
15 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Warning

Clearing conditions
The situation clears when the condition becomes false.

KQP_Office_RTB_SystemIOTraffic situation
Description
Crawling has been paused because of high System IO traffic.
The situation is evaluated for each distinct value of the NAME attribute.

Formula
*IF *VALUE KQP_OFFICE_SEARCH_GATHERER.Reason_to_Back_Off *EQ 1
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
5 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

240

Monitoring Agent for Microsoft SharePoint Server: Users Guide

KQP_Office_Doc_Delayed_Retry situation
Description
Problems in accessing the Web storage system.
The situation is evaluated for each distinct value of the NAME attribute.

Formula
*IF *VALUE KQP_OFFICE_SEARCH_GATHERER.Documents_Delayed_Retry *GT 0
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
10 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

KQP_Office_Active_Queue_Length situation
Description
Active Queue Length is greater than 100.
The situation is evaluated for each distinct value of the NAME attribute.

Formula
*IF *VALUE KQP_OFFICE_SEARCH_GATHERER.Active_Queue_Length *GT 100
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
15 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Chapter 5. Situations reference

241

Clearing conditions
The situation clears when the condition becomes false.

KQP_Office_Retries_Rate situation
Description
The rate at which the document access has been retried is high.
The situation is evaluated for each distinct value of the NAME attribute.

Formula
*IF *VALUE KQP_OFFICE_SEARCH_GATHERER_PROJECTS.Retries_Rate *GT 5
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
40 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Warning

Clearing conditions
The situation clears when the condition becomes false.

KQP_Office_Search_Index_Size situation
Description
The current size of index is increasing.
The situation is evaluated for each distinct value of the NAME attribute.

Formula
*IF *VALUE KQP_OFFICE_SEARCH_INDEXER_CATALOGS.Index_Size *GT 200
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
15 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

242

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Severity
Warning

Clearing conditions
The situation clears when the condition becomes false.

MSPS Search Navigator item


KQP_MSPS_RBT_SystemIOTraffic situation
Description
Crawling has been paused because of high System IO traffic.
The situation is evaluated for each distinct value of the NAME attribute.

Formula
*IF *VALUE KQP_SEARCH_GATHERER.Reason_to_Back_Off *EQ 1
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
5 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

KQP_MSPS_Search_DocDelayRetry situation
Description
SharePoint is unable to crawl the SharePoint contents.
The situation is evaluated for each distinct value of the NAME attribute.

Formula
*IF *VALUE KQP_SEARCH_GATHERER.Documents_Delayed_Retry *GT 0
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
10 minutes
Chapter 5. Situations reference

243

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

KQP_MSPS_ActiveQueueLength situation
Description
A large number of documents are waiting to be processed.
The situation is evaluated for each distinct value of the NAME attribute.

Formula
*IF *VALUE KQP_SEARCH_GATHERER.Active_Queue_Length *GT 100
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
15 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

KQP_MSPS_Retries_Rate situation
Description
The rate at which the document access has been retried is high.
The situation is evaluated for each distinct value of the NAME attribute.

Formula
*IF *VALUE KQP_SEARCH_GATHERER_PROJECTS.Retries_Rate *GT 5
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

244

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Sampling interval
40 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Warning

Clearing conditions
The situation clears when the condition becomes false.

Shared Service Provider Navigator item


There are no predefined situations for this Navigator item.

SharePoint Publishing Navigator item


KQP_SP_Publish_CacheHitRatio situation
Description
Low value of Cache Hit Ratio leads to slow response to end user.
The situation is evaluated for each distinct value of the NAME attribute.

Formula
*IF *VALUE KQP_SP_PUBLISHING_CACHE.Publishing_Cache_Hit_Ratio *GT 0 *AND
*VALUE KQP_SP_PUBLISHING_CACHE.Publishing_Cache_Hit_Ratio *LT 80
See Attribute groups and attributes for the Monitoring Agent for Microsoft
SharePoint Server on page 37 for descriptions of the attributes in this formula.

Run at startup
This situation is available for distribution.

Sampling interval
15 minutes

Situation persistence
The number of times the conditions of the situation must occur for the situation to
be true is 1.

Severity
Critical

Clearing conditions
The situation clears when the condition becomes false.

Web Server Navigator item


There are no predefined situations for this Navigator item.

Chapter 5. Situations reference

245

246

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Chapter 6. Take Action commands reference


This chapter contains an overview of Take Action commands, references for
detailed information about Take Action commands, and descriptions of the Take
Action commands included in this monitoring agent, if any.

About Take Action commands


Take Action commands can be run from the portal client or included in a situation
or a policy.
When included in a situation, the command runs when the situation becomes true.
A Take Action command in a situation is also referred to as reflex automation.
When you enable a Take Action command in a situation, you automate a response
to system conditions. For example, you can use a Take Action command to send a
command to restart a process on the managed system or to send a text message to
a cell phone.
Advanced automation uses policies to perform actions, schedule work, and
automate manual tasks. A policy comprises a series of automated steps called
activities that are connected to create a workflow. After an activity is completed,
Tivoli Enterprise Portal receives return code feedback, and advanced automation
logic responds with subsequent activities prescribed by the feedback.
A basic Take Action command displays the return code of the operation in a
message box that is displayed after the action completes or in a log file. After you
close this window, no further information is available for this action.

More information about Take Action commands


For more information about working with Take Action commands, see the IBM
Tivoli Monitoring Users Guide.
For a list of the Take Action commands for this monitoring agent and a description
of each command, see the Predefined Take Action commands section in this
chapter and the information in that section for each individual command.

Predefined Take Action commands


This monitoring agent contains the following Take Action commands:
v Start Microsoft Single Sign-on Service
v Start Office Document Conversions Launcher Service
v Start Office Document Conversions Load Balancer Service
v Start Office SharePoint Server Search Service
v
v
v
v
v
v

Start
Start
Start
Start
Start
Start

Copyright IBM Corp. 2008, 2009

SharePoint Portal Administration Service


SharePoint Portal Alert Service
SharePoint Portal Search Service
SharePoint Timer Service
Windows SharePoint Services Administration Service
Windows SharePoint Services Search Service

247

v
v
v
v
v

Start Windows SharePoint Services Timer Service


Start Windows SharePoint Services Tracing Service
Start Windows SharePoint Services VSS Writer Service
Stop Microsoft Single Sign-on Service
Stop Office Document Conversions Launcher Service

v
v
v
v
v
v
v

Stop
Stop
Stop
Stop
Stop
Stop
Stop

Office Document Conversions Load Balancer Service


Office SharePoint Server Search Service
SharePoint Portal Administration Service
SharePoint Portal Alert Service
SharePoint Portal Search Service
SharePoint Timer Service
Windows SharePoint Services Administration Service

v
v
v
v

Stop
Stop
Stop
Stop

Windows
Windows
Windows
Windows

SharePoint
SharePoint
SharePoint
SharePoint

Services
Services
Services
Services

Search Service
Timer Service
Tracing Service
VSS Writer Service

The remaining sections of this chapter contain descriptions of these Take Action
commands, which are listed alphabetically. The following information is provided
about each Take Action command:
Description
Which actions the command performs on the system to which it is sent,
and the permissions required for the Take Action command to function
Return codes
Information that the Take Action command returns

Start Microsoft Single Sign-on Service action


Description
Starts the Microsoft Single Sign-on Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0011I
Message: The Microsoft Single Sign-on service was started.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0013E
Message: Error starting Microsoft Single Sign-on service. Possible
Causes 1. Already started or Service is disabled. 2. Logon failure or
Service does not exist. Check the event log for more information.

248

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Start Office Document Conversions Launcher Service action


Description
Starts the Office Document Conversions Launcher Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0071I
Message: The Office Document Conversions Launcher service was started.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0073E
Message: Error starting Office Document Conversions Launcher service.
Possible Causes 1. Already started or Service is disabled. 2. Logon
failure or Service does not exist. Check the event log for more
information.

Start Office Document Conversions Load Balancer Service action


Description
Starts the Office Document Conversions Load Balancer Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0081I
Message: The Office Document Conversions Load Balancer service was
started.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0083E
Message: Error starting Office Document Conversions Load Balancer
service. Possible Causes 1. Already started or Service is disabled. 2.
Logon failure or Service does not exist. Check the event log for more
information.

Start Office SharePoint Server Search Service action


Description
Starts the Office SharePoint Server Search Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Chapter 6. Take Action commands reference

249

Message ID: KQP0061I


Message: The Office SharePoint Server Search service was started.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0063E
Message: Error starting Office SharePoint Server Search service.
Possible Causes 1. Already started or Service is disabled. 2. Logon
failure or Service does not exist. Check the event log for more
information.

Start SharePoint Portal Administration Service action


Description
Starts the SharePoint Portal Administration Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0001I
Message: The SharePoint Portal Administration service was started.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0003E
Message: Error starting the SharePoint Portal Administration service.
Possible Causes 1. Already started or Service is disabled. 2. Logon
failure or Service does not exist. Check the event log for more
information.

Start SharePoint Portal Alert Service action


Description
Starts the SharePoint Portal Alert Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0041I
Message: The SharePoint Portal Alert service was started.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0043E
Message: Error starting SharePoint Portal Alert service. Possible
Causes 1. Already started or Service is disabled. 2. Logon failure or
Service does not exist. Check the event log for more information.

250

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Start SharePoint Portal Search Service action


Description
Starts the SharePoint Portal Search Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0031I
Message: The SharePoint Portal Search service was started.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0033E
Message: Error starting SharePoint Portal Search service. Possible
Causes 1. Already started or Service is disabled. 2. Logon failure or
Service does not exist. Check the event log for more information.

Start SharePoint Timer Service action


Description
Starts the SharePoint Timer Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0021I
Message: The SharePoint Timer service was started.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0023E
Message: Error starting SharePoint Timer service. Possible Causes 1.
Already started or Service is disabled. 2. Logon failure or Service
does not exist. Check the event log for more information.

Start Windows SharePoint Services Administration Service action


Description
Starts the Windows SharePoint Services Administration Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0131I
Message: The Windows SharePoint Services Administration service was
started.
Chapter 6. Take Action commands reference

251

v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0133E
Message: Error starting Windows SharePoint Services Administration
service. Possible Causes 1. Already started or Service is disabled. 2.
Logon failure or Service does not exist. Check the event log for more
information.

Start Windows SharePoint Services Search Service action


Description
Starts the Windows SharePoint Services Search Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0121I
Message: The Windows SharePoint Services Search service was started.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0123E
Message: Error starting Windows SharePoint Services Search service.
Possible Causes 1. Already started or Service is disabled. 2. Logon
failure or Service does not exist. Check the event log for more
information.

Start Windows SharePoint Services Timer Service action


Description
Starts the Windows SharePoint Services Timer Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0111I
Message: The SharePoint Portal Timer service was started.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0113E
Message: Error starting Windows SharePoint Services Timer service.
Possible Causes 1. Already started or Service is disabled. 2. Logon
failure or Service does not exist. Check the event log for more
information.

252

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Start Windows SharePoint Services Tracing Service action


Description
Starts the Windows SharePoint Services Tracing Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0101I
Message: The Windows SharePoint Services Tracing service was started.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0103E
Message: Error starting Windows SharePoint Services Tracing
service.
Possible Causes
1. Already started or Service
is disabled.
2. Logon failure or Service does not
exist.
Check the event log for more information.

Start Windows SharePoint Services VSS Writer Service action


Description
Starts the Windows SharePoint Services VSS Writer Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0091I
Message: The Windows SharePoint Services VSS Writer service was
started.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0093E
Message: Error starting Windows SharePoint Services VSS Writer
service. Possible Causes 1. Already started or Service is disabled. 2.
Logon failure or Service does not exist. Check the event log for more
information.

Stop Microsoft Single Sign-on Service action


Description
Stops Microsoft the Single Sign-on Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Chapter 6. Take Action commands reference

253

Message ID: KQP0014I


Message: The Microsoft Single Sign-on service was stopped.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0016E
Message: Error stopping Microsoft Single Sign-on service. Possible
Causes 1. Already stopped, Service is not started 2. Logon failure or
Service does not exist. Check the event log for more information.

Stop Office Document Conversions Launcher Service action


Description
Stops the Office Document Conversions Launcher Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0074I
Message: The Office Document Conversions Launcher service was stopped.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0076E
Message: Error stopping Office Document Conversions Launcher service.
Possible Causes 1. Already stopped, Service is not started 2. Logon
failure or Service does not exist Check the event log for more
information.

Stop Office Document Conversions Load Balancer Service action


Description
Stops the Office Document Conversions Load Balancer Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0084I
Message: The Office Document Conversions Load Balancer service was
stopped.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0086E
Message: Error stopping Office Document Conversions Load Balancer
service. Possible Causes 1. Already stopped, Service is not started 2.
Logon failure or Service does not exist Check the event log for more
information.

254

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Stop Office SharePoint Server Search Service action


Description
Stops the Office SharePoint Server Search Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0064I
Message: The Office SharePoint Server Search service was stopped.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0066E
Message: Error stopping Office SharePoint Server Search service.
Possible Causes 1. Already stopped, Service is not started 2. Logon
failure or Service does not exist Check the event log for more
information.

Stop SharePoint Portal Administration Service action


Description
Stops the SharePoint Portal Administration Service. If take action timeout error
occurs, then increase the timeout interval for CDP_DP_ACTION_TIMEOUT
variable. The default take action timeout interval is 20 seconds.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0004I
Message: The SharePoint Portal Administration service was stopped.
Dependent service Microsoft SharePointPS Search has also stopped.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0006E
Message: Error stopping SharePoint Portal Administration service.
Possible Causes 1. Already stopped, Service is not started 2. Logon
failure or Service does not exist. Check the event log for more
information.

Stop SharePoint Portal Alert Service action


Description
Stops the SharePoint Portal Alert Service.

Chapter 6. Take Action commands reference

255

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0044I
Message: The SharePoint Portal Alert service was stopped.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0046E
Message: Error stopping SharePoint Portal Alert service. Possible
Causes 1. Already stopped, Service is not started 2. Logon failure or
Service does not exist Check the event log for more information.

Stop SharePoint Portal Search Service action


Description
Stops the SharePoint Portal Search Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0034I
Message: The SharePoint Portal Search service was stopped.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0036E
Message: Error stopping SharePoint Portal Search service. Possible
Causes 1. Already stopped, Service is not started 2. Logon failure or
Service does not exist Check the event log for more information.

Stop SharePoint Timer Service action


Description
Stops the SharePoint Timer Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0024I
Message: The SharePoint Timer service was stopped.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0026E
Message: Error stopping SharePoint Timer service. Possible Causes 1.
Already stopped, Service is not started 2. Logon failure or Service
does not exist Check the event log for more information.

256

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Stop Windows SharePoint Services Administration Service action


Description
Stops the Windows SharePoint Services Administration Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0134I
Message: The Windows SharePoint Services Administration service was
stopped.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0136E
Message: Error stopping Windows SharePoint Services Administration
service. Possible Causes 1. Already stopped, Service is not started 2.
Logon failure or Service does not exist Check the event log for more
information.

Stop Windows SharePoint Services Search Service action


Description
Stops the Windows SharePoint Services Search Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0124I
Message: The Windows SharePoint Services Search service was stopped.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0126E
Message: Error stopping Windows SharePoint Services Search service.
Possible Causes 1. Already stopped, Service is not started 2. Logon
failure or Service does not exist Check the event log for more
information.

Stop Windows SharePoint Services Timer Service action


Description
Stops the Windows SharePoint Services Timer Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Chapter 6. Take Action commands reference

257

Message ID: KQP0114I


Message: The Windows SharePoint Services Timer service was stopped.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0116E
Message: Error stopping Windows SharePoint Services Timer service.
Possible Causes 1. Already stopped, Service is not started 2. Logon
failure or Service does not exist Check the event log for more
information.

Stop Windows SharePoint Services Tracing Service action


Description
Stops the Windows SharePoint Services Tracing Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0104I
Message: The Windows SharePoint Services Tracing service was stopped.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0106E
Message: Error stopping Windows SharePoint Services Tracing
service.
Possible Causes
1. Already stopped, Service
is not started
2. Logon failure or Service does not
exist
Check the event log for more information.

Stop Windows SharePoint Services VSS Writer Service action


Description
Stops the Windows SharePoint Services VSS Writer Service.

Return codes
v Return Code: 0
Return Code Type: OK
Operating systems: Windows
Message ID: KQP0094I
Message: The Windows SharePoint Services VSS Writer service was
stopped.
v Return Code: 2
Return Code Type: GENERAL_ERROR
Operating systems: Windows
Message ID: KQP0096E
Message: Error stopping Windows SharePoint Services VSS Writer
service. Possible Causes 1. Already stopped, Service is not started 2.
Logon failure or Service does not exist Check the event log for more
information.

258

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Chapter 7. Policies reference


This chapter contains an overview of policies, references for detailed information
about policies, and descriptions of the predefined policies included in this
monitoring agent, if any.

About policies
Policies are an advanced automation technique for implementing more complex
workflow strategies than you can create through simple automation.
A policy is a set of automated system processes that can perform actions, schedule
work for users, or automate manual tasks. You use the Workflow Editor to design
policies. You control the order in which the policy executes a series of automated
steps, which are also called activities. Policies are connected to create a workflow.
After an activity is completed, Tivoli Enterprise Portal receives return code
feedback and advanced automation logic responds with subsequent activities
prescribed by the feedback.

More information about policies


This monitoring agent does not provide predefined policies. For more information
about working with policies, see the IBM Tivoli Monitoring Users Guide.
For information about using the Workflow Editor, see the IBM Tivoli Monitoring
Administrators Guide or the Tivoli Enterprise Portal online help.

Predefined policies
The Monitoring Agent for Microsoft SharePoint Server does not provide predefined
policies.

Copyright IBM Corp. 2008, 2009

259

260

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Chapter 8. Tivoli Common Reporting for the monitoring agent


This chapter contains descriptions of the reports that are currently available with
the Monitoring Agent for Microsoft SharePoint Server.
The reports of IBM Tivoli Monitoring for Microsoft Applications are historical
reports that provide information about the summarized data that is collected in the
Tivoli Data Warehouse. These reports run only on the SharePoint agent V6.2.0 or
later. The supported versions of the Tivoli Common Reporting servers are: V1.1.1.0,
V1.2.0.0, and V1.2.0.1.Table 4 contains the supported databases.
Table 4. Supported databases
Database

Version

Oracle

Oracle V9.2,10g Release 1 and 10g Release 2

DB2

DB2 V8.1 Fix Pack 10 and higher, V8.2 Fix Pack


3 and higher, V9.1 and fix packs

MSSQL

SQL Server 2005 Service Pack 2, SQL Server


2000 Service Pack 4, SQL Server 2008 Service
Pack 1

See the following additional information about using reports with this monitoring
agent:
v The IBM Tivoli Common Reporting Administrators guide V1.2.0.1 or later contains
information about prerequisites, importing and running the reports, and
configuring the data sources.
v Tivoli Common Reporting troubleshooting on page 310 contains information
about common errors when using Tivoli Common Reporting with this
monitoring agent.
Complete documentation for the Tivoli Common Reporting tool is located at
http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/
com.ibm.tivoli.tcr.doc/tcr_welcome.html
Use the following image and directory to install the Tivoli Common Reporting files
on the Tivoli Common Reporting server:
Product image: ITMfMSApps620InterimFeature1
Package: \REPORTS\KQP\SharePointReports_V1.0.zip
The reports in this chapter are grouped into the following categories:
Category 1: Performance reports
Document Conversion Status report
Displays status of the document conversion process in terms of
pending document conversions on multiple servers.
Document Conversion Status Subreport
Displays the document conversion status for the selected server.
Excel Services Performance report
Displays status of the session and the active requests of multiple
servers.

Copyright IBM Corp. 2008, 2009

261

Excel Services Performance Subreport


Displays the session status and the active requests status of
multiple servers.
Shared Service Provider Performance report
Displays the number of user profiles that are imported, the rate at
which the user profiles are imported, the site latency, and the
throughput.
Gatherer report
Displays state of the gatherer service, IO traffic rate, status of the
filtered documents, and the number of servers that are accessed by
the system.
Indexer Catalogs report
Displays the indexing details, such as index size and active
connection.
Archival Plug-in report
Displays the status of the document while searching the content of
the SharePoint site and the documents present in the first and the
second queue.
Category 2: Alerts report
Alert Notification Status report
Displays the daily and weekly notifications that are sent.
Alert Plug-in report
Displays status of alerts and the documents processing.
Alert Plug-in Subreport
Displays status of the alerts and documents processing.
Category 3: Availability report
SharePoint Services Availability report
Displays status of the important services of MOSS 2007 and MSPS
2003 like Windows SharePoint Services Search, SharePoint Portal
Alert, Microsoft SharePoint PS Search, WSSADMIN, SPSAdmin,
and Osearch.
SharePoint Services Availability Subreport
Displays the status of the important services of MOSS 2007 and
MSPS 2003 like Windows SharePoint Services Search, SharePoint
Portal Alert, Microsoft SharePoint PS Search, WSSADMIN,
SPSAdmin, and Osearch in a bar chart view.
Category 4: Memory Utilization report
Memory And Threads Usage report
Displays the memory usage and thread count of the important
services of MOSS 2007 and MSPS 2003 such as Windows
SharePoint Services Search, SharePoint Portal Alert, Microsoft
SharePointPS Search, WSSADMIN, SPSAdmin, and Osearch.
Memory And Threads Usage Subreport
Displays the memory usage and thread count of the important
services of MOSS 2007 and MSPS 2003 such as Windows
SharePoint Services Search, SharePoint Portal Alert, Microsoft
SharePointPS Search, and WSSADMIN, SPSAdmin, Osearch.

262

Monitoring Agent for Microsoft SharePoint Server: Users Guide

InfoPath Forms Memory Usage report


Displays the memory usage by the InfoPath forms and templates.
SharePoint Publishing Cache report
Displays the total number of hits and misses on the publishing
cache, total number of times the SharePoint user has updated the
cache because of site changes, and the cache size.
SharePoint Publishing Cache Subreport
Displays the total number of hits and misses on the publishing
cache, total number of times the SharePoint user has updated the
cache because of site changes, and the cache size.
Category 5: Event Details report
SharePoint Event Details report
Displays the types of events generated , such as Error or Warning
on multiple servers.
The remaining sections in this chapter contain descriptions of the reports. For each
report, the following information is included:
v
v
v
v
v

Name
Description
Purpose
Parameters
Input Attributes

v Tables or views used


v Output
v Usage

Category 1: Performance reports


Document Conversion Status report
Name

Document Conversion Status report

Description

This report displays status of the document conversion process in terms of pending
document conversions on multiple servers. This report is available only for MOSS 2007.

Purpose

You can use this report to identify the number of documents pending conversion.

Chapter 8. Tivoli Common Reporting for the monitoring agent

263

Parameters

Server Name
Select the name of the server from the Server Name list. To view data on all servers,
select All servers.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.

Input attributes

Node
Pending Conversions

Tables or views used

KQP_DOCUMENT_CONVERSIONS_DV

Output

The bar chart displays the maximum number of documents that are not converted from
one file type to another file type. For this bar chart:
X-Axis: Server Name
Y-Axis: Number of pending conversions
You can drill down the bar chart to view the status of the document conversion for the
selected server in the line chart. For the line chart:
X-Axis: Days
Y-Axis: Number of pending conversions
The line chart displays two lines. One line displays maximum pending conversion status
and the other line displays the average pending conversion status. You can also view the
pending conversions on multiple servers.
IT administrators can use this report to view the information about the performance of the
document process on different servers. Thus, the administrator can compare the status of
document conversions on different servers.

Usage

Document Conversion Status Subreport


Name

Document Conversion Status Subreport

Description

This report displays the document conversion status for the selected server. This report is
available only for MOSS 2007.

264

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Purpose

You can use this report to obtain the document conversion status details for the selected
sever.

Parameters

Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.

Input attributes

Node
Pending Conversions

Tables or views used

KQP_DOCUMENT_CONVERSIONS_DV

Output

You can get the status of the document conversion for the selected server in the line chart.
For the line chart:
X-Axis: Days
Y-Axis: Number of pending conversions
The line chart displays two lines. One line displays maximum pending conversion status
and the other line displays the average pending conversion status. You can also view the
pending conversions on multiple servers.

Usage

This report displays document conversion status details for the selected sever. Line chart
have two lines, one line shows average number of pending conversions and other line
shows maximum number of pending conversions

Excel Services Performance report


Name

Excel Services Performance report

Description

This report displays the status of the session and the active requests of multiple servers.
This report is available only for MOSS 2007.

Purpose

You can use this report to identify the performance of the excel services.

Chapter 8. Tivoli Common Reporting for the monitoring agent

265

Parameters

Input attributes

Server Name
Select the name of the server from the Server Name list. To view data on all servers,
select All servers.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.
Active Sessions
Active Requests
Average Request Processing Time
Requests Received per Sec
Workbook Cache Size
Requests with Errors per Sec
Excel Web Access Request Time

Tables or views used

v KQPEXCELCA_DV
v KQP_EXCEL_WEB_ACCESS_DV

266

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Output

This report contains a bar chart and a table. The bar chart displays the maximum number
of active sessions and active requests that are processed by the Excel calculation service.
For this bar chart:
X-Axis: Server Name
Y-Axis: Number of Active sessions and Active requests
This report displays two vertical bars for active sessions and active requests indicated by
different colors for the selected server. You can view the data for multiple servers.
Click the server on the bar chart to drill down to a line chart. The line chart displays the
detailed information about the active sessions and active requests on that server. This
report also displays the Excel services performance details line chart. This chart displays
two lines for active sessions and active requests. For this line chart:
X-Axis: Date and Time
Y-Axis: Number of Active sessions and Active requests
The table contains all the details of the excel calculation service in terms of number of
active sessions, active requests, average request processing time, requests received per
second, workbook cache size, requests with errors per second, and Excel Web access
request time.

Usage

IT administrators can use this report to view the information about the performance of the
Excel service of MOSS 2007 on multiple servers.

Excel Services Performance Subreport


Name

Excel Services Performance Subreport

Description

This report displays the status of the sessions and the active requests of multiple servers.
This report is available only for MOSS 2007.

Purpose

You can use this report to identify the performance of excel service.

Chapter 8. Tivoli Common Reporting for the monitoring agent

267

Parameters

Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.

Input attributes

Active Sessions
Active Requests

Tables or views used

v KQP_EXCELCA_DV
v KQP_EXCEL_WEB_ACCESS_DV

Output

The line chart displays the detailed information about the active sessions and active
requests on that server. This report also displays the Excel services performance details
line chart. For this line chart:
X-Axis: Date and Time
Y-Axis: Number of Active sessions and Active requests
This chart displays two lines for active sessions and active requests.
IT administrators can use this report to view information about the trends of active
sessions and active requests over a period of time.

Usage

Shared Service Provider Performance report


Name

Shared Service Provider Performance report

Description

This report displays the number of user profiles that are imported, the rate at which the
user profiles are imported, the site latency, and the throughput. This report is available
only for MOSS 2007.

Purpose

You can use this report to identify the performance of Shared Service Provider
administration site.

268

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Parameters

Input attributes

Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.
Node
Name
Distribution Lists Imported
User Profile Import Rate
Users Imported
Personal Site Latency
Public Site Latency
Personal Site Throughput
Public Site Throughput

Tables or views used

KQP_SHARED_SERVICE_PROVIDER_DV

Output

This report contains two bar charts and a table. You can select a single server and can
view the details of Shared Service Provider (SSP) administration site. The first bar chart
displays the number of user profiles that are imported on the selected server. For the first
bar chart:
X-Axis: Instance name
Y-Axis: Average number of users imported
The second bar chart displays the personal and public site latency. For the second bar
chart:
X-Axis: Instance name
Y-Axis: Value of Personal site latency and Public site latency.
This chart contains two vertical bars for personal site latency and public site latency for
different instances.
The table displays the distribution lists imported, user profile import rate, number of users
imported, personal and public site latency, and throughput.

Chapter 8. Tivoli Common Reporting for the monitoring agent

269

IT administrators can use this report to get information about the performance of the SSP
administration site in terms of user profiles imported, site latency, and throughput.

Usage

Gatherer report
Name

Gatherer report

Description

This report displays the state of the gatherer service, IO traffic rate, status of the filtered
documents, and the number of servers that are accessed by the system. This report is
available for Microsoft SharePoint Portal Server (MSPS) 2003 and Microsoft Office
SharePoint Server (MOSS) 2007.

Purpose

You can use this report to identify status of the gatherer service and the performance of
the service.

Parameters

SharePoint Version
Select the version of the SharePoint as SPS 2003 or MOSS 2007 from the SharePoint
Version.
Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.

Input attributes

Node
Reason to Back Off
Admin Client
Server Objects
System IO traffic rate
Percent Documents Filtered Unsuccessfully
Retries
Documents Filtered with Errors
Successfully Filtered Documents

270

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Tables or views used

v KQP_OFFICE_SEARCH_GATHERER_DV
v KQP_OFFICE6_DV

Output

This report contains a line chart and a table for Office gatherer, SharePoint gatherer, and
MSPS gatherer. This report is available for a single server. The line chart displays the
detailed information about the percentage of unsuccessfully filtered documents over a
period of time. For this line chart:
X-Axis: Date and Time
Y-Axis: Percentage of unsuccessfully filtered documents
If you select MSPS 2003, then a line chart and a table for MSPS gatherer are displayed. If
you select MOSS 2007, then a line chart and a table for Office gatherer and SharePoint
gatherer are displayed.
The table contains the information about the Reason to Back Off, Admin Client, Server
Objects, System IO traffic rate in MB, Percentageof Documents Filtered Unsuccessfully,
Retries, Documents Filtered with Errors, and Successfully Filtered Documents.
For the Office gatherer, the data is selected from the KQP_OFFICE_SEARCH_GTAHERER
table. For the MSPS gatherer, the data is selected from the KQP_SEARCH_GATHERER
table.

Usage

IT administrators can use this report to get information about the number of servers that
are currently accessed by the system. IT administrators can also use this report to identify
the status of the crawling process, and the status and performance of the gatherer service.

Indexer Catalogs report


Name

Indexer Catalogs report

Description

This report displays indexing details, such as the index size and the active connection. This
report is available for both MSPS 2003 and MOSS 2007.

Purpose

You can use this report to identify the details of the indexing process.

Chapter 8. Tivoli Common Reporting for the monitoring agent

271

Parameters

Input attributes

SharePoint Version
Select the version of the SharePoint as SPS 2003 or MOSS 2007 from the SharePoint
Version.
Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget. You
must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.
Node
Index Size
Persistent Indexes
Queries
Queries Succeeded
Unique Keys
Percent of Failed Queries
Active Connections
Successful Queries

Tables or views used

v KQPOFFICE7_DV
v KQP_SEARCH_CATALOGS _DV

272

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Output

This report contains a line chart and a table for the Office indexer catalog, the SharePoint
indexer catalog, and the MSPS indexer catalog. If you select MSPS 2003, then a line chart
and a table for MSPS indexer catalog are displayed. If you select MOSS 2007, then a line
chart and a table for Office indexer catalog and SharePoint indexer catalog are displayed.
This report is available for a single server.
The line chart displays the detailed information about the percentage of failed queries for a
period of time. For this line chart:
X-Axis: Date and Time
Y-Axis: Percentage of failed queries
The Office indexer catalog table and the SharePoint indexer catalog table contain the
information about the following attributes: Index Size, Persistent Indexes, Queries, Queries
Succeeded, Unique Keys, Percent of Failed Queries, and Active Connections. The MSPS
indexer catalog table contains the information about the following attributes: Persistent
Indexes, Queries, Successful Queries, Unique Keys, and Percent of Failed Queries.
For Office indexer catalog, the data is selected from the KQPOFFICE7 view. For SharePoint
indexer catalog, the data is selected from the KQPSHARE12 view, and for MSPS indexer
catalog, the data is selected from the KQP_SEARCH_CATALOGS view.

Usage

IT administrators can use this report to get the information indexing details. The
administrator can use this report to monitor the status of the search catalog, number of
search queries posted to the catalog, number of queries that produce successful searches,
and the index size.

Archival Plug-in report


Name

Archival Plug-in report

Description

This displays the status of the document while searching the content of the SharePoint site
and the documents present in the first and second queue. This report is available for MSPS
2003 and MOSS 2007.

Purpose

You can use this report to identify the status of the document.

Chapter 8. Tivoli Common Reporting for the monitoring agent

273

Parameters

Input attributes

SharePoint Version
Select the version of the SharePoint as SPS 2003 or MOSS 2007 from the SharePoint
Version.
Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.
Node
Name
Total Documents in First Queue
Total Documents in Second Queue
Error Documents
Blocked Documents
Retried Documents

Tables or views used

274

KQPOFFICE4_DV

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Output

The Archival Plug-in report for MOSS 2007 contains two bar charts, each for Office search
archival plug-in and SharePoint search archival plug-in. The Archival Plug-in Report for
MSPS 2003 contains two bar charts for MSPS search archival plug-in. The first bar chart
displays information about the total number of error, blocked, and retried documents. For
the first bar chart:
X-Axis: Error Documents, Blocked Documents, and Retried Documents
Y-Axis: Related values of the attributes
The second bar chart displays information about the number of documents in the first and
second queue. For the second bar chart:
X-Axis: Total Documents in First Queue, Total Documents in Second Queue
Y-Axis: Related values of the attributes
The bar charts display vertical bars of different colors for error, blocked, retried documents,
and documents in first and second queue for a particular instance. You can select a single
server. For Office search archival plug-in, the data is selected from the view KQPOFFICE4
for SharePoint search archival plug, the data gets selected from the view KQPSHARE10,
and for MSPS search archival plug-in, the data gets selected from the view
KQP_SEARCH_ARCHIVAL_PLUGIN.

Usage

IT administrators can use to get information related to the document status while searching
the content of the SharePoint site.

Category 2: Alerts reports


Alert Notification Status report
Name

Alert Notification Status report

Description

This report displays the daily and weekly notifications that are sent. You can use the alert
notification service to schedule and send alerts, and alert results on one or more servers
that run SharePoint portal server. A notification is sent by an e-mail for certain events, such
as changes in the document or changes in the search result for a particular query. This
report is available only for MSPS 2003.

Purpose

You can use this report to identify alerts. The alerts can be identified with the help of
notifications that are sent.

Chapter 8. Tivoli Common Reporting for the monitoring agent

275

Parameters

Server Name
Select the name of the server from the Server Name list. To view data on all servers,
select All servers.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.

Input attributes

Node
Daily Notifications Sent
Weekly Notifications Sent
Immediate Notifications Sent
Total Notifications Sent
Notification currently processed

Tables or views used

KQPSHAREP1_DV

Output

This report contains 2 bar charts. You can select multiple servers to view the data on them.
The first bar chart displays the total number of Daily notifications sent, Weekly
notifications sent, Immediate notifications sent, and Total notifications sent by the selected
server. For this bar chart:
X-Axis: Server name
Y-Axis: Total number of notifications
For each notification type, a bar is displayed with different colors. The second bar chart
displays the number of notifications that are currently being processed by the notification
service on the selected server. For this bar chart:
X-Axis: Server Name
Y-Axis: Number of notification currently processed

Usage

IT administrators can use this report to get notification about the alerts that are generated.
Thus, the administrator can keep a track of the alerts and prioritize them accordingly.

Alert Plug-in report


Name

276

Alert Plug-in report

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Description

This report displays the status of the alerts and the document processing. It also helps in
identifying the performance of the alert engine in terms of Total Documents Processed,
Total Hits Received and Total Security Checks done by the alert engine. This report is
available only for MSPS 2003.

Purpose

You can use this report to identify the status of the alerts. You can also use this report to
identify the performance of the alert engine in terms of Total Documents Processed, Total
Hits Received, and Total Security Checks done by the alert engine.

Parameters

Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.

Input attributes

Node
Total Alerts
Total Alerts Added
Total Alerts Deactivated
Total Alerts Deleted
Total Documents Failed
Total Documents Processed
Total Hits Received
Total Quota Processing
Total Security Checks

Tables or views used

KQPSHAREP3_DV

Chapter 8. Tivoli Common Reporting for the monitoring agent

277

This report contains a bar chart that displays information about the alert statistics. In the
bar chart:

Output

X-Axis: Server Name


Y-Axis: Number of Total Alerts, Total Alerts Added, and Total Alerts Deleted
For each server, three vertical bars get displayed with different color for Total Alerts, Total
Alerts Added, and Total Alerts Deleted attributes.
The table view contains information about the following attributes: Total Alerts, Total
Alerts Added, Total Alerts Deactivated, Total Alerts Deleted, Total Documents Failed, Total
Documents Processed, Total Hits Received, Total Quota Processing, and Total Security
Checks on the selected server. Click the server in the table to drill down to a heat map. The
heat map displays information about the alerts that are added. For the heat map:
X-Axis: Hours
Y-Axis: Days
IT administrators can use this report to compare the status of the alerts. IT administrator
can also get information about the security checks that are done by the alert engine.

Usage

Alert Plug-in Subreport


Name

Alert Plug-in Subreport

Description

This report displays the Alerts status and the documents processing status. It also helps in
identifying the performance of the alert engine in terms of Total Documents Processed,
Total Hits Received and Total Security Checks done by the alert engine. This report is
available only for MSPS 2003.

Purpose

You can use this report to identify status of the alerts.

Parameters

Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Threshold Specification
You can enter threshold specification for Fair, Warning, Bad, and Critical status.
Instance Name
Select the instance name from the Instance Name list.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.

Input attributes

Node
Total Alerts Added

Tables or views used

KQPSHAREP3_HV

Output

This report contains a heat map that displays the information about the alerts added. For
the heat map:
X-Axis: Hours
Y-Axis: Days

Usage

278

IT administrators can use this report to identify the status of alerts and the performance of
the alert engine.

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Category 3: Availability reports


SharePoint Services Availability report
Name

SharePoint Services Availability report

Description

This report displays the status of the important services of MOSS 2007 and MSPS 2003
such as Windows SharePoint Services Search, SharePoint Portal Alert, Microsoft SharePoint
PS Search, WSSADMIN, SPSAdmin, and Osearch in z bar chart view. You can drill down
the bar chart to see the detailed status of each service over a period of time.

Purpose

You can use this report to identify the status (UP or DOWN) of the important services.

Parameters

Service Name
Select the name of the service from the Service Name list. You can view the
availability of the selected service on all the servers.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.

Input attributes

Name
Status
Write time

Tables or views used

KQP_AVAILABILITY

Output

This report contains a bar chart for the selected service. The bar chart displays the status of
the selected service on multiple servers. For the bar chart:
X-Axis: Server Name
Y-Axis: Service availability percentage
Click the service name to drill down to a line chart. The line chart displays the details of
the service status with respect to time. The line chart displays the status of the selected
service over the time period. For this line chart:
X-Axis Date and Time
Y-Axis Service status
The status of the service is UP, if the service is running on that computer, DOWN if the
service is not running, and UNKNOWN if the MOSS or MSPS is not installed on the target
computer.
The Windows SharePoint Services Search, WSSADMIN, and Osearch are the services of
Microsoft Office SharePoint Server 2007. The SharePoint Portal Alert, Microsoft
SharePointPS Search, and SPSAdmin are the services of Microsoft SharePoint Portal Server
2003.

Usage

IT administrators can use this report to observe the status of the services, such as Up,
Down, Unknown, Warning, Pass, Fail, and Process Data Not Available. UNKNOWN status
indicates that the service is not available.

SharePoint Services Availability Subreport


Name

SharePoint Services Availability Subreport


Chapter 8. Tivoli Common Reporting for the monitoring agent

279

Description

This report displays the status of the important services of MOSS 2007 and MSPS 2003 like
Windows SharePoint Services Search, SharePoint Portal Alert, Microsoft SharePoint PS
Search, WSSADMIN, SPSAdmin, and Osearch in a bar chart view. You can drill down the
bar chart to see the detailed status of each service over a period of time.

Purpose

You can use this report to identify the status (UP or DOWN) of important services.

Parameters

Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Service Name
Select the name of the service from the Service Name list. You can view the
availability of the selected service on all the servers.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.

Input attributes

Name
Status
Write time

Tables or views used

KQP_AVAILABILITY

Output

The line chart displays the status of that service over the time period. For this line chart:
X-Axis Date and Time
Y-Axis Service status
The status of the service is UP, if the service is running on that computer, DOWN if the
service is not running, and UNKNOWN if the MOSS or MSPS is not installed on the target
computer.
The Windows SharePoint Services Search, WSSADMIN, and Osearch are the services of
Microsoft Office SharePoint Server 2007. The SharePoint Portal Alert, Microsoft
SharePointPS Search, and SPSAdmin are the services of Microsoft SharePoint Portal Server
2003.
IT administrators can use this report to observe the status of the services, such as Up,
Down, Unknown, Warning, Pass, Fail, and Process Data Not Available. UNKNOWN status
indicates that the service is not available.

Usage

Category 4: Memory Utilization reports


Memory And Threads Usage report
Name

Memory And Threads Usage report

Description

This report displays the memory usage and thread count of the important services of
MOSS 2007 and MSPS 2003 such as Windows SharePoint Services Search, SharePoint
Portal Alert, Microsoft SharePoint PS Search, and WSSADMIN, SPSAdmin, Osearch.

Purpose

You can use this report to identify the virtual size and working set size for the important
SharePoint services. You can also use this report to get the information about the number
of threads that are currently allocated by the process.

280

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Parameters

Input attributes

SharePoint Version
Select the version of the SharePoint as SPS 2003 or MOSS 2007 from the SharePoint
Version.
Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.
Node
Name
Virtual size in MB
Working set Size
Thread count

Tables or views used

KQP_AVAILABILITY_DV

Output

This report contains a bar chart that displays the average memory usage in terms of
virtual size in MB, working set size in MB and thread count. For this bar chart:
X-Axis: Name of services
Y-Axis: Values of virtual size in MB and working set Size in MB
Secondary Y-Axis: Number of Thread Counts
Thus, for each service, the X axis has three vertical bars with different colors. Click a
service to drill down to a line chart that provides the details about the memory usage for
that service. For the line chart:
X-Axis: Date and Time
Y-Axis: Values of virtual size in MB, working set size in MB, and Thread Count
You can view the data for a single server.

Usage

IT administrators can use this report to get information about the memory allocated by
different services and the number of threads that are currently allocated by the process.

Chapter 8. Tivoli Common Reporting for the monitoring agent

281

Memory And Threads Usage Subreport


Name

Memory And Threads Usage Subreport

Description

This report displays the memory usage and thread count of the important services of
MOSS 2007 and MSPS 2003 such as Windows SharePoint Services Search, SharePoint
Portal Alert, Microsoft SharePointPS Search, and WSSADMIN, SPSAdmin, Osearch.

Purpose

You can use this report to identify the virtual size and working set size for the important
SharePoint services. You can also use this report to know the number of threads currently
allocated by the process.

Parameters

SharePoint Version
Select the version of the SharePoint as SPS 2003 or MOSS 2007 from the SharePoint
Version.
Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Service Name
Select the name of the service from the Service Name list.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an end
date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.

Input attributes

Node
Virtual size in MB
Working set Size
Thread count

Tables or views used

KQP_AVAILABILITY_DV

Output

The line chart provides all the details about the memory usage for that service. For the line
chart:
X-Axis: Date and Time
Y-Axis: Values of virtual size in MB, working set size in MB, and Thread Count

Usage

282

IT administrators can use this report to get information about the memory allocated by
different services and the number of threads that are currently allocated by the process.

Monitoring Agent for Microsoft SharePoint Server: Users Guide

InfoPath Forms Memory Usage report


Name

InfoPath Forms Memory Usage report

Description

This report displays memory used by the InfoPath forms and templates. The InfoPath
form service is built on the Microsoft Windows SharePoint Services 3.0. You can use the
InfoPath service to fill the InfoPath forms and publish them on the SharePoint sites. This
report is available only for MOSS 2007.

Purpose

You can use this report to identify the memory used by InfoPath forms, business logic
assemblies, and InfoPath templates.

Parameters

Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an
end date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.

Input attributes

Node
Business Logic Assemblies in Memory
Cached Form Templates
Form Templates in Memory
Forms in Memory

Tables or views

KQP_ INFOPATH_FORMS_SERVICES_DV

Output

The bar chart displays the maximum memory usage on the selected server by the forms
and business logic assemblies. For this bar chart:
X-Axis: Instance Name
Y-Axis: Number of forms or templates

Usage

IT administrators can use this report to get information about the memory used by
InfoPath forms, templates, and Business logic assemblies. Thus, the administrator can get
information about the total load on the InfoPath forms service. The Cached form
templates display the number of form templates added to the ASP.NET object cache and,
which are not yet expired.

Chapter 8. Tivoli Common Reporting for the monitoring agent

283

SharePoint Publishing Cache report


Name

SharePoint Publishing Cache report

Description

This report displays the total number of hits and misses on the publishing cache, total
number of times the SharePoint user has updated the cache because of site changes, and
the cache size. This report is available only for MOSS 2007.

Purpose

You can use this report to identify the utilization of the cache and the frequency of cache
used.

Parameters

Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an
end date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.

Input attributes

Name
Publishing Cache Hit Count
Publishing Cache Hit Ratio
Publishing Cache Miss Count
Total Blob Disk Size
Total Cache Flushes
Total Objects
Total Objects Added
Total Objects discard

Tables or views used

284

KQP_SP_PUBLISHING_CACHE_DV

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Output

The bar chart displays the ratio of hits to misses on the Publishing cache and the Total
cache flushes. For the bar chart:
X-Axis: Values of Publishing cache hit ratio and Total cache flushes
Y-Axis: Site name
Click a site on the bar chart to drill down to the line chart. The line chart displays the hit
ratio and cache flush details of the selected site. For the line chart:
X-Axis: Date and time
Y-Axis: Values of Publishing cache hit ratio and Total cache flushes
The table contains the detailed information about the following attributes: Publishing
Cache Hit Count, Publishing Cache Hit Ratio, Publishing Cache Miss Count, Total Blob
Disk Size, Total Cache Flushes, Total Objects in the Cache, Total Objects Added and
Discarded.

Usage

IT administrators can use this report to get information about cache utilization and the hit
and miss count to the publishing cache. The administrators can also get information about
the number of sites that are present on the selected server.

SharePoint Publishing Cache Subreport


Name

SharePoint Publishing Cache Subreport

Description

This report displays the total number of hits and misses on the publishing cache, total
number of times the SharePoint user has updated the cache because of site changes, and
the cache size. This report is available only for MOSS 2007.

Purpose

You can use this report to identify the utilization of the cache and the frequency of cache
used.

Chapter 8. Tivoli Common Reporting for the monitoring agent

285

Parameters

Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Instance Name
Select the name of the instance from the Instance Name list.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an
end date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Summarization Type
Select the summarization types, such as Hourly, Daily, Weekly, Monthly, Quarterly,
Yearly, or Default from the list. If you select the Default option, the summarization
type is computed based on the number of days for the date range.
Shift and Vacation Period
Shift Period
If shifts are enabled, the hourly table displays the shift period as 1 or 2,
depending on the peak and off-peak hours that are configured in the data
warehouse. The daily table consists of 1 and 2 corresponding to the peak and
off-peak hours, and -1 corresponding to the summarized value for that day. If
shifts are not enabled, then the default value is -1.
Vacation Period
If the vacation period is not enabled, the default value is -1. You can enter the
value 1 or 2, if the vacation period is enabled.

Input attributes

Publishing Cache Hit Ratio


Total Cache Flushes

Tables or views used

KQP_SP_PUBLISHING_CACHE_DV

Output

The line chart displays the hit ratio and cache flush details of the selected site. For this
line chart:
X-Axis: Date and time
Y-Axis: Values of Publishing cache hit ratio and Total cache flushes
IT administrators can use this report to get information about cache utilization and the hit
and miss count to the publishing cache. The administrators can also get information about
the number of sites that are present on the selected server.

Usage

Category 5: Event Details reports


SharePoint Event Details report
Name

SharePoint Event Details report

Description

This report displays the types of events generated, such as Error or Warning on multiple
servers. Thus the administrator can use this report to prioritize the tasks and resolve the
problem. This report is available for MOSS 2007 and MSPS 2003.

Purpose

You can use this report to identify the errors or the warnings generated.

286

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Parameters

Input attributes

Server Name
Select the name of the server from the Server Name list. You can view the data for
the selected server.
Event Source
Select an event source from the Event Source list of the selected server to view the
data for that event source.
Date Range
Report Period
Select the report period from a predefined date range, such as Last Week,
Current Month, Last 30 Days, and so on. You can also enter a start date, an
end date, and the time for the reporting period.
Start Date
Select a start date from the calendar and the start time from the time widget.
You must select both date and time.
End Date
Select an end date from the calendar and an end time from the time widget.
You must select both date and time.
Node
Event type
Time generated Event ID
Event Source
Event Category

Tables or views used

KQP_EVENT_LOG

Output

This report contains all the details about the generated events. The bar chart displays the
total number of critical events and warnings that are generated.
The table displays information about the events generated only for the selected event
source. You can view the event information for a single server and a single event source.
The table contains Node, Event type as error or warning, Time when the event got
generated, Event ID, Event source, and Event category.

Usage

IT administrators can use this report to monitor the errors and warnings, and to correct
the performance issues and the potential problems accordingly.

Chapter 8. Tivoli Common Reporting for the monitoring agent

287

288

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Chapter 9. Troubleshooting
This chapter provides agent-specific troubleshooting information. See the IBM
Tivoli Monitoring Troubleshooting Guide for general troubleshooting information. Also
see Support information on page 312 for other problem-solving options.
Note: You can resolve some problems by ensuring that your system matches the
system requirements listed in Chapter 2, Requirements and agent-specific
installation and configuration information for the monitoring agent, on
page 7.

Gathering product information for IBM Software Support


Before contacting IBM Software Support about a problem you are experiencing
with this product, gather the information in Table 5 that relates to the problem.
Table 5. Information to gather before contacting IBM Software Support
Information type

Description

Log files

Collect trace log files from failing systems. Most logs are located in a logs subdirectory
on the host computer. See Trace logging on page 290 for lists of all trace log files and
their locations. See the IBM Tivoli Monitoring Users Guide for general information about
the IBM Tivoli Monitoring environment.

Microsoft SharePoint
Server information

v Version number and patch level

Operating system

Operating system version number and patch level

Messages

Messages and other information displayed on the screen

Version numbers for


IBM Tivoli Monitoring

Version number of the following members of the monitoring environment:


v IBM Tivoli Monitoring. Also provide the patch level, if available.
v IBM Tivoli Monitoring for Microsoft Applications: Microsoft SharePoint Server Agent

Screen captures

Screen captures of incorrect output, if any.

See http://www.ibm.com/software/support/probsub.html for information about


working with IBM Software Support.

Built-in troubleshooting features


The primary troubleshooting feature in the Monitoring Agent for Microsoft
SharePoint Server is logging. Logging refers to the text messages and trace data
generated by the Monitoring Agent for Microsoft SharePoint Server. Messages and
trace data are sent to a file.
Trace data captures transient information about the current operating environment
when a component or application fails to operate as designed. IBM Software
Support personnel use the captured trace information to determine the source of
an error or unexpected condition. See Trace logging on page 290 for more
information.

Copyright IBM Corp. 2008, 2009

289

Problem classification
The following types of problems might occur with the Monitoring Agent for
Microsoft SharePoint Server:
v Installation and configuration
v General usage and operation
v Display of monitoring data
v Take Action commands
This chapter provides symptom descriptions and detailed workarounds for these
problems, as well as describing the logging capabilities of the monitoring agent.
See the IBM Tivoli Monitoring Troubleshooting Guide for general troubleshooting
information.

Trace logging
Trace logs capture information about the operating environment when component
software fails to operate as intended. The principal log type is the RAS (Reliability,
Availability, and Serviceability) trace log. These logs are in the English language
only. The RAS trace log mechanism is available for all components of IBM Tivoli
Monitoring. Most logs are located in a logs subdirectory on the host computer. See
the following sections to learn how to configure and use trace logging:
v Principal trace log files on page 291
v Examples: using trace logs on page 292
v Setting RAS trace parameters on page 293
Note: The documentation refers to the RAS facility in IBM Tivoli Monitoring as
RAS1.
IBM Software Support uses the information captured by trace logging to trace a
problem to its source or to determine why an error occurred. All components in
the IBM Tivoli Monitoring environment have a default tracing level. The tracing
level can be changed on a per-component level to adjust the type of trace
information collected, the degree of trace detail, the number of trace logs to be
kept, and the amount of disk space used for tracing.

Overview of log file management


Table 6 on page 291 provides the names, locations, and descriptions of RAS1 log
files. The log file names adhere to the following naming convention:
Windows systems
hostname_productcode_program_HEXtimestamp-nn.log

where:
v hostname is the host name of the computer where the monitoring component is
running.
v productcode is the two-character product code. For IBM Tivoli Monitoring for
Microsoft Applications: Microsoft SharePoint Server Agent, the product code is
qp.
v program is the name of the program being run.
v HEXtimestamp is a hexadecimal time stamp representing the time at which the
program started.
v nn is a rolling log suffix.

290

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Principal trace log files


Table 6 contains locations, file names, and descriptions of trace logs that can help
determine the source of problems with agents.
Table 6. Trace log files for troubleshooting agents
System where log
is located

File name and path

Description

On the Tivoli
Enterprise
Monitoring Server

v Windows: The file in the


install_dir\InstallITM path

Provides details about products that are


installed.
Note: Trace logging is enabled by default. A
configuration step is not required to enable this
tracing.

v UNIX: The candle_installation.log file in


the install_dir/logs path
The Warehouse_Configuration.log file is in
the following location on Windows systems:
install_dir\InstallITM

Provides details about the configuration of data


warehousing for historical reporting.

The name of the RAS log file is as follows:

Traces activity on the monitoring server.

v Windows: install_dir\logs\
hostname_ms_timestamp-nn.log
v UNIX: install_dir/logs/
hostname_productcode_timestamp.log
Note: File names for RAS1 logs include a
hexadecimal time stamp.
Also on UNIX, a log with a decimal time
stamp is provided:
hostname_productcode_timestamp.log and
hostname_productcode_ timestamp.pidnnnnn in
the install_dir/logs path, where nnnnn is the
process ID number.
On the Tivoli
Enterprise Portal
Server

The name of the RAS log file is as follows:

Traces activity on the portal server.

v Windows: install_dir\logs\
hostname_cq_HEXtimestamp-nn.log
v UNIX: install_dir/logs/
hostname_cq_HEXtimestamp-nn.log
Note: File names for RAS1 logs include a
hexadecimal time stamp.
Also on UNIX, a log with a decimal time
stamp is provided:
hostname_productcode_timestamp.log and
hostname_productcode_ timestamp.pidnnnnn in
the install_dir/logs path, where nnnnn is the
process ID number.
The teps_odbc.log file is located in the
following path
v Windows: install_dir\InstallITM path.

When you enable historical reporting, this log


file traces the status of the warehouse proxy
agent.

v UNIX: install_dir/logs

Chapter 9. Troubleshooting

291

Table 6. Trace log files for troubleshooting agents (continued)


System where log
is located

File name and path

Description

On the computer
that hosts the
monitoring agent

The RAS1 log files are as follows:

Traces activity of the monitoring agent.

v Windows: hostname_qp_kqpagent
_HEXtimestamp-nn.log in the
install_dir\tmaitm6\logs directory
These logs are in the following directories:
v Windows: install_dir\tmaitm6\logs
The agent operations log files are as follows: Shows whether the agent was able to connect to
the monitoring server. Shows which situations
instance_hostname_QP.LG0 is the current log are started and stopped, and shows other events
created when the agent was started
while the agent is running. A new version of this
file is generated every time the agent is
instance_hostname_QP.LG1 is the backup of restarted.
the previous log
IBM Tivoli Monitoring generates one backup
These logs are in the following directory
copy of the *.LG0 file with the tag .LG1. View
depending on the operating system that you .LG1 to learn the following details regarding the
are using:
previous monitoring session:
v Windows: install_dir\tmaitm6\logs
v Status of connectivity with the monitoring
server.
v Situations that were running.
v The success or failure status of Take Action
commands.
The Take Action command log files are as
follows:
v host_qp_takeactioncommand.log
The logs are in the following directories:

Traces activity each time a Take Action


command runs. For example, when a
hypothetical start_command Take Action
command runs, IBM Tivoli Monitoring generates
a start_command.log file.

v Windows: install_dir\tmaitm6\logs
Definitions of variables:
timestamp is time stamp whose format includes year (y), month (m), day (d), hour (h), and minute (m), as
follows: yyyymmdd hhmm
HEXtimestamp is a hexadecimal representation of the time at which the process was started.
install_dir represents the directory path where you installed the IBM Tivoli Monitoring component. install_dir can
represent a path on the computer that host the monitoring system, the monitoring agent, or the portal.
instance refers to the name of the database instance that you are monitoring.
hostname refers to the name of the computer on which the IBM Tivoli Monitoring component runs.
nn represents the circular sequence in which logs are rotated. Ranges from 1-5, by default, though the first is
always retained, because it includes configuration parameters.
productcode specifies the product codes, for example, um for Universal Agent or nt for Windows.

See the IBM Tivoli Monitoring Installation and Setup Guide for more information on
the complete set of trace logs that are maintained on the monitoring server.

Examples: using trace logs


Typically, IBM Software Support applies specialized knowledge to analyze trace
logs to determine the source of problems. You can open trace logs in a text editor
to learn some basic facts about your IBM Tivoli Monitoring environment. The
following examples are from the Tivoli Enterprise Monitoring Server log.
Example one
This excerpt shows the typical log for a failed connection between a
monitoring agent and a monitoring server with the host name server1a:

292

Monitoring Agent for Microsoft SharePoint Server: Users Guide

(Thursday, August 11, 2005, 08:21:30-{94C}kdcl0cl.c,105,"KDCL0_ClientLookup") status=1c020006,


"location server unavailable", ncs/KDC1_STC_SERVER_UNAVAILABLE
(Thursday, August 11, 2005, 08:21:35-{94C}kraarreg.cpp,1157,"LookupProxy") Unable to connect to
broker at ip.pipe:: status=0, "success", ncs/KDC1_STC_OK
(Thursday, August 11, 2005, 08:21:35-{94C}kraarreg.cpp,1402,"FindProxyUsingLocalLookup") Unable
to find running CMS on CT_CMSLIST <IP.PIPE:#server1a>

Example two
The following excerpts from the trace log for the monitoring server show the
status of an agent, identified here as Remote node. The name of the
computer where the agent is running is SERVER5B:
(42C039F9.0000-6A4:kpxreqhb.cpp,649,"HeartbeatInserter") Remote node SERVER5B:QP is ON-LINE.
. . .
(42C3079B.0000-6A4:kpxreqhb.cpp,644,"HeartbeatInserter") Remote node SERVER5B:QP is OFF-LINE.

Key points regarding the preceding excerpt:


v The monitoring server appends the QP product code to the server name
to form a unique name (SERVER5B:QP) for this instance of the Monitoring
Agent for Microsoft SharePoint Server. This unique name enables you to
distinguish multiple monitoring products that might be running on
SERVER5B.
v The log shows when the agent started (ON-LINE) and later stopped
(OFF-LINE) in the environment.
v For the sake of brevity an ellipsis (...) represents the series of trace log
entries that were generated while the agent was running.
v Between the ON-LINE and OFF-LINE log entries, the agent was
communicating with the monitoring server.
v The ON-LINE and OFF-LINE log entries are always available in the
trace log. All trace levels that are described in Setting RAS trace
parameters provide these entries.
On Windows, you can use the following alternate method to view trace logs:
1. In the Windows Start menu, choose Program Files > IBM Tivoli Monitoring >
Manage Tivoli Enterprise Monitoring Services. The Manage Tivoli Enterprise
Monitoring Services window is displayed.
2. Right-click a component and select Advanced > View Trace Log in the pop-up
menu. For example, if you want to view the trace log of the Microsoft
SharePoint Server agent, right-click the name of the that agent in the window.
You can also use the viewer to access remote logs.
Note: The viewer converts time stamps in the logs to a format that is easier to
read.

Setting RAS trace parameters


Objective
Pinpoint a problem by setting detailed tracing of individual components of the
monitoring agent and modules.

Background Information
The Monitoring Agent for Microsoft SharePoint Server uses RAS1 tracing and
generates the logs described in Table 6 on page 291. The default RAS1 trace level is
ERROR.

Chapter 9. Troubleshooting

293

Before you begin


See Overview of log file management on page 290 to ensure that you understand
log rolling and can reference the correct log files when you manage log file
generation.

After you finish


Monitor the size of the logs directory. Default behavior can generate a total of 45 to
60 MB for each agent that is running on a computer. For example, each database
instance that you monitor can generate 45 to 60 MB of log data. See the
Procedure section to learn how to adjust file size and numbers of log files to
prevent logging activity from occupying too much disk space.
Regularly prune log files other than the RAS1 log files in the logs directory. Unlike
the RAS1 log files that are pruned automatically, other log types can grow
indefinitely, for example, the logs in Table 6 on page 291 that include a process ID
number (PID).
Consider using collector trace logs as an additional source of troubleshooting
information.
Note: The KDC_DEBUG setting and the Maximum error tracing setting can
generate a large amount of trace logging. Use them only temporarily, while
you are troubleshooting problems. Otherwise, the logs can occupy excessive
amounts of hard disk space.

Procedure
On Windows systems, you can use the graphical user interface to set trace options:
1. Open the Manage Tivoli Enterprise Monitoring Services window.
2. Right-click the icon of the monitoring agent whose logging you want to modify.
3. Select Advanced > Edit Trace Parms. The Tivoli Enterprise Monitoring Server
Trace Parameters window is displayed.
4. Select a new trace setting in the pull-down menu in the Enter RAS1 Filters
field or type a valid string.
The selections are as follows:
v General error tracing. KBB_RAS1=ERROR
v Intensive error tracing. KBB_RAS1=ERROR (UNIT:kqz ALL)
v Maximum error tracing. KBB_RAS1=ERROR (UNIT:kqz ALL) (UNIT:kra ALL)
Notes: As this example shows, you can set multiple RAS tracing options in
a single statement.
5. Modify the value for Maximum Log Size Per File (MB) to change the log file
size (changes LIMIT value).
6. Modify the value for Maximum Number of Log Files Per Session to change
the number of log files per startup of a program (changes COUNT value).
7. Modify the value for Maximum Number of Log Files Total to change the
number of log files for all startups of a program (changes MAXFILES value).
8. (Optional) Click Y (Yes) in the KDC_DEBUG Setting menu to log information
that can help you diagnose communications and connectivity problems
between the monitoring agent and the monitoring server.
Note: The KDC_DEBUG setting and the Maximum error tracing setting can
generate a large amount of trace logging. Use them only temporarily,

294

Monitoring Agent for Microsoft SharePoint Server: Users Guide

while you are troubleshooting problems. Otherwise, the logs can occupy
excessive amounts of hard disk space.
9. Click OK. You see a message reporting a restart of the monitoring agent so that
your changes take effect.
You can also manually edit the RAS1 trace logging parameters using this method:
1. Open the trace options file:
Windows: install_dir\tmaitm6\KQPENV
2. Edit the line that begins with KBB_RAS1= to set trace logging preferences. For
example, if you want detailed trace logging, set the Maximum Tracing
option:KBB_RAS1=ERROR (UNIT:kqz ALL) (UNIT:kra ALL)
3. Edit the line that begins with KBB_RAS1_LOG= to manage the generation of
log files:
v MAXFILES: the total number of files that are to be kept for all startups of a
given program. When this value is exceeded, the oldest log files are
discarded. Default value is 9.
v LIMIT: the maximum size, in megabytes (MB) of a RAS1 log file. Default
value is 5.
v IBM Software Support might guide you to modify the following parameters:
COUNT: the number of log files to keep in the rolling cycle of one
program startup. Default is 3.
PRESERVE: the number of files that are not to be reused in the rolling
cycle of one program startup. Default value is 1.
Notes: The KBB_RAS1_LOG parameter also provides for the specification of
the log file directory, log file name, and the inventory control file
directory and name. Do not modify these values or log information can
be lost.
4. Restart the monitoring agent so that your changes take effect.

Problems and workarounds


The following sections provide symptoms and workarounds for problems that
might occur with the Monitoring Agent for Microsoft SharePoint Server:
v
v
v
v
v

Installation and configuration troubleshooting on page 295


Remote deployment troubleshooting on page 297
Agent troubleshooting on page 298
Workspace troubleshooting on page 301
Situation troubleshooting on page 307

Note: You can resolve some problems by ensuring that your system matches the
system requirements listed in Chapter 2, Requirements and agent-specific
installation and configuration information for the monitoring agent, on
page 7.
This chapter provides agent-specific troubleshooting information. See the IBM
Tivoli Monitoring Troubleshooting Guide for general troubleshooting information.

Installation and configuration troubleshooting


This section provides tables that show solutions for installation, configuration, and
uninstallation problems.

Chapter 9. Troubleshooting

295

Table 7. Problems and solutions for installation and configuration


Problem

Solution

A problem can arise when you install and


configure a new monitoring agent to a
computer where other agents are running
as described in this example:

You must reconfigure the previously existing agents to restore their


communication connection with TEMS1. For example, you can
right-click the row for a specific agent in the Manage Tivoli Enterprise
Monitoring Services, and select Reconfigure. See the IBM Tivoli
Monitoring Installation and Setup Guide for more information on
reconfiguration.

v Agents are running on computer and


communicating with a Tivoli Enterprise
Monitoring Server, called TEMS1.
v You install a new agent on the same
computer and you want this agent to
communicate with a different
monitoring server, called TEMS2.
v When you configure the new agent to
communicate with TEMS2, all the
existing agents are re-configured to
communicate with TEMS2.

Diagnosing problems with product browse When you have problems with browse settings, perform the following
settings (Windows systems only).
steps:
1. Click Start > Programs > IBM Tivoli Monitoring > Manage Tivoli
Enterprise Monitoring Services. The Manage Tivoli Enterprise
Monitoring Services window is displayed.
2. Right-click the Windows agent and select Browse Settings. A text
window is displayed.
3. Click Save As and save the information in the text file. If requested,
you can forward this file to IBM Software Support for analysis.
A message similar to Unable to find
running CMS on CT_CMSLIST in the log
file is displayed.

If a message similar to Unable to find running CMS on CT_CMSLIST


is displayed in the Log file, the agent is not able to connect to the
monitoring server. Confirm the following points:
v Do multiple network interface cards (NICs) exist on the system?
v If multiple NICs exist on the system, find out which one is
configured for the monitoring server. Ensure that you specify the
correct host name and port settings for communication in the IBM
Tivoli Monitoring environment.

The system is experiencing high CPU


usage.

Agent process: View the memory usage of the KQPCMA process. If


CPU usage seems to be excessive, recycle the monitoring agent.
Network Cards: The network card configurations can decrease the
performance of a system. Each of the stream of packets that a network
card receives (assuming it is a broadcast or destined for the
under-performing system) must generate a CPU interrupt and transfer
the data through the I/O bus. If the network card in question is a
bus-mastering card, work can be off-loaded and a data transfer
between memory and the network card can continue without using
CPU processing power. Bus-mastering cards are generally 32-bit and
are based on PCI or EISA bus architectures.

In the both local and remote installation


Configure the agent manually and start the agent service.
methods, the state of the SharePoint agent
remains stopped after upgrading the agent
from V6.1.1 to V6.2.0. While upgrading the
agent, system does not provide the agent
configuration option.

296

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Table 7. Problems and solutions for installation and configuration (continued)


Problem

Solution

In the both local and remote installation


Start the agent service.
methods, the state of the SharePoint agent
remains stopped after upgrading the agent
from V6.1.1 to V6.2.0.1.
In the both local and remote installation
Start the agent service.
methods, the state of the SharePoint agent
remains stopped after upgrading the agent
from V6.2.0 to V6.2.0.1.
When new V6.1 or V6.2 agent support files
are added to IBM Tivoli Monitoring V6.2.1
on Windows 2008, the portal server
configuration portion of the installation
hangs

See When new agent support files are added to V6.2.1, the portal
server configuration portion of the installation hangs in the
Installation and configuration troubleshooting chapter of the IBM
Tivoli Monitoring Troubleshooting Guide.

Table 8. General problems and solutions for uninstallation


Problem

Solution

On Windows, uninstallation of IBM Tivoli


Monitoring fails to uninstall the entire
environment.

Be sure that you follow the general uninstallation process described in


the IBM Tivoli Monitoring Installation and Setup Guide:
1. Remove Tivoli Enterprise Monitoring Server Application support by
completing the following steps:
a. Use Manage Tivoli Enterprise Monitoring Services.
b. Select Tivoli Enterprise Monitoring Server.
c. Right-click and select Advanced.
d. Select Remove TEMS application support.
e. Select the agent to remove its application support.
2. Uninstall monitoring agents first, as in the following examples:
v Uninstall a single monitoring agent for a specific database.
-ORv Uninstall all instances of a monitoring product, such as IBM
Tivoli Monitoring for Databases.
3. Uninstall IBM Tivoli Monitoring.

The way to remove inactive managed


systems (systems whose status is
OFFLINE) from the Navigator tree in the
portal is not obvious.

Use the following steps to remove, but not uninstall, an offline


managed system from the Navigator tree:
1. Click the Enterprise icon in the Navigator tree.
2. Right-click, then click Workspace > Managed System Status.
3. Right-click the offline managed system, and select Clear offline
entry.
If you also want to uninstall the monitoring agent, use the procedure
described in the IBM Tivoli Monitoring Installation and Setup Guide.

Remote deployment troubleshooting


Table 9 on page 298 lists problems that might occur with remote deployment. This
section provides information about troubleshooting remote deployment of the
monitoring agent. See the IBM Tivoli Monitoring Troubleshooting Guide for general
troubleshooting information.
This section describes problems and solutions for remote deployment and removal
of agent software using Agent Remote Deploy.
Chapter 9. Troubleshooting

297

Table 9. Remote deployment problems and solutions


Problem

Solution

Do not close or modify this window. It is part of the installation


While you are using the remote
process and is dismissed automatically.
deployment feature to install the
Monitoring Agent for Microsoft SharePoint
Server, an empty command window is
displayed on the target computer. This
problem occurs when the target of remote
deployment is a Windows computer. (See
the IBM Tivoli Monitoring Installation and
Setup Guide for more information on the
remote deployment feature.)
The removal of a monitoring agent fails
when you use the remote removal process
in the Tivoli Enterprise Portal desktop or
browser.

This problem might occur when you attempt the remote removal
process immediately after you have restarted the Tivoli Enterprise
Monitoring Server. You must allow time for the monitoring agent to
refresh its connection with the Tivoli Enterprise Monitoring Server
before you begin the remote removal process.

Agent troubleshooting
This section lists problems that might occur with agents.
This chapter provides agent-specific troubleshooting information. See the IBM
Tivoli Monitoring Troubleshooting Guide for general troubleshooting information.
Table 10. Agent problems and solutions
Problem

Solution

Log data accumulates too rapidly.

Check the RAS trace option settings, which are described in Setting
RAS trace parameters on page 293. The trace options settings that you
can set on the KBB_RAS1= and KDC_DEBUG= lines potentially generate
large amounts of data.

When using the F1 key or selecting Help


--> Contents and Index, you receive a
message in your Microsoft Internet
Explorer browser which states, It seems
javascript is disabled in your browser,
please enable it and reload again, or click
here to view without javascript. If you
select here, the Tivoli Enterprise Portal
Help is displayed, but the agent help is
not.

Ensure that the local site is added to the trusted site for the browser,
and then enable the javascript.

If you want to receive multiple trace logs


for separate invocations of the same Take
Action command, leaving this setting on
permanently fills the available disk space.

Do not leave this setting on permanently. By doing so, you create a


new log file for each invocation of the Take Action command and ALL
of them are left on the agent system.

298

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Table 10. Agent problems and solutions (continued)


Problem

Solution

The Tivoli Enterprise Portal displays


negative values for the following
attributes:

Set your operating system to a 32-bit display to run IBM Tivoli


Monitoring properly. See Chapter 3 in the IBM Tivoli Monitoring
Installation and Setup Guide for more information on how to configure
the display settings properly.

v Active Requests (Excel Calculation


Service attribute group)
v Active Sessions (Excel Calculation
Service attribute group
v L3 Merge Speed Average (SharePoint
Search Indexer Catalog attribute group)
v L3 Merge Speed Last (SharePoint Search
Indexer Catalog attribute group)
v Incremental Crawls (Office Search
Gatherer Projects attribute group)
v Crawls in Progress (Office Search
Gatherer Projects attribute group)
v Documents Processed Per Sec (Search
Schema Plug-in attribute group)
When the SharePoint agent V6.2.0.1 is
running on a 64-bit operating system with
the 64-bit Microsoft Office SharePoint
Server (MOSS 2007) application installed
on the same workstation, the Tivoli
Enterprise Portal client does not display
data for the 64-bit SharePoint application.

There is no solution for this problem at this time.

The SharePoint agent permits back


leveling of IBM Tivoli Monitoring for
Microsoft Applications V6.1.1 agent on an
already installed IBM Tivoli Monitoring
for Microsoft Applications V6.2.0.1 agent.
After back leveling, there is no change in
the version of the SharePoint agent and
the entry for IBM Tivoli Monitoring for
Microsoft Applications is removed from
the Add or Remove Programs.

There is no solution for this problem at this time.

There is no solution for this problem at this time.


The SharePoint agent permits back
leveling of IBM Tivoli Monitoring for
Microsoft Applications V6.2.0 agent on an
already installed IBM Tivoli Monitoring
for Microsoft Applications V6.2.0.1 agent.
After back leveling, there is a change in
the version of SharePoint agent. The
SharePoint agent does not display the new
functionalities. However, the entry for IBM
Tivoli Monitoring for Microsoft
Applications is not removed from the Add
or Remove Programs.
The cross-linking to .NET agent, IIS agent,
and SQL agent is not working. The
following error message is displayed:The
link target cannot be found. The link
definition might be incorrect or the
target is unavailable.

For cross-links to work, install the specified or the later version of the
following agents:
v IIS agent 6.2.0.1
v .Net agent 6.2.0.1
v SQL agent 6.2.1

Chapter 9. Troubleshooting

299

Table 10. Agent problems and solutions (continued)


Problem

Solution

A configured and running instance of the


monitoring agent is not displayed in the
Tivoli Enterprise Portal, but other
instances of the monitoring agent on the
same system do appear in the portal.

Tivoli Monitoring products use Remote Procedure Call (RPC) to define


and control product behavior. RPC is the mechanism that allows a
client process to make a subroutine call (such as GetTimeOfDay or
ShutdownServer) to a server process somewhere in the network. Tivoli
processes can be configured to use TCP/UDP, TCP/IP, SNA, and SSL
as the desired protocol (or delivery mechanism) for RPCs.
IP.PIPE is the name given to Tivoli TCP/IP protocol for RPCs. The
RPCs are socket-based operations that use TCP/IP ports to form socket
addresses. IP.PIPE implements virtual sockets and multiplexes all
virtual socket traffic across a single physical TCP/IP port (visible from
the netstat command).
A Tivoli process derives the physical port for IP.PIPE communications
based on the configured, well-known port for the HUB Tivoli
Enterprise Monitoring Server. (This well-known port or BASE_PORT is
configured using the PORT: keyword on the KDC_FAMILIES /
KDE_TRANSPORT environment variable and defaults to 1918.)
The physical port allocation method is defined as (BASE_PORT +
4096*N) where N=0 for a Tivoli Enterprise Monitoring Server process
and N={1, 2, ..., 15} for a non-Tivoli Enterprise Monitoring Server. Two
architectural limits result as a consequence of the physical port
allocation method:
v No more than one Tivoli Enterprise Monitoring Server reporting to a
specific Tivoli Enterprise Monitoring Server HUB can be active on a
system image.
v No more than 15 IP.PIPE processes can be active on a single system
image.
A single system image can support any number of Tivoli Enterprise
Monitoring Server processes (address spaces) provided that each Tivoli
Enterprise Monitoring Server on that image reports to a different HUB.
By definition, there is one Tivoli Enterprise Monitoring Server HUB per
monitoring Enterprise, so this architecture limit has been simplified to
one Tivoli Enterprise Monitoring Server per system image.
No more than 15 IP.PIPE processes or address spaces can be active on a
single system image. With the first limit expressed above, this second
limitation refers specifically to Tivoli Enterprise Monitoring Agent
processes: no more than 15 agents per system image.
This limitation can be circumvented (at current maintenance levels, IBM
Tivoli Monitoring V6.1 Fix Pack 4 and later) if the Tivoli Enterprise
Monitoring Agent process is configured to use EPHEMERAL IP.PIPE.
(This is IP.PIPE configured with the EPHEMERAL:Y keyword in the
KDC_FAMILIES / KDE_TRANSPORT environment variable). There is
no limitation to the number of ephemeral IP.PIPE connections per
system image. If ephemeral endpoints are used, the Warehouse Proxy
Agent is accessible from the Tivoli Enterprise Monitoring Server
associated with the agents using ephemeral connections either by
running the Warehouse Proxy Agent on the same computer or by using
the Firewall Gateway feature. (The Firewall Gateway feature relays the
Warehouse Proxy Agent connection from the Tivoli Enterprise
Monitoring Server computer to the Warehouse Proxy Agent computer if
the Warehouse Proxy Agent cannot coexist on the same computer.)

300

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Workspace troubleshooting
Table 11 shows problems that might occur with workspaces. This chapter provides
agent-specific troubleshooting information. See the IBM Tivoli Monitoring
Troubleshooting Guide for general troubleshooting information.
Table 11. Workspace problems and solutions
Problem

Solution

The process application components are


This problem occurs because the PerfProc performance object is
available, but the Availability status shows disabled. When this condition exists, IBM Tivoli Monitoring cannot
PROCESS_DATA_NOT_ AVAILABLE.
collect performance data for this process. Do the following to confirm
that this problem exists and resolve it:
1. Choose Run in the Windows Start menu.
2. Type perfmon.exe in the Open field of the Run window. The
Performance window is displayed.
3. Click the plus sign (+) in the tool bar located above the right pane.
The Add Counters window is displayed.
4. Look for Process in the Performance object pull-down menu.
5. Perform one of the following actions:
v If you see Process in the pull-down menu, the PerfProc
performance object is enabled and the problem is coming from a
different source. You might need to contact IBM Software
Support.
v If you do not see Process in the pull-down menu, use the
Microsoft utility from the following Web site to enable the
PerfProc performance object:
http://blogs.technet.com/mscom/archive/2008/12/18/
the-mystery-of-the-missing-process-performancecounter-in-perfmon.aspxThe Process performance object becomes
visible in the Performance object pull-down menu of the Add
Counters windows, and IBM Tivoli Monitoring is able to detect
Availability data.
6. Restart the monitoring agent.

Chapter 9. Troubleshooting

301

Table 11. Workspace problems and solutions (continued)


Problem

Solution

Event Log workspace events are


unfiltered, are not collected more than
every 60 seconds, and are removed from
the Event Log Views after 1 hour of being
received.

All events currently in the Application Event Log are sent to the Tivoli
Enterprise Monitoring Server when the agent starts. Environment
variables that control the behavior of the Event Log Workspace are
stored in the agent ENV file on the Tivoli Enterprise Monitoring agent,
where the agent is running. These are the variables:
CDP_DP_CACHE_TTL
This is the minimum number of seconds before data (for a
particular table) is collected again. By default this variable is
present in the ENV file and the value is set to 60.
CDP_NT_EVENT_LOG_GET_ALL_ENTRIES_FIRST_TIME
This variable determines whether the agent sends all events
currently in the Application Event Log to the Tivoli Enterprise
Monitoring Server when the agent starts. Legal values are YES
and NO. By default this variable is present in the ENV file and
the value is set to NO.
CDP_NT_EVENT_LOG_CACHE_TIMEOUT
This variable determines how long in seconds, events are
displayed in the Tivoli Enterprise Monitoring Server Event Log
Views. By default this variable is NOT present in the ENV file.
A default value of 3600 (1 Hour) is used unless overridden by
the presence of this variable in the agent ENV file. The
minimum legal value is 300.
To view or edit the agent ENV file, on the Tivoli Enterprise Monitoring
agent where the agent is installed, use Manage Tivoli Enterprise
Monitoring Services to select the agent. Right-click and select Advanced
- Edit ENV File. The agent must be restarted to implement changes.

The name of the attribute does not display When a chart or graph view that includes the attribute is scaled to a
in a bar chart or graph view.
small size, a blank space is displayed instead of a truncated name. To
see the name of the attribute, expand the view of the chart until there is
sufficient space to display all characters of the attribute name.
You start collection of historical data but
the data cannot be seen.

Managing options for historical data collection:


v Basic historical data collection populates the Warehouse with raw
data. This type of data collection is turned off by default. See the
IBM Tivoli Monitoring Administrators Guide for information on
managing this feature including how to set the interval at which data
is collected. By setting a more frequent interval for data collection
you reduce the load on the system incurred every time data is
uploaded.
v You use the Summarization and Pruning monitoring agent to collect
specific amounts and types of historical data. Be aware that historical
data is not displayed until the Summarization and Pruning
monitoring agent begins collecting the data. By default, this agent
begins collection at 2 AM daily. At that point, data is visible in the
workspace view. See the IBM Tivoli Monitoring Administrators Guide
to learn how to modify the default collection settings.

302

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Table 11. Workspace problems and solutions (continued)


Problem

Solution

Historical data collection is unavailable


because of incorrect queries in the Tivoli
Enterprise Portal.

The column, Sort By, Group By, and First/Last functions are not
compatible with the historical data collection feature. Use of these
advanced functions makes a query ineligible for historical data
collection.
Even if data collection has been started, you cannot use the time span
feature if the query for the chart or table includes column functions or
advanced query options (Sort By, Group By, First / Last).
To ensure support of historical data collection, do not use the Sort By,
Group By, or First/Last functions in your queries.
See the IBM Tivoli Monitoring Administrators Guide or the Tivoli
Enterprise Portal online help for information about the Historical Data
Collection function.

When you use a long process name in the


situation, the process name is truncated.

Truncation of process or service names for situations in the Availability


table in the portal display is the expected behavior. 100 bytes is the
maximum name length.

Regular (non-historical) monitoring data


fails to be displayed.

Check the formation of the queries you use to gather data. For
example, look for invalid SQL statements.

Navigator items and workspace titles are


labeled with internal names such as
Kr6:KR60000 or Knt:KNT0000 rather than
the correct names (such as Disk).

Ensure application support has been added on the monitoring server,


portal server, and portal client.

There is no data in the workspaces of the


Excel Services navigator group when the
monitoring agent is running on Microsoft
Office SharePoint Server 2007 Client
Access License (CAL) Standard Edition,
Microsoft Forms Server 2007- Server
License Edition, and Microsoft Forms
Server 2007 for Internet Sites Edition of
SharePoint Server 2007. Excel Calculation
Services feature is not supported in these
editions, but MOSS Standard Edition and
Microsoft Forms Server exposes Excel
Calculation Services attribute groups in
Perfmon.

There is no solution for this problem at this time.

No data is displayed in the workspace of


Document Conversions navigator group
when the monitoring agent is running on
Microsoft Forms Server 2007- Server
License and Microsoft Forms Server 2007
for Internet sites editions of SharePoint
Server 2007. The Document Conversions
feature is not supported in these editions,
but Microsoft Forms Server exposes
Document Conversion attribute group in
Perfmon.

There is no solution for this problem at this time.

For more information and instruction on installing application support


see Installing and enabling application support in the IBM Tivoli
Monitoring Installation and Setup Guide.

Chapter 9. Troubleshooting

303

Table 11. Workspace problems and solutions (continued)


Problem

Solution

There is no solution for this problem at this time.


No data is displayed in the workspace of
Shared Service Provider navigator group
when the monitoring agent is running on
Microsoft Forms Server 2007- Server
License and Microsoft Forms Server 2007
for Internet sites editions of SharePoint
Server 2007. The Shared Service Provider
feature is supported in these editions, but
support for features of Shared Service
Provider that are required to generate the
data for attributes of Shared Service
Provider are not available. Microsoft
Forms Server exposes the web applications
name created for Shared Service Provider
as instances in Perfmon for Shared Service
Provider attribute groups that display no
data.
If .NET framework 2.0 service pack 1 or
.NET framework 3.5 is installed on the
server, the following workspaces do not
show data:

Install .NET framework 3.5 service pack 1.

v Web Server
v ASP NET Applications

304

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Table 11. Workspace problems and solutions (continued)


Problem

Solution

There are no sites listed for SharePoint


applications in the following workspaces:

1. Create a system Data Source Name (DSN) to establish a connection


to the SharePoint configuration database and obtain data for the
sites that are related to SharePoint sites.

v Web Server
v ASP NET Applications

a. Select the Change the default database to check box.


b. Select the name of the SharePoint configuration database from
the list.
c. Enter the User ID, password, and DSN while configuring the
agent.
Note: If you create a DSN for SharePoint agent that monitors a 32
bit SharePoint Portal Server (SPS) 2003 application that runs on 64
bit operating system, then use the %WinDir%\SysWOW64\
odbcad32.exe.
2. Verify that the following WMI classes are present and return data:
v For Windows Server 2003:
Win32_PerfFormattedData_ASPNET_114322_ASPNET
Appsv114322
Win32_PerfFormattedData_ASPNET_2050727_ASPNET
Appsv2050727
v For Windows Server 2008:
Win32_PerfFormattedData_ASPNET114322_ASPNET
Appsv114322
Win32_PerfFormattedData_ASPNET2050727_ASPNET
Appsv2050727
Note:
v If you use SQL authentication to create a DSN, then the role of the
SQL User ID must be db_datareader for the SharePoint configuration
database.
v

If you use Windows authentication to create a DSN, then the role of


the Windows account must be db_datareader for the Sharepoint
configuration database. You must specify the database login details
for your workstation in the following format:
domain\workstation_$
If you are not able to see data in the workspaces after completing the
steps to create a DSN and configure an agent, check the contents of
the Workstation_qp_kqclient_xxxxxxxxx.log file in the following folder:
IBM\ITM\TMAITM6\logs
If you see the Login failed for NT Authority\Anonymous Logon error
in the log file, add database login NT AUTHORITY\ANONYMOUS
LOGON in the database for Windows authentication and set the role
as db_datareader. Alternatively, you can use the SQL authentication
to see data in the workspaces.

v If you use Windows authentication to create a DSN, the parameters


Database User ID and Database Password are optional.

Chapter 9. Troubleshooting

305

Table 11. Workspace problems and solutions (continued)


Problem

Solution

If Microsoft SharePoint Portal Server 2003


is installed on Windows Server 2003 (64
bit), and the agent is configured, no data
is displayed in the following workspaces:

If Service Pack 1 of .NET framework 1.1 is installed, install hotfix


NDP1.1sp1-KB928366-X86.exe and then follow below mentioned steps:

v Web Server
v ASP NET Applications

For .NET framework 1.1:


1. Click Start > Run. Type %WinDir%\SysWow64\cmd.exe and
click OK.
2. In the command prompt, run the following commands in
the specified order:
a. cscript %SYSTEMDRIVE%\inetpub\adminscripts\
adsutil.vbs SET W3SVC/AppPools/
Enable32bitAppOnWin64 1
b. %SYSTEMROOT%\Microsoft.NET\Framework\v1.1.4322
\aspnet_regiis.exe -u
c. %SYSTEMROOT%\Microsoft.NET\Framework\v1.1.4322
\aspnet_regiis.exe -i -enable
d. Wmiadap /c
e. Wmiadap /r
f. Wmiadap /f
g. Net stop winmgmt /y
h. Net start winmgmt
i. winmgmt /resyncperf
For .NET framework 2.0 (32 bit):
1. Click Start > Run. Type %WinDir%\SysWow64\cmd.exe and
click OK.
2. In the command prompt, run the following commands in
the specified order:
a. cscript %SYSTEMDRIVE%\inetpub\adminscripts\
adsutil.vbs SET W3SVC/AppPools/
Enable32bitAppOnWin64 1
b. %SYSTEMROOT%\Microsoft.NET\Framework\v2.0.50727\
aspnet_regiis.exe -u
c. %SYSTEMROOT%\Microsoft.NET\Framework\v2.0.50727\
aspnet_regiis.exe -i -enable
d. Wmiadap /c
e. Wmiadap /r
f. Wmiadap /f
g. Net stop winmgmt /y
h. Net start winmgmt
i. winmgmt /resyncperf
For .NET framework 2.0 (64 bit):
1. Click Start > Run. Type cmd.exe and click OK.
2. In the command prompt, run the following commands in
the specified order:
a. cscript %SYSTEMDRIVE%\inetpub\adminscripts\
adsutil.vbs SET W3SVC/AppPools/
Enable32bitAppOnWin64 0
b. %SYSTEMROOT%\Microsoft.NET\Framework64\v2.0.50727\
aspnet_regiis.exe -u
c. %SYSTEMROOT%\Microsoft.NET\Framework64\v2.0.50727\
aspnet_regiis.exe -i -enable
d. Wmiadap /c
e. Wmiadap /r
f. Wmiadap /f
g. Net stop winmgmt /y
h. Net start winmgmt
i. winmgmt /resyncperf

306

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Situation troubleshooting
This section provides information about both general situation problems and
problems with the configuration of situations. See the IBM Tivoli Monitoring
Troubleshooting Guide for more information about troubleshooting for situations.

General situation problems


Table 12 lists general problems that might occur with situations.
Table 12. General situation problems and solutions
Problem

Solution

Monitoring activity requires too much disk Check the RAS trace logging settings that are described in Setting
space.
RAS trace parameters on page 293. For example, trace logs grow
rapidly when you apply the ALL logging option.
Monitoring activity requires too many
system resources.

Disk capacity planning for historical data on page 216 describes the
performance impact of specific attribute groups. If possible, decrease
your use of the attribute groups that require greater system resources.

A formula that uses mathematical


operators appears to be incorrect. For
example, if you were monitoring Linux, a
formula that calculates when Free Memory
falls under 10 percent of Total Memory
does not work: LT
#'Linux_VM_Stats.Total_Memory' / 10

This formula is incorrect because situation predicates support only


logical operators. Your formulas cannot have mathematical operators.
Note: The Situation Editor provides alternatives to math operators.
Regarding the example, you can select % Memory Free attribute and
avoid the need for math operators.

You want to change the appearance of


situations when they are displayed in the
Navigation tree.

1. Right-click an item in the Navigation tree.


2. Select Situations in the pop-up menu. The Situation Editor window
is displayed.
3. Select the situation that you want to modify.
4. Use the State pull-down menu in the lower right of the window to
set the status and appearance of the Situation when it triggers.
Note: The State setting is not related to severity settings in IBM
Tivoli Enterprise Console.

When a situation is triggered in the Event


Log attribute group, it remains in the
Situation Event Console as long as the
event ID entry is present in the Event Log
workspace. When this event ID entry is
removed from the Event Log workspace
on the Tivoli Enterprise Portal, the
situation is also cleared even if the actual
problem that caused the event is not
resolved, and the event ID entry is also
present in the Windows Event Viewer.

There is a timeout on the cache of events for the NT Event Log group.
Increase the cache time of Event Log collection to meet your
requirements by adding the following variable and timeout value to
the KXXENV file for the agent:
CDP_NT_EVENT_LOG_CACHE_TIMEOUT=3600

When a situation is triggered in the Event


Log attribute group, it remains in the
Situation Event Console as long as the
event ID entry is present in the Event Log
workspace. When this event ID entry is
removed from the Event Log workspace in
the Tivoli Enterprise Portal, the situation is
cleared even if the actual problem that
caused the event is not resolved and the
event is cleared from the Windows Event
Viewer.

There is a timeout on the cache of events for the NT Event Log group.
Increase the cache time of Event Log collection to meet your
requirements by adding the following variable and timeout value to
the KQPENV file for the agent:
CDP_NT_EVENT_LOG_CACHE_TIMEOUT=3600.

This variable determines how long events from the NT Event Log are
kept.

This variable determines how long events from the NT Event Log are
kept.

Chapter 9. Troubleshooting

307

Problems with configuration of situations


Table 13 lists problems that might occur with configuring situations.
This section provides information for troubleshooting for agents. Be sure to consult
the IBM Tivoli Monitoring Troubleshooting Guide for more general troubleshooting
information.
Table 13. Problems with configuring situations that you solve in the Situation Editor
Problem

Solution

Note: To get started with the solutions in this section, perform these steps:
1. Launch the Tivoli Enterprise Portal.
2. Click Edit > Situation Editor.
3. In the tree view, choose the agent whose situation you want to modify.
4. Choose the situation in the list. The Situation Editor view is displayed.
The situation for a specific agent is not
visible in the Tivoli Enterprise Portal.

Open the Situation Editor. Access the All managed servers view. If the
situation is absent, confirm that the monitoring server has been seeded
for the agent. If not, seed the server, as described in the IBM Tivoli
Monitoring Installation and Setup Guide.

The monitoring interval is too long.

Access the Situation Editor view for the situation that you want to
modify. Check the Sampling interval area in the Formula tab. Adjust
the time interval as needed.

The situation did not activate at startup.

Manually recycle the situation as follows:


1. Right-click the situation and choose Stop Situation.
2. Right-click the situation and choose Start Situation.
Note: You can permanently avoid this problem by placing a check
mark in the Run at Startup option of the Situation Editor view for a
specific situation.

The situation is not displayed.

Click the Action tab and check whether the situation has an automated
corrective action. This action can occur directly or through a policy. The
situation might be resolving so quickly that you do not see the event or
the update in the graphical user interface.

An Alert event has not occurred even


though the predicate has been properly
specified.

Check the logs, reports, and workspaces.

A situation fires on an unexpected


managed object.

Confirm that you have distributed and started the situation on the
correct managed system.

The product did not distribute the


situation to a managed system.

Click the Distribution tab and check the distribution settings for the
situation.

308

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Table 13. Problems with configuring situations that you solve in the Situation Editor (continued)
Problem

Solution

The situation does not fire.

This problem can be caused when incorrect predicates are present in


the formula that defines the situation. For example, the managed object
shows a state that normally triggers a monitoring event, but the
situation is not true because the wrong attribute is specified in the
formula.
In the Formula tab, analyze predicates as follows:
1. Click the fx icon in the upper-right corner of the Formula area. The
Show formula window is displayed.
a. Confirm the following details in the Formula area at the top of
the window:
v The attributes that you intend to monitor are specified in the
formula.
v The situations that you intend to monitor are specified in the
formula.
v The logical operators in the formula match your monitoring
goal.
v The numerical values in the formula match your monitoring
goal.
b. (Optional) Click the Show detailed formula check box in the
lower left of the window to see the original names of attributes
in the application or operating system that you are monitoring.
c. Click OK to dismiss the Show formula window.
2. (Optional) In the Formula area of the Formula tab, temporarily
assign numerical values that immediately trigger a monitoring
event. The triggering of the event confirms that other predicates in
the formula are valid.
Note: After you complete this test, you must restore the numerical
values to valid levels so that you do not generate excessive
monitoring data based on your temporary settings.
See the IBM Tivoli Monitoring Troubleshooting Guide for additional
information about situations that do not fire.

Table 14. Problems with configuration of situations that you solve in the Workspace area
Problem

Solution

Situation events are not displayed in the


Events Console view of the workspace.

Associate the situation with a navigator item.


Note: The situation does not need to be displayed in the workspace. It
is sufficient that the situation be associated with any navigator item.

You do not have access to a situation.

Note: You must have administrator privileges to perform these steps.


1. Select Edit > Administer Users to access the Administer Users
window.
2. In the Users area, select the user whose privileges you want to
modify.
3. In the Permissions tab, Applications tab, and Navigator Views tab,
select the permissions or privileges that correspond to the user role.
4. Click OK.

Chapter 9. Troubleshooting

309

Table 14. Problems with configuration of situations that you solve in the Workspace area (continued)
Problem

Solution

A managed system seems to be offline.

1. Select Physical View and highlight the Enterprise Level of the


navigator tree.
2. Select View > Workspace > Managed System Status to see a list of
managed systems and their status.
3. If a system is offline, check network connectivity and the status of
the specific system or application.

Take Action commands troubleshooting


Table 15 lists general problems that might occur with Take Action commands.
When each Take Action command runs it generates the log file listed in Table 6 on
page 291. This chapter provides agent-specific troubleshooting information.
See the IBM Tivoli Monitoring Troubleshooting Guide for general troubleshooting
information.
Table 15. Take Action commands problems and solutions
Problem

Solution

Take Action commands often require


several minutes to complete.

Allow several minutes. If you do not see a pop-up message advising


you of completion, try to run the command manually.

Situations fail to trigger Take Action


commands.

Attempt to manually run the Take Action command in the Tivoli


Enterprise Portal. If the Take Action command works, look for
configuration problems in the situation. See Situation troubleshooting
on page 307. If the Take Action command fails, see IBM Tivoli
Monitoring Troubleshooting Guide for general information on
troubleshooting Take Action commands.

Tivoli Common Reporting troubleshooting


Table 16 contains a list of problems that might occur with the Tivoli Common
Reporting predefined reports for Monitoring Agent for Microsoft SharePoint Server.
For information about troubleshooting for the Tivoli Common Reporting tool, see
http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/
com.ibm.tivoli.tcr.doc/tcr_welcome.html.
Table 16. Tivoli Common Reporting for Monitoring Agent for Microsoft SharePoint Server problems and solutions
Problem

Solution

If a view or a table for the selected


summarization type does not exist in the
database for a report, then the report does
not open and the following error message
is displayed:

Configure the Summarization and Pruning agent properly and generate


data in the database for all Summarization Types.

CTGTRV014E The report cannot be


successfully formatted because it
completed with errors,reference ID
[DESIGNID_141_OBJECTID_3d9a3d9a]

310

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Table 16. Tivoli Common Reporting for Monitoring Agent for Microsoft SharePoint Server problems and
solutions (continued)
Problem

Solution

If data source is incorrect and you run a


report, the Tivoli Common Reporting tool
does not display the report in a correct
format and displays the following error
message:

Ensure that the parameters:

CTGTRV014E The report cannot be


successfully formatted because it
completed with errors, reference ID
[REPORTID_5_OBJECTID_5cc65cc6].
If the .jar files are not added to the Tivoli
Common Reporting tool, then the
following error message is displayed:
CTGTRV014E The report can not be
successfully formatted because it
completed with errors, reference ID
[REPORTID_1049_OBJECTID_dbe0dbe].

v Are correctly set while configuring the data source in the Edit Data
Source window of the Tivoli Common Reporting tool.
v Match the parameters of the Summarization and Pruning agent (for
example, Database URL, Driver, User, and Password) that is
connected to a particular database.

Add the .jar files to the appropriate directory of the Tivoli Common
Reporting. These .jar files are put in the JDBC driver while configuring
the Summarization and Pruning agent. The following list gives the
names of the .jar files for different databases:
v The ojdbc14.jar file for the Oracle database
v The sqljdbc.jar and the sqljdbc4.jar files for the SQL Server
database
v The db2jcc_license_cu.jar and the db2jcc.jar files for the DB2
database
Add these .jar files to one of the following locations of the Tivoli
Common Reporting:
Location for the Tivoli Common Reporting V1.1.1.0
C:\Program Files\IBM\tcr\lib\birt-runtime-2_2_1\
ReportEngine\plugins\
org.eclipse.birt.report.data.oda.jdbc_
2.2.1.r22x_v20070919\drivers
Location for the Tivoli Common Reporting V1.2.0.0 and V1.2.0.1
C:\IBM\tivoli\tip\products\tcr\lib\birt-runtime-2_2_1\
ReportEngine\plugins\
org.eclipse.birt.report.data.oda.jdbc_
2.2.1.r22x_v20070919\drivers

Data does not exist in the database for the


selected parameters.

Configure the Summarization and Pruning agent properly and generate


data in the database for all Summarization Types.

If you open the report in Adobe


Increase the zoom percentage in Adobe PostScript to display X and Y
PostScript, X and Y axis are not displayed. axis.
If you open a report in the Adobe
PostScript format, the page numbers do
not display properly.

None.

If you open a report in the Adobe


PostScript format, some part of charts or
data in the report is truncated.

The default size of the report is A4. For the full view of the report,
click 11x17 from the Media menu.

If you open a report in Microsoft Excel


format, then the key values are displayed
as column headings.

None.

You cannot drill down from the charts in


the main report to the subreport in PDF.

There is no solution to this problem at this time.

If you open a report in PDF, the Web


address of the Tivoli Common Reporting
Server is displayed as the title instead of
the report name.

None.

Chapter 9. Troubleshooting

311

Table 16. Tivoli Common Reporting for Monitoring Agent for Microsoft SharePoint Server problems and
solutions (continued)
Problem

Solution

If you try to drill down to a subreport or


sort a column in a report in Microsoft
Excel format, the following error is
displayed:

There is no solution to this problem at this time.

CTGTRV004E A drill-through report


cannot be formatted because the
drillthrough information cannot be
found. The most likely cause is an
expired HTTP session.
The snapshot report fails to open in PDF.
When you open the snapshot report in the
Microsoft Excel or Adobe PostScript
format, the following error message is
displayed:

None.

Internet Explorer cannot download view


from localhost Internet Explorer was
not able to open this Internet site.
The requested site is either
unavailable or cannot be found.Please
try again later.

Support information
If you have a problem with your IBM software, you want to resolve it quickly. IBM
provides the following ways for you to obtain the support you need:
Online
Go to the IBM Software Support site at http://www.ibm.com/software/
support/probsub.html and follow the instructions.
IBM Support Assistant
The IBM Support Assistant (ISA) is a free local software serviceability
workbench that helps you resolve questions and problems with IBM
software products. The ISA provides quick access to support-related
information and serviceability tools for problem determination. To install
the ISA software, go to http://www.ibm.com/software/support/isa.

Informational, warning, and error messages


This chapter introduces message logging and explains how to gather information
from those logs.
Message logging refers to the text and numeric messages created by the software.
These messages relay information about how the system or application is
performing and can alert you to exceptional conditions when they occur. Messages
are sent to an output destination, such as a file, database, or console screen.
If you receive a warning or error message, you can do one of the following:
v Follow the instructions listed in the Detail window of the message if this
information is included there.
v Consult the message details listed in this chapter to see what action you can take
to correct the problem.

312

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v Consult the message log for message ID and text, time and date of the message,
as well as other data you can use to diagnose the problem.

Message format
Monitoring Agent for Microsoft SharePoint Server messages have the following
format:
Message ID and text
Explanation
Operator Response
The message ID has the following format:
CCC####severity

where:
CCC

Prefix that indicates the component to which the message applies. The
component is one of the following:
KQP

####

General Monitoring Agent for Microsoft SharePoint Server


messages

Number of the message

severity
Severity of the message. There are three levels of severity:
I

Informational messages provide feedback about something that


happened in the product or system that might be important. These
messages can provide guidance when you are requesting a specific
action from the product.

Warning messages call your attention to an exception condition.


The condition might not be an error but can cause problems if not
resolved.

Error messages indicate that an action cannot be completed


because of a user or system error. These messages require user
response.

The Text of the message provides a general statement regarding the problem or
condition that occurred. The Explanation provides additional information about the
message and what might have caused the condition. The Operator Response
provides actions to take in response to the condition, particularly for error
messages (messages with the E suffix).
Note: Many message texts and explanations contain variables, such as the specific
name of a server or application. Those variables are represented in this
chapter as symbols, such as &1. Actual messages contain values for these
variables.
This chapter includes the messages for the following software:
v Monitoring Agent for Microsoft SharePoint Server

Monitoring Agent for Microsoft SharePoint Server messages

Chapter 9. Troubleshooting

313

KQP0001I KQP0021I
KQP0001I

The SharePoint Portal Administration service was started.

Explanation: The SharePoint Portal Administration service was started.


Operator response: None.
KQP0003E

Error starting the SharePoint Portal Administration service. Possible Causes 1. Already started or
Service is disabled. 2. Logon failure or Service does not exist. Check the event log for more
information.

Explanation: Error starting SharePoint Portal Administration service.


Operator response: Check the event log for more information.
KQP0004I

The SharePoint Portal Administration service was stopped. Dependent service Microsoft
SharePointPS Search has also stopped.

Explanation: The SharePoint Portal Administration service was stopped.


Operator response: None.
KQP0006E

Error stopping SharePoint Portal Administration service. Possible Causes 1. Already stopped,
Service is not started 2. Logon failure or Service does not exist. Check the event log for more
information.

Explanation: Error stopping SharePoint Portal Administration service.


Operator response: Check the event log for more information.
KQP0011I

The Microsoft Single Sign-on service was started.

Explanation: The Microsoft Single Sign-on service was started.


Operator response: None.
KQP0013E

Error starting Microsoft Single Sign-on service. Possible Causes 1. Already started or Service is
disabled. 2. Logon failure or Service does not exist. Check the event log for more information.

Explanation: Error starting Microsoft Single Sign-on service.


Operator response: Check the event log for more information.
KQP0014I

The Microsoft Single Sign-on service was stopped.

Explanation: The Microsoft Single Sign-on service was stopped.


Operator response: None.
KQP0016E

Error stopping Microsoft Single Sign-on service. Possible Causes 1. Already stopped, Service is not
started 2. Logon failure or Service does not exist. Check the event log for more information.

Explanation: Error stopping Microsoft Single Sign-on service.


Operator response: Check the event log for more information.
KQP0021I

The SharePoint Timer service was started.

Explanation: The SharePoint Timer service was started.


Operator response: None.

314

Monitoring Agent for Microsoft SharePoint Server: Users Guide

KQP0023E KQP0043E
KQP0023E

Error starting SharePoint Timer service. Possible Causes 1. Already started or Service is disabled. 2.
Logon failure or Service does not exist. Check the event log for more information.

Explanation: Error starting SharePoint Timer service.


Operator response: Check the event log for more information.
KQP0024I

The SharePoint Timer service was stopped.

Explanation: The SharePoint Timer service was stopped.


Operator response: None.
KQP0026E

Error stopping SharePoint Timer service. Possible Causes 1. Already stopped, Service is not started
2. Logon failure or Service does not exist Check the event log for more information.

Explanation: Error stopping SharePoint Timer service.


Operator response: Check the event log for more information.
KQP0031I

The SharePoint Portal Search service was started.

Explanation: The SharePoint Portal Search service was started.


Operator response: None.
KQP0033E

Error starting SharePoint Portal Search service. Possible Causes 1. Already started or Service is
disabled. 2. Logon failure or Service does not exist. Check the event log for more information.

Explanation: Error starting SharePoint Portal Search service.


Operator response: Check the event log for more information.
KQP0034I

The SharePoint Portal Search service was stopped.

Explanation: The SharePoint Portal Search service was stopped.


Operator response: None.
KQP0036E

Error stopping SharePoint Portal Search service. Possible Causes 1. Already stopped, Service is not
started 2. Logon failure or Service does not exist Check the event log for more information.

Explanation: Error stopping SharePoint Portal Search service.


Operator response: Check the event log for more information.
KQP0041I

The SharePoint Portal Alert service was started.

Explanation: The SharePoint Portal Alert service was started.


Operator response: None.
KQP0043E

Error starting SharePoint Portal Alert service. Possible Causes 1. Already started or Service is
disabled. 2. Logon failure or Service does not exist. Check the event log for more information.

Explanation: Error starting SharePoint Portal Alert service.


Operator response: Check the event log for more information.

Chapter 9. Troubleshooting

315

KQP0044I KQP0074I
KQP0044I

The SharePoint Portal Alert service was stopped.

Explanation: The SharePoint Portal Alert service was stopped.


Operator response: None.
KQP0046E

Error stopping SharePoint Portal Alert service. Possible Causes 1. Already stopped, Service is not
started 2. Logon failure or Service does not exist Check the event log for more information.

Explanation: Error stopping SharePoint Portal Alert service.


Operator response: Check the event log for more information.
KQP0061I

The Office SharePoint Server Search service was started.

Explanation: The Office SharePoint Server Search service was started.


Operator response: None.
KQP0063E

Error starting Office SharePoint Server Search service. Possible Causes 1. Already started or Service
is disabled. 2. Logon failure or Service does not exist. Check the event log for more information.

Explanation: Error starting Office SharePoint Server Search service.


Operator response: Check the event log for more information.
KQP0064I

The Office SharePoint Server Search service was stopped.

Explanation: The Office SharePoint Server Search service was stopped.


Operator response: None.
KQP0066E

Error stopping Office SharePoint Server Search service. Possible Causes 1. Already stopped, Service
is not started 2. Logon failure or Service does not exist Check the event log for more information.

Explanation: Error stopping Office SharePoint Server Search service.


Operator response: Check the event log for more information.
KQP0071I

The Office Document Conversions Launcher service was started.

Explanation: The Office Document Conversions Launcher service was started.


Operator response: None.
KQP0073E

Error starting Office Document Conversions Launcher service. Possible Causes 1. Already started or
Service is disabled. 2. Logon failure or Service does not exist. Check the event log for more
information.

Explanation: Error starting Office Document Conversions Launcher service.


Operator response: Check the event log for more information.
KQP0074I

The Office Document Conversions Launcher service was stopped.

Explanation: The Office Document Conversions Launcher service was stopped.


Operator response: None.

316

Monitoring Agent for Microsoft SharePoint Server: Users Guide

KQP0076E KQP0096E
KQP0076E

Error stopping Office Document Conversions Launcher service. Possible Causes 1. Already stopped,
Service is not started 2. Logon failure or Service does not exist Check the event log for more
information.

Explanation: Error stopping Office Document Conversions Launcher service.


Operator response: Check the event log for more information.
KQP0081I

The Office Document Conversions Load Balancer service was started.

Explanation: The Office Document Conversions Load Balancer service was started.
Operator response: None.
KQP0083E

Error starting Office Document Conversions Load Balancer service. Possible Causes 1. Already
started or Service is disabled. 2. Logon failure or Service does not exist. Check the event log for
more information.

Explanation: Error starting Office Document Conversions Load Balancer service.


Operator response: Check the event log for more information.
KQP0084I

The Office Document Conversions Load Balancer service was stopped.

Explanation: The Office Document Conversions Load Balancer service was stopped.
Operator response: None.
KQP0086E

Error stopping Office Document Conversions Load Balancer service. Possible Causes 1. Already
stopped, Service is not started 2. Logon failure or Service does not exist Check the event log for
more information.

Explanation: Error stopping Office Document Conversions Load Balancer service.


Operator response: Check the event log for more information.
KQP0091I

The Windows SharePoint Services VSS Writer service was started.

Explanation: The Windows SharePoint Services VSS Writer service was started.
Operator response: None.
KQP0093E

Error starting Windows SharePoint Services VSS Writer service. Possible Causes 1. Already started
or Service is disabled. 2. Logon failure or Service does not exist. Check the event log for more
information.

Explanation: Error starting Windows SharePoint Services VSS Writer service.


Operator response: Check the event log for more information.
KQP0094I

The Windows SharePoint Services VSS Writer service was stopped.

Explanation: The Windows SharePoint Services VSS Writer service was stopped.
Operator response: None.
KQP0096E

Error stopping Windows SharePoint Services VSS Writer service. Possible Causes 1. Already
stopped, Service is not started 2. Logon failure or Service does not exist Check the event log for
more information.

Explanation: Error stopping Windows SharePoint Services VSS Writer service.


Operator response: Check the event log for more information.

Chapter 9. Troubleshooting

317

KQP0101I KQP0121I
KQP0101I

The Windows SharePoint Services Tracing service was started.

Explanation: The Windows SharePoint Services Tracing service was started.


Operator response: None.
KQP0103E

Error starting Windows SharePoint Services Tracing service. Possible Causes 1. Already started or
Service is disabled. 2. Logon failure or Service does not exist. Check the event log for more
information.

Explanation: Error starting Windows SharePoint Services Tracing service.


Operator response: Check the event log for more information.
KQP0104I

The Windows SharePoint Services Tracing service was stopped.

Explanation: The Windows SharePoint Services Tracing service was stopped.


Operator response: None.
KQP0106E

Error stopping Windows SharePoint Services Tracing service. Possible Causes 1. Already stopped,
Service is not started 2. Logon failure or Service does not exist Check the event log for more
information.

Explanation: Error stopping Windows SharePoint Services Tracing service.


Operator response: Check the event log for more information.
KQP0111I

The SharePoint Portal Timer service was started.

Explanation: The SharePoint Portal Timer service was started.


Operator response: None.
KQP0113E

Error starting Windows SharePoint Services Timer service. Possible Causes 1. Already started or
Service is disabled. 2. Logon failure or Service does not exist. Check the event log for more
information.

Explanation: Error starting Windows SharePoint Services Timer service.


Operator response: Check the event log for more information.
KQP0114I

The Windows SharePoint Services Timer service was stopped.

Explanation: The Windows SharePoint Services Timer service was stopped.


Operator response: None.
KQP0116E

Error stopping Windows SharePoint Services Timer service. Possible Causes 1. Already stopped,
Service is not started 2. Logon failure or Service does not exist Check the event log for more
information.

Explanation: Error stopping Windows SharePoint Services Timer service.


Operator response: Check the event log for more information.
KQP0121I

The Windows SharePoint Services Search service was started.

Explanation: The Windows SharePoint Services Search service was started.


Operator response: None.

318

Monitoring Agent for Microsoft SharePoint Server: Users Guide

KQP0123E KQP0136E
KQP0123E

Error starting Windows SharePoint Services Search service. Possible Causes 1. Already started or
Service is disabled. 2. Logon failure or Service does not exist. Check the event log for more
information.

Explanation: Error starting Windows SharePoint Services Search service.


Operator response: Check the event log for more information.
KQP0124I

The Windows SharePoint Services Search service was stopped.

Explanation: The Windows SharePoint Services Search service was stopped.


Operator response: None.
KQP0126E

Error stopping Windows SharePoint Services Search service. Possible Causes 1. Already stopped,
Service is not started 2. Logon failure or Service does not exist Check the event log for more
information.

Explanation: Error stopping Windows SharePoint Services Search service.


Operator response: Check the event log for more information.
KQP0131I

The Windows SharePoint Services Administration service was started.

Explanation: The Windows SharePoint Services Administration service was started.


Operator response: None.
KQP0133E

Error starting Windows SharePoint Services Administration service. Possible Causes 1. Already
started or Service is disabled. 2. Logon failure or Service does not exist. Check the event log for
more information.

Explanation: Error starting Windows SharePoint Services Administration service.


Operator response: Check the event log for more information.
KQP0134I

The Windows SharePoint Services Administration service was stopped.

Explanation: The Windows SharePoint Services Administration service was stopped.


Operator response: None.
KQP0136E

Error stopping Windows SharePoint Services Administration service. Possible Causes 1. Already
stopped, Service is not started 2. Logon failure or Service does not exist Check the event log for
more information.

Explanation: Error stopping Windows SharePoint Services Administration service.


Operator response: Check the event log for more information.

Chapter 9. Troubleshooting

319

320

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Appendix A. IBM Tivoli Enterprise Console event mapping


Each event class corresponds to an attribute group in the IBM Tivoli Enterprise
Console. For a description of the event slots for each event class, see the lists in
this appendix. For more information about mapping attribute groups to event
classes, see the IBM Tivoli Monitoring Administrators Guide.
Generic event mapping provides useful event class and attribute information for
situations that do not have specific event mapping defined. BAROC files are found
on the Tivoli Enterprise Monitoring Server in the installation directory in TECLIB
(that is, install_dir/cms/TECLIB for Windows systems and install_dir/tables/
TEMS_hostname/TECLIB for UNIX systems). IBM Tivoli Enterprise Console event
synchronization provides a collection of ready-to-use rule sets that you can deploy
with minimal configuration. Be sure to install IBM Tivoli Enterprise Console event
synchronization to access the correct Sentry.baroc, which is automatically included
during base configuration of IBM Tivoli Enterprise Console rules if you indicate
that you want to use an existing rulebase. See the IBM Tivoli Monitoring Installation
and Setup Guide for details.
Each of the event classes is a child of KQP_Base and is defined in the kqp.baroc
file. The KQP_Base event class can be used for generic rules processing for any
event from the IBM Tivoli Monitoring for Microsoft Applications: Microsoft
SharePoint Server Agent.
For events generated by situations in the ASP NET Applications attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_ASP_NET_APPLICATIONS class. This class contains the following slots:
v
v
v
v
v
v

node: STRING
timestamp: STRING
site_id: STRING
site_name: STRING
port: STRING
ssl_port: STRING

v name: STRING
v host_name: STRING
For events generated by situations in the Availability attribute group, Tivoli
Enterprise Console events are sent using the ITM_KQP_AVAILABILITY class. This
class contains the following slots:
v node: STRING
v timestamp: STRING
v application_component: STRING
v name: STRING
v name_enum: STRING
v kqp_status: INTEGER
v kqp_status_enum: STRING
v full_name: STRING
v full_name_enum: STRING
Copyright IBM Corp. 2008, 2009

321

v
v
v
v
v

type: INTEGER
type_enum: STRING
virtual_size: INTEGER
page_faults_per_sec: INTEGER
working_set_size: INTEGER

v
v
v
v
v
v
v

thread_count: INTEGER
pid: INTEGER
percent_privileged_time: INTEGER
percent_user_mode_time: INTEGER
percent_processor_time: INTEGER
command_line: STRING
command_line_enum: STRING

v functionality_test_status: INTEGER
v functionality_test_status_enum: STRING
v functionality_test_message: STRING
For events generated by situations in the Database attribute group, Tivoli
Enterprise Console events are sent using the ITM_KQP_DATABASE class. This
class contains the following slots:
v node: STRING
v timestamp: STRING
v
v
v
v

kqp_hostname: STRING
databases: STRING
database_type: STRING
instance_name: STRING

v version_name: STRING
For events generated by situations in the Document Conversions attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_DOCUMENT_CONVERSIONS class. This class contains the following
slots:
v node: STRING
v timestamp: STRING
v incoming_email_messages_processed: REAL
v pending_conversions: INTEGER
For events generated by situations in the Event Log attribute group, Tivoli
Enterprise Console events are sent using the ITM_KQP_EVENT_LOG class. This
class contains the following slots:
v node: STRING
v
v
v
v
v
v
v

322

log_name: STRING
event_source: STRING
event_type: INTEGER
event_type_enum: STRING
event_id: INTEGER
event_category: STRING
message: STRING

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v time_generated: STRING
For events generated by situations in the Excel Calculation Services attribute
group, Tivoli Enterprise Console events are sent using the
ITM_KQP_EXCEL_CALCULATION_SERVICES class. This class contains the
following slots:
v
v
v
v
v
v
v

node: STRING
timestamp: STRING
active_requests: INTEGER
active_sessions: INTEGER
average_request_processing_time: REAL
average_session_time: REAL
cached_charts_requested_per_sec: REAL

v
v
v
v
v
v

rendered_charts_requested_per_sec: REAL
requests_received_per_sec: REAL
requests_with_errors_per_sec: REAL
sessions_per_sec: REAL
unused_items_manager_in_mb: REAL
workbook_cache_size_in_mb: REAL

For events generated by situations in the Excel Services Web Front End attribute
group, Tivoli Enterprise Console events are sent using the
ITM_KQP_EXCEL_SERVICES_WEB_FRONT_END class. This class contains the
following slots:
v node: STRING
v timestamp: STRING
v active_requests: INTEGER
v average_request_processing_time: REAL
v requests_per_sec: REAL
For events generated by situations in the Excel Web Access attribute group, Tivoli
Enterprise Console events are sent using the ITM_KQP_EXCEL_WEB_ACCESS
class. This class contains the following slots:
v
v
v
v
v

node: STRING
timestamp: STRING
average_chart_image_request_time: REAL
chart_image_requests_per_sec: REAL
excel_web_access_request_time: REAL

For events generated by situations in the InfoPath Forms Services attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_INFOPATH_FORMS_SERVICES class. This class contains the following
slots:
v
v
v
v
v
v

node: STRING
timestamp: STRING
business_logic_assemblies_in_memory: INTEGER
cached_form_templates: INTEGER
forms_in_memory: INTEGER
form_templates_in_memory: INTEGER
Appendix A. IBM Tivoli Enterprise Console event mapping

323

v
v
v
v
v

average_data_adapter_query_duration: INTEGER
average_data_connection_submit_duration: INTEGER
average_session_duration: INTEGER
average_transaction_duration: INTEGER
data_connection_query_completed_rate: REAL

v
v
v
v
v
v
v

data_connection_query_failure_rate: REAL
data_connection_query_started_rate: REAL
data_connection_submit_completed_rate: REAL
data_connection_submit_failure_rate: REAL
data_connection_submit_started_rate: REAL
session_completed_rate: REAL
session_started_rate: REAL

v transactions_completed_rate: REAL
v transactions_started_rate: REAL
v name: STRING
For events generated by situations in the Office Search Archival Plugin attribute
group, Tivoli Enterprise Console events are sent using the
ITM_KQP_OFFICE_SEARCH_ARCHIVAL_PLUGIN class. This class contains the
following slots:
v node: STRING
v timestamp: STRING
v active_documents_in_first_queue: INTEGER
v active_documents_in_second_queue: INTEGER
v active_queue: INTEGER
v blocked_documents: INTEGER
v bulk_insert_sessions: INTEGER
v error_documents: INTEGER
v retried_documents: INTEGER
v
v
v
v

total_documents_in_first_queue: INTEGER
total_documents_in_second_queue: INTEGER
total_documents: INTEGER
name: STRING

For events generated by situations in the Office Search Gatherer attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_OFFICE_SEARCH_GATHERER class. This class contains the following
slots:
v node: STRING
v
v
v
v
v
v
v
v

324

timestamp: STRING
accessing_robots_text_file: INTEGER
active_queue_length: INTEGER
admin_clients: INTEGER
all_notifications_received: INTEGER
delayed_documents: INTEGER
document_entries: INTEGER
documents_delayed_retry: INTEGER

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v
v
v
v
v

total_documents_filtered: INTEGER
documents_filtered_rate: REAL
documents_successfully_filtered: INTEGER
documents_successfully_filtered_rate: REAL
external_notifications_rate: REAL

v
v
v
v
v
v
v

external_notifications_received: INTEGER
filtering_threads: INTEGER
filter_objects: INTEGER
filter_process_created: INTEGER
filter_processes: INTEGER
filter_processes_max: INTEGER
heartbeats: INTEGER

v
v
v
v
v
v

idle_threads: INTEGER
notification_sources: INTEGER
notifications_rate: REAL
performance_level: INTEGER
reason_to_back_off: INTEGER
robots_text_requests: INTEGER

v server_objects: INTEGER
v server_objects_created: INTEGER
v servers_currently_unavailable: INTEGER
v
v
v
v

servers_unavailable: INTEGER
stemmers_cached: INTEGER
threads_accessing_network: INTEGER
threads_blocked_due_to_back_off: INTEGER

v threads_in_plugins: INTEGER
v time_outs: INTEGER
v word_breakers_cached: INTEGER
v
v
v
v

system_io_traffic_rate_in_mb: REAL
back_off_reason: INTEGER
back_off_reason_enum: STRING
percent_documents_filtered_unsuccessfully: REAL

For events generated by situations in the Office Search Gatherer Projects attribute
group, Tivoli Enterprise Console events are sent using the
ITM_KQP_OFFICE_SEARCH_GATHERER_PROJECTS class. This class contains the
following slots:
v node: STRING
v
v
v
v
v
v
v
v

timestamp: STRING
accessed_file_rate: REAL
accessed_files: INTEGER
accessed_http: INTEGER
accessed_http_rate: REAL
adaptive_crawl_accepts: INTEGER
adaptive_crawl_errors: INTEGER
adaptive_crawl_error_samples: INTEGER
Appendix A. IBM Tivoli Enterprise Console event mapping

325

v
v
v
v
v

adaptive_crawl_excludes: INTEGER
adaptive_crawl_false_positives: INTEGER
adaptive_crawl_total: INTEGER
changed_documents: INTEGER
crawls_in_progress: INTEGER

v
v
v
v
v
v
v

delayed_documents: INTEGER
document_additions: INTEGER
document_add_rate: REAL
document_delete_rate: REAL
document_deletes: INTEGER
document_modifies: INTEGER
document_modifies_rate: REAL

v
v
v
v
v
v

document_move_and_rename_rate: REAL
document_moves_or_renames: INTEGER
documents_in_progress: INTEGER
documents_on_hold: INTEGER
error_rate: REAL
file_errors: INTEGER

v file_errors_rate: REAL
v filtered_html: INTEGER
v filtered_html_rate: REAL
v
v
v
v

filtered_office: INTEGER
filtered_office_rate: REAL
filtered_text: INTEGER
filtered_text_rate: REAL

v filtering_documents: INTEGER
v gatherer_paused_flag: INTEGER
v history_recovery_progress: INTEGER
v
v
v
v
v

http_errors: INTEGER
http_errors_rate: REAL
incremental_crawls: INTEGER
iterating_history_in_progress_flag: INTEGER
not_modified_documents: INTEGER

v processed_documents: INTEGER
v processed_documents_rate: REAL
v
v
v
v
v
v
v

recovery_in_progress_flag: INTEGER
retries: INTEGER
retries_rate: REAL
started_documents: INTEGER
documents_filtered_with_errors: INTEGER
successfully_filtered_documents: INTEGER
success_rate: REAL

v unique_documents: INTEGER
v urls_in_history: INTEGER
v waiting_documents: INTEGER

326

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v name: STRING
For events generated by situations in the Office Search Indexer Catalogs attribute
group, Tivoli Enterprise Console events are sent using the
ITM_KQP_OFFICE_SEARCH_INDEXER_CATALOGS class. This class contains the
following slots:
v
v
v
v
v
v
v

node: STRING
timestamp: STRING
active_connections: INTEGER
documents_filtered: INTEGER
index_size: INTEGER
l0_indexes_wordlists: INTEGER
l0_merge_flush_count: INTEGER

v
v
v
v
v
v

l0_merge_flush_speed_average: INTEGER
l0_merge_flush_speed_last: INTEGER
l0_merges_flushes_now: INTEGER
l1_merge_count: INTEGER
l1_merges_now: INTEGER
l1_merge_speed_average: INTEGER

v l1_merge_speed_last: INTEGER
v l2_merge_count: INTEGER
v l2_merges_now: INTEGER
v
v
v
v

l2_merge_speed_average: INTEGER
l2_merge_speed_last: INTEGER
l3_merge_count: INTEGER
l3_merges_now: INTEGER

v l3_merge_speed_average: INTEGER
v l3_merge_speed_last: INTEGER
v l4_merge_count: INTEGER
v
v
v
v
v

l4_merges_now: INTEGER
l4_merge_speed_average: INTEGER
l4_merge_speed_last: INTEGER
l5_merge_count: INTEGER
l5_merges_now: INTEGER

v l5_merge_speed_average: INTEGER
v l5_merge_speed_last: INTEGER
v
v
v
v
v
v
v

l6_merge_count: INTEGER
l6_merges_now: INTEGER
l6_merge_speed_average: INTEGER
l6_merge_speed_last: INTEGER
l7_merge_count: INTEGER
l7_merges_now: INTEGER
l7_merge_speed_average: INTEGER

v l7_merge_speed_last: INTEGER
v l8_merge_count: INTEGER
v l8_merges_now: INTEGER
Appendix A. IBM Tivoli Enterprise Console event mapping

327

v
v
v
v
v

l8_merge_speed_average: INTEGER
l8_merge_speed_last: INTEGER
master_index_level: INTEGER
master_merge_progress: INTEGER
master_merges_now: INTEGER

v
v
v
v
v
v
v

master_merges_to_date: INTEGER
out_of_date_document_id_files: INTEGER
persistent_indexes: INTEGER
persistent_indexes_l1: INTEGER
persistent_indexes_l2: INTEGER
persistent_indexes_l3: INTEGER
persistent_indexes_l4: INTEGER

v
v
v
v
v
v

persistent_indexes_l5: INTEGER
persistent_indexes_l6: INTEGER
persistent_indexes_l7: INTEGER
persistent_indexes_l8: INTEGER
queries: INTEGER
queries_failed: INTEGER

v queries_succeeded: INTEGER
v shadow_merge_levels: INTEGER
v shadow_merge_levels_threshold: INTEGER
v
v
v
v

unique_keys: INTEGER
up_to_date_document_id_files: INTEGER
work_items_created: INTEGER
work_items_deleted: INTEGER

v percent_of_failed_queries: REAL
v name: STRING
For events generated by situations in the Office Search Schema Plugin attribute
group, Tivoli Enterprise Console events are sent using the
ITM_KQP_OFFICE_SEARCH_SCHEMA_PLUGIN class. This class contains the
following slots:

328

v
v
v
v
v
v

node: STRING
timestamp: STRING
aliases_loaded: INTEGER
aliases_mapped: INTEGER
duplicate_aliases: INTEGER
error_documents: INTEGER

v
v
v
v
v

refresh_count: INTEGER
total_documents_processed: INTEGER
total_properties_processed: INTEGER
documents_processed_per_sec: REAL
name: STRING

Monitoring Agent for Microsoft SharePoint Server: Users Guide

For events generated by situations in the Performance Object Status attribute


group, Tivoli Enterprise Console events are sent using the
ITM_KQP_PERFORMANCE_OBJECT_STATUS class. This class contains the
following slots:
v node: STRING
v timestamp: STRING
v query_name: STRING
v
v
v
v
v

object_name: STRING
object_type: INTEGER
object_type_enum: STRING
object_status: INTEGER
object_status_enum: STRING

v error_code: INTEGER
v error_code_enum: STRING
For events generated by situations in the Search attribute group, Tivoli Enterprise
Console events are sent using the ITM_KQP_SEARCH class. This class contains the
following slots:
v node: STRING
v timestamp: STRING
v active_threads: INTEGER
v current_connections: INTEGER
v
v
v
v

failed_queries: INTEGER
failed_query_rate: REAL
queries: INTEGER
query_rate: REAL

v
v
v
v

result_rate: REAL
results: INTEGER
succeeded_queries: INTEGER
succeeded_query_rate: REAL

v threads: INTEGER
v percent_of_failed_queries: REAL
For events generated by situations in the Search Archival Plugin attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_SEARCH_ARCHIVAL_PLUGIN class. This class contains the following
slots:
v node: STRING
v timestamp: STRING
v
v
v
v
v
v
v
v

active_documents_in_first_queue: INTEGER
active_documents_in_second_queue: INTEGER
active_queue: INTEGER
blocked_documents: INTEGER
bulk_insert_sessions: INTEGER
error_documents: INTEGER
retried_documents: INTEGER
total_documents_in_first_queue: INTEGER
Appendix A. IBM Tivoli Enterprise Console event mapping

329

v total_documents_in_second_queue: INTEGER
v total_documents: INTEGER
v name: STRING
For events generated by situations in the Search Catalogs attribute group, Tivoli
Enterprise Console events are sent using the ITM_KQP_SEARCH_CATALOGS
class. This class contains the following slots:
v node: STRING
v timestamp: STRING
v catalog_size_in_mb: INTEGER
v
v
v
v
v
v

failed_queries: INTEGER
failed_queries_rate: REAL
number_of_documents: INTEGER
persistent_indexes: INTEGER
queries: INTEGER
queries_rate: REAL

v results: INTEGER
v results_rate: REAL
v successful_queries: INTEGER
v successful_queries_rate: REAL
v unique_keys: INTEGER
v percent_of_failed_queries: REAL
v name: STRING
For events generated by situations in the Search Gatherer attribute group, Tivoli
Enterprise Console events are sent using the ITM_KQP_SEARCH_GATHERER
class. This class contains the following slots:
v node: STRING
v timestamp: STRING
v accessing_robots_text_file: INTEGER
v active_queue_length: INTEGER
v admin_clients: INTEGER
v all_notifications_received: INTEGER
v delayed_documents: INTEGER

330

v
v
v
v
v

document_entries: INTEGER
documents_delayed_retry: INTEGER
total_documents_filtered: INTEGER
documents_filtered_rate: REAL
documents_successfully_filtered: INTEGER

v
v
v
v
v
v
v

documents_successfully_filtered_rate: REAL
external_notifications_rate: REAL
external_notifications_received: INTEGER
filtering_threads: INTEGER
filter_objects: INTEGER
filter_process_created: INTEGER
filter_processes: INTEGER

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v
v
v
v
v

filter_processes_max: INTEGER
heartbeats: INTEGER
idle_threads: INTEGER
notification_sources: INTEGER
notifications_rate: REAL

v
v
v
v
v
v
v

performance_level: INTEGER
reason_to_back_off: INTEGER
robots_text_requests: INTEGER
server_objects: INTEGER
server_objects_created: INTEGER
servers_currently_unavailable: INTEGER
servers_unavailable: INTEGER

v
v
v
v
v
v

stemmers_cached: INTEGER
threads_accessing_network: INTEGER
threads_blocked_due_to_back_off: INTEGER
threads_in_plugins: INTEGER
time_outs: INTEGER
word_breakers_cached: INTEGER

v system_io_traffic_rate_in_mb: REAL
v back_off_reason: INTEGER
v back_off_reason_enum: STRING
v percent_documents_filtered_unsuccessfully: REAL
For events generated by situations in the Search Gatherer Projects attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_SEARCH_GATHERER_PROJECTS class. This class contains the
following slots:
v node: STRING
v timestamp: STRING
v accessed_file_rate: REAL
v accessed_files: INTEGER
v accessed_http: INTEGER
v
v
v
v
v
v

accessed_http_rate: REAL
adaptive_crawl_accepts: INTEGER
adaptive_crawl_errors: INTEGER
adaptive_crawl_error_samples: INTEGER
adaptive_crawl_excludes: INTEGER
adaptive_crawl_false_positives: INTEGER

v
v
v
v
v
v
v
v

adaptive_crawl_total: INTEGER
changed_documents: INTEGER
crawls_in_progress: INTEGER
delayed_documents: INTEGER
document_additions: INTEGER
document_add_rate: REAL
document_delete_rate: REAL
document_deletes: INTEGER
Appendix A. IBM Tivoli Enterprise Console event mapping

331

v
v
v
v
v

document_modifies: INTEGER
document_modifies_rate: REAL
document_move_and_rename_rate: REAL
document_moves_or_renames: INTEGER
documents_in_progress: INTEGER

v
v
v
v
v
v
v

documents_on_hold: INTEGER
error_rate: REAL
file_errors: INTEGER
file_errors_rate: REAL
filtered_html: INTEGER
filtered_html_rate: REAL
filtered_office: INTEGER

v
v
v
v
v
v

filtered_office_rate: REAL
filtered_text: INTEGER
filtered_text_rate: REAL
filtering_documents: INTEGER
gatherer_paused_flag: INTEGER
history_recovery_progress: INTEGER

v http_errors: INTEGER
v http_errors_rate: REAL
v incremental_crawls: INTEGER
v
v
v
v

iterating_history_in_progress_flag: INTEGER
not_modified_documents: INTEGER
processed_documents: INTEGER
processed_documents_rate: REAL

v recovery_in_progress_flag: INTEGER
v retries: INTEGER
v retries_rate: REAL
v
v
v
v
v

started_documents: INTEGER
documents_filtered_with_errors: INTEGER
successfully_filtered_documents: INTEGER
success_rate: REAL
unique_documents: INTEGER

v urls_in_history: INTEGER
v waiting_documents: INTEGER
v name: STRING
For events generated by situations in the Search Indexer Catalogs attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_SEARCH_INDEXER_CATALOGS class. This class contains the following
slots:
v node: STRING
v timestamp: STRING
v active_documents: INTEGER
v build_in_progress: INTEGER
v documents_filtered: INTEGER

332

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v
v
v
v
v

documents_in_progress: INTEGER
files_to_be_filtered: INTEGER
index_size_in_mb: INTEGER
merge_progress: INTEGER
number_of_documents: INTEGER

v
v
v
v
v

number_of_propagations: INTEGER
persistent_indexes: INTEGER
unique_keys: INTEGER
wordlists: INTEGER
name: STRING

For events generated by situations in the Search Schema Plugin attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_SEARCH_SCHEMA_PLUGIN class. This class contains the following
slots:
v node: STRING
v timestamp: STRING
v aliases_loaded: INTEGER
v aliases_mapped: INTEGER
v duplicate_aliases: INTEGER
v error_documents: INTEGER
v refresh_count: INTEGER
v
v
v
v

total_documents_processed: INTEGER
total_properties_processed: INTEGER
documents_processed_per_sec: REAL
name: STRING

For events generated by situations in the Search Topic Assistant attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_SEARCH_TOPIC_ASSISTANT class. This class contains the following
slots:
v node: STRING
v timestamp: STRING
v
v
v
v
v
v

total_categories_found: INTEGER
total_documents_processed: INTEGER
total_documents_processed_per_sec: REAL
total_example_documents_found: INTEGER
total_keywords_found: INTEGER
name: STRING

For events generated by situations in the Shared Service Provider attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_SHARED_SERVICE_PROVIDER class. This class contains the following
slots:
v node: STRING
v timestamp: STRING
v distribution_list_import_rate: REAL
v distribution_lists_imported: INTEGER
Appendix A. IBM Tivoli Enterprise Console event mapping

333

v
v
v
v
v

users_imported: INTEGER
personal_site_latency: INTEGER
personal_site_throughput: REAL
profile_sync_change_process_rate: REAL
profile_sync_content_database_process_count: INTEGER

v
v
v
v
v
v
v

profile_sync_copy_rate: REAL
profile_sync_count_columns_created: INTEGER
profile_sync_site_collection_process_count: INTEGER
public_site_latency: INTEGER
public_site_throughput: REAL
ssp_job_execution_rate: REAL
usage_data_processing_time_in_milliseconds: INTEGER

v user_profile_import_rate: REAL
v name: STRING
For events generated by situations in the SharePoint Components attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_SHAREPOINT_COMPONENTS class. This class contains the following
slots:
v node: STRING
v timestamp: STRING
v property: STRING
v kqp_value: STRING
For events generated by situations in the SP Publishing Cache attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_SP_PUBLISHING_CACHE class. This class contains the following slots:
v node: STRING
v timestamp: STRING
v publishing_cache_flushes_per_sec: REAL
v publishing_cache_hit_count: INTEGER
v publishing_cache_hit_ratio: REAL
v
v
v
v
v
v

publishing_cache_hits_per_sec: REAL
publishing_cache_miss_count: INTEGER
publishing_cache_misses_per_sec: REAL
total_blob_index_writes: INTEGER
total_cache_compactions: INTEGER
total_cache_flushes: INTEGER

v
v
v
v
v

total_objects_added: INTEGER
total_object_discards: INTEGER
total_objects: INTEGER
total_blob_disk_size_in_mb: REAL
name: STRING

For events generated by situations in the SP Search Archival Plugin attribute


group, Tivoli Enterprise Console events are sent using the
ITM_KQP_SP_SEARCH_ARCHIVAL_PLUGIN class. This class contains the
following slots:

334

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v
v
v
v
v

node: STRING
timestamp: STRING
active_documents_in_first_queue: INTEGER
active_documents_in_second_queue: INTEGER
active_queue: INTEGER

v
v
v
v
v
v
v

blocked_documents: INTEGER
bulk_insert_sessions: INTEGER
error_documents: INTEGER
retried_documents: INTEGER
total_documents_in_first_queue: INTEGER
total_documents_in_second_queue: INTEGER
total_documents: INTEGER

v name: STRING
For events generated by situations in the SP Search Gatherer attribute group, Tivoli
Enterprise Console events are sent using the ITM_KQP_SP_SEARCH_GATHERER
class. This class contains the following slots:
v node: STRING
v timestamp: STRING
v accessing_robots_text_file: INTEGER
v active_queue_length: INTEGER
v
v
v
v

admin_clients: INTEGER
all_notifications_received: INTEGER
delayed_documents: INTEGER
document_entries: INTEGER

v documents_delayed_retry: INTEGER
v total_documents_filtered: INTEGER
v documents_filtered_rate: REAL
v
v
v
v
v

documents_successfully_filtered: INTEGER
documents_successfully_filtered_rate: REAL
external_notifications_rate: REAL
external_notifications_received: INTEGER
filtering_threads: INTEGER

v filter_objects: INTEGER
v filter_process_created: INTEGER
v
v
v
v
v
v
v

filter_processes: INTEGER
filter_processes_max: INTEGER
heartbeats: INTEGER
idle_threads: INTEGER
notification_sources: INTEGER
notifications_rate: REAL
performance_level: INTEGER

v
v
v
v

reason_to_back_off: INTEGER
robots_text_requests: INTEGER
server_objects: INTEGER
server_objects_created: INTEGER
Appendix A. IBM Tivoli Enterprise Console event mapping

335

v
v
v
v
v

servers_currently_unavailable: INTEGER
servers_unavailable: INTEGER
stemmers_cached: INTEGER
threads_accessing_network: INTEGER
threads_blocked_due_to_back_off: INTEGER

v
v
v
v
v
v
v

threads_in_plugins: INTEGER
time_outs: INTEGER
word_breakers_cached: INTEGER
system_io_traffic_rate_in_mb: REAL
back_off_reason: INTEGER
back_off_reason_enum: STRING
percent_documents_filtered_unsuccessfully: REAL

For events generated by situations in the SP Search Gatherer Projects attribute


group, Tivoli Enterprise Console events are sent using the
ITM_KQP_SP_SEARCH_GATHERER_PROJECTS class. This class contains the
following slots:
v node: STRING
v timestamp: STRING
v accessed_file_rate: REAL
v accessed_files: INTEGER
v accessed_http: INTEGER
v accessed_http_rate: REAL
v adaptive_crawl_accepts: INTEGER
v adaptive_crawl_errors: INTEGER
v adaptive_crawl_error_samples: INTEGER
v adaptive_crawl_excludes: INTEGER
v adaptive_crawl_false_positives: INTEGER
v adaptive_crawl_total: INTEGER
v
v
v
v
v

changed_documents: INTEGER
crawls_in_progress: INTEGER
delayed_documents: INTEGER
document_additions: INTEGER
document_add_rate: REAL

v document_delete_rate: REAL
v document_deletes: INTEGER
v
v
v
v
v
v
v

document_modifies: INTEGER
document_modifies_rate: REAL
document_move_and_rename_rate: REAL
document_moves_or_renames: INTEGER
documents_in_progress: INTEGER
documents_on_hold: INTEGER
error_rate: REAL

v file_errors: INTEGER
v file_errors_rate: REAL
v filtered_html: INTEGER

336

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v
v
v
v
v

filtered_html_rate: REAL
filtered_office: INTEGER
filtered_office_rate: REAL
filtered_text: INTEGER
filtered_text_rate: REAL

v
v
v
v
v
v
v

filtering_documents: INTEGER
gatherer_paused_flag: INTEGER
history_recovery_progress: INTEGER
http_errors: INTEGER
http_errors_rate: REAL
incremental_crawls: INTEGER
iterating_history_in_progress_flag: INTEGER

v
v
v
v
v
v

not_modified_documents: INTEGER
processed_documents: INTEGER
processed_documents_rate: REAL
recovery_in_progress_flag: INTEGER
retries: INTEGER
retries_rate: REAL

v started_documents: INTEGER
v documents_filtered_with_errors: INTEGER
v successfully_filtered_documents: INTEGER
v
v
v
v

success_rate: REAL
unique_documents: INTEGER
urls_in_history: INTEGER
waiting_documents: INTEGER

v name: STRING
For events generated by situations in the SP Search Indexer Catalogs attribute
group, Tivoli Enterprise Console events are sent using the
ITM_KQP_SP_SEARCH_INDEXER_CATALOGS class. This class contains the
following slots:
v node: STRING
v
v
v
v
v
v

timestamp: STRING
active_connections: INTEGER
documents_filtered: INTEGER
index_size: INTEGER
l0_indexes_wordlists: INTEGER
l0_merge_flush_count: INTEGER

v
v
v
v
v
v
v
v

l0_merge_flush_speed_average: INTEGER
l0_merge_flush_speed_last: INTEGER
l0_merges_flushes_now: INTEGER
l1_merge_count: INTEGER
l1_merges_now: INTEGER
l1_merge_speed_average: INTEGER
l1_merge_speed_last: INTEGER
l2_merge_count: INTEGER
Appendix A. IBM Tivoli Enterprise Console event mapping

337

v
v
v
v
v

l2_merges_now: INTEGER
l2_merge_speed_average: INTEGER
l2_merge_speed_last: INTEGER
l3_merge_count: INTEGER
l3_merges_now: INTEGER

v
v
v
v
v
v
v

l3_merge_speed_average: INTEGER
l3_merge_speed_last: INTEGER
l4_merge_count: INTEGER
l4_merges_now: INTEGER
l4_merge_speed_average: INTEGER
l4_merge_speed_last: INTEGER
l5_merge_count: INTEGER

v
v
v
v
v
v

l5_merges_now: INTEGER
l5_merge_speed_average: INTEGER
l5_merge_speed_last: INTEGER
l6_merge_count: INTEGER
l6_merges_now: INTEGER
l6_merge_speed_average: INTEGER

v l6_merge_speed_last: INTEGER
v l7_merge_count: INTEGER
v l7_merges_now: INTEGER
v
v
v
v

l7_merge_speed_average: INTEGER
l7_merge_speed_last: INTEGER
l8_merge_count: INTEGER
l8_merges_now: INTEGER

v l8_merge_speed_average: INTEGER
v l8_merge_speed_last: INTEGER
v master_index_level: INTEGER
v
v
v
v
v

master_merge_progress: INTEGER
master_merges_now: INTEGER
master_merges_to_date: INTEGER
out_of_date_document_id_files: INTEGER
persistent_indexes: INTEGER

v persistent_indexes_l1: INTEGER
v persistent_indexes_l2: INTEGER
v
v
v
v
v
v
v

persistent_indexes_l3:
persistent_indexes_l4:
persistent_indexes_l5:
persistent_indexes_l6:
persistent_indexes_l7:
persistent_indexes_l8:
queries: INTEGER

INTEGER
INTEGER
INTEGER
INTEGER
INTEGER
INTEGER

v queries_failed: INTEGER
v queries_succeeded: INTEGER
v shadow_merge_levels: INTEGER

338

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v
v
v
v
v

shadow_merge_levels_threshold: INTEGER
unique_keys: INTEGER
up_to_date_document_id_files: INTEGER
work_items_created: INTEGER
work_items_deleted: INTEGER

v percent_of_failed_queries: REAL
v name: STRING
For events generated by situations in the SP Search Schema Plugin attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_SP_SEARCH_SCHEMA_PLUGIN class. This class contains the following
slots:
v node: STRING
v
v
v
v
v
v

timestamp: STRING
aliases_loaded: INTEGER
aliases_mapped: INTEGER
duplicate_aliases: INTEGER
error_documents: INTEGER
refresh_count: INTEGER

v total_documents_processed: INTEGER
v total_properties_processed: INTEGER
v documents_processed_per_sec: REAL
v name: STRING
For events generated by situations in the SPP Alerts Notification Service attribute
group, Tivoli Enterprise Console events are sent using the
ITM_KQP_SPP_ALERTS_NOTIFICATION_SERVICE class. This class contains the
following slots:
v node: STRING
v timestamp: STRING
v percent_of_non_empty_sets_of_notifications: REAL
v average_email_size: INTEGER
v emails_sent_per_sec: REAL
v
v
v
v
v
v

max_email_size: INTEGER
notifications_sent_per_sec: REAL
daily_notifications_sent: INTEGER
immediate_notifications_sent: INTEGER
notifications_currently_processed: INTEGER
weekly_notifications_sent: INTEGER

v total_email_notifications_sent: INTEGER
v total_notifications_sent: INTEGER
v name: STRING
For events generated by situations in the SPP Server Alert Manager attribute
group, Tivoli Enterprise Console events are sent using the
ITM_KQP_SPP_SERVER_ALERT_MANAGER class. This class contains the
following slots:
v node: STRING
Appendix A. IBM Tivoli Enterprise Console event mapping

339

v
v
v
v
v

timestamp: STRING
average_notifications_returned_from_getresults_apis: INTEGER
calls_to_activatealert_per_sec: REAL
calls_to_activateuseralerts_per_sec: REAL
calls_to_deactivatealert_per_sec: REAL

v
v
v
v
v
v
v

calls_to_deactivateuseralerts_per_sec: REAL
calls_to_deletealert_per_sec: REAL
calls_to_deleteuseralerts_per_sec: REAL
calls_to_editalert_per_sec: REAL
calls_to_getresults_from_management_web_part_per_sec: REAL
calls_to_getresults_from_summary_web_part_per_sec: REAL
calls_to_manipulatealert_per_sec: REAL

v
v
v
v
v
v

calls_to_activatealert: INTEGER
calls_to_activateuseralerts: INTEGER
calls_to_deactivateuseralerts: INTEGER
calls_to_dectivatealert: INTEGER
calls_to_deletealert: INTEGER
calls_to_deleteuseralerts: INTEGER

v calls_to_editalert: INTEGER
v calls_to_getresults_from_management_web_part: INTEGER
v calls_to_getresults_from_summary_web_part: INTEGER
v calls_to_manipulatealert: INTEGER
v name: STRING
For events generated by situations in the SPP Server Alerts Plugin attribute group,
Tivoli Enterprise Console events are sent using the
ITM_KQP_SPP_SERVER_ALERTS_PLUGIN class. This class contains the following
slots:
v node: STRING
v timestamp: STRING
v current_documents_processed: INTEGER
v current_quota_processing_processed: INTEGER

340

v
v
v
v
v
v

total_alerts: INTEGER
total_alerts_added: INTEGER
total_alerts_deactivated: INTEGER
total_alerts_deleted: INTEGER
total_boolean_immediate_alerts: INTEGER
total_boolean_immediate_hits_received: INTEGER

v
v
v
v
v
v
v
v

total_boolean_immediate_hits_received_per_sec: REAL
total_boolean_quota_processing: INTEGER
total_boolean_quota_processing_per_sec: REAL
total_boolean_scheduled_alerts: INTEGER
total_boolean_scheduled_hits_received: INTEGER
total_boolean_scheduled_hits_received_per_sec: REAL
total_documents_failed: INTEGER
total_documents_processed: INTEGER

Monitoring Agent for Microsoft SharePoint Server: Users Guide

v
v
v
v
v

total_documents_processed_per_sec: REAL
total_hits_received: INTEGER
total_hits_received_per_sec: REAL
total_quota_processing: INTEGER
total_quota_processing_per_sec: REAL

v
v
v
v
v
v
v

total_rank_immediate_alerts: INTEGER
total_rank_immediate_hits_received_per_sec: REAL
total_rank_immediate_hits_received: INTEGER
total_rank_quota_processing: INTEGER
total_rank_quota_processing_per_sec: REAL
total_rank_scheduled_alerts: INTEGER
total_rank_scheduled_hits_received: INTEGER

v
v
v
v

total_rank_scheduled_hits_received_per_sec: REAL
total_security_checks: INTEGER
total_security_checks_per_sec: REAL
name: STRING

For events generated by situations in the Web Server attribute group, Tivoli
Enterprise Console events are sent using the ITM_KQP_WEB_SERVER class. This
class contains the following slots:
v node: STRING
v
v
v
v

timestamp: STRING
site_id: STRING
site_name: STRING
port: STRING

v ssl_port: STRING
v name: STRING
v host_name: STRING

Appendix A. IBM Tivoli Enterprise Console event mapping

341

342

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Appendix B. Documentation library


This appendix contains information about the publications related to the
Monitoring Agent for Microsoft SharePoint Server. These publications are listed in
the following categories:
v Monitoring Agent for Microsoft SharePoint Server library
v Prerequisite publications
v Related publications
See the IBM Tivoli Monitoring and OMEGAMON XE products: Documentation Guide,
SC23-8816, for information about accessing and using publications. You can find
the Documentation Guide in the IBM Tivoli Monitoring and OMEGAMON XE
Information Center at http://publib.boulder.ibm.com/infocenter/tivihelp/v15r1/
topic/com.ibm.docguide.doc/DocGuide.htm. To open the Documentation Guide in
the information center, select Using the publications in the Contents pane.
To find a list of new and changed publications, click Whats new on the Welcome
page of the IBM Tivoli Monitoring and OMEGAMON XE Information Center. To
find publications from the previous version of a product, click Previous versions
under the name of the product in the Contents pane.

Monitoring Agent for Microsoft SharePoint Server library


There is one document specific to the Monitoring Agent for Microsoft SharePoint
Server: IBM Tivoli Monitoring for Microsoft Applications: Microsoft SharePoint Server
Agent Users Guide. This publication provides agent-specific information for
configuring, using, and troubleshooting the Monitoring Agent for Microsoft
SharePoint Server
Use the configuration chapter in this guide with the IBM Tivoli Monitoring
Installation and Setup Guide to set up the software.
Use the information in this guide with the IBM Tivoli Monitoring Users Guide to
monitor Microsoft SharePoint Server resources.

Prerequisite publications
To use the information in this publication effectively, you must have some
prerequisite knowledge, which you can obtain from the following IBM Tivoli
Monitoring publications:
v Exploring IBM Tivoli Monitoring
v IBM Tivoli Monitoring Administrators Guide
v IBM Tivoli Monitoring Agent Builder Users Guide
v
v
v
v
v

IBM
IBM
IBM
IBM
IBM

Tivoli
Tivoli
Tivoli
Tivoli
Tivoli

Monitoring Command Reference


Monitoring: Configuring Tivoli Enterprise Monitoring Server on z/OS
Monitoring Installation and Setup Guide
Monitoring: Messages
Monitoring Troubleshooting Guide

v IBM Tivoli Monitoring: Upgrading from Tivoli Distributed Monitoring


Copyright IBM Corp. 2008, 2009

343

v
v
v
v
v
v
v

IBM
IBM
IBM
IBM
IBM
IBM
IBM

Tivoli
Tivoli
Tivoli
Tivoli
Tivoli
Tivoli
Tivoli

Monitoring: Upgrading from V5.1.2


Monitoring Users Guide
Monitoring: i5/OS Agent Users Guide
Monitoring: Linux OS Agent Users Guide
Monitoring: UNIX Log OS Agent Users Guide
Monitoring: UNIX OS Agent Users Guide
Monitoring: Windows OS Agent Users Guide

v IBM Tivoli Monitoring Universal Agent Users Guide


v IBM Tivoli Monitoring Universal Agent API and Command Programming Reference
Guide

Related publications
The following documents also provide useful information:
v IBM Tivoli Enterprise Console Adapters Guide
v IBM Tivoli Enterprise Console Event Integration Facility Users Guide
v IBM Tivoli Enterprise Console Reference Manual
v IBM Tivoli Enterprise Console Rule Builders Guide

Other sources of documentation


You can also obtain technical documentation about Tivoli Monitoring and
OMEGAMON XE products from the following sources:
v IBM Tivoli Open Process Automation Library (OPAL)
http://www.ibm.com/software/tivoli/opal
OPAL is an online catalog that contains integration documentation as well as
other downloadable product extensions.
v Redbooks
http://www.redbooks.ibm.com/
IBM Redbooks, Redpapers, and Redbooks Technotes provide information about
products from platform and solution perspectives.
v Technotes
Technotes provide the latest information about known product limitations and
workarounds. You can find Technotes through the IBM Software Support Web
site at http://www.ibm.com/software/support.
v Tivoli wikis on the IBM developerWorks Web site
Tivoli Wiki Central at http://www.ibm.com/developerworks/wikis/display/
tivoli/Home is the home for interactive wikis that offer best practices and
scenarios for using Tivoli products. The wikis contain white papers contributed
by IBM employees, and content created by customers and business partners.

344

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Two of these wikis are of particular relevance to IBM Tivoli Monitoring:


Tivoli Distributed Monitoring and Application Management Wiki at
http://www.ibm.com/developerworks/wikis/display/tivolimonitoring/
Home provides information about IBM Tivoli Monitoring and related
distributed products, including IBM Tivoli Composite Application
Management products.
Tivoli System z Monitoring and Application Management Wiki at
http://www.ibm.com/developerworks/wikis/display/tivoliomegamon/
Home provides information about the OMEGAMON XE products, NetView
for z/OS, Tivoli Monitoring Agent for z/TPF, and other System z monitoring
and application management products.

Appendix B. Documentation library

345

346

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Appendix C. Accessibility
Accessibility features help users with physical disabilities, such as restricted
mobility or limited vision, to use software products successfully. The major
accessibility features in this product enable users to do the following:
v Use assistive technologies, such as screen-reader software and digital speech
synthesizer, to hear what is displayed on the screen. Consult the product
documentation of the assistive technology for details on using those technologies
with this product.
v Operate specific or equivalent features using only the keyboard.
v Magnify what is displayed on the screen.
In addition, the product documentation was modified to include the following
features to aid accessibility:
v All documentation is available in both HTML and convertible PDF formats to
give the maximum opportunity for users to apply screen-reader software.
v All images in the documentation are provided with alternative text so that users
with vision impairments can understand the contents of the images.

Navigating the interface using the keyboard


Standard shortcut and accelerator keys are used by the product and are
documented by the operating system. See the documentation provided by your
operating system for more information.

Magnifying what is displayed on the screen


You can enlarge information on the product windows using facilities provided by
the operating systems on which the product is run. For example, in a Microsoft
Windows environment, you can lower the resolution of the screen to enlarge the
font sizes of the text on the screen. See the documentation provided by your
operating system for more information.

Copyright IBM Corp. 2008, 2009

347

348

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Appendix D. Notices
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the users responsibility 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 this document. The furnishing of this document does not give you
any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785 U.S.A.
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan, Ltd.
3-2-12, Roppongi, Minato-ku, Tokyo 106-8711 Japan
The following paragraph does not apply to the United Kingdom or any other
country where such provisions 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 NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
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 periodically made 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 this
publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.

Copyright IBM Corp. 2008, 2009

349

IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Corporation
2Z4A/101
11400 Burnet Road
Austin, TX 78758 U.S.A.
Such information may be available, subject to appropriate terms and conditions,
including in some cases payment of a fee.
The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.
Any performance data contained herein was determined in a controlled
environment. Therefore, the results obtained in other operating environments may
vary significantly. Some measurements may have been made on development-level
systems and there is no guarantee that these measurements will be the same on
generally available systems. Furthermore, some measurement may have been
estimated through extrapolation. Actual results may vary. Users of this document
should verify the applicable data for their specific environment.
Information concerning non-IBM products was obtained from the suppliers of
those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.
All statements regarding IBMs future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.
All IBM prices shown are IBMs suggested retail prices, are current and are subject
to change without notice. Dealer prices may vary.
This information is for planning purposes only. The information herein is subject to
change before the products described become available.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which
illustrate programming techniques on various operating platforms. You may copy,
modify, and distribute these sample programs in any form without payment to

350

Monitoring Agent for Microsoft SharePoint Server: Users Guide

IBM, for the purposes of developing, using, marketing or distributing application


programs conforming to the application programming interface for the operating
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs. You may copy,
modify, and distribute these sample programs in any form without payment to
IBM for the purposes of developing, using, marketing, or distributing application
programs conforming to IBMs application programming interfaces.
Each copy or any portion of these sample programs or any derivative work, must
include a copyright notice as follows:
(your company name) (year). Portions of this code are derived from IBM Corp.
Sample Programs. Copyright IBM Corp. _enter the year or years_. All rights
reserved.
If you are viewing this information in softcopy form, the photographs and color
illustrations might not be displayed.

Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at Copyright and
trademark information at www.ibm.com/legal/copytrade.shtml.
Adobe, Acrobat, PostScript and all Adobe-based trademarks are either registered
trademarks or trademarks of Adobe Systems Incorporated in the United States,
other countries, or both.
Cell Broadband Engine and Cell/B.E. are trademarks of Sony Computer
Entertainment, Inc., in the United States, other countries, or both and is used under
license therefrom.
Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino
logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are
trademarks or registered trademarks of Intel Corporation or its subsidiaries in the
United States and other countries.
IT Infrastructure Library is a registered trademark of the Central Computer and
Telecommunications Agency which is now part of the Office of Government
Commerce.
ITIL is a registered trademark, and a registered community trademark of the
Office of Government Commerce, and is registered in the U.S. Patent and
Trademark Office.
Java and all Java-based trademarks and logos are trademarks or
registered trademarks of Sun Microsystems, Inc. in the United States,
other countries, or both.

Linux is a trademark of Linus Torvalds in the United States, other countries, or


both.
Appendix D. Notices

351

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other
countries.
Other company, product, and service names may be trademarks or service marks
of others.

352

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Index
A
Accessed File Rate attribute 73, 126, 168
Accessed Files attribute 73, 126, 168
Accessed HTTP attribute 73, 127, 168
Accessed HTTP Rate attribute 73, 127, 169
accessibility 347
Accessing Robots Text File attribute 63, 116, 158
Active Connections attribute 85, 181
Active Documents attribute 139
Active Documents in First Queue attribute 60, 110, 155
Active Documents in Second Queue attribute 60, 110, 156
Active Queue attribute 60, 110, 156
Active Queue Length attribute 63, 117, 159
Active Requests attribute 49, 52
Active Sessions attribute 49
Active Threads attribute 107
Adaptive Crawl Accepts attribute 74, 127, 169
Adaptive Crawl Error Samples attribute 74, 127, 169
Adaptive Crawl Errors attribute 74, 127, 169
Adaptive Crawl Excludes attribute 74, 128, 169
Adaptive Crawl False Positives attribute 75, 128, 170
Adaptive Crawl Total attribute 75, 128, 170
Admin Clients attribute 63, 117, 159
agent
trace logs 291
agents
troubleshooting 298
Alert
situations 220, 222
workspaces
descriptions 17
list 15
Alert Plugin Details workspace 17
Alert workspace 17
Alerts API Details workspace 17
Alerts Manager Details workspace 18
Alerts Notification Service E-mail Status workspace 18
Aliases Loaded attribute 101, 142, 196
Aliases Mapped attribute 101, 142, 196
All Notifications Received attribute 64, 117, 159
Application Component attribute 42
ASP NET Applications
situations 220, 222
workspaces
descriptions 18
list 15
ASP NET Applications attribute group 40
ASP NET Applications workspace 18
attribute groups
ASP NET Applications 40
Availability 42
Database 45
Document Conversions 46
Event Log 47
Excel Calculation Services 49
Excel Services Web Front End 52
Excel Web Access 53
InfoPath Forms Services 54
list of all 37
more information 37
new 3
Copyright IBM Corp. 2008, 2009

attribute groups (continued)


Office Search Archival Plugin 60
Office Search Gatherer 63
Office Search Gatherer Projects 72
Office Search Indexer Catalogs 85
Office Search Schema Plugin 101
overview 37
Performance Object Status 103
Search 106
Search Archival Plugin 110
Search Catalogs 112
Search Gatherer 116
Search Gatherer Projects 126
Search Indexer Catalogs 138
Search Schema Plugin 142
Search Topic Assistant 144
Shared Service Provider 146
SharePoint Components 150
SP Publishing Cache 151
SP Search Archival Plugin 155
SP Search Gatherer 158
SP Search Gatherer Projects 167
SP Search Indexer Catalogs 180
SP Search Schema Plugin 196
SPP Alerts Notification Service 198
SPP Server Alert Manager 201
SPP Server Alerts Plugin 207
Web Server 215
attributes
Accessed File Rate 73, 126, 168
Accessed Files 73, 126, 168
Accessed HTTP 73, 127, 168
Accessed HTTP Rate 73, 127, 169
Accessing Robots Text File 63, 116, 158
Active Connections 85, 181
Active Documents 139
Active Documents in First Queue 60, 110, 155
Active Documents in Second Queue 60, 110, 156
Active Queue 60, 110, 156
Active Queue Length 63, 117, 159
Active Requests 49, 52
Active Sessions 49
Active Threads 107
Adaptive Crawl Accepts 74, 127, 169
Adaptive Crawl Error Samples 74, 127, 169
Adaptive Crawl Errors 74, 127, 169
Adaptive Crawl Excludes 74, 128, 169
Adaptive Crawl False Positives 75, 128, 170
Adaptive Crawl Total 75, 128, 170
Admin Clients 63, 117, 159
Aliases Loaded 101, 142, 196
Aliases Mapped 101, 142, 196
All Notifications Received 64, 117, 159
Application Component 42
ASP NET Applications 41
Availability 42
Average Chart Image Request Time 54
Average Data Adapter Query Duration 56
Average Data Connection Submit Duration 56
Average Email Size 199
Average Notifications Returned from GetResults APIs

202

353

attributes (continued)
Average Request Processing Time 50, 53
Average Session Duration 56
Average Session Time 50
Average Transaction Duration 57
Back Off Reason 72, 125, 167
Blocked Documents 61, 111, 156
Build in Progress 139
Bulk Insert Sessions 61, 111, 156
Business Logic Assemblies in Memory 55
Cached Charts Requested Per Sec 50
Cached Form Templates 55
Calls to ActivateAlert 205
Calls to ActivateAlert Per Sec 202
Calls to ActivateUserAlerts 205
Calls to ActivateUserAlerts Per Sec 202
Calls to DeactivateAlert Per Sec 203
Calls to DeactivateUserAlerts 205
Calls to DeactivateUserAlerts Per Sec 203
Calls to DectivateAlert 205
Calls to DeleteAlert 205
Calls to DeleteAlert Per Sec 203
Calls to DeleteUserAlerts 206
Calls to DeleteUserAlerts Per Sec 203
Calls to EditAlert 206
Calls to EditAlert Per Sec 204
Calls to GetResults from Management Web Part 206
Calls to GetResults from Management Web Part Per
Sec 204
Calls to GetResults from Summary Web Part 206
Calls to GetResults from Summary Web Part Per Sec 204
Calls to ManipulateAlert 207
Calls to ManipulateAlert Per Sec 204
Catalog Size in MB 113
Changed Documents 75, 128, 170
Chart Image Requests Per Sec 54
Command Line 44
Crawls in Progress 75, 129, 170
Current Connections 107
Current Documents Processed 207
Current Quota Processing Processed 208
Daily Notifications Sent 200
Data Connection Query Completed Rate 57
Data Connection Query Failure Rate 57
Data Connection Query Started Rate 57
Data Connection Submit Completed Rate 58
Data Connection Submit Failure Rate 58
Data Connection Submit Started Rate 58
Database 45
Database Type 46
Databases 46
Delayed Documents 64, 75, 117, 129, 159, 171
Distribution List Import Rate 147
Distribution Lists Imported 147
Document Add Rate 76, 129, 171
Document Additions 76, 129, 171
Document Conversions 46
Document Delete Rate 76, 130, 171
Document Deletes 76, 130, 172
Document Entries 64, 118, 159
Document Modifies 77, 130, 172
Document Modifies Rate 77, 130, 172
Document Move and Rename Rate 77, 130, 172
Document Moves or Renames 77, 131, 172
Documents Delayed Retry 64, 118, 160
Documents Filtered 86, 139, 181
Documents Filtered Rate 65, 118, 160

354

attributes (continued)
Documents Filtered with Error 83, 179
Documents Filtered with Errors 137
Documents in Progress 78, 131, 140, 173
Documents on Hold 78, 131, 173
Documents Processed Per Sec 103, 144, 198
Documents Successfully Filtered 65, 119, 160
Documents Successfully Filtered Rate 65, 119, 161
Duplicate Aliases 101, 143, 196
Emails Sent Per Sec 199
Error Code 105
Error Documents 61, 102, 111, 143, 156, 197
Error Rate 78, 131, 173
Event Category 48
Event ID 48
Event Log 47
Event Source 48
Event Type 48
Excel Calculation Services 49
Excel Services Web Front End 52
Excel Web Access 53
Excel Web Access Request Time 54
External Notifications Rate 66, 119, 161
External Notifications Received 66, 119, 161
Failed Queries 107, 113
Failed Queries Rate 113
Failed Query Rate 107
File Errors 78, 132, 173
File Errors Rate 79, 132, 174
Files to be Filtered 140
Filter Objects 66, 120, 162
Filter Process Created 67, 120, 162
Filter Processes 67, 120, 162
Filter Processes Max 67, 120, 162
Filtered HTML 79, 132, 174
Filtered HTML Rate 79, 132, 174
Filtered Office 79, 133, 174
Filtered Office Rate 79, 133, 175
Filtered Text 80, 133, 175
Filtered Text Rate 80, 133, 175
Filtering Documents 80, 134, 175
Filtering Threads 66, 120, 161
Form Templates in Memory 56
Forms in Memory 55
Full Name 43
Functionality Test Message 45
Functionality Test Status 44
Gatherer Paused Flag 80, 134, 176
Heartbeats 67, 121, 163
History Recovery Progress 81, 134, 176
Host Name 41, 216
HostName 46
HTTP Errors 81, 134, 176
HTTP Errors Rate 81, 134, 176
Idle Threads 68, 121, 163
Immediate Notifications Sent 200
Incoming E Mail Messages Processed 47
Incremental Crawls 81, 135, 176
Index Size 86, 181
Index Size in MB 140
InfoPath Forms Services 55
Instance Name 46
Iterating History in Progress Flag 82, 135, 177
L0 Indexes Wordlists 86, 181
L0 Merge Flush Count 86, 182
L0 Merge Flush Speed Average 87, 182
L0 Merge Flush Speed Last 87, 182

Monitoring Agent for Microsoft SharePoint Server: Users Guide

attributes (continued)
L0 Merges Flushes Now 87, 182
L1 Merge Count 87, 183
L1 Merge Speed Average 88, 183
L1 Merge Speed Last 88, 183
L1 Merges Now 88, 183
L2 Merge Count 88, 183
L2 Merge Speed Average 89, 184
L2 Merge Speed Last 89, 184
L2 Merges Now 89, 184
L3 Merge Count 89, 184
L3 Merge Speed Average 90, 185
L3 Merge Speed Last 90, 185
L3 Merges Now 90, 185
L4 Merge Count 90, 185
L4 Merge Speed Average 91, 186
L4 Merge Speed Last 91, 186
L4 Merges Now 90, 186
L5 Merge Count 91, 186
L5 Merge Speed Average 92, 187
L5 Merge Speed Last 92, 187
L5 Merges Now 91, 187
L6 Merge Count 92, 187
L6 Merge Speed Average 93, 188
L6 Merge Speed Last 93, 188
L6 Merges Now 92, 187
L7 Merge Count 93, 188
L7 Merge Speed Average 93, 189
L7 Merge Speed Last 94, 189
L7 Merges Now 93, 188
L8 Merge Count 94, 189
L8 Merge Speed Average 94, 190
L8 Merge Speed Last 95, 190
L8 Merges Now 94, 189
Log Name 48
Master Index Level 95, 190
Master Merge Progress 95, 190
Master Merges Now 95, 190
Master Merges To Date 96, 191
Max Email Size 199
Merge Progress 140
Message 48
more information 37
Name 41, 42, 59, 62, 85, 100, 103, 112, 116, 138, 142, 144,
146, 150, 155, 158, 180, 195, 198, 201, 207, 215, 216
Node 41, 42, 45, 46, 47, 49, 52, 53, 55, 60, 63, 72, 85, 101,
103, 106, 110, 113, 116, 126, 139, 142, 144, 146, 151, 155,
158, 168, 180, 196, 198, 202, 207, 216
Not Modified Documents 82, 135, 177
Notification Sources 68, 121, 163
Notifications Currently Processed 200
Notifications Rate 68, 121, 163
Notifications Sent Per Sec 199
Number of Documents 114, 140
Number of Propagations 141
Object Name 104
Object Status 104
Object Type 104
Office Search Archival Plugin 60
Office Search Gatherer 63
Office Search Gatherer Projects 72
Office Search Indexer Catalogs 85
Office Search Schema Plugin 101
Out of Date Document ID Files 96, 191
overview 37
Page Faults per Sec 43
Pending Conversions 47

attributes (continued)
Percent Documents Filtered Unsuccessfully 72, 125, 167
Percent of Failed Queries 100, 109, 116, 195
Percent of Non Empty Sets of Notifications 199
Percent Privileged Time 44
Percent Processor Time 44
Percent User Mode Time 44
Performance Level 68, 122, 163
Performance Object Status 103
Persistent Indexes 96, 114, 141, 191
Persistent Indexes L1 96, 191
Persistent Indexes L2 96, 192
Persistent Indexes L3 97, 192
Persistent Indexes L4 97, 192
Persistent Indexes L5 97, 192
Persistent Indexes L6 97, 192
Persistent Indexes L7 98, 193
Persistent Indexes L8 98, 193
Personal Site Latency 147
Personal Site Throughput 148
PID 44
Port 41, 216
Processed Documents 82, 135, 177
Processed Documents Rate 82, 136, 177
Profile Sync Change Process Rate 148
Profile Sync Content Database Process Count 148
Profile Sync Copy Rate 148
Profile Sync Count Columns Created 149
Profile Sync Site Collection Process Count 149
Property 151
Public Site Latency 149
Public Site Throughput 149
Publishing Cache Flushes Per Sec 152
Publishing Cache Hit Count 152
Publishing Cache Hit Ratio 152
Publishing Cache Hits Per Sec 152
Publishing Cache Miss Count 153
Publishing Cache Misses Per Sec 153
Queries 98, 108, 114, 193
Queries Failed 98, 193
Queries Rate 114
Queries Succeeded 98, 194
Query Name 104
Query Rate 108
Reason to Back Off 68, 164
Reason To Back Off 122
Recovery in Progress Flag 83, 136, 178
Refresh Count 102, 143, 197
Rendered Charts Requested Per Sec 50
Requests Per Sec 53
Requests Received Per Sec 51
Requests with Errors Per Sec 51
Result Rate 108
Results 108, 114
Results Rate 115
Retried Documents 61, 111, 157
Retries 83, 136, 178
Retries Rate 83, 136, 178
Robots Text Requests 69, 122, 164
Search 106
Search Archival Plugin 110
Search Catalogs 113
Search Gatherer 116
Search Gatherer Projects 126
Search Indexer Catalogs 139
Search Schema Plugin 142
Search Topic Assistant 144
Index

355

attributes (continued)
Server Objects 69, 122, 164
Server Objects Created 69, 123, 164
Servers Currently Unavailable 69, 123, 165
Servers Unavailable 70, 123, 165
Session Completed Rate 58
Session Started Rate 59
Sessions Per Sec 51
Shadow Merge Levels 99, 194
Shadow Merge Levels Threshold 99, 194
Shared Service Provider 146
SharePoint Components 151
Site ID 41, 216
Site Name 41, 216
SP Publishing Cache 151
SP Search Archival Plugin 155
SP Search Gatherer 158
SP Search Gatherer Projects 168
SP Search Indexer Catalogs 180
SP Search Schema Plugin 196
SPP Alerts Notification Service 198
SPP Server Alert Manager 202
SPP Server Alerts Plugin 207
SSL Port 41, 216
SSP Job Execution Rate 150
Started Documents 83, 137, 178
Status 42
Stemmers Cached 70, 123, 165
Succeeded Queries 108
Succeeded Query Rate 109
Success Rate 84, 137, 179
Successful Queries 115
Successful Queries Rate 115
Successfully Filtered Documents 84, 137, 179
System IO Traffic Rate in MB 71, 125, 167
Thread Count 44
Threads 109
Threads Accessing Network 70, 124, 165
Threads Blocked due to Back Off 70
Threads Blocked Due To Back Off 124, 166
Threads in Plugins 71, 124, 166
Time Generated 48
Time Outs 71, 124, 166
Timestamp 41, 42, 46, 47, 49, 52, 53, 55, 60, 63, 73, 85, 101,
104, 106, 110, 113, 116, 126, 139, 142, 145, 146, 151, 155,
158, 168, 181, 196, 198, 202, 207, 216
Total Alerts 208
Total Alerts Added 208
Total Alerts Deactivated 208
Total Alerts Deleted 209
Total Blob Disk Size in MB 155
Total Blob Index Writes 153
Total Boolean Immediate Alerts 209
Total Boolean Immediate Hits Received 209
Total Boolean Immediate Hits Received Per Sec 209
Total Boolean Quota Processing 210
Total Boolean Quota Processing Per Sec 210
Total Boolean Scheduled Alerts 210
Total Boolean Scheduled Hits Received 210
Total Boolean Scheduled Hits Received Per Sec 211
Total Cache Compactions 153
Total Cache Flushes 154
Total Categories Found 145
Total Documents 62, 112, 157
Total Documents Failed 211
Total Documents Filtered 65, 118, 160
Total Documents in First Queue 62, 112, 157

356

attributes (continued)
Total Documents in Second Queue 62, 112, 157
Total Documents Processed 102, 143, 145, 197, 211
Total Documents Processed Per Sec 145, 211
Total Email Notifications Sent 201
Total Example Documents Found 145
Total Hits Received 212
Total Hits Received Per Sec 212
Total Keywords Found 146
Total Notifications Sent 201
Total Object Discards 154
Total Objects 154
Total Objects Added 154
Total Properties Processed 102, 144, 197
Total Quota Processing 212
Total Quota Processing Per Sec 212
Total Rank Immediate Alerts 213
Total Rank Immediate Hits Received 213
Total Rank Immediate Hits Received Per Sec 213
Total Rank Quota Processing 213
Total Rank Quota Processing Per Sec 214
Total Rank Scheduled Alerts 214
Total Rank Scheduled Hits Received 214
Total Rank Scheduled Hits Received Per Sec 214
Total Security Checks 215
Total Security Checks Per Sec 215
Transactions Completed Rate 59
Transactions Started Rate 59
Type 43
Unique Documents 84, 138, 179
Unique Keys 99, 115, 141, 194
Unused Items Manager in MB 51
Up to Date Document ID Files 99, 195
URLs in History 84, 138, 180
Usage Data Processing Time in Milliseconds 150
User Profile Import Rate 150
Users Imported 147
Value 151
Version Name 46
Virtual Size 43
Waiting Documents 85, 138, 180
Web Server 216
Weekly Notifications Sent 200
Word Breakers Cached 71, 124, 166
Wordlists 141
Work Items Created 100, 195
Work Items Deleted 100, 195
Workbook Cache Size in MB 52
Working Set Size 43
Availability
situations 220, 222
workspaces
descriptions 18
list 15
Availability attribute group 42
Availability workspace 18
Average Chart Image Request Time attribute 54
Average Data Adapter Query Duration attribute 56
Average Data Connection Submit Duration attribute 56
Average Email Size attribute 199
Average Notifications Returned from GetResults APIs
attribute 202
Average Request Processing Time attribute 50, 53
Average Session Duration attribute 56
Average Session Time attribute 50
Average Transaction Duration attribute 57

Monitoring Agent for Microsoft SharePoint Server: Users Guide

B
Back Off Reason attribute 72, 125, 167
Blocked Documents attribute 61, 111, 156
Build in Progress attribute 139
built-in troubleshooting features 289
Bulk Insert Sessions attribute 61, 111, 156
Business Logic Assemblies in Memory attribute

55

C
Cached Charts Requested Per Sec attribute 50
Cached Form Templates attribute 55
calculate historical data disk space 216
Calls to ActivateAlert attribute 205
Calls to ActivateAlert Per Sec attribute 202
Calls to ActivateUserAlerts attribute 205
Calls to ActivateUserAlerts Per Sec attribute 202
Calls to DeactivateAlert Per Sec attribute 203
Calls to DeactivateUserAlerts attribute 205
Calls to DeactivateUserAlerts Per Sec attribute 203
Calls to DectivateAlert attribute 205
Calls to DeleteAlert attribute 205
Calls to DeleteAlert Per Sec attribute 203
Calls to DeleteUserAlerts attribute 206
Calls to DeleteUserAlerts Per Sec attribute 203
Calls to EditAlert attribute 206
Calls to EditAlert Per Sec attribute 204
Calls to GetResults from Management Web Part attribute 206
Calls to GetResults from Management Web Part Per Sec
attribute 204
Calls to GetResults from Summary Web Part attribute 206
Calls to GetResults from Summary Web Part Per Sec
attribute 204
Calls to ManipulateAlert attribute 207
Calls to ManipulateAlert Per Sec attribute 204
capacity planning
Monitoring Agent for Microsoft SharePoint Server 217
capacity planning for historical data 216
Catalog Size in MB attribute 113
Changed Documents attribute 75, 128, 170
changes
attribute groups, new 3
baroc file updated 4
situations 3
views 3
workspaces 3
Chart Image Requests Per Sec attribute 54
Command Line attribute 44
commands
tacmd addSystem 11
commands, Take Action 247
components 4
configuration 7
after installation 10
fields 10
remote 11
values 10
configuring the monitoring agent 10
Crawls in Progress attribute 75, 129, 170
Current Connections attribute 107
Current Documents Processed attribute 207
Current Quota Processing Processed attribute 208

D
Daily Notifications Sent attribute

200

data
trace logs 290
Data Connection Query Completed Rate attribute 57
Data Connection Query Failure Rate attribute 57
Data Connection Query Started Rate attribute 57
Data Connection Submit Completed Rate attribute 58
Data Connection Submit Failure Rate attribute 58
Data Connection Submit Started Rate attribute 58
data logged
Monitoring Agent for Microsoft SharePoint Server 217
data provider logs
See agent
Database
situations 220, 226
workspaces
descriptions 19
list 15
Database attribute group 45
Database Type attribute 46
Database workspace 19
Databases attribute 46
Delayed Documents attribute 64, 75, 117, 129, 159, 171
developerWorks Web site 344
disk capacity planning
See capacity planning
disk capacity planning for historical data 216
Distribution List Import Rate attribute 147
Distribution Lists Imported attribute 147
Document Add Rate attribute 76, 129, 171
Document Additions attribute 76, 129, 171
Document Conversions
situations 220, 226
workspaces
descriptions 19
list 15
Document Conversions attribute group 46
Document Conversions workspace 19
Document Delete Rate attribute 76, 130, 171
Document Deletes attribute 76, 130, 172
Document Entries attribute 64, 118, 159
Document Modifies attribute 77, 130, 172
Document Modifies Rate attribute 77, 130, 172
Document Move and Rename Rate attribute 77, 130, 172
Document Moves or Renames attribute 77, 131, 172
documentation
See publications
Documents Delayed Retry attribute 64, 118, 160
Documents Filtered attribute 86, 139, 181
Documents Filtered Rate attribute 65, 118, 160
Documents Filtered with Error attribute 83, 179
Documents Filtered with Errors attribute 137
Documents in Progress attribute 78, 131, 140, 173
Documents on Hold attribute 78, 131, 173
Documents Processed Per Sec attribute 103, 144, 198
Documents Successfully Filtered attribute 65, 119, 160
Documents Successfully Filtered Rate attribute 65, 119, 161
Duplicate Aliases attribute 101, 143, 196

E
Emails Sent Per Sec attribute 199
environment
features 1
functions 1
Error Code attribute 105
Error Documents attribute 61, 102, 111, 143, 156, 197
Error Rate attribute 78, 131, 173
Index

357

event
mapping 321
Event Category attribute 48
Event ID attribute 48
Event Log
situations 220, 226
workspaces
descriptions 20
list 15
Event Log attribute group 47
Event Log workspace 20
Event Source attribute 48
Event Type attribute 48
Excel Calculation Services attribute group 49
Excel Calculation Services Session Status workspace 20
Excel Services
situations 220, 237
workspaces
descriptions 20
list 15
Excel Services Web Front End attribute group 52
Excel Services workspace 20
Excel Web Access attribute group 53
Excel Web Access Request Status workspace 21
Excel Web Access Request Time attribute 54
Excel Web Front End Request Status workspace 21
External Notifications Rate attribute 66, 119, 161
External Notifications Received attribute 66, 119, 161

Gatherer Paused Flag attribute 80, 134, 176


gathering support information 289

H
Heartbeats attribute 67, 121, 163
historical data
calculate disk space 216
capacity planning
Monitoring Agent for Microsoft SharePoint Server
disk capacity planning 216
History Recovery Progress attribute 81, 134, 176
Host Name attribute 41, 216
HostName attribute 46
HTTP Errors attribute 81, 134, 176
HTTP Errors Rate attribute 81, 134, 176

F
Failed Queries attribute 107, 113
Failed Queries Rate attribute 113
Failed Query Rate attribute 107
features, Monitoring Agent for Microsoft SharePoint Server
File Errors attribute 78, 132, 173
File Errors Rate attribute 79, 132, 174
files
agent trace 291
installation trace 291
other trace log 291
trace logs 290
Files to be Filtered attribute 140
Filter Objects attribute 66, 120, 162
Filter Process Created attribute 67, 120, 162
Filter Processes attribute 67, 120, 162
Filter Processes Max attribute 67, 120, 162
Filtered HTML attribute 79, 132, 174
Filtered HTML Rate attribute 79, 132, 174
Filtered Office attribute 79, 133, 174
Filtered Office Rate attribute 79, 133, 175
Filtered Text attribute 80, 133, 175
Filtered Text Rate attribute 80, 133, 175
Filtering Documents attribute 80, 134, 175
Filtering Threads attribute 66, 120, 161
Form Templates in Memory attribute 56
Forms in Memory attribute 55
Full Name attribute 43
Functionality Test Message attribute 45
Functionality Test Status attribute 44
functions, Monitoring Agent for Microsoft SharePoint
Server 1

358

IBM Software Support


See support
IBM Support Assistant 312
IBM Tivoli Enterprise Console
event mapping 321
Idle Threads attribute 68, 121, 163
Immediate Notifications Sent attribute 200
Incoming E Mail Messages Processed attribute 47
Incremental Crawls attribute 81, 135, 176
Index Size attribute 86, 181
Index Size in MB attribute 140
InfoPath Forms Data Connection Status workspace 21
InfoPath Forms Services
situations 221, 238
workspaces
descriptions 21
list 15
InfoPath Forms Services attribute group 54
InfoPath Forms Services workspace 22
information
troubleshooting 289
information, additional
attributes 37
policies 259
situations 219
Take Action commands 247
workspaces 13
installation
log file 291
problems 295
remote 11
silent 7
Instance Name attribute 46
interface, user 4
ISA 312
Iterating History in Progress Flag attribute 82, 135, 177

K
KQP_Alert_InvalidPortalSetting situation 236
KQP_Alert_Noti_NoMAILServerRes situation 229
KQP_Connection_To_SP_DB situation 230
KQP_ECS_Active_Sessions situation 237
KQP_ECS_Session_Time_Out situation 237
KQP_InfoPath_Form_Actions situation 226

Monitoring Agent for Microsoft SharePoint Server: Users Guide

217

KQP_InfoPath_Session_State situation 227


KQP_Insufficient_DB_Permission situation 228
KQP_Last_Query_Server_Removed situation 235
KQP_Membership_Import_Failed situation 232
KQP_MS_SSO_Service_Down situation 225
KQP_MSPS_ActiveQueueLength situation 244
KQP_MSPS_RBT_SystemIOTraffic situation 243
KQP_MSPS_Retries_Rate situation 244
KQP_MSPS_Search_DocDelayRetry situation 243
KQP_MSPS_Search_Service_Down situation 225
KQP_My_Site_Creation_Failure situation 231
KQP_Office_Active_Queue_Length situation 241
KQP_Office_Doc_Delayed_Retry situation 241
KQP_Office_Protocol_Handler situation 229
KQP_Office_Retries_Rate situation 242
KQP_Office_RTB_SystemIOTraffic situation 240
KQP_Office_Search_Index_Size situation 242
KQP_Office_Search_Service_Down situation 224
KQP_Profile_Import_Failed situation 231
KQP_SP_Active_Queue_Length situation 239
KQP_SP_DB_Login_Failed situation 228
KQP_SP_Doc_Delayed_Retry situation 238
KQP_SP_Publish_CacheHitRatio situation 245
KQP_SP_RTB_SystemIOTraffic situation 238
KQP_SP_Search_Index_Size situation 239
KQP_SP_Search_Service_Down situation 224
KQP_SPP_Admin_Service_Down situation 222
KQP_SPP_Alert_Service_Down situation 223
KQP_SPP_Timer_Service_Down situation 222
KQP_SSP_Admin_Site_Unavailable situation 233
KQP_SSP_DB_Sync_Failed situation 236
KQP_SSP_Provisioning_Failed situation 234
KQP_Sync_Job_Scheduler_Failed situation 234
KQP_User_Profile_Commit_Failed situation 232
KQP_User_Profile_Sync_Failed situation 233
KQP_WSS_Protocol_Handler situation 230
KQP_WSS_Tracing_Service_Down situation 226

L
L0
L0
L0
L0
L0
L1
L1
L1
L1
L2
L2
L2
L2
L3
L3
L3
L3
L4
L4
L4
L4
L5
L5
L5
L5
L6
L6

Indexes Wordlists attribute 86, 181


Merge Flush Count attribute 86, 182
Merge Flush Speed Average attribute 87, 182
Merge Flush Speed Last attribute 87, 182
Merges Flushes Now attribute 87, 182
Merge Count attribute 87, 183
Merge Speed Average attribute 88, 183
Merge Speed Last attribute 88, 183
Merges Now attribute 88, 183
Merge Count attribute 88, 183
Merge Speed Average attribute 89, 184
Merge Speed Last attribute 89, 184
Merges Now attribute 89, 184
Merge Count attribute 89, 184
Merge Speed Average attribute 90, 185
Merge Speed Last attribute 90, 185
Merges Now attribute 90, 185
Merge Count attribute 90, 185
Merge Speed Average attribute 91, 186
Merge Speed Last attribute 91, 186
Merges Now attribute 90, 186
Merge Count attribute 91, 186
Merge Speed Average attribute 92, 187
Merge Speed Last attribute 92, 187
Merges Now attribute 91, 187
Merge Count attribute 92, 187
Merge Speed Average attribute 93, 188

L6 Merge Speed Last attribute 93, 188


L6 Merges Now attribute 92, 187
L7 Merge Count attribute 93, 188
L7 Merge Speed Average attribute 93, 189
L7 Merge Speed Last attribute 94, 189
L7 Merges Now attribute 93, 188
L8 Merge Count attribute 94, 189
L8 Merge Speed Average attribute 94, 190
L8 Merge Speed Last attribute 95, 190
L8 Merges Now attribute 94, 189
library, Monitoring Agent for Microsoft SharePoint
Server 343
list of messages 313
Log Name attribute 48
logged data
Monitoring Agent for Microsoft SharePoint Server
logging
agent trace logs 291
built-in features 289
installation log files 291
trace log files 290

217

M
Master Index Level attribute 95, 190
Master Merge Progress attribute 95, 190
Master Merges Now attribute 95, 190
Master Merges To Date attribute 96, 191
Max Email Size attribute 199
Merge Progress attribute 140
Message attribute 48
messages
built-in features 289
for Monitoring Agent for Microsoft SharePoint Server
format 313
overview 312
syntax 313
Microsoft SharePoint Server
situations 220, 222
workspaces
descriptions 16
list 15
Microsoft SharePoint Server workspace 16
Monitoring Agent for Microsoft SharePoint Server
components 4
features 1
functions 1
performance considerations 307
MOSS Search
situations 221, 238
workspaces
descriptions 22
list 15
MOSS Search workspace 22
MSPS Search
situations 221, 243
workspaces
descriptions 29
list 16
MSPS Search workspace 29

313

N
Name attribute 41, 42, 59, 62, 85, 100, 103, 112, 116, 138, 142,
144, 146, 150, 155, 158, 180, 195, 198, 201, 207, 215, 216
new attribute groups 3
Index

359

new or changed situations 3


new or changed views 3
new or changed workspaces 3
Node attribute 41, 42, 45, 46, 47, 49, 52, 53, 55, 60, 63, 72, 85,
101, 103, 106, 110, 113, 116, 126, 139, 142, 144, 146, 151, 155,
158, 168, 180, 196, 198, 202, 207, 216
Not Modified Documents attribute 82, 135, 177
Notification Sources attribute 68, 121, 163
Notifications Currently Processed attribute 200
Notifications Rate attribute 68, 121, 163
Notifications Sent Per Sec attribute 199
Number of Documents attribute 114, 140
Number of Propagations attribute 141

O
Object Name attribute 104
Object Status attribute 104
Object Type attribute 104
Office Search Archival Plugin attribute group 60
Office Search Archival Plugin Details workspace 22
Office Search Gatherer attribute group 63
Office Search Gatherer Documents Status workspace 23
Office Search Gatherer Projects attribute group 72
Office Search Gatherer Projects Details workspace 23
Office Search Gatherer Projects Documents Crawl Status
workspace 24
Office Search Gatherer Projects Documents Delayed Status
workspace 24
Office Search Gatherer Projects Documents Details
workspace 24
Office Search Indexer Catalog Details workspace 24
Office Search Indexer Catalog Merge Status workspace 25
Office Search Indexer Catalogs attribute group 85
Office Search Schema Plugin attribute group 101
Office Search Schema Plugin Details workspace 25
OPAL documentation 344
other new function 4
Out of Date Document ID Files attribute 96, 191

P
Page Faults per Sec attribute 43
Pending Conversions attribute 47
Percent Documents Filtered Unsuccessfully attribute 72, 125,
167
Percent of Failed Queries attribute 100, 109, 116, 195
Percent of Non Empty Sets of Notifications attribute 199
Percent Privileged Time attribute 44
Percent Processor Time attribute 44
Percent User Mode Time attribute 44
performance considerations 307
Performance Level attribute 68, 122, 163
Performance Object Status attribute group 103
Performance Object Status workspace 19
Persistent Indexes attribute 96, 114, 141, 191
Persistent Indexes L1 attribute 96, 191
Persistent Indexes L2 attribute 96, 192
Persistent Indexes L3 attribute 97, 192
Persistent Indexes L4 attribute 97, 192
Persistent Indexes L5 attribute 97, 192
Persistent Indexes L6 attribute 97, 192
Persistent Indexes L7 attribute 98, 193
Persistent Indexes L8 attribute 98, 193
Personal Site Latency attribute 147
Personal Site Throughput attribute 148

360

PID attribute 44
policies
more information 259
overview 259
Port attribute 41, 216
problems and workarounds 295
Processed Documents attribute 82, 135, 177
Processed Documents Rate attribute 82, 136, 177
Profile Sync Change Process Rate attribute 148
Profile Sync Content Database Process Count attribute 148
Profile Sync Copy Rate attribute 148
Profile Sync Count Columns Created attribute 149
Profile Sync Site Collection Process Count attribute 149
Property attribute 151
Public Site Latency attribute 149
Public Site Throughput attribute 149
publications
developerWorks Web site 344
Monitoring Agent for Microsoft SharePoint Server 343
OPAL 344
prerequisite 343
Redbooks 344
related 344
Technotes 344
types 343
wikis 344
Publishing Cache Flushes Per Sec attribute 152
Publishing Cache Hit Count attribute 152
Publishing Cache Hit Ratio attribute 152
Publishing Cache Hits Per Sec attribute 152
Publishing Cache Miss Count attribute 153
Publishing Cache Misses Per Sec attribute 153
purposes
troubleshooting 289

Q
Queries attribute 98, 108, 114, 193
Queries Failed attribute 98, 193
Queries Rate attribute 114
Queries Succeeded attribute 98, 194
queries, using attributes 37
Query Name attribute 104
Query Rate attribute 108

R
Reason to Back Off attribute 68, 164
Reason To Back Off attribute 122
Recovery in Progress Flag attribute 83, 136, 178
Redbooks 344
Refresh Count attribute 102, 143, 197
remote
installation and configuration 11
remote deployment
troubleshooting 297
Rendered Charts Requested Per Sec attribute 50
Requests Per Sec attribute 53
Requests Received Per Sec attribute 51
Requests with Errors Per Sec attribute 51
requirements 7
Result Rate attribute 108
Results attribute 108, 114
Results Rate attribute 115
Retried Documents attribute 61, 111, 157
Retries attribute 83, 136, 178

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Retries Rate attribute 83, 136, 178


Robots Text Requests attribute 69, 122, 164

S
Search Archival Plugin attribute group 110
Search Archival Plugin Details workspace 29
Search attribute group 106
Search Catalogs attribute group 112
Search Catalogs Details workspace 29
Search Catalogs Query Status workspace 30
Search Gatherer attribute group 116
Search Gatherer Details workspace 30
Search Gatherer Documents Status workspace 30
Search Gatherer Projects Adaptive Crawl Status
workspace 31
Search Gatherer Projects attribute group 126
Search Gatherer Projects Details workspace 31
Search Gatherer Projects Documents Crawl Status
workspace 31
Search Gatherer Projects Documents Delayed Status
workspace 32
Search Gatherer Projects Documents Details workspace 32
Search Indexer Catalogs attribute group 138
Search Indexer Catalogs Details workspace 32
Search Indexer Catalogs Document Status workspace 32
Search Indexer Catalogs Status workspace 33
Search Query Details workspace 33
Search Schema Plugin attribute group 142
Search Schema Plugin Details workspace 33
Search Topic Assistant attribute group 144
Search Topic Assistant Details workspace 34
Server Objects attribute 69, 122, 164
Server Objects Created attribute 69, 123, 164
Servers Currently Unavailable attribute 69, 123, 165
Servers Unavailable attribute 70, 123, 165
Session Completed Rate attribute 58
Session Started Rate attribute 59
Sessions Per Sec attribute 51
Shadow Merge Levels attribute 99, 194
Shadow Merge Levels Threshold attribute 99, 194
Shared Service Provider
situations 221, 245
workspaces
descriptions 34
list 16
Shared Service Provider attribute group 146
Shared Service Provider workspace 34
SharePoint Components attribute group 150
SharePoint Publishing
situations 221, 245
workspaces
descriptions 35
list 16
SharePoint Publishing Cache Hit Miss Status workspace 35
SharePoint Publishing Cache workspace 35
SharePoint Publishing workspace 35
SharePoint Search Archival Plugin Details workspace 25
SharePoint Search Gatherer Details workspace 26
SharePoint Search Gatherer Documents Status workspace 26
SharePoint Search Gatherer Projects Details workspace 27
SharePoint Search Gatherer Projects Documents Crawl Status
workspace 27
SharePoint Search Gatherer Projects Documents Delayed Status
workspace 27
SharePoint Search Gatherer Projects Documents Details
workspace 27

SharePoint Search Indexer Catalog Details workspace 28


SharePoint Search Indexer Catalog Merge Status
workspace 28
SharePoint Search Schema Plugin Details workspace 28
silent installation 7
Site ID attribute 41, 216
Site Name attribute 41, 216
situations
general troubleshooting 307, 308
KQP_Alert_InvalidPortalSetting 236
KQP_Alert_Noti_NoMAILServerRes 229
KQP_Connection_To_SP_DB 230
KQP_ECS_Active_Sessions 237
KQP_ECS_Session_Time_Out 237
KQP_InfoPath_Form_Actions 226
KQP_InfoPath_Session_State 227
KQP_Insufficient_DB_Permission 228
KQP_Last_Query_Server_Removed 235
KQP_Membership_Import_Failed 232
KQP_MS_SSO_Service_Down 225
KQP_MSPS_ActiveQueueLength 244
KQP_MSPS_RBT_SystemIOTraffic 243
KQP_MSPS_Retries_Rate 244
KQP_MSPS_Search_DocDelayRetry 243
KQP_MSPS_Search_Service_Down 225
KQP_My_Site_Creation_Failure 231
KQP_Office_Active_Queue_Length 241
KQP_Office_Doc_Delayed_Retry 241
KQP_Office_Protocol_Handler 229
KQP_Office_Retries_Rate 242
KQP_Office_RTB_SystemIOTraffic 240
KQP_Office_Search_Index_Size 242
KQP_Office_Search_Service_Down 224
KQP_Profile_Import_Failed 231
KQP_SP_Active_Queue_Length 239
KQP_SP_DB_Login_Failed 228
KQP_SP_Doc_Delayed_Retry 238
KQP_SP_Publish_CacheHitRatio 245
KQP_SP_RTB_SystemIOTraffic 238
KQP_SP_Search_Index_Size 239
KQP_SP_Search_Service_Down 224
KQP_SPP_Admin_Service_Down 222
KQP_SPP_Alert_Service_Down 223
KQP_SPP_Timer_Service_Down 222
KQP_SSP_Admin_Site_Unavailable 233
KQP_SSP_DB_Sync_Failed 236
KQP_SSP_Provisioning_Failed 234
KQP_Sync_Job_Scheduler_Failed 234
KQP_User_Profile_Commit_Failed 232
KQP_User_Profile_Sync_Failed 233
KQP_WSS_Protocol_Handler 230
KQP_WSS_Tracing_Service_Down 226
list of all 220, 221
more information 219
new or changed 3
overview 219
predefined 220
situations, using attributes 37
Software Support 312
SP Publishing Cache attribute group 151
SP Search Archival Plugin attribute group 155
SP Search Gatherer attribute group 158
SP Search Gatherer Projects attribute group 167
SP Search Indexer Catalogs attribute group 180
SP Search Schema Plugin attribute group 196
SPP Alerts Notification Service attribute group 198
SPP Server Alert Manager attribute group 201
Index

361

SPP Server Alerts Plugin attribute group 207


SSL Port attribute 41, 216
SSP Job Execution Rate attribute 150
SSP Site Latency and Throughput workspace 34
SSP User Profiles and Profile Synchronization workspace 35
Start Microsoft Single Sign-on Service action 248
Start Office Document Conversions Launcher Service
action 249
Start Office Document Conversions Load Balancer Service
action 249
Start Office SharePoint Server Search Service action 249
Start SharePoint Portal Administration Service action 250
Start SharePoint Portal Alert Service action 250
Start SharePoint Portal Search Service action 251
Start SharePoint Timer Service action 251
Start Windows SharePoint Services Administration Service
action 251
Start Windows SharePoint Services Search Service action 252
Start Windows SharePoint Services Timer Service action 252
Start Windows SharePoint Services Tracing Service action 253
Start Windows SharePoint Services VSS Writer Service
action 253
Started Documents attribute 83, 137, 178
Status attribute 42
Stemmers Cached attribute 70, 123, 165
Stop Microsoft Single Sign-on Service action 253
Stop Office Document Conversions Launcher Service
action 254
Stop Office Document Conversions Load Balancer Service
action 254
Stop Office SharePoint Server Search Service action 255
Stop SharePoint Portal Administration Service action 255
Stop SharePoint Portal Alert Service action 255
Stop SharePoint Portal Search Service action 256
Stop SharePoint Timer Service action 256
Stop Windows SharePoint Services Administration Service
action 257
Stop Windows SharePoint Services Search Service action 257
Stop Windows SharePoint Services Timer Service action 257
Stop Windows SharePoint Services Tracing Service action 258
Stop Windows SharePoint Services VSS Writer Service
action 258
Succeeded Queries attribute 108
Succeeded Query Rate attribute 109
Success Rate attribute 84, 137, 179
Successful Queries attribute 115
Successful Queries Rate attribute 115
Successfully Filtered Documents attribute 84, 137, 179
support
gathering information for 289
list of messages 313
messages 312
support assistant 312
syntax
messages 313
System IO Traffic Rate in MB attribute 71, 125, 167

T
tacmd addSystem command 11
Take Action commands
list of all 247
more information 247
overview 247
predefined 247
Start Microsoft Single Sign-on Service 248
Start Office Document Conversions Launcher Service

362

249

Take Action commands (continued)


Start Office Document Conversions Load Balancer
Service 249
Start Office SharePoint Server Search Service 249
Start SharePoint Portal Administration Service 250
Start SharePoint Portal Alert Service 250
Start SharePoint Portal Search Service 251
Start SharePoint Timer Service 251
Start Windows SharePoint Services Administration
Service 251
Start Windows SharePoint Services Search Service 252
Start Windows SharePoint Services Timer Service 252
Start Windows SharePoint Services Tracing Service 253
Start Windows SharePoint Services VSS Writer Service 253
Stop Microsoft Single Sign-on Service 253
Stop Office Document Conversions Launcher Service 254
Stop Office Document Conversions Load Balancer
Service 254
Stop Office SharePoint Server Search Service 255
Stop SharePoint Portal Administration Service 255
Stop SharePoint Portal Alert Service 255
Stop SharePoint Portal Search Service 256
Stop SharePoint Timer Service 256
Stop Windows SharePoint Services Administration
Service 257
Stop Windows SharePoint Services Search Service 257
Stop Windows SharePoint Services Timer Service 257
Stop Windows SharePoint Services Tracing Service 258
Stop Windows SharePoint Services VSS Writer Service 258
troubleshooting 310
Technotes 344
Thread Count attribute 44
Threads Accessing Network attribute 70, 124, 165
Threads attribute 109
Threads Blocked due to Back Off attribute 70
Threads Blocked Due To Back Off attribute 124, 166
Threads in Plugins attribute 71, 124, 166
Time Generated attribute 48
Time Outs attribute 71, 124, 166
Timestamp attribute 41, 42, 46, 47, 49, 52, 53, 55, 60, 63, 73,
85, 101, 104, 106, 110, 113, 116, 126, 139, 142, 145, 146, 151,
155, 158, 168, 181, 196, 198, 202, 207, 216
Tivoli Common Reporting
troubleshooting 310
Total Alerts Added attribute 208
Total Alerts attribute 208
Total Alerts Deactivated attribute 208
Total Alerts Deleted attribute 209
Total Blob Disk Size in MB attribute 155
Total Blob Index Writes attribute 153
Total Boolean Immediate Alerts attribute 209
Total Boolean Immediate Hits Received attribute 209
Total Boolean Immediate Hits Received Per Sec attribute 209
Total Boolean Quota Processing attribute 210
Total Boolean Quota Processing Per Sec attribute 210
Total Boolean Scheduled Alerts attribute 210
Total Boolean Scheduled Hits Received attribute 210
Total Boolean Scheduled Hits Received Per Sec attribute 211
Total Cache Compactions attribute 153
Total Cache Flushes attribute 154
Total Categories Found attribute 145
Total Documents attribute 62, 112, 157
Total Documents Failed attribute 211
Total Documents Filtered attribute 65, 118, 160
Total Documents in First Queue attribute 62, 112, 157
Total Documents in Second Queue attribute 62, 112, 157
Total Documents Processed attribute 102, 143, 145, 197, 211

Monitoring Agent for Microsoft SharePoint Server: Users Guide

Total Documents Processed Per Sec attribute 145, 211


Total Email Notifications Sent attribute 201
Total Example Documents Found attribute 145
Total Hits Received attribute 212
Total Hits Received Per Sec attribute 212
Total Keywords Found attribute 146
Total Notifications Sent attribute 201
Total Object Discards attribute 154
Total Objects Added attribute 154
Total Objects attribute 154
Total Properties Processed attribute 102, 144, 197
Total Quota Processing attribute 212
Total Quota Processing Per Sec attribute 212
Total Rank Immediate Alerts attribute 213
Total Rank Immediate Hits Received attribute 213
Total Rank Immediate Hits Received Per Sec attribute 213
Total Rank Quota Processing attribute 213
Total Rank Quota Processing Per Sec attribute 214
Total Rank Scheduled Alerts attribute 214
Total Rank Scheduled Hits Received attribute 214
Total Rank Scheduled Hits Received Per Sec attribute 214
Total Security Checks attribute 215
Total Security Checks Per Sec attribute 215
trace logs 290
Transactions Completed Rate attribute 59
Transactions Started Rate attribute 59
troubleshooting 289, 295
agents 298
built-in features 289
installation 295
installation logs 291
messages 312
remote deployment 297
situations 307, 308
Take Action commands 310
Tivoli Common Reporting 310
uninstallation 295
uninstallation logs 291
workspaces 301
Type attribute 43

U
uninstallation
log file 291
problems 295
Unique Documents attribute 84, 138, 179
Unique Keys attribute 99, 115, 141, 194
Unused Items Manager in MB attribute 51
Up to Date Document ID Files attribute 99, 195
URLs in History attribute 84, 138, 180
Usage Data Processing Time in Milliseconds attribute
user interfaces options 4
User Profile Import Rate attribute 150
Users Imported attribute 147

150

V
Value attribute 151
Version Name attribute 46
views
Alert Plugin Details workspace 17
Alert workspace 17
Alerts API Details workspace 17
Alerts Manager Details workspace 18
Alerts Notification Service E-mail Status workspace

18

views (continued)
ASP NET Applications workspace 18
Availability workspace 18
Database workspace 19
Document Conversions workspace 19
Event Log workspace 20
Excel Calculation Services Session Status workspace 20
Excel Services workspace 20
Excel Web Access Request Status workspace 21
Excel Web Front End Request Status workspace 21
InfoPath Forms Data Connection Status workspace 21
InfoPath Forms Services workspace 22
Microsoft SharePoint Server workspace 16
MOSS Search workspace 22
MSPS Search workspace 29
new or changed 3
Office Search Archival Plugin Details workspace 22
Office Search Gatherer Documents Status workspace 23
Office Search Gatherer Projects Details workspace 23
Office Search Gatherer Projects Documents Crawl Status
workspace 24
Office Search Gatherer Projects Documents Delayed Status
workspace 24
Office Search Gatherer Projects Documents Details
workspace 24
Office Search Indexer Catalog Details workspace 24
Office Search Indexer Catalog Merge Status workspace 25
Office Search Schema Plugin Details workspace 25
Performance Object Status workspace 19
Search Archival Plugin Details workspace 29
Search Catalogs Details workspace 29
Search Catalogs Query Status workspace 30
Search Gatherer Details workspace 30
Search Gatherer Documents Status workspace 30
Search Gatherer Projects Adaptive Crawl Status
workspace 31
Search Gatherer Projects Details workspace 31
Search Gatherer Projects Documents Crawl Status
workspace 31
Search Gatherer Projects Documents Delayed Status
workspace 32
Search Gatherer Projects Documents Details workspace 32
Search Indexer Catalogs Details workspace 32
Search Indexer Catalogs Document Status workspace 32
Search Indexer Catalogs Status workspace 33
Search Query Details workspace 33
Search Schema Plugin Details workspace 33
Search Topic Assistant Details workspace 34
Shared Service Provider workspace 34
SharePoint Publishing Cache Hit Miss Status
workspace 35
SharePoint Publishing Cache workspace 35
SharePoint Publishing workspace 35
SharePoint Search Archival Plugin Details workspace 25
SharePoint Search Gatherer Details workspace 26
SharePoint Search Gatherer Documents Status
workspace 26
SharePoint Search Gatherer Projects Details workspace 27
SharePoint Search Gatherer Projects Documents Crawl
Status workspace 27
SharePoint Search Gatherer Projects Documents Delayed
Status workspace 27
SharePoint Search Gatherer Projects Documents Details
workspace 27
SharePoint Search Indexer Catalog Details workspace 28
SharePoint Search Indexer Catalog Merge Status
workspace 28
Index

363

views (continued)
SharePoint Search Schema Plugin Details workspace
SSP Site Latency and Throughput workspace 34
SSP User Profiles and Profile Synchronization
workspace 35
Web Server workspace 36
Virtual Size attribute 43

28

W
Waiting Documents attribute 85, 138, 180
Web Server
situations 221, 245
workspaces
descriptions 36
list 16
Web Server attribute group 215
Web Server workspace 36
Weekly Notifications Sent attribute 200
wikis 344
Word Breakers Cached attribute 71, 124, 166
Wordlists attribute 141
Work Items Created attribute 100, 195
Work Items Deleted attribute 100, 195
workarounds 295
agents 298
remote deployment 297
situations 307
Take Action commands 310
Tivoli Common Reporting 310
workspaces 301
Workbook Cache Size in MB attribute 52
Working Set Size attribute 43
workspaces
Alert 17
Alert Plugin Details 17
Alerts API Details 17
Alerts Manager Details 18
Alerts Notification Service E-mail Status 18
ASP NET Applications 18
Availability 18
Database 19
Document Conversions 19
Event Log 20
Excel Calculation Services Session Status 20
Excel Services 20
Excel Web Access Request Status 21
Excel Web Front End Request Status 21
InfoPath Forms Data Connection Status 21
InfoPath Forms Services 21, 22
list of all 15
Microsoft SharePoint Server 16
more information 13
MOSS Search 22
MSPS Search 29
new or changed 3
Office Search Archival Plugin Details 22
Office Search Gatherer Documents Status 23
Office Search Gatherer Projects Details 23
Office Search Gatherer Projects Documents Crawl
Status 24
Office Search Gatherer Projects Documents Delayed
Status 24
Office Search Gatherer Projects Documents Details 24
Office Search Indexer Catalog Details 24
Office Search Indexer Catalog Merge Status 25
Office Search Schema Plugin Details 25

364

workspaces (continued)
overview 13
Performance Object Status 19
predefined 15
Search Archival Plugin Details 29
Search Catalogs Details 29
Search Catalogs Query Status 30
Search Gatherer Details 30
Search Gatherer Documents Status 30
Search Gatherer Projects Adaptive Crawl Status 31
Search Gatherer Projects Details 31
Search Gatherer Projects Documents Crawl Status 31
Search Gatherer Projects Documents Delayed Status 32
Search Gatherer Projects Documents Details 32
Search Indexer Catalogs Details 32
Search Indexer Catalogs Document Status 32
Search Indexer Catalogs Status 33
Search Query Details 33
Search Schema Plugin Details 33
Search Topic Assistant Details 34
Shared Service Provider 34
SharePoint Publishing 35
SharePoint Publishing Cache 35
SharePoint Publishing Cache Hit Miss Status 35
SharePoint Search Archival Plugin Details 25
SharePoint Search Gatherer Details 26
SharePoint Search Gatherer Documents Status 26
SharePoint Search Gatherer Projects Details 27
SharePoint Search Gatherer Projects Documents Crawl
Status 27
SharePoint Search Gatherer Projects Documents Delayed
Status 27
SharePoint Search Gatherer Projects Documents Details 27
SharePoint Search Indexer Catalog Details 28
SharePoint Search Indexer Catalog Merge Status 28
SharePoint Search Schema Plugin Details 28
SSP Site Latency and Throughput 34
SSP User Profiles and Profile Synchronization 35
troubleshooting 301
Web Server 36

Monitoring Agent for Microsoft SharePoint Server: Users Guide



Printed in USA

SC23-9758-02

Das könnte Ihnen auch gefallen