BusinessObjects Enterprise XI 3.

0 Monitoring Guide

BusinessObjects Enterprise XI 3.0

Copyright

2008 Business Objects, an SAP company. All rights reserved. Business Objects owns the following U.S. patents, which may cover products that are offered and licensed by Business Objects: 5,295,243; 5,339,390; 5,555,403; 5,590,250; 5,619,632; 5,632,009; 5,857,205; 5,880,742; 5,883,635; 6,085,202; 6,108,698; 6,247,008; 6,289,352; 6,300,957; 6,377,259; 6,490,593; 6,578,027; 6,581,068; 6,628,312; 6,654,761; 6,768,986; 6,772,409; 6,831,668; 6,882,998; 6,892,189; 6,901,555; 7,089,238; 7,107,266; 7,139,766; 7,178,099; 7,181,435; 7,181,440; 7,194,465; 7,222,130; 7,299,419; 7,320,122 and 7,356,779. Business Objects and its logos, BusinessObjects, Business Objects Crystal Vision, Business Process On Demand, BusinessQuery, Cartesis, Crystal Analysis, Crystal Applications, Crystal Decisions, Crystal Enterprise, Crystal Insider, Crystal Reports, Crystal Vision, Desktop Intelligence, Inxight and its logos , LinguistX, Star Tree, Table Lens, ThingFinder, Timewall, Let There Be Light, Metify, NSite, Rapid Marts, RapidMarts, the Spectrum Design, Web Intelligence, Workmail and Xcelsius are trademarks or registered trademarks in the United States and/or other countries of Business Objects and/or affiliated companies. SAP is the trademark or registered trademark of SAP AG in Germany and in several other countries. All other names mentioned herein may be trademarks of their respective owners. Business Objects products in this release may contain redistributions of software licensed from third-party contributors. Some of these individual components may also be available under alternative licenses. A partial listing of third-party contributors that have requested or permitted acknowledgments, as well as required notices, can be found at: http://www.businessobjects.com/thirdparty 2008-12-04

Third-party Contributors

Contents
Chapter 1 Preface 7 About this guide...........................................................................................8 Comments welcome....................................................................................8 Chapter 2 Developing a monitoring strategy 9

Determining which components to monitor...............................................10 Performance goals and service level agreements (SLAs)...................11 BusinessObjects Enterprise architecture.............................................12 Surveying end users.............................................................................14 Interviewing system architects and administrators...............................15 Components recommended by BusinessObjects................................16 Defining metrics, targets, and monitoring activities...................................18 Defining monitoring responses..................................................................20 Integrating monitoring probes into your strategy.......................................21 Staging your monitoring implementation...................................................22 Chapter 3 BusinessObjects monitoring probes 25

Introduction to monitoring probes..............................................................26 Monitoring probes overview.................................................................28 Deploying monitoring probes.....................................................................31 Deploying the monitoring probes package on Windows......................32 Deploying the monitoring probes package on UNIX............................34 Deploying the monitoring.war file.........................................................35 Configuring monitoring probes for authentication................................40 Running monitoring probes.......................................................................42 Running a monitoring probe in command line mode............................42

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Contents

Running a monitoring probe in web mode...........................................44 Monitoring probe attributes and parameters........................................46 Monitoring probe output.......................................................................51 Specifying probe attributes and parameters dynamically.....................54 Working with monitoring probes................................................................55 User account guidelines for running monitoring probes.......................55 Running probes in command line mode versus web mode ................56 Defining performance measures for monitoring probes ......................57 Defining monitoring probe execution frequency...................................58 Security and audit considerations........................................................59 Monitoring the Central Management Server (CMS) and authentication servers..................................................................................................59 Monitoring report engines and data sources........................................60 Probe failure ........................................................................................62 Monitoring probe connectors and probe integration.............................63 Using server groups to monitor individual BusinessObjects Enterprise services ...............................................................................................64 Monitoring probe limitations and known issues....................................65 Uninstalling monitoring probes..................................................................67 Uninstalling monitoring probes on Windows........................................67 Uninstalling monitoring probes on Unix................................................67 Chapter 4 Monitoring BusinessObjects using system and application tools 69

Chapter 5

Monitoring BusinessObjects with IBM Tivoli

73

Configuring Tivoli to monitor a BusinessObjects application metric..........74 Configuring Tivoli to monitor BusinessObjects using a probe...................82 Preparing a probe configuration file (Tivoli)..........................................82 Preparing the agent metafile................................................................84 Configuring Tivoli to run a monitoring probe........................................86

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Contents

Chapter 6

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) 91 Installing a MOM agent on a BusinessObjects server...............................92 Configuring MOM to monitor a BusinessObjects Enterprise application metric.........................................................................................................93 Create a rule group for BusinessObjects Enterprise application metrics..................................................................................................93 Creating a data provider.......................................................................94 Configuring monitoring for an application metric..................................95 Configuring MOM to monitor BusinessObjects using a probe.................100 Creating a rule group for monitoring probes......................................100 Preparing a probe configuration file (MOM).......................................102 Inputting the probe response script....................................................103 Specifying the Event Rule and Data Provider ...................................105 Viewing probe events in the MOM Operator Console........................110

Chapter 7

Components and metrics reference

115

BusinessObjects Enterprise components and metrics............................116 Web Application Server components and metrics...................................122 System level components and metrics....................................................123 Database components and metrics.........................................................126 Availability monitoring example...............................................................126 Chapter 8 Monitoring probe reference 131

CMS Logon Logoff probe.........................................................................132 Crystal Reports service through Page and Cache Server probe.............133 Crystal Reports Service through Report Application Server....................136 Desktop Intelligence Service probe.........................................................138 Web Intelligence Service probe...............................................................140 CMS ping probe.......................................................................................143

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Contents

CMS cache probe....................................................................................144 CMS database connection probe............................................................146 Appendix A Get More Help 149

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Preface

Preface About this guide

About this guide

The objective of this guide is to provide information about developing and implementing a monitoring solution for BusinessObjects Enterprise. Information includes guidelines and recommendations for developing a monitoring strategy, usage information for BusinessObjects monitoring probes, and instructions for implementing a monitoring solution using system and application tools, IBM Tivoli, and Microsoft Operations Manager.

Comments welcome
Your feedback is important to us. You can send your comments about this guide to: mailto:[email protected]

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Developing a monitoring strategy

Developing a monitoring strategy Determining which components to monitor

This section of the guide describes a process for developing a monitoring strategy that includes: Determining which components to monitor Defining metrics, targets, and monitoring activities Defining monitoring responses Integrating BusinessObjects monitoring probes into your strategy Implementing your monitoring solution in stages
Note:

If your requirement is to quickly implement a basic monitoring solution, it is recommended that you start with availability metrics for key components of your system. "Components recommended by BusinessObjects" describes key components for a typical BusinessObjects Enterprise system. Staging your monitoring implementation on page 22 provides information about implementing availability monitoring as a first step. The Availability monitoring example on page 126 shows components, metrics, targets, and monitoring activities for an availability monitoring solution.

Determining which components to monitor

The first step in developing a monitoring strategy is determining which system components to monitor. The diagram below shows information sources you can draw upon to identify and prioritize system components.

10

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Developing a monitoring strategy Determining which components to monitor

Recommendations for how to use each source of information are provided in the following topics: Performance goals and service level agreements (SLAs) on page 11 BusinessObjects Enterprise architecture on page 12 Surveying end users on page 14 Interviewing system architects and administrators on page 15 Components recommended by BusinessObjects on page 16

Performance goals and service level agreements (SLAs)

Performance goals are commonly defined in Service Level Agreements (SLAs) between IT departments and business units. The following list includes examples of performance goals that you may find in a typical SLA: Availability schedules (e.g. 24/7 availability with planned system outages for maintenance) User login wait time (e.g. 7 seconds maximum wait time) Availability of report outputs (e.g. report output refreshed daily by 6AM) Maximum wait times for viewing a report (e.g. 10 seconds for simple report) Performance goals can often be broken down into the system and application components involved in delivering a particular service to end users. For example, the process behind viewing a BusinessObjects Web Intelligence report may depend on the following system and application components:

BusinessObjects Enterprise XI 3.0 Monitoring Guide

11

Developing a monitoring strategy Determining which components to monitor

Web application server hardware and software Authentication server hardware and software BusinessObjects Enterprise server hardware BusinessObjects Enterprise application components: Web Intelligence Report Server Central Management Server (CMS) Input/Output File Repository Server BusinessObjects database server and software Corporate database server and software Corporate network and related software

Note:

The BusinessObjects Enterprise Administrator's Guide provides an overview of the BusinessObjects Enterprise architecture in which it describes each system component and provides an overview of information flows for scheduling and viewing objects. Components directly linked to performance goals are likely to be high priority components in your monitoring strategy. If your organization does not define performance goals within an SLA, a first step in defining your monitoring strategy may be to define performance goals that reflect business requirements. This information will help identify and prioritize system and components to include in your monitoring strategy.

BusinessObjects Enterprise architecture

When developing a monitoring strategy, consider all of the components that participate in your BI system. Identifying relevant components in an enterprise system can be a challenging undertaking in larger IT environments. You may require assistance from system architects and administrators. A tiered view of the BusinessObjects Enterprise architecture is shown in the following diagram. The diagram may be of assistance in identifying the components of your system.

12

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Developing a monitoring strategy Determining which components to monitor

For a description of each component refer to the BusinessObjects Enterprise XI 3.0 Administrator's Guide. When identifying components keep in mind that BusinessObjects components may be installed on more than one machine, server processes may be

BusinessObjects Enterprise XI 3.0 Monitoring Guide

13

Developing a monitoring strategy Determining which components to monitor

distributed, and duplicate instances of server processes may be running on one or more machines. The BusinessObjects Central Configuration Manager (CCM) can display list of BusinessObjects services that are part of the your BusinessObjects Enterprise system. On Windows the CCM is a graphical interface tool, as shown in the diagram below. On UNIX, the CCM is a shell script (ccm.sh) that allows you to manage BusinessObjects Enterprise servers from the command line.

Surveying end users

Surveying end users can help you determine which areas of your system require monitoring. For example, an end user survey can tell you which applications are used most often, where there are performance issues, and where to expect increased user activity.

14

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Developing a monitoring strategy Determining which components to monitor

An end user survey may tell you that running a particular report takes longer than usual, or that the Finance department is hiring new people who will increase demand on system components used to create financial reports. When conducting an end user survey, ask users about performance concerns, average daily usage, and future usage. Questions you might ask include: What types of reports are run and how often? Is performance slow when performing particular tasks? What types of objects are used most often? Will system usage increase or decrease in the near future? Is the business hiring new people? Does the business plan to use BusinessObjects applications to perform additional tasks in the future? The information gathered will help identify and prioritize components for monitoring.

Interviewing system architects and administrators

When defining a monitoring strategy, interviewing system architects and administrators can provide insight into which components require monitoring. For example, System Architects may be able to help answer the following types of questions: What type of load is the system designed for (e.g. how many concurrent active users and simultaneous requests can system components support?) Which components are at risk if load increases? Which components are low risk? For example, is network bandwidth a low risk component? Are there system dependencies that may not be obvious? Are there single points of failure in the system (i.e. systems or components that have no redundancy) Which machines are likely to require additional CPU resource, memory, or disk space in the near future? System Administrators may be able to provide the following types of information: A history of system performance including previous trouble spots Insight into application components or information flows

BusinessObjects Enterprise XI 3.0 Monitoring Guide

15

Developing a monitoring strategy Determining which components to monitor

System usage patterns including peak usage times

Components recommended by BusinessObjects

For typical BusinessObjects Enterprise deployments that include Crystal Reports, Web Intelligence, and Desktop Intelligence applications, the components recommended for monitoring are outlined in the diagram below. Components include: BusinessObjects Enterprise components System level components Web application server (WAS) components Database components Your system components may be a subset of the recommended components or may include additional components. For example, you may have custom applications or other BusinessObjects applications you want to include in your monitoring solution.

16

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Developing a monitoring strategy Determining which components to monitor

Information about recommended components is provided in the following reference topics: BusinessObjects Enterprise components and metrics on page 116 Web Application Server components and metrics on page 122 System level components and metrics on page 123 Database components and metrics on page 126

BusinessObjects Enterprise XI 3.0 Monitoring Guide

17

Developing a monitoring strategy Defining metrics, targets, and monitoring activities

Defining metrics, targets, and monitoring activities

After you identify the components you want to monitor, the next step is to establish metrics, targets, and monitoring activities for each component. Metrics are used to measure the health of a component. The metrics you define depend on the components you are monitoring and your requirements. Examples of metrics include user login time, query execution time, CPU usage percentage, availability status for a system service, etc. A target is an expected result for a metric. For example, your business may require that a system login action take no more than 6 seconds or that average CPU usage on your servers is below 85 percent. A result that does not meet a target may indicate a problem. Defining targets often requires that measurements be taken over time to establish an acceptable result range. A monitoring activity defines how and when data is collected for a metric. For example, you may decide to collect user login data using an automated script that performs a login action every few minutes, or you may use a monitoring tool to poll your system for CPU usage metrics at a specified interval. The following tables provide examples of metrics, targets, and monitoring activities for a BusinessObjects service (CMS.exe), a web application server, system CPU, and a database.
Note:

Targets and monitoring activities, including execution and polling frequency, will differ from system to system. For example, you may want to poll your system less frequently if you are concerned about impacting system performance. BusinessObjects component (CMS.exe):

18

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Developing a monitoring strategy Defining metrics, targets, and monitoring activities

Metric

Target

Monitoring activity Ping every 2 minutes Perform login action every 5 minutes Poll system every 30 seconds Poll system every 30 seconds Poll system every 30 seconds

CMS service availabil- 24/7 ity CMS login time CMS CPU usage CMS Disk read time CMS Disk write time < 6 seconds < 30% usage < 95% usage < 5% usage

Web application server component

Metric Availability Response time Target 24/7 < 6 seconds Monitoring activity Ping server every 2 minutes Send HTTP request every 5 minutes

System component (CPU):

Metric Target Monitoring activity Poll system every 30 seconds Poll system every 30 seconds Poll system every 30 seconds Poll system every 30 seconds Poll system every 30 seconds

Average CPU utiliza- < 85% usage tion User CPU System CPU Run queue I/O wait time < 90% usage < user CPU < 2 per CPU < 30%

Database component

BusinessObjects Enterprise XI 3.0 Monitoring Guide

19

Developing a monitoring strategy Defining monitoring responses

Metric Availability Response time

Target 24/7 < 6 seconds

Monitoring activity Ping server every 2 minutes Run a database query every 5 minutes

For components recommended for monitoring by BusinessObjects, metrics and targets are outlined in the following topics: "BusinessObjects Enterprise components and metrics" Web Application Server components and metrics on page 122 System level components and metrics on page 123 Database components and metrics on page 126

Defining monitoring responses

After you define metrics, targets, and monitoring activities, the next step is to define responses if monitoring results do not meet expected targets. The response you define depends on the metric. For metrics related to availability, you may chose to raise an e-mail alert to initiate immediate action. For less critical metrics, it may be more appropriate to log results to a report that is reviewed weekly by a system administrator. The following table shows example responses for metrics used to measure the health of the BusinessObjects CMS service (CMS.exe). In this example, the response for the availability metric is to raise an e-mail alert after three consecutive failed attempts. For login time, CPU, and disk metrics, data is logged to a report.

20

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Developing a monitoring strategy Integrating monitoring probes into your strategy

Metric

Target

Monitoring activi- Response ty Ping every 2 minutes Perform login action every 5 minutes E-mail notification after 3 consecutive failed attempts Log data to report

CMS service 24/7 availability CMS login time CMS CPU usage CMS Disk read time CMS Disk write time < 6 seconds

< 30% us- Poll system every age 30 seconds < 95% us- Poll system every age 30 seconds < 5% usage Poll system every 30 seconds

Log data to report Log data to report Log data to report

Integrating monitoring probes into your strategy

BusinessObjects monitoring probes are a set of SDK-based scripts you can use to monitor components of your BusinessObjects Enterprise system. With BusinessObjects monitoring probes you can: Simulate end user workflows including user login actions and report execution for Web Intelligence, Desktop Intelligence, and Crystal Reports applications. Test availability, functionality, and performance of BusinessObjects services Test the BusinessObjects Central Management Server (CMS) core functionality, CMS cache service, and CMS database connection Test your web application server by running probes in web mode (through a browser) Test Windows AD or LDAP authentication services by running probes under a user account that requires authentication Monitoring probes, which can be run from a command line or web browser, can be quickly integrated into any monitoring strategy to provide a means of monitoring BusinessObjects components. Probes are also designed with

BusinessObjects Enterprise XI 3.0 Monitoring Guide

21

Developing a monitoring strategy Staging your monitoring implementation

XML-based input and output streams that allow for integration with proprietary or industry standard monitoring tools such as IBM Tivoli or Microsoft Operations Manager. The next section of the guide provides in-depth information about deploying, running, and working with BusinessObjects monitoring probes.
Related Topics

Introduction to monitoring probes on page 26 Deploying monitoring probes on page 31 Working with monitoring probes on page 55 Monitoring BusinessObjects with IBM Tivoli on page 73 Monitoring BusinessObjects with Microsoft Operations Manager (MOM) on page 91

Staging your monitoring implementation

It is generally recommended that monitoring be implemented in stages. Your monitoring requirements may dictate a different approach, but as a guideline the following staged implementation is recommended:
Stage 1: Availability monitoring

Availability monitoring is defined as monitoring availability of BusinessObjects services and core system components. Availability monitoring can largely be achieved through process based monitoring (to ensure the process/service is alive) and the use of BusinessObjects monitoring probes. For an example of availability monitoring, see Availability monitoring example on page 126.
Stage 2: Stability monitoring

Stability monitoring adds metrics for key system indicators that help you detect early signs of system instability. For example, in this stage you might add monitoring for CPU, memory, and disk usage by BusinessObjects services. Key indicators may differ for your system but the goal is the same, which is to add metrics to your monitoring solution that allow you to react before an outage occurs.

22

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Developing a monitoring strategy Staging your monitoring implementation

Stage 3: Performance monitoring

In this stage, a wider range of system metrics are added to the monitoring solution. The goal is to use a wide array of data from system metrics, monitoring probes, and key indicators to better understand how system components interact, where bottlenecks occur, and how sizing and tuning parameters can be adjusted to improve or maintain system performance.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

23

Developing a monitoring strategy Staging your monitoring implementation

24

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes

BusinessObjects monitoring probes Introduction to monitoring probes

Introduction to monitoring probes

BusinessObjects Enterprise monitoring probes provide you with the ability to monitor your BusinessObjects system using simulated application workflows which are run through SDK-based scripts. Monitoring probes are provided in a Monitoring Add-on package that is distributed as a .zip file for Windows deployments and a tar.gz file for UNIX deployments. The package is available for download from the Business Objects Labs website at: http://labs.businessobjects.com/enterprise_moni toring/ The files required to run monitoring probes are deployed to your system when you extract the Monitorig Add-on package to your BusinessObjects root installation directory. There are eight monitoring probes you can use to monitor different aspects of your BusinessObjects system: CMS Logon Logoff probe Crystal Reports Service through Page and Cache Server probe Crystal Reports Service through Report Application Server probe Desktop Intelligence Service probe Web Intelligence Service probe CMS Ping probe CMS Cache probe CMS Database Connection probe Monitoring probes are described in the Monitoring probes overview on page 28. Running a monitoring probe involves executing a monitoring probe command with the appropriate attributes and parameters. The monitoring probe command is monitoring.bat on Windows systems and monitoring.sh on UNIX systems. You can run a monitoring probe from a command line (command line mode) or from within a URL (web mode). All monitoring probes share the same attributes which include user, password, system, authtype, and classname. Monitoring probes that run against Crystal Reports, Web Intelligence, and Desktop Intelligence report engines include document ID, document name, document refresh, and file export parameters.

26

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Introduction to monitoring probes

Attributes and parameters can be defined dynamically or in an XML-based configuration file that is called when a monitoring probe is run. The following is an example of a monitoring probe configuration file:
<probeconfig user='bobjuser' password='bobjpassword' sys tem='servername' authtype='secEnterprise' classname='ProbeCR PageServer'> <!-- Uncomment one of the search options: cuid, docid, name-> <!-- Enter in the correct value afterwards--> <!-- CUID identifier for document--> <!-<param type='java.lang.String' value='ASHeDJIWZSBAmtwnFIWGybs' /> --> <!-- DOCID identifier for document--> <!-<param type='int' value='656' /> --> <!-- NAME of document--> <param type='java.lang.String' value='Mail Labels' /> <!--Document display options--> <!-- REFRESH document select true or false --> <param type='boolean' value='false' /> <!-- PDFEXPORT document select true or false --> <param type='boolean' value='false' /> </probeconfig>

Monitoring probe output is an XML-based data stream with information that includes a success flag, execution duration, and error description (if an error is encountered). The following screen capture shows output from a monitoring probe run in web mode:

BusinessObjects Enterprise XI 3.0 Monitoring Guide

27

BusinessObjects monitoring probes Introduction to monitoring probes

XML based input and output streams are intended to provide flexibility for integrating monitoring probes with industry-standard and proprietary monitoring solutions.
Related Topics

Monitoring probe attributes and parameters on page 46 Running a monitoring probe in command line mode on page 42 Running a monitoring probe in web mode on page 44

Monitoring probes overview

The following table describes the current set of monitoring probes and the application workflows they simulate.

28

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Introduction to monitoring probes

Monitoring probe CMS Logon Logoff

Description Tests the availability of the Central Management Server (CMS) and the ability of users to log on to the system through client applications. The probe logs on a single user, tests session validity, and logs off the user. Tests the availability of the Crystal Reports service through Crystal Reports Page Servers and Cache Servers. Using the Crystal Reports Page and Cache Servers, the probe opens a report, refreshes the report, optionally exports the report to PDF format, and closes the report. Tests the availability of the Crystal Report service through the Report Application Servers. Using the Report Application Servers, the probe opens a report, optionally exports the report to PDF format, and closes the report. Tests the availability of the Desktop Intelligence service through Desktop Intelligence Report Servers. The probe opens a Desktop Intelligence document, refreshes it, optionally exports the document to XLS and PDF format, and closes the document. Tests the availability of the Web Intelligence service through Web Intelligence Report Servers. The probe opens a Web Intelligence document, refreshes it, optionally exports the document to XLS and PDF format, and closes the document.

Crystal Reports service through Page and Cache Server

Crystal Reports service through Report Application Server

Desktop Intelligence Service

Web Intelligence Service

BusinessObjects Enterprise XI 3.0 Monitoring Guide

29

BusinessObjects monitoring probes Introduction to monitoring probes

Monitoring probe CMS ping

Description Sends an empty query to the CMS. The test is considered successful if the CMS returns a parse failure error. Because query parsing is part of CMS core functionality, the test is expected to complete quickly. Tests the availability and health of the CMS cache by executing the following query:
select SI_NAME from CI_SYSTEMOBJS where SI_ID=4

CMS cache

This query returns the system InfoObject that contains the CMS cluster name. After a warmup period, it is expected that the CMS retrieves the system InfoObject from the cache rather than the repository database. If the query fails, the cache may not be functioning properly or the cluster definition may be incorrect. CMS database connection Tests the availability of the repository database by executing the following query:
select SI_NAME from CI_SYSTEMOBJS where SI_OBTYPE=13

This query returns the system InfoObject which contains the CMS cluster name. The CMS retrieves the system InfoObject from the repository database. If this query fails there may be a connection problem between the CMS server and repository database. Note:

Crystal Reports, Desktop Intelligence, and Web Intelligence probes require a report to run whereas CMS related probes do not. Probes that use reports have report related parameters.

30

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Deploying monitoring probes

Deploying monitoring probes

Monitoring probe deployment includes one or more of the steps described in the following table:
Deployment step Description

Step 1: Deploying the monitoring Deploying the monitoring probes package probes package (on Windows or is required to run monitoring probes. After UNIX).

deploying the monitoring probes package to your system, you can run monitoring probes in command line mode.
After deploying the monitoring probes package, you have the option of deploying the monitoring.war file which allows you to run monitoring probes through a web browser (web mode).

Step 2: Deploying the monitor ing.war file

To deploy the monitoring.war file, you must: 1. Update the monitoring.war file 2. Deploy the monitoring.war file to your web application server. If you do not plan to use monitoring probes in web mode, you can skip this step.
Step 3: Configuring monitoring probes for authentication If you want to use monitoring probes with Windows AD or LDAP authentication, you must perform additional configuration steps. If you do not plan to run monitoring probes with Windows AD or LDAP authentication, you can skip this step.

Related Topics

Configuring monitoring probes for authentication on page 40

BusinessObjects Enterprise XI 3.0 Monitoring Guide

31

BusinessObjects monitoring probes Deploying monitoring probes

Deploying the monitoring probes package on Windows

Monitoring probes require Java Development Kit (JDK) 1.4.2 or 1.5.1. If you are using a BusinessObjects Enterprise Java application (e.g. Java Infoview), it is recommended that you use the same JDK for the monitoring probes. Deploying the monitoring probes package on Windows involves extracting the content of the monitoring probes package (XI3_monitoring.zip) to the root directory of your BusinessObjects installation. 1. Extract the contents of the XI3_monitoring.zip file to the BusinessObjects root installation directory. The default BusinessObjects root installation directory is: X:\Program Files\Business Objects\, where X: is the system drive. Extracting the contents of the XI3_monitoring.zip deploys the following: a monitoring.jar file to <INSTALL_DIR>\common\4.0\java\lib a monitoring.war file to <BOE_INSTALL_DIR>\BusinessObjects
Enterprise 12.0\java\applications

a monitoring folder to <BOE_INSTALL_DIR> (the BusinessObjects root directory).

The <BOE_INSTALL_DIR>\monitoring directory will appear as follows in Windows Explorer:

32

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Deploying monitoring probes

2. Locate the monitoring.bat file in the <BOE_INSTALL_DIR>\monitoring directory. Open the file in a text editor. 3. In the monitoring.bat file, ensure that the values for the BOE_HOME and JAVA_DIR variables reflect your environment. BOE_HOME must be set to your BusinessObjects root installation directory. JAVA_DIR must be set to the JDK root installation folder. The default settings appear as follows:
rem ---- BOE_HOME : root folder of your Business Objects Enterprise installation set BOE_HOME=C:\Program Files\Business Objects rem ---- JAVA_DIR : root folder of your JDK set JAVA_DIR=%BOE_HOME%\javasdk rem set JAVA_DIR=%JAVA_HOME%

4. Save and exit the file.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

33

BusinessObjects monitoring probes Deploying monitoring probes

Deploying the monitoring probes package on UNIX

Monitoring probes require Java Development Kit (JDK) 1.4.2 or 1.5.1. If you are using a BusinessObjects Enterprise Java application (e.g. Java Infoview), it is recommended that you use the same JDK for the monitoring probes. Deploying monitoring probes package on UNIX involves extracting the contents of the monitoring probes package (XI3_monitoring.tar.gz) to the root directory of your BusinessObjects installation. 1. Copy the BusinessObjects monitoring package (XI3_monitoring.tar.gz ) to the BusinessObjects Enterprise root directory. 2. In the BusinessObjects Enterprise root installation directory, unpackage XI3_monitoring.tar.gz using the following command:
gunzip XI3_monitoring.tar.gz tar -xvf XI3_monitoring.tar

Unpackaging the XI3_monitoring.tar.gz file deploys the following: a monitoring.jar file to bobje/lib a monitoring.war template file to BOBJ/enterprise120/java/ap
plications

a monitoring folder under the bobje directory

3. Locate the monitoring.sh file under bobje/monitoring and open the file in a text editor:
vi monitoring.sh

4. In the monitoring.sh file, ensure that the values for the BOE_HOME and JAVA_HOME variables reflect your environment. BOE_HOME must be set to your BusinessObjects root installation directory. JAVA_HOME must be set to the JDK root installation folder. The default settings appear as follows:
BOE_HOME="/apps/xi30" JAVA_HOME="{BOBJE_DIR}/jdk"

5. Save and exit the file.

34

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Deploying monitoring probes

Deploying the monitoring.war file

If you want to use the BusinessObjects monitoring probes in web mode, you must perform the following steps after you deploy the monitoring probes package to your system: Step 1: Update the monitoring.war file, as described in Updating the monitoring.war file on page 35. Step 2: Deploy the updated monitoring.war file to your web application server. Refer to the deployment instructions for your web application server: Deploying the monitoring.war file to Tomcat on page 37 Deploying the monitoring.war file to WebLogic on page 38 Deploying the monitoring.war file to WebSphere on page 39
Note:

The monitoring.war should be deployed to the web application server where InfoView is deployed. Monitoring probes should work with all web application servers supported by BusinessObjects Enterprise but instructions are only provided for web application servers that have been tested with the monitoring probes. Deployment of the monitoring.war file follows the standard procedure for BusinessObjects web component deployment. If instructions for your web application server are not provided in this guide, refer to the web component deployment instructions in the BusinessObjects Enterprise Installation Guide.

Updating the monitoring.war file

This task assumes that you have deployed the BusinessObjects Enterprise monitoring probe package (monitoring.zip or monitoring.tar.gz) to your system. The monitoring.war file must be updated with libraries from your BusinessObjects environment before you deploy the monitoring.war file to your web application server. This task describes how to update the moni

BusinessObjects Enterprise XI 3.0 Monitoring Guide

35

BusinessObjects monitoring probes Deploying monitoring probes

toring.war file using the updateWAR.bat or updateWAR.sh utilities that are

provided with the monitoring probe package.

Note:

Because BusinessObjects libraries are updated when a BusinessObjects FixPack or Service pack is applied, the monitoring.war file must be updated and each time you upgrade your BusinessObjects system. 1. Locate the updateWar.bat file (for Windows deployments) or the update WAR.sh file (for UNIX deployments) in the monitoring directory under your BusinessObjects root installation directory. 2. Open the updateWar.bat (for Windows deployments) or updateWar.sh (for UNIX deployments) in a text editor and ensure that the BOE_HOME variable is set to your BusinessObjects root installation directory. For example, on Windows, the default setting in the monitoring.bat file appears as follows:
rem ---- BOE_HOME : root folder of your Business Objects Enterprise installation set BOE_HOME=C:\Program Files\Business Objects

3. Save and exit the file. 4. To update the monitoring.war file, run updateWAR.bat (for Windows deployments) or the updateWAR.sh (for UNIX deployments) from the monitoring directory. 5. As an optional step, you can verify the that monitoring.war file is correctly updated by extracting the contents of the monitoring.war file to a temporary folder using a Winzip or jar program. The lib folder under the WEB-INF directory should contain .jar files from your BusinessObjects installation. If the lib folder is empty, the update was not successful. The web.xml file under the WEB-INF directory should have the directory for the monitoring root installation folder correctly set. For example, the setting should appear as follows (with BOE_HOME set to your BusinessObjects installation root directory:
<param-name>businessobjects.monitoring.root</param-name> <param-value>BOE_HOME/monitoring</param-value>

The next step is to deploy the monitoring.war file to your web application server.

36

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Deploying monitoring probes

Related Topics

Deploying the monitoring.war file to WebSphere on page 39 Deploying the monitoring.war file to WebLogic on page 38

Deploying the monitoring.war file to Tomcat

Before you deploy the monitoring.war file to your application server, you must update the monitoring.war file with libraries from your BusinessObjects environment, as described in Updating the monitoring.war file on page 35. The following instructions are for a BusinessObjects Enterprise Tomcat installation on Windows and assume the following default installation directory for Tomcat: C:\Program Files\Business Objects\Tomcat\ If you have a non-default installation directory, you must adjust the following instructions accordingly. 1. Before configuring Tomcat to use monitoring probes in web mode, you must deploy the monitoring probes package to your BusinessObjects Enterprise system. 2. Stop the Tomcat service. 3. Copy the monitoring.war file from C:\Program Files\Business Objects\BusinessObjects Enterprise 12.0\java\applications to
C:\Program Files\Business Objects\Tomcat\webapps

4. Restart the Tomcat service. 5. Open a browser and logon to the following URL:
http://<servername>:<serverport>/monitoring

where <servername>:<serverport> are your web application server name and port number . The following web page should appear:

BusinessObjects Enterprise XI 3.0 Monitoring Guide

37

BusinessObjects monitoring probes Deploying monitoring probes

Before attempting to run a probe in web mode from this web page, ensure that you have updated the probe configuration file. Refer to Running a monitoring probe in web mode on page 44 for more information.

Deploying the monitoring.war file to WebLogic

Before you deploy the monitoring.war file to your application server, you must update the monitoring.war file with libraries from your BusinessObjects environment, as described in Updating the monitoring.war file on page 35. This monitoring probe web configuration is tested on Redhat Linux Version 4 with Weblogic 9.2. 1. Before configuring WebLogic to use monitoring probes in web mode, the monitoring probes package must be deployed to your BusinessObjects Enterprise system. 2. Login to the Weblogic Administration Console. 3. Under Deployments, browse to the folder where the monitoring.war file is located.

38

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Deploying monitoring probes

4. 5. 6. 7.

Accept the default entries on all dialogs and select OK. Click Finish to complete the war file deployment. Activate the changes and start the monitoring application. Open a browser and logon to the following URL to view a default launch web page for the monitoring probes:
http://<servername>:<serverport>/monitoring

where <servername>:<serverport> are your web application server name and port number. See Deploying the monitoring.war file to Tomcat on page 37 for a screen capture of the web page.

Deploying the monitoring.war file to WebSphere

Before you deploy the monitoring.war file to your application server, you must update the monitoring.war file with libraries from your BusinessObjects environment, as described in Updating the monitoring.war file on page 35. This monitoring probe web configuration is tested on AIX 5.3 with WebSphere 6.0.2.2. 1. Before configuring WebSphere to use monitoring probes in web mode, the monitoring probes package must be deployed to your BusinessObjects Enterprise system. 2. Login to the WebSphere Application Server Administration Console. 3. Under Deployments, browse to the folder where the monitoring.war file is located. 4. Install the monitoring.war file as an application. Accept the default entries on all installation dialogs. 5. Click Finish to complete the war file deployment. 6. Activate changes and start the monitoring application. 7. Open a browser and logon to the following URL to view a default launch web page for the monitoring probes:
http://<servername>:<serverport>/monitoring

where <servername>:<serverport> are your web application server name and port number. See Deploying the monitoring.war file to Tomcat on page 37 for a screen capture of the web page.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

39

BusinessObjects monitoring probes Deploying monitoring probes

Configuring monitoring probes for authentication

If you use Windows AD or LDAP authentication in your BusinessObjects environment, you must perform additional configuration steps to run monitoring probes. If you do not use Windows AD or LDAP authentication, you can skip this step.
Related Topics

Configuring monitoring probes for Windows Active Directory authentication on page 40 Configuring monitoring probes for LDAP authentication on page 41

Configuring monitoring probes for Windows Active Directory authentication

This configuration assumes that BusinessObjects is already configured to work with Windows Active Directory - Kerberos authentication. In the following example, Windows Active Directory - Kerberos configuration files (Krb5.ini and bscLogin.conf) are located in C:\winnt. The location may differ on your system. To configure monitoring probes for Windows Active Directory authentication, perform the following steps: 1. Open the monitoring.bat file in a text editor. The monitoring.bat file is located in the monitoring directory under your BuisnessObjects root installation directory. 2. Uncomment the following line by removing rem from the line:
rem set KERBEROS_OPTIONS=-Djava.security.auth.login.con fig=C:\winnt\bscLogin.conf -Djava.security.krb5.conf=C:\win nt\Krb5.ini

3. If the name and location of your Kerberos configuration files are different than the default value for the KERBEROS_OPTIONS variable, provide the correct name and location. 4. Save and exit the file.

40

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Deploying monitoring probes

5. Before running a probe, set the authentication type attribute to "secWinAD", as in the following configuration file example for the CMS Logon Logoff probe:
<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secWinAD' classname='ProbeLogonLogoff' />

Note:

Windows Active Directory - Kerberos authentication is case sensitive. If the user name and system values are not entered correctly, the probe will not be permitted to run.

Configuring monitoring probes for LDAP authentication

This configuration assumes that BusinessObjects is already configured to work with LDAP - Kerberos authentication. In the following example, LDAP - Kerberos configuration files (Krb5.ini and bscLogin.conf) are located in C:\winnt. The location may differ on your system. To configure monitoring probes for LDAP authentication, perform the following steps: 1. Open the monitoring.bat file in a text editor. The monitoring.bat file is located in the monitoring directory under your BuisnessObjects root installation directory. 2. Uncomment the following line by removing rem from the line:
rem set KERBEROS_OPTIONS=-Djava.security.auth.login.con fig=C:\winnt\bscLogin.conf -Djava.security.krb5.conf=C:\win nt\Krb5.ini

3. If the name and location of your Kerberos configuration files are different than the default value for the KERBEROS_OPTIONS variable, provide the correct name and location. 4. Save and exit the file. 5. If you plan to use monitoring probes in web mode, you must update the Java Options for Apache Tomcat through the "Tomcat Properties" dialog. Select Start > Programs > Tomcat > Tomcat Configuration. On the

BusinessObjects Enterprise XI 3.0 Monitoring Guide

41

BusinessObjects monitoring probes Running monitoring probes

"Tomcat Properties" dialog, select the Java tab. Enter the following lines in the Java Options text box:
-Djava.security.auth.login.config=C:\winnt\bscLogin.conf Djava.security.krb5.conf=C:\winnt\Krb5.ini

6. Click Apply and OK on the "Tomcat Properties" dialog. 7. Before running a probe, set the authentication type attribute to "secLDAP", as in the following configuration file example for the CMS Logon Logoff probe:
<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secLDAP' classname='ProbeLogonLogoff' />

Note:

LDAP authentication is case sensitive. If the user name and system values are not entered correctly, the probe will not be permitted to run.

Running monitoring probes

Running a monitoring probe in command line mode
This task assumes you have deployed the monitoring probe package to your BusinessObjects Enterprise system. The following task describes how to run the CMS Logon Logoff probe in command line mode. 1. Locate the configuration template file for the CMS Logon Logoff probe (template_probe1.xml). Probe configuration files are located in <BOE_INSTALL_DIR>\monitor ing\probes on Windows, and bobje/monitoring/probes on UNIX. 2. Open the template_probe1.xml file in a text editor. The content of the template file appears as follows:
<probeconfig user='bobjuser' password='bobjpassword' sys tem='servername' authtype='secEnterprise' classname='ProbeL ogonLogoff' />

42

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Running monitoring probes

3. Modify the probe attributes as required for your system. For attribute descriptions, see Monitoring probe attributes and parameters on page 46. To run the probe on your system, you must specify a valid user name, password, system name, and authtype.
Note:

CMS related probes do not use reports and therfore have no report related parameters. If you run a Crystal Reports, Desktop Intelligence, or Web Intelligence probe, a report is required and report related parameters must be set in the probe configuration file. 4. Save the configuration file in the probes directory. On Windows: <BOE_INSTALL_DIR>\monitoring\probes On UNIX: bobje/monitoring/probes

5. From the monitoring directory, run the monitoring command, calling the CMS Logon Logoff probe configuration file:
monitoring.bat -probefile template_probe1.xml

Note:

If you are running the probe on a UNIX system, use the monitoring.sh command instead of monitoring.bat. If successful, the monitoring probe result output should appear similar to the following:
<probe name="CMS Logon Logoff" description="This probe tests the availability of the CMS and the ability for users to log on to the BOE system through any client applications. It suc cessively logs one user on, tests the session validity, and logs the user off."> <probeconfig user="jdoe" system="plbvm01" authtype="secEnter prise" classname="com.businessobjects.monitoring.probes.ProbeL ogonLogoff"> <connector>none</connector> </probeconfig> <result success="true" startdatetime="2008-04-25 17:23:34.109 PDT" error="" duration="1953"/> </probe>

The XML based output shows a success flag, a start time, no error, and the time it took for the probe to complete.
Related Topics

Crystal Reports service through Page and Cache Server probe on page 133

BusinessObjects Enterprise XI 3.0 Monitoring Guide

43

BusinessObjects monitoring probes Running monitoring probes

Running a monitoring probe in web mode

This task assumes you have deployed the monitoring probe package to your BusinessObjects Enterprise system and that you have deployed the moni toring.war file to your application server. The following task describes how to run the CMS Logon Logoff probe in web mode. 1. Locate the configuration template file for the CMS Logon Logoff probe (template_probe1.xml). Probe configuration files are located in <BOE_INSTALL_DIR>\monitor ing\probes on Windows, and bobje/monitoring/probes on UNIX. 2. Open the template_probe1.xml file in a text editor. The content of the template file appears as follows:
<probeconfig user='bobjuser' password='bobjpassword' sys tem='servername' authtype='secEnterprise' classname='ProbeL ogonLogoff' />

3. Modify the probe attributes as required for your system. For attribute descriptions, see Monitoring probe attributes and parameters on page 46. To run the probe on your system, you must specify a valid user name, password, system name, and authtype.
Note:

CMS related probes do not use reports and therfore have no report related parameters. If you run a Crystal Reports, Desktop Intelligence, or Web Intelligence probe, a report is required and report related parameters must be set in the probe configuration file. 4. Save the configuration file in the probes directory. On Windows: <BOE_INSTALL_DIR>\monitoring\probes On UNIX: bobje/monitoring/probes

5. Open a browser and logon to the following URL:

http://<servername>:<serverport>/monitoring

where <servername>:<serverport> are your web application server name and port number . The following web page should appear:

44

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Running monitoring probes

6. Click on the following link: Template Probe 1: CMS Logon Logoff

Note:

Alternatively, you can specify a URL similar to the following in your Web browser's address field that directly calls the probe configuration file:
http://webserver:8080/monitoring/monitoring?probefile=tem plate_probe1.xml

If successful, the monitoring probe output appears in the browser window:

BusinessObjects Enterprise XI 3.0 Monitoring Guide

45

BusinessObjects monitoring probes Running monitoring probes

The XML based output shows a success flag, a start time, no error, and the time it took for the probe to complete.
Related Topics

Crystal Reports service through Page and Cache Server probe on page 133

Monitoring probe attributes and parameters

This topic describes monitoring probe attributes and parameters. The following example, from a ProbeWebi configuration file, shows all possible monitoring probe attributes and parameters, each of which is described in the tables that follow.
<probeconfig user='bobjuser' password='bobjpassword' sys tem='servername' authtype='secEnterprise' classname='ProbeDes ki'> <!-- Uncomment one of the search options: cuid, docid, name-> <!-- Enter in the correct value afterwards--> <!-- CUID identifier for document-->

46

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Running monitoring probes

<!-<param type='java.lang.String' value='ASHeDJIWZSBAmtwnFIWGybs' /> --> <!-- DOCID identifier for document--> <param type='int' value='5852' /> <!-- NAME of document--> <!-<param type='java.lang.String' value='Mail Labels' /> --> <!--Document display options--> <!-- REFRESH document select true or false --> <param type='boolean' value='true' /> <!-- PDFEXPORT document select true or false --> <param type='boolean' value='false' /> <!-- XLSEXPORT document select true or false --> <param type='boolean' value='false' /> </probeconfig>

Attributes

All BusinessObjects monitoring probes share the same attributes which are described in the following table.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

47

BusinessObjects monitoring probes Running monitoring probes

Probe attributes user password

Valid arguments BusinessObjects user name used to perform the test. Example:
user='jdoe'

Password for the BusinessObjects user. Example: pass word='jdoepwd'.

If your BusinessObjects user does not have a password assigned, use empty quotes, as follows: password=''
system

CMS machine name: <cmsmachinename>:<portnum ber>. <cmsmachinename> can be the machine name, fully qualified domain name (FQDN), or IP address. Example: system='plbvm01' or system='plbvm01:6400'
Note:

<portnumber> is not required if the default port number (6400) is used. In a clustered CMS environment, any CMS can be specified. The request is automatically forwarded to other CMS servers, if required.
authtype Authentication type for your BusinessObjects Enterprise system. Example: authtype='secEnterprise'

Authentication types include: BusinessObjects Enterprise authentication: secEnter

prise

classname

LDAP authentication: secLDAP Windows Active Directory authentication: secWinAD

48

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Running monitoring probes

Probe attributes

Valid arguments

Classname for the monitoring probe. Classnames for all eight probes are: CMS Logon Logoff probe: ProbeLogonLogoff Crystal Reports service through Page and Cache Server probe: ProbeCRPageServer Crystal Reports service through Report Application Server probe: ProveCRRAS Desktop Intelligence service probe: ProbeDeski Web Intelligence service probe: ProbeWebi CMS ping probe: ProbeCMSQuery1 CMS cache probe: ProbeCMSQuery2 CMS database connection probe: ProbeCMSQuery3
Note:

The classname attribute is already specified in the probe configuration file templates that are located in the probes directory of the monitoring probes package.

Parameters

Monitoring probes that run against reporting engines require a report to run, and include some or all of the report-related parameters described in the table below. Monitoring probes that do not run against reporting engines (CMS Logon Logoff, CMS Ping, CMS cache, and CMS database connection) do not include report-related parameters.
Note:

There are three ways to specify a report document when configuring a probe. You can identify a document using its CUID, document id, or document name. Only use one of the three parameters.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

49

BusinessObjects monitoring probes Running monitoring probes

Probe param- Valid arguments eters CUID

A CUID uniquely identifies an object such as report. Using the CUID to identify a monitoring probe report is advantageous if you expect to move the report to a different environment (e.g from one BusinessObjects cluster to another or from a test system to a production system). The CUID remains unchanged, which means you do not have to update the monitoring probe parameters after a report is moved.
Param type: 'java.lang.String' Value: e.g. 'ASHeDJIWZSBAmtwnFIWGybs '

Note: Only one of the following can be specified to identify your report: CUID, document id, or document name. The two unused options must be commented out. document id Param type: 'int' Value: e.g. '5852'

Note: Only one of the following can be specified to identify your report: CUID, document id, or document name. The two unused options must be commented out . document name Param type: 'java.lang.String' Value: document_name, e.g. 'ABC report'

Note: Only one of the following can be specified to identify your report: CUID, document id, or document name. The two unused options must be commented out. REFRESH document Param type: 'boolean' Value: 'true' or 'false' Param type: 'boolean' Value: 'true' or 'false'

PDFEXPORT document

50

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Running monitoring probes

Probe param- Valid arguments eters XLSEXPORT document Param type: 'boolean' Value: 'true' or 'false'

Monitoring probe output

The monitoring probe output stream is XML based to provide integration flexibility. This topic provides examples of probe output for command line mode and web mode, and explains output parameters. The monitoring probe output described in this topic is based on the input specified in the following ProbeCRPageServer configuration file example:
<probeconfig user='jdoe' password='jdoepassword' system='plb vm01' authtype='secEnterprise' classname='ProbeCRPageServer'> <!-- Uncomment one of the search options: cuid, docid, name-> <!-- Enter in the correct value afterwards--> <!-- CUID identifier for document--> <!-<param type='java.lang.String' value='ASHeDJIWZSBAmtwnFIWGybs' /> --> <!-- DOCID identifier for document--> <!-<param type='int' value='656' /> --> <!-- NAME of document--> <param type='java.lang.String' value='Mail Labels' /> <!--Document display options--> <!-- REFRESH document select true or false --> <param type='boolean' value='false' /> <!-- PDFEXPORT document select true or false --> <param type='boolean' value='false' /> </probeconfig>

BusinessObjects Enterprise XI 3.0 Monitoring Guide

51

BusinessObjects monitoring probes Running monitoring probes

Command line output

When the ProbeCRPageServer probe run from the command line, output appears similar to the following:
<probe name="Crystal Reports Service through Page and Cache Server" description="This probe tests the availability of the Crystal Report service through Page and Cache servers. Using the Page and Cache servers, it successively opens a Crystal report, refreshes it, optionally export it to the PDF format and then closes it."> <probeconfig user="jdoe" system="plbvm01" authtype="secEnter prise" classname="com.businessobjects.monitoring.probes.Probe CRPageServer"> <param type="java.lang.String" value="Mail Labels"/> <param type="boolean" value="false"/> <param type="boolean" value="false"/> <connector>none</connector> </probeconfig> <result success="true" startdatetime="2008-01-31 24:59:59.234 PDT" error="" duration="6718"/> </probe>

Web mode probe output

When the ProbeCRPageServer probe run from a web browser (web mode), output appears similar to the following:

52

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Running monitoring probes

Output parameter definitions

Probe output includes the following parameters:

Output param- Values eter name description probeconfig Monitoring probe name Monitoring probe description Input attributes and parameters passed to the probe including user, system, authtype, document id/document name, refresh options, and export options Connector name (if any) Boolean flag to indicate if the probe was successful or not (true or false)

connector success

BusinessObjects Enterprise XI 3.0 Monitoring Guide

53

BusinessObjects monitoring probes Running monitoring probes

Output param- Values eter startdatetime Date and time the probe execution started (e.g. 2008-01-31 24:59:59.234 PDT) Note: PDT is a time zone abbreviation. error Error returned by the BusinessObjects Enterprise system Note: Error code and description are only returned if the probe encounters an error. duration Duration of probe execution (time in milliseconds it takes the probe to complete)

Specifying probe attributes and parameters dynamically

In addition to using a configuration file to specify probe attributes and parameters, you can specify probe attributes and parameters dynamically in both command line mode and web mode. The following example shows a command line statement for the CMS Logon Logoff probe with attributes specified dynamically:
monitoring.bat -probeconfig "<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeLogonLogoff' />"

This example shows the same CMS Logon Logoff probe with attributes specified dynamically within a URL:
http://webserver:8080/monitoring/monitoring?probecon fig=http://webserver:8080 /monitoring/monitoring?probeconfig=<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeLogonLogoff' />

54

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Working with monitoring probes

where webserver:8080 is the name and port number where the monitoring web application component (monitoring.war) is deployed.
Note:

On UNIX, probes are run using the monitoring.sh command instead of the monitoring.bat command. Attributes and parameters are defined in the same way regardless of operating system. Dynamic usage examples for each probe are provided in the monitoring probe reference section.

Working with monitoring probes

The topics in this section provide information and guidelines for using monitoring probes. You will find answers to questions such as: What are the user account requirements for running monitoring probes? When do you run monitoring probes in command line mode versus web mode? How do you define performance measures for monitoring probes? How often should you run monitoring probes? Are there any considerations related to security or auditing? How can you monitor the CMS and authentication using monitoring probes? How can you monitor report engines (for Crystal Reports, Desktop Intelligence, and Web Intelligence) using monitoring probes? Can I integrate monitoring probes with industry-standard or proprietary monitoring solutions? What are the limitations and known issues?

User account guidelines for running monitoring probes

At a minimum, a BusinessObjects user account with default Enterprise authority is required to run a monitoring probe. The following additional requirements and guidelines may also apply:

BusinessObjects Enterprise XI 3.0 Monitoring Guide

55

BusinessObjects monitoring probes Working with monitoring probes

For security and audit considerations it is recommended that you define a BusinessObjects user account specifically for running monitoring probes. For more information, see Security and audit considerations on page 59. For BusinessObjects monitoring probes that use a report, the BusinessObjects user account must have the rights necessary to execute the report you define. You may want to make use of existing profiles or groups if testing of user rights integrity is part of your monitoring strategy. For more information, see Monitoring report engines and data sources on page 60.

If your system uses an LDAP or Windows Active Directory authentication service, and you plan to run monitoring probes under the same authentication service, ensure that the BusinessObjects user account belongs to a user group that is mapped to your LDAP or Windows Active Directory group.

Running probes in command line mode versus web mode

Whether you run probes in command line mode, web mode, or in combination depends on your monitoring goals. The following table outlines a number of possible monitoring goals with a recommendation for which mode to use:

56

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Working with monitoring probes

Monitoring goal

Mode

To perform a simple check of BusinessObjects Enter- Command line mode prise server availability on the physical machine where BusinessObjects Enterprise servers are running To isolate testing of BusinessObjects Enterprise Command line mode servers in a web application environment by checking BusinessObjects server availability on the physical machine where BusinessObjects servers are running To test availability of BusinessObjects Enterprise servers through your web application server Web mode

To determine if a problem exists at a BusinessObjects Combination of comserver tier or web application server tier by running the mand line and web same probe in command line mode and web mode. mode

If the probe is successful in command line mode at the physical BusinessObjects server machine and unsuccessful in web mode, the problem is likely with the application server.

Related Topics

Running a monitoring probe in command line mode on page 42 Running a monitoring probe in web mode on page 44

Defining performance measures for monitoring probes

In addition to monitoring system availability, probes can monitor server performance. To monitor performance, a baseline performance measure must be established. Performance, such as how long it takes to open, refresh, and export a report, will depend on your particular computing environment. A recommended approach is to define performance buckets for each probe. For example, if you are running the Desktop Intelligence Service probe to measure Desktop Intelligence server performance, you might define performance buckets as shown in the following example:

BusinessObjects Enterprise XI 3.0 Monitoring Guide

57

BusinessObjects monitoring probes Working with monitoring probes

Performance buckets Green (acceptable performance) Yellow (potential performance problem) Red (performance problem)

Response time Less than 5 seconds Between 5 and 20 seconds Over 20 seconds

You can then define an alert policy based on the performance buckets. For example, you may want to send an e-mail alert to a system administrator if the probe returns a performance result in the Red performance bucket range, or if performance results fall into the Yellow performance bucket over a number of successive probe tests.

Defining monitoring probe execution frequency

Because monitoring probes simulate user actions, they can add load to your system. Running probes too frequently or running too many probes concurrently can impact system performance and stability. It is also important to note that each probe execution requires a session and will therefore impact license usage. In addition to considering the load monitoring probes can add to your system, you may also need to consider Service Level Agreements (SLA) that exist between the IT department and the end user community and how performance commitments may be affected by your monitoring probe implementation. When running probes, it is generally recommended that the execution interval for a probe be longer than the probe execution time. The execution interval should be at least double of the execution time. For example, if probe execution takes 30 seconds, the probe should not be run more than once each minute. Refer to Monitoring report engines and data sources on page 60 for more information about probe execution intervals.

58

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Working with monitoring probes

Security and audit considerations

For security and audit reasons, it is recommended that you define user accounts and reports specifically for running monitoring probes. Defining user accounts and only assigning rights required to run monitoring probes helps limit security risks. Defining specific user accounts and reports also helps to identify monitoring probe activity in audit reports and enables you to distinguish between probe activity and actual end user activity.

Monitoring the Central Management Server (CMS) and authentication servers

To monitor the BusinessObjects Central Management Server (CMS), you can run the CMS Logon Logoff probe at regular intervals using the same authentication mode as end users, which is typically LDAP or Active Directory authentication. If you encounter a problem when running the CMS Logon Logoff probe, you can run other CMS probes, including CMS Ping, CMS Cache, CMS database connection to try and locate the source of the problem. You can also switch out probe parameters such the authtype parameter to assess the functioning of the authentication service in a CMS related workflow. For example, to determine if a logon issue is due to an LDAP or Active Directory authentication server problem, you can run the CMS Logon Logoff probe using default authentication (BusinessObjects Enterprise authentication) and compare the result to the result returned when running the probe under LDAP or Active Directory authentication. If the Enterprise authentication result is significantly better, the problem is likely at the LDAP or Active Directory server. As a general guideline, it is recommended that you run the CMS logon logoff probe execution at 2 minute intervals. You can run the probe at a greater interval if system load is heavy, if your number of licenses is limited, or if SLA requirements limit the amount of load you can safely add to the system.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

59

BusinessObjects monitoring probes Working with monitoring probes

Monitoring report engines and data sources

The following monitoring probes are report engine probes that use a report to test BusinessObjects servers and data sources: Web Intelligence Service probe Desktop Intelligence Service probe Crystal Reports service through Page and Cache Server probe Crystal Reports service through Report Application Server probe For example, the Web Intelligence Service probe opens a Web Intelligence report, optionally refreshes it, and optionally exports the report to XLS or PDF format. There are a number of recommended guidelines for running report engine probes: Use simple, lightweight reports to avoid creating unnecessary system load. As a guideline, it should not take more than a few seconds for the probe to open and refresh a report. If it takes significantly longer, your report may be too complex for monitoring purposes. The refresh and export parameters are provided to enable you to simulate how end users use reports. For example, if users regularly refreshes reports and export reports to PDF format, use the refresh and PDF export parameters. If, on the other hand, users only view reports through a DHTML viewer, do not export to PDF format.
Note:

Monitoring probe export options do not save PDF or XLS files to your system. Output formats are created in memory. You may want to run probes with different parameters at different times of the day. For example, in an environment where reports are refreshed nightly and users consume reports in read-only mode, you might run probes with the refresh parameter from 6 PM to 6AM. As a starting point, a 5 minute interval between execution of the same type of report engine probe is recommended. For example, after running a Web Intelligence Service probe, wait five minutes before running another Web Intelligence Service probe. Running the same probe too often may negatively impact system performance and running a probe too infrequently may not provide the monitoring data required to meet your

60

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Working with monitoring probes

monitoring goals. The frequency you define will depend on your system load and resources required by the monitoring probe. In terms of monitoring goals, the following guidelines are recommended:

BusinessObjects Enterprise XI 3.0 Monitoring Guide

61

BusinessObjects monitoring probes Working with monitoring probes

Monitoring goal

Recommendation

Testing server availAs an Administrator user, run a single probe with a ability

simple, lightweight report. For example, to check Desktop Intelligence server availability, run the Desktop Intelligence Service probe with a simple, lightweight report As an Administrator user, run a single probe with a simple, lightweight report, and export the report to PDF or XLS format. For example, run the Desktop Intelligence Service probe with a simple, lightweight report, and export it to PDF format. To measure performance, a performance baseline should be established. See Defining performance measures for monitoring probes on page 57 for details.

Testing server performance

Testing data source Use a single report per data source and run one probe availability

per report with the "Refresh document" option enabled. For example, run the Desktop Intelligence Service probe using a report that extracts data from the corporate database. Enable the "Refresh document" option to ensure that the corporate database is accessed.

Testing user rights integrity

For each typical user group or profile, run a probe with a report. Use the refresh and export options if relevant to that user group or profile. For example, run a typical HR report as an HR group user, or run a typical marketing report as a Marketing group user.

Probe failure
When a probe fails, the result output indicates that success is equal to "false", similar to the following example:

62

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Working with monitoring probes

<result success=false startdatetime=2008-01-31 24:59:59.234 PDT error=error_message duration=6718>

If a probe fails, a general recommendation is to run the probe twice more at a 30 second interval, and to raise an alert with an error message if the probe continues to report a failure. Running the probe again before raising an alert will help to avoid unnecessary alert generation in situations where a system may self-correct or resume normal functioning after a momentary delay.

Monitoring probe connectors and probe integration

Monitoring probe output is XML-based and can be manipulated as required through XSL programming for integration with industry-standard or proprietary monitoring solutions. Default XML-based output for a monitoring probe appears similar to the following example:
<probe name="CMS Logon Logoff" description="This probe tests the availability of the CMS and ability for users to log on to the BOE system through any client application. It successively logs one user on, tests the session validity, and logs the user off."> <probeconfig user="jdoe" system="plbvm01" authtype="secEnter prise" classname="com.businessobjects.monitoring.probes.ProbeL ogonLogoff"> <connector>none</connector> </probeconfig> <result success="true" startdatetime="2008-05-05 18:35:11.250 PDT" error="" duration="703"/> </probe>

Because monitoring solutions, whether proprietary or industry-standard, expect data in a particular format, monitoring probes have been designed to facilitate data conversion to any format through the use of XSL style sheet connectors. The monitoring probe package includes XSL style sheet connectors for integration with IBM Tivoli and Microsoft Operations Manager (MOM). The following connector files for IBM Tivoli and MOM integration are located in connectors directory of your monitoring probe deployment:
totext4tivoli.xsl totext4mom.xsl

BusinessObjects Enterprise XI 3.0 Monitoring Guide

63

BusinessObjects monitoring probes Working with monitoring probes

The XSL styles sheets convert XML-based monitoring probe output into the required format for integration with IBM Tivoli and MOM. To integrate monitoring probes with a different monitoring solution, you can develop your own XSL style sheet (i.e. a connector) to convert default XML probe output into the required format, whether it be text, csv, XML, or another data format. In order to use a connector with a monitoring probe, the probe configuration file must contain a connector node (<connector></connector>) with the name of the XSL connector file as a value, as shown in the following example:
<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeLogonLogoff'> <connector>totext4tivoli.xsl</connector> </probeconfig>

Note:

For IBM Tivoli and Microsoft Operations Manager (MOM) probe configuration template files for each monitoring probe are provided with connector information already specified. Probe configuration files for IBM Tivoli and MOM are located in the <BOE_INSTALL_DIR>\monitoring\probes directory and have 4tivoli or 4mom in the file name (e.g. tem plate_probe1_4tivoli.xml) . The XSL connector file must be located in the connectors directory of your monitoring probe deployment: Windows: <BOE_INSTALL_DIR>\monitoring\connectors UNIX: <BOE_INSTALL_DIR>/monitoring/connectors
Note:

If a connector is not defined in the probe configuration file or if the XSL file name is incorrect, the probe returns the default XML output.

Using server groups to monitor individual BusinessObjects Enterprise services

If you have more than one instance of a BusinessObjects server (one of the services that can be monitored using a probe), and you want to monitor the health of each server individually, you may consider using server groups. For example, if you have multiple Web Intelligence Report Servers running

64

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Working with monitoring probes

on your system, you can monitor the health of each Web Intelligence Report Server individually by running Web Intelligence Report Server probe with a report that is assigned to a server group that includes only one of the Web Intelligence Report Servers. In this scenario, when the probe is run, the report only runs against the Web Intelligence Report Server that belongs to the server group. To further illustrate, assume you have a clustered system with four Web Intelligence Report Server instances. You can monitor the individual status of each Web Intelligence Report server by: 1. Assigning each of the four Web Intelligence Report Servers to a separate server group 2. Creating four simple Web Intelligence reports (to test with) and assigning one to each server group selecting following options in the CMC: Default Servers To Use For Viewing And Modification and Only use servers belonging to the selected group. 3. Running a Web Intelligence Report Server probe with each of the four reports on a regular basis In this way, you can monitor the health of each Web Intelligence Report Server by itself. The same methodology can be applied to other BusinessObjects reporting services that can be monitored with BusinessObjects monitoring probes. In a case where you have a distributed or clustered system with more than one instance of a service, isolate the service using a server group, assign a report to the server group, and run a probe with the report to assess the individual status of the isolated server.

Monitoring probe limitations and known issues

The following limitations and known issues apply to BusinessObjects monitoring probes:
Limitations

Kerberos must be setup to use monitoring probes with Windows AD authentication. If Kerberos cannot be setup for systems running Windows AD authentication (e.g. if Windows is already setup with NTLM), BusinessObjects Enterprise authentication can be used to run monitoring probes.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

65

BusinessObjects monitoring probes Working with monitoring probes

The user name and password for the BusinessObjects user used to run a monitoring probe is not encrypted. To avoid typing a user name and password to a configuration file, probe attributes including user name and password can be defined dynamically in command-line mode or web mode. It is recommended that you create a BusinessObjects user with limited rights for running BusinessObjects monitoring probes.

Corba SSL is currently not supported with BusinessObjects monitoring probes. Running monitoring probes in web mode is only supported with Java web application servers. For non-Java web application server deployments, such as a BusinessObjects Enterprise .Net deployment, you can only run monitoring probes in command line mode. Monitoring probes and associated documentation are only available in English. Because the primary purpose of monitoring probes is to test availability and performance, monitoring probes are not designed to run reports that are configured to prompt for user input. For most BusinessObjects environments, a simple report (that does not prompt for user input) is sufficient for monitoring purposes.

Known issues

The connector to text output option is only available when running probes in command line mode. This option is not available for web mode. If the directory specified as the Monitoring_Install_Folder does not exist, the following error is displayed in the MOM installation log when a probe is run in MOM: Description: An error occurred on line 52 while executing script 'BOE monitoring probe with error' Source: (null) Description: (null).

66

BusinessObjects Enterprise XI 3.0 Monitoring Guide

BusinessObjects monitoring probes Uninstalling monitoring probes

Uninstalling monitoring probes

Uninstalling monitoring probes on Windows
Before uninstalling the BusinessObjects monitoring probes you may want to backup probe configuration files that you have modified for use in your environment. Probe configuration files are located in the <BOE_IN STALL_DIR>\monitoring\probes directory. If you plan to use monitoring probes again in the future, backing up files may save you from having to configure probe files again. To uninstall monitoring probes, perform the following steps: 1. Remove the monitoring folder from <BOE_INSTALL_DIR> (the BusinessObjects root directory). 2. Remove the monitoring.war file from
<BOE_INSTALL_DIR>\BusinessObjects Enterprise 12.0\java\applications

3. Remove the monitoring.jar file from <INSTALL_DIR>\common\4.0\ja

va\lib

Uninstalling monitoring probes on Unix

Before uninstalling the BusinessObjects monitoring probes you may want to backup probe configuration files that you have modified for use in your environment. Probe configuration files are located in the bobje/monitor ing/probes directory. If you plan to use monitoring probes again in the future, backing up files may save you from having to configure probe files again. To uninstall monitoring probes, perform the following steps: 1. Remove the monitoring folder from the bobje directory. 2. Remove the monitoring.war file from bobje/enterprise120/java/ap
plication

3. Remove the monitoring.jar file from bobje/lib

BusinessObjects Enterprise XI 3.0 Monitoring Guide

67

BusinessObjects monitoring probes Uninstalling monitoring probes

68

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects using system and application tools

Monitoring BusinessObjects using system and application tools

If you do not use an Enterprise monitoring tool such as IBM Tivoli or Microsoft Operations Manager (MOM), you can use system tools, application tools, and BusinessObjects monitoring probes to perform system monitoring tasks. The following sections describe how monitoring can be performed on recommended components, as described in Components recommended by BusinessObjects on page 16.
BusinessObjects Enterprise metrics

For BusinessObjects you can check server availability and other metrics using the Central Management Console. The Servers management area of the CMC displays server metrics that provide statistics and information about each BusinessObjects Enterprise server. The general information displayed for each server includes information about the machine that the server is running onits name, operating system, total hard disk space, free hard disk space, total RAM, number of CPUs, and local time.
Web Application server metrics

For web application server metrics, it is recommended that you work with your web server administrator or that you refer to your web application server documentation for tools that you can use to monitor availability, response time, number of open sessions, and JVM performance.
System level components and metrics

System level components include such things as CPU, memory, and disk. You can use system tools to perform monitoring for these components. For example, you can establish a baseline for average CPU usage for machines that participate in your BusinessObjects system and use the Performance tab in the "Windows Task Manager" take regular readings. Another example is the nmon tool, which can be used to gather performance information on Linux and UNIX systems.
Database metrics

To monitor database metrics, a database server command line interface can be used to perform regular checks. For example, to check database availability, SQL statements can be run.

70

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects using system and application tools

It is recommended that you work with your database administrator to define simple health checks for your BusinessObjects and corporate database, which you can use to assess response time, percentage of requests serviced from the cache, and frequency of lock waits.
BusinessObjects monitoring probes

BusinessObjects monitoring probes can be run from the command line or through a web browser. For detailed information about the monitoring capabilities of BusinessObjects monitoring probes, refer to the monitoring probes section of this guide. Monitoring probes can be used to provide a health check for your BusinessObjects system and are an excellent compliment to a monitoring strategy.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

71

Monitoring BusinessObjects using system and application tools

72

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with IBM Tivoli

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor a BusinessObjects application metric

This chapter provides example procedures you can use to configure monitoring for BusinessObjects Enterprise using IBM Tivoli. In particular, the topics in this chapter describe how to: Configure IBM Tivoli to monitor a BusinessObjects application metric Configure IBM Tivoli to monitor BusinessObjects using a monitoring probe The examples documented use IBM Tivoli Monitoring version 6.1. While this section only describes how to implement monitoring for a single component metric and a single probe, the example procedures can be used to implement a full monitoring solution that includes multiple system metrics, application metrics, and monitoring probes.

Configuring Tivoli to monitor a BusinessObjects application metric

The following procedure describes how to configure monitoring for memory usage for a BusinessObjects Enterprise CMS service running on a Windows system. 1. Login to Tivoli Enterprise Portal.

The Tivoli Enterprise Portal dashboard is displayed.

74

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor a BusinessObjects application metric

2. In the "Navigator" pane, navigate to the computer that hosts BusinessObjects Enterprise. In this example, BusinessObjects Enterprise is hosted on a Windows server named CDI5BOE. 3. From the Tivoli Enterprise Portal menu bar, select Edit > Situation Editor. 4. In the "Situation Editor" dialog, select Windows OS.

5. Click on the Create new Situation icon at the top of the Navigation pane. 6. On the "Create Situation" dialog, enter a name and description. In this example, the following values are entered: Name: NT_BOE_CMS_High_Memory Description: Monitors high memory usage by the CMS process for the BusinessObjects Enterprise server

7. Click OK. 8. On the "Select condition" dialog, select the conditions to be monitored for this situation.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

75

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor a BusinessObjects application metric

Because memory usage for the a process is being monitored, the NT Process attribute group is selected with Virtual kBytes selected as the Attribute item. Click OK to create the condition. 9. In the "Situation Editor" dialog, define the threshold for the monitored situation. In this example, the threshold is set to 100MB.

76

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor a BusinessObjects application metric

10. On the "Situation Editor" dialog, click the Add conditions button. 11. On the "Select condition" dialog, select NT Process from the Attribute group list box with Process Name selected as the Attribute item.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

77

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor a BusinessObjects application metric

12. Click OK. 13. On the "Situation Editor" dialog, set the value of the process name to CMS, which is the process name for the BusinessObjects Enterprise CMS service.

14. Click Apply. 15. On the "Situation Editor" dialog, select the Distribution tab. 16. On the Distribution tab, assign the situation to the BusinessObjects system by selecting the name of the system (CDI5BOE:NT) from the Available Managed Systems list box and clicking on the arrow button to add it to the Assigned list box, on the left.

78

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor a BusinessObjects application metric

17. Click Apply. 18. Click on the Expert Advice tab. In the Text or Advice Location text box, provide information that can be used by your monitoring administrator to determine a course of action when the situation occurs.

19. Click on the Action tab. Define the action to take if the situation is triggered. In this example, "Universal Message" is selected.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

79

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor a BusinessObjects application metric

The Universal Message option allows you to use the "Universal Message Console" to monitor for this situation. Click Apply. You have defined a situation that monitors for high memory consumption by the BusinessObjects Enterprise CMS server process. When the CMS memory threshold of 100MB is passed, a message is sent to the Universal Message Console. 20. To display an alert in the Tivoli Enterprise Portal for the managed BusinessObjects Enterprise server, the situation must be associated with the managed BusinessObjects Enterprise server. In the "Situation Editor" dialog, select the managed BusinessObjects Enterprise server (CDI5BOE) from the list, right click, and select Situations. Currently there are no situations associated with the BusinessObjects Enterprise server (CDI5BOE), so none are displayed. 21. Click on the Set situation criteria filter icon. The Show Situations dialog is displayed.

80

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor a BusinessObjects application metric

22. Check Eligible for association and uncheck Associated with this object.

23. Click OK You now have a situation that you can assign to the managed BusinessObjects Enterprise system. 24. Select NT_BOE_CMS_High_Memory, right click and select Associate. Click OK. The situation is now associated with the managed BusinessObjects Enterprise system. If the situation occurs (i.e. the CMS memory usage threshold of 100MB is passed) an alert icon will be displayed in the Navigator pane.

You can view alert information by hovering over the alert icon for the managed system. Click on the buttons in the popup window to view

BusinessObjects Enterprise XI 3.0 Monitoring Guide

81

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor BusinessObjects using a probe

additional details about the alert including situation values and expert advice.

Configuring Tivoli to monitor BusinessObjects using a probe

Preparing a probe configuration file (Tivoli)
This procedure assumes that you have deployed the BusinessObjects monitoring probes package to your BusinessObjects server. Before you can configure Tivoli to run a monitoring probe, you must configure a probe configuration file and define a command line execution statement for the probe. Because the probe is used with Tivoli, we will use a special probe configuration file for Tivoli. Probe configuration files are located in <BOE_IN STALL_DIR>\monitoring\probes\ and have 4tivoli in the file name (e.g. template_probe1_4tivoli.xml)

82

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor BusinessObjects using a probe

A separate Tivoli probe configuration file is provided for each of the eight monitoring probes (template_probe1_4tivoli.xml to tem plate_probe8_4tivoli.xml). If you run a different probe, ensure that you use the correct probe configuration file. In this example, a CMS Logon Logoff probe configuration file for Tivoli is configured (template_probe1_4tivoli.xml). The command line execution statement that you define will be added to the Universal Agent metafile when you configure Tivoli. 1. Open the CMS Logon Logoff probe configuration file for Tivoli (tem plate_probe1_4tivoli.xml) in a text editor. The CMS Logon Logoff probe configuration file for Tivoli is located in the <BOE_INSTALL_DIR>\mon itoring\probes\ directory. The template file appears similar to the following:
<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeLogonLogoff'> <connector>totext4tivoli.xsl</connector> </probeconfig>

2. Change the user, password, system, and authtype parameters as required for your BusinessObjects server. In this example, the configuration file is modified as follows:
<probeconfig user='BOEuser' password='mypassword' sys tem='CDI5BOE' authtype='secEnterprise' classname='ProbeLo gonLogoff'> <connector>totext4tivoli.xsl</connector> </probeconfig>

Note:

The classname parameter specifies the probe that will be run. 3. Save the CMS Logon Logoff probe configuration to the your monitoring directory on the BusinessObjects server. In this example, the configuration file is saved to C:\Program Files\BusinessObjects\monitoring\ directory.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

83

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor BusinessObjects using a probe

You are now prepared to configure Tivoli to run the CMS Logon Logoff probe through the following command line statement, which you will add to the Tivoli Universal Agent metafile:
C:\Program Files\BusinessObjects\monitoring\monitoring.bat "probefile template_probe1_4tivoli.xml"

Note:

The BusinessObjects directory may be different for your environment depending on where you have installed BusinessObjects Enterprise. Since you are running the probe on Windows, monitoring.bat command is used in the command line execution statement. If you were configuring a probe to run on a UNIX system, the monitoring.sh command would be used.

You can verify that the probe is configured properly by running the command line statement directly from a command window on your BusinessObjects server.

Preparing the agent metafile

The following procedure describes how to prepare a metafile (an MDL file) that is required by the Tivoli Universal Agent. A metafile template for each monitoring probe is provided in the <BOE_INSTALL_DIR>\monitoring\con nectors directory. 1. On the BusinessObjects server, copy the agent metafile for the CMS Logon Logoff monitoring probe (tivoliuniversala gent4boe_probe1.mdl) from <BOE_INSTALL_DIR>\monitoring\connec tors to C:\ibm\ITM\TMAITM6\metafiles 2. Open the metafile in a text editor and edit the first three lines as required:
//APPL P01 BOE Monitoring Probe Logon Logoff //NAME PROBE1DATA P Interval=60 //SOURCE SCRIPT C:\Program Files\BusinessObjects\monitor ing\monitoring.bat "-probefile template_probe1_4tivoli.xml" //ATTRIBUTES '#' ProbeName D 30 User D 30 System D 80 AuthType D 15 Success S 1 1

84

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor BusinessObjects using a probe

StartDateTime T ErrorMsg D 200 Duration C 3600000 ProbeDescription D 200 *

Note:

The asterisk (*) in the code example above is a required closing character. The //APPL statement specifies the agent name. In the MDL file template, the agent is named for the monitoring probe: BOE Monitoring Probe Logon Logoff.
Note:

The first three characters of the value you enter for the APPL parameter should be unique. Tivoli uses the first three characters to uniquely name the agent metafile. The naming convention we use in the example above is to prefix P01 to the name of the probe. 'P02' would be prefixed to the next probe name, and so on. The //NAME statement specifies the name of the attribute group and nature of the data. Typically, a probe is run in polled mode (P). The time interval is defined in seconds (Interval=60). The interval is set to 60 seconds in this example. You can adjust the value as required. The //SOURCE statement specifies the script command to be executed. This is the probe command line execution statement that you defined when you prepared the probe configuration file.
Note:

Ensure that the directory path specified for the BusinessObjects mon itoring directory is correct. The directory path for your environment may differ from the directory path in the template file. 3. Save and exit the file.
Note:

Refer to the IBM Tivoli documentation for more information about metafile configuration (see the Related Topics).
Related Topics

http://publib.boulder.ibm.com/infocenter/tivihelp/v15r1/index.jsp?top ic=/com.ibm.itm.doc_6.1/610uausers.htm http://publib.boulder.ibm.com/infocenter/tivihelp/v15r1/top ic/com.ibm.itm.doc_6.1/610uausers119.htm

BusinessObjects Enterprise XI 3.0 Monitoring Guide

85

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor BusinessObjects using a probe

http://publib.boulder.ibm.com/infocenter/tivihelp/v15r1/top ic/com.ibm.itm.doc_6.1/610uausers188.htm

Configuring Tivoli to run a monitoring probe

Before you begin, ensure that you have deployed the BusinessObjects monitoring probe package to your BusinessObjects Enterprise server and that you have prepared the probe configuration file for CMS Logon Logoff probe. The following steps describe how to configuring Tivoli to use the CMS Logon Logoff monitoring probe on a BusinessObjects Enterprise server named CDI5BOE. The probe is configured to run every 60 seconds. 1. Install the IBM Tivoli Universal Agent on the BusinessObjects server (CDI5BOE). For information about Tivoli Universal Agent deployment, refer to the IBM Tivoli documentation. 2. In the Tivoli Enterprise Portal, navigate to the Universal Agent node: Enterprise > Windows Systems > CDI5BOE (your BusinessObjects system) > Universal Agent.

3. Expand Universal Agent and right click on cdi5BOEASFSdp.UAGENT00. Select Take Action > Select.

86

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor BusinessObjects using a probe

cdi5BOEASFSdp.UAGENT00 is a default entry that was created when you installed the Universal Agent on the BusinessObjects server.

4. On the "Take Action" dialog, select Control Import from the Action Name drop-down box. 5. Click on the Arguments button. The "Edit Argument Values" dialog appears.

6. Enter the name of the agent metafile (MDL file) that you prepared previously(tivoliuniversalagent4boe_probe1.mdl). Click OK.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

87

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor BusinessObjects using a probe

The script executes immediately once the agent metafile is loaded to allow you to verify that it runs successfully. 7. In the Tivoli Enterprise Portal, navigate to the Universal Agent node: Enterprise > Windows Systems > your BusinessObjects system (CDI5BOE) > Universal Agent. You should now see a second entry named cdi5BOE:BOECMS01 nested under the Universal Agent node. Select PROBE1DATA under this entry to view the probe output data in the Report pane.

8. You can view the DPLOG (data provider log) to see if there were errors from running the script.

88

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor BusinessObjects using a probe

After the script runs successfully, the script will continue to run at the interval you specified in the metafile (60 seconds in this example).

BusinessObjects Enterprise XI 3.0 Monitoring Guide

89

Monitoring BusinessObjects with IBM Tivoli Configuring Tivoli to monitor BusinessObjects using a probe

90

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with Microsoft Operations Manager (MOM)

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Installing a MOM agent on a BusinessObjects server

This section provides example procedures you can use to configure monitoring for BusinessObjects Enterprise using Microsoft Operations Manager (MOM). In particular, the topics in this chapter describe how to: Install a MOM agent on a BusinessObjects Enterprise server Configure MOM to monitor a BusinessObjects application metric Configure MOM to monitor BusinessObjects using a probe While this section only describes how to implement monitoring for a single component metric and a single probe, the procedures that are described can be used to implement a full monitoring solution that includes multiple system metrics, application metrics, and monitoring probes. When implementing a full monitoring solution that includes multiple systems, components, and metrics it is recommended that you take advantage of MOM computer group and rule group management capabilities. Consult with your MOM administrator and refer to the MOM documentation for more information.

Installing a MOM agent on a BusinessObjects server

The following procedure describes how to install a Microsoft Operations Manager (MOM) agent to a BusinessObjects Enterprise server machine. The server machine in this example is named VANPGWAMU02. 1. Launch the Microsoft Operations Manager (MOM) Administrator Console. 2. Select Administration in the navigation pane. 3. Select Install/Uninstall Agents to start the "Install/Uninstall Agents Wizard". 4. Enter the name of the computers you want MOM to manage. You can type the names manually or use the Browse button to find the computers on your network. Click Next. In this example, an agent is deployed to the two Windows server where BusinessObjects Enterprise is installed (VANPGWAMU02). You can use the Management Server Action account to install the agents unless the machine resides in a domain other than the one the Management Server resides in.

92

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor a BusinessObjects Enterprise application metric

You can use the Local System account for the Agent Action Account unless you require the agent to perform actions that require access to external resources (transfer a file to a share for example). 5. Provide the installation path for the agents. This default installation path is %PROGRAMFILES% on the C:\ drive, which is generally an acceptable installation location. 6. Click Finish to complete the agent installation.

Configuring MOM to monitor a BusinessObjects Enterprise application metric

Create a rule group for BusinessObjects Enterprise application metrics
The following procedure describes how to create a rule group. In this example, a rule group is created to group rules related to BusinessObjects Enterprise application metrics. In a later step, another rule group is created to group rules related to monitoring probes. 1. In the Microsoft Operations Manager (MOM) Administrator Console, right click on Rule Groups and select Create Rule Group. 2. On the Rule Group Properties dialog, provide a name and description for the rule group and enable the Rule Group ID. Click Next. In this example, a rule group named BOE Application Metrics is created. 3. On the "Rule Group Properties - Knowledge Base" dialog, click Next. In this example, the "Rule Group Properties - Knowledge Base" setup option is not used. For more information about this setup option, refer to the MOM documentation. 4. You receive a message dialog asking you if you would like to deploy the rules to a group of computers. Click No. 5. Click Finish.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

93

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor a BusinessObjects Enterprise application metric

Creating a data provider

The following procedure describes how to create a data provider in Microsoft Operations Manager (MOM) for memory usage for the BusinessObjects CMS service. 1. Launch the Microsoft Operations Manager (MOM) Administrator Console. 2. In the navigation pane, select Management Packs > Providers. 3. Right click on Providers and select Create. 4. On the "Select Data Provider Type" dialog, select Windows NT Performance Counter.

5. Click Next. 6. On the "Windows NT Performance Counter Provider Properties - General" dialog, click Browse to select the computer you want to monitor. In this example, the BusinessObjects server, VANPGWAMU02, is selected. 7. Click OK and click Next. 8. On the "Windows NT Performance Counter Provider Properties - General" dialog, specify the following values: Select the Process object from the Object drop-down box. Select CMS from the Instance drop-down box Select Virtual Bytes from the Counter drop-down box

94

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor a BusinessObjects Enterprise application metric

Specify Sample every 5 minutes to have the performance counter run at 5 minute intervals.

9. Click Next. 10. On the "Windows NT Performance Counter Provider Properties Synchronization" dialog, click Finish. Synchronization is not used in this example. Data is collected at the sampling rate specified in the previous step. You now have a data provider for memory usage by the BusinessObjects CMS service. The next step is to create a rule and define an alert for the for the CMS Memory Threshold data provider.

Configuring monitoring for an application metric

The following procedure describes how to configure monitoring for BusinessObjects Enterprise Application metric. In particular, the procedure describes how to create a Performance Rule for BusinessObjects Enterprise CMS memory usage and how to configure an alert if a specified threshold is passed.
Note:

Different types of rules can be created including Event Rules and Alert Rules. Refer to your MOM documentation for information about the types of rules that can be created to monitor various system and application metrics. 1. In the Microsoft Operations Manager (MOM) Administrator Console, select Rule Groups > BOE Application Metrics. This is the rule group you created earlier. 2. Right click on Performance Rules and select Create. 3. On the "Performance Rule Type" dialog, select Compare Performance Data (Threshold).

BusinessObjects Enterprise XI 3.0 Monitoring Guide

95

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor a BusinessObjects Enterprise application metric

4. Click Next. 5. On the "Threshold Rule Properties - Data Provider" dialog, select the provider you defined from the drop-down box.

6. Click Next. 7. On the "Threshold Rule Properties - Schedule" dialog, click Next. 8. On the "Threshold Rules Properties - Criteria" click Next. 9. On the "Threshold Rules Properties - Threshold" dialog, select the sample value as the Threshold value. For Match when the threshold meets the following condition, select greater than the following value and specify 1000000 bytes (100 MB).

96

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor a BusinessObjects Enterprise application metric

10. Click Next. 11. On the "Threshold Rule Properties - Alert" dialog, select the Generate Alert checkbox and select Error as the Alert severity. If CMS memory usage passes the threshold of 100 MBs, an error is logged. 12. Click Next. 13. On the "Threshold Rule Properties - Alert Suppression" dialog select the Suppress duplicate alerts checkbox. Instead of duplicate alerts, the RepeatCount field for the Alert will be incremented by 1 each time the alert is triggered

BusinessObjects Enterprise XI 3.0 Monitoring Guide

97

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor a BusinessObjects Enterprise application metric

14. Click Next. 15. On the "Threshold Rule Properties - Alert" dialog, select Generate Alert, and specify the Alert properties.

98

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor a BusinessObjects Enterprise application metric

16. On the "Threshold Rule Properties - Responses" dialog, define the response actions you want to take when the threshold is passed. Actions include: Launching a script Send an SNMP trap Send a notification to a Notification Group Execute a command or batch file Update sate variable Transfer a file Call a method on a managed code assembly A recommended option is to launch a script that runs the CMS Logon Logoff monitoring probe to run when the CMS memory threshold is passed in order to check whether a user is able to logon the system. The next section describes how to configure MOM to use the CMS Logon Logoff monitoring probe.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

99

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

Configuring MOM to monitor BusinessObjects using a probe

Creating a rule group for monitoring probes
The following procedure describes how to create a rule group for the BusinessObjects Enterprise monitoring probes. 1. In the Microsoft Operations Manager (MOM) Administrator Console, under Management Packs, right click on Rule Groups and select Create Rule Group.

100

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

2. On the Rule Group Properties dialog, provide a name and description for the rule group and enable the Rule Group ID. Click Next. In this example, a rule group named BOE Monitoring Probes Rule Group is created. 3. On the "Rule Group Properties - Knowledge Base" dialog, click Next. In this example, the "Rule Group Properties - Knowledge Base" setup option is not used. For more information about this setup option, refer to the MOM documentation. 4. You receive a message dialog asking you if you would like to deploy the rules to a group of computers. Click No.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

101

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

5. Click Finish.

Preparing a probe configuration file (MOM)

This procedure assumes that you have deployed the BusinessObjects monitoring probes package to your BusinessObjects server. Before you can configure MOM to run a monitoring probe, you must configure a probe configuration file. Because the probe is used with MOM, we will use a special probe configuration file for MOM. Probe configuration files are located in <BOE_IN STALL_DIR>\monitoring\probes\ and have 4mom in the file name (e.g. template_probe1_4mom.xml) A separate MOM probe configuration file is provided for each of the eight monitoring probes (template_probe1_4mom.xml to tem plate_probe8_4mom.xml). If you run a different probe, ensure that you use the correct probe configuration file. In this example, a CMS Logon Logoff probe configuration file for MOM is configured (template_probe1_4mom.xml). 1. Open the CMS Logon Logoff probe configuration template file (tem plate_probe1_4mom.xml) in a text editor. The CMS Logon Logoff probe configuration template file is located in the <BOE_INSTALL_DIR>\monitor ing\probes\ directory. The template file appears similar to the following:
<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeLogonLogoff'> <connector>totext4mom.xsl</connector> </probeconfig>

2. Change the user, password, system, and authtype parameters as required for your BusinessObjects server. In this example, the configuration file is modified as follows:
<probeconfig user='BOEuser' password='mypassword' sys tem='CDI5BOE' authtype='secEnterprise' classname='ProbeLo gonLogoff'>

102

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

<connector>totext4mom.xsl</connector> </probeconfig>

Note:

The classname parameter specifies the probe that will be run. 3. Save the CMS Logon Logoff MOM probe configuration file to the moni toring directory on the BusinessObjects server. In this example, the configuration file is saved to the C:\Program Files\BusinessObjects\monitoring\ directory. You are now prepared to configure MOM to run the CMS Logon Logoff probe.
Note:

The BusinessObjects directory may be different for your environment depending on where you have installed BusinessObjects Enterprise. Since you are running the probe on Windows, monitoring.bat command is used in the command line execution statement. If you were configuring a probe to run on a UNIX system, the monitoring.sh command would be used.

You can verify that the probe is configured properly by running the command line statement directly from a command window on your BusinessObjects server.
Related Topics

CMS Logon Logoff probe on page 132

Inputting the probe response script

The following procedure describes how to create a script in MOM that is used to launch a BusinessObjects monitoring probe. The script is provided to you as part of the monitoring probe package. In the procedure following this one you will define an event that will run at a timed interval, which in turn, launches the monitoring probe. 1. In the Microsoft Operations Manager (MOM) Administrator Console, under Management Packs, select Scripts, right click, and select Create Script. 2. On the "Script Properties" dialog, on the General tab, provide the script name, description, and script language. In this example, the name of the BusinessObjects monitoring probe is entered, and VBScript is specified as the script language.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

103

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

3. On the "Script" dialog, paste the script for the monitoring probe. Click Apply and OK. The probe script is provided in a text file in the BusinessObjects monitoring probes directory located at <BOE_INSTALL_DIR>\monitoring\connec tors\momscript4boe.txt. The script should be copied directly. Do not modify.

104

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

4. On the Parameters tab, specify the parameters to be passed to the script. For BusinessObjects Enterprise monitoring probes, you must specify the following parameters: Monitoring_Install_Folder: This is the location where the BusinessObjects Enterprise monitoring probes are installed. In this example the following value is specified: C:\Program
Files\BusinessObjects\monitoring

Probe_file_name: This is the name of the monitoring probe configuration file where you have specified monitoring probe parameters. In this example, the configuration file for the CMS Logon Logoff probe configuration file is named template_probe1_4mom.xml

5. Click OK to close the "Script Properties" dialog.

Specifying the Event Rule and Data Provider

The following procedure describes how to create a timed event that will launch the monitoring probe script that you created in the previous step. The script will, in turn, launch the BusinessObjects monitoring probe.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

105

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

1. In the Microsoft Operations Manager (MOM) Administrator Console, under Management Packs > Rule Groups > BOE Monitoring Probes Rule Group right click on Event Rules and select Create Event Rule. 2. On the "Select and Event Rule Type" dialog, select Alert on or Respond to Event (Event) and click Next.

3. On the Event Rule Properties - Data Provider dialog, click New to create a new provider. 4. In the "Select Provider Type" dialog, select Timed Event and click OK.

106

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

5. On the "Timed Event Provider Properties - Schedule" dialog, specify a schedule frequency to generate the event and click Finish, then click Next. A 15 minute interval is specified.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

107

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

6. On the "Event Rule Properties - Schedule" dialog, you can specify an optional schedule for the Event rule. In this example, no optional schedule is entered indicating that the rule will always be active. Click Next. 7. On the "Event Rule Properties - Alert Suppression" dialog, you can choose to suppress duplicate alerts. In this example, duplicate alerts are allowed. Click Next. 8. On the "Event Rule Properties - Responses" dialog, you can define the response actions you want to take when a match occurs. In this example, the Launch a script option is selected. Click Add and select Launch a script. 9. On the "Launch script" dialog, select the monitoring probe script from the Script name drop-down box. This is the monitoring probe you defined earlier. Click OK.

108

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

10. Click Next. 11. On the "Event Rule - Knowledge Base" dialog, click Next. 12. On the "Event Rule Properties - General" dialog, Enter a Rule Name and enable the Rule by selecting the This rule is enabled checkbox. Click Finish.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

109

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

Viewing probe events in the MOM Operator Console

After you have configured a probe to run in Microsoft Operations Manager (MOM), you can view probe events in the MOM Operator Console. The following examples show probe events for a successful CMS Logon Logoff probe, a failed Desktop Intelligence Service probe, and a failed Crystal Reports through Cache Server probe.
CMS Logon Logoff probe success

An Information event in the MOM Operator Console shows that the CMS Logon Logoff probe has run successfully.

110

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

Desktop Intelligence Server probe failure

An Error event in the MOM Operator Console shows a Desktop Intelligence Server probe failure. The failure occurs because no server is available to process the request to run the probe.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

111

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

Crystal Reports through Page and Cache Server probe failure

An Error event in the MOM Operator Console shows Crystal Reports through Page and Cache Server probe failure. The Mail Labels report which the probe is configured to run cannot be found. This error could be due to a number of reasons including an incorrect Document Name or Document ID parameter specified in the probe configuration file, the report being moved or deleted, or the user not having rights required to access the report.

112

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

BusinessObjects Enterprise XI 3.0 Monitoring Guide

113

Monitoring BusinessObjects with Microsoft Operations Manager (MOM) Configuring MOM to monitor BusinessObjects using a probe

114

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Components and metrics reference

Components and metrics reference BusinessObjects Enterprise components and metrics

BusinessObjects Enterprise components and metrics

The following table describes recommended BusinessObjects Enterprise application components and associated metrics.

116

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Components and metrics reference BusinessObjects Enterprise components and metrics

Component

Metric Service availability CPU usage: 30 % Disk Read Time: 95% Disk Write Time: 5% Virtual memory size: 45MB + See comment Login time: (e.g. 7 seconds)

Details

CMS Windows: CMS.exe Linux and UNIX: boe_cmsd

The Percent of Disk Read and Write Times are based on performance load testing of a two-machine BusinessObjects server cluster (4 CPUs per server) running 250 to 300 concurrent users. The memory size for the CMS is controlled by the number of objects stored in the CMS cache. It is best to determine the appropriate memory based on setting this parameter and testing for the appropriate value for your deployment. To monitor login time, establish an acceptable baseline time for your environment and measure against it.

Server Intelligence Agent

Windows: sia.exe Linux and UNIX:
restart.sh

Service availability CPU usage: 35 % Disk Read Time: 50% Disk Write Time: 15% Virtual memory size: 100MB Service availability Disk read time: 85% Disk write time: 15%

BusinessObjects Enterprise XI 3.0 Monitoring Guide

117

Components and metrics reference BusinessObjects Enterprise components and metrics

Component

Metric

Details

Input FRS Windows: input

fileserver.exe

Linux and UNIX: boe_filesd

The Percent of Disk Read and Write Times are based on performance load testing of a two-machine BusinessObjects server cluster (4 CPUs per server) running 250 to 300 concurrent users.
Service availability Disk read time: 60% Disk write time: 40%

Output FRS Windows: output

fileserver.exe

Linux and UNIX: boe_filesd

The Percent of Disk Read and Write Times are based on performance load testing of a two-machine BusinessObjects server cluster (4 CPUs per server) running 250 to 300 concurrent users. The Percent of Disk Read and Write Times are based on performance load testing of a two-machine BusinessObjects server cluster (4 CPUs per server) running 250 to 300 concurrent users.

Crystal Report Cache Server Windows:

cacheserver.exe

Linux and UNIX: boe_cachesd

Service availability CPU usage: 50% Virtual memory size: 1MB / simultaneous process request + 17MB base size Disk read time: 35% Disk write time: 65%

118

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Components and metrics reference BusinessObjects Enterprise components and metrics

Component

Metric Service availability CPU usage: 50% Disk read time: 40% Disk write time: 60%

Details

Desktop Intelligence Cache Server Windows: fc

cache.exe

Linux and UNIX: boe_fccached

The Percent of Disk Read and Write Times are based on performance load testing of a two-machine BusinessObjects server cluster (4 CPUs per server) running 250 to 300 concurrent users. The Percent of Disk Read and Write Times are based on performance load testing of a two-machine BusinessObjects server cluster (4 CPUs per server) running 250 to 300 concurrent users. The memory used by the Desktop Intelligence Report Server will vary depending upon the type of actions performed by the users (view, modify, refresh). The most demand is placed on the process by the refresh actions. It would be best to identify a baseline from initial frequent monitoring.

Desktop Intelligence Report Server Windows:

fcproc.exe

Linux and UNIX: boe_fcprocd

Service availability CPU usage: 65% Disk Read Time: 60% Disk Write Time: 40% Virtual memory Size: 35MB + See comment

BusinessObjects Enterprise XI 3.0 Monitoring Guide

119

Components and metrics reference BusinessObjects Enterprise components and metrics

Component

Metric Service availability CPU usage: 15% Virtual memory Size: 15MB base + See comment

Details

Desktop Intelligence Job Server Windows: Job

ServerFull client.exe

Linux and UNIX: boe_jobsd

The Desktop Intelligence Job Server acts as a scheduling manager for Desktop Intelligence reports. Memory usage for this process will be determined based on the number of scheduled Desktop Intelligence reports. It would be best to identify a baseline from initial frequent monitoring.

List of Values Job Serv- er Windows: pro

cLov.exe

Linux and UNIX: boe_jobsd

Service availability CPU usage: 15% Virtual memory size: (LOV Report Size * 40) * # of LOV Reports

Web Intelligence Job Server Windows: procWe

bi.exe

Linux and UNIX: boe_jobd

Service availability CPU usage: 15% Virtual memory size: 15MB base + see comment

The Web Intelligence Job Server acts as a scheduling manager for Web Intelligence reports. Memory usage for this process will be determined based on the number of scheduled Web Intelligence reports. It would be best to identify a baseline from initial frequent monitoring.

120

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Components and metrics reference BusinessObjects Enterprise components and metrics

Component

Metric service availability CPU usage: 65% Disk Read Time: 95% Disk Write Time: 5% Virtual memory Size: 50MB + See comment

Details

Web Intelligence Report Server Windows: WIReport

Server.exe

Linux and UNIX: WIReportServer

The Percent of Disk Read and Write Times are based on performance load testing of a two-machine BusinessObjects server cluster (4 CPUs per server) running 250 to 300 concurrent users. The memory used by the Web Intelligence Report Server will vary depending upon the type of actions performed by the users (view, modify, refresh). The most demand is placed on the process by the refresh actions. It would be best to identify a baseline from initial frequent monitoring.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

121

Components and metrics reference Web Application Server components and metrics

Component

Metric Service availability CPU usage: 15% Virtual memory size: (Average report size * 40) * Max. Simultaneous report jobs

Details

Crystal Report Job Server Windows: JobServ

er.exe

Linux and UNIX: boe_jobsd

Crystal Report Page Server Windows: pageserv

er.exe

Linux and UNIX: boe_pagesd

Service availability CPU usage: 65% Virtual memory Size: (Average report size * 40) * Max. Simultaneous report jobs

Report Application Server Windows: crystal

ras.exe

Linux and UNIX: boe_crystalrasd

Service availability CPU usage: 65% Virtual memory size: (Average Report Size * 40) * Max. Simultaneous report jobs

Memory usage for the Program Job Server will fluctuate depending upon the program that is being executed. It is best to monitor the memory usage during a run of the program and determine what is to be expected.

Web Application Server components and metrics

The following table describes recommended Web Application Server components, JVM components, and associated metrics.

122

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Components and metrics reference System level components and metrics

Web Application Server Metric Availability Response Time Number of sessions Details Can the web application server process requests outside of Business Objects? How long does it take the web application server to serve a request outside of Business Objects? The number of sessions running at the web server should be monitored to see if there is a plateau, which may indicate a bottleneck and a need for an additional web server.

Java Virtual Machine (JVM) Metric Number of threads Memory Size Details The number of threads running at the web server should be monitored to see if there is a plateau, which would indicate a bottleneck and the need for another web server. It is important to monitor the memory size for the JVM as this can be a very demanding process on system memory.

System level components and metrics

The following table describes recommended system level components and associated metrics.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

123

Components and metrics reference System level components and metrics

CPU Metric Average utilization Load average User CPU System CPU Run queue I/O wait time Threshold Less than 85% 6 Less than 90% Less than user CPU Less than 2 per CPU Less than 30% Linux/UNIX Details

Memory Metric Average utilization Swap space available Page-out rate per second Swap rate (thrashing) Swap space utilization Threshold 3% of total 70% 60 1 per day Less than 90% Details

Network Metric Threshold Details

Ping time (laten- Less than cy) 100ms Collisions Bytes received per second Less than 15% See details Should increase proportionally with load. A lessthan-linear increase indicates a limitation of network capacity. A greater-than-linear increase indicates inefficient use of the network capacity.

124

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Components and metrics reference Database components and metrics

Metric Bytes sent per second

Threshold Details See details Should increase proportionally with load. A lessthan-linear increase indicates a limitation of network capacity. A greater-than-linear increase indicates inefficient use of the network capacity.

Disk I/O Metric Threshold Details A plateau may indicate a bottleneck. A plateau may indicate a bottleneck.

Disk reads per second No available threshold Disk writes per second No available threshold Percent busy Queue length Average service time Less than 35% Less than 1 Less than 30ms

File system space Metric Threshold Details File system space should be monitored for all disks that are part of your system architecture. Recommendations include but are not limited to file system space for: Operating systems BusinessObjects Enterprise binaries Input/Ouput FRS Web application servers Database servers Log files Temporary space

Free space Less than 85%

BusinessObjects Enterprise XI 3.0 Monitoring Guide

125

Components and metrics reference Availability monitoring example

Database components and metrics

Database

The following table describes recommended database metrics.

Metric Availability Response time Details Is the database responding to requests outside of Business Objects? How long does it take the database server to serve a request outside of Business Objects?

Percentage of requests E.g. Greater than or equal to 90% (this target may serviced from cache differ depending on your system requirements). Lock waits A small number of lock waits is not uncommon. Attention should be placed on the frequency of lock waits measured over time. The length of time that a query is allowed to run will be different for each system. The threshold for this metric is determined by establishing a baseline measure for average query time and monitoring for queries that run beyond an upper limit based on average query time.

Long running queries

Availability monitoring example

The following tables show an availability monitoring example for a typical BusinessObjects Enterprise system that includes a BusinessObjects server, web application server, authentication server, and database servers. Availability monitoring is recommended as a basic monitoring solution or as a first stage in a more comprehensive solution. For several BusinessObjects services, monitoring includes basic process monitoring (to ensure that a service is active) and monitoring using BusinessObjects monitoring probes. In addition to monitoring service's availability, monitoring probes provide data that lets you know that a service is functioning.

126

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Components and metrics reference Availability monitoring example

For more information about monitoring probes refer to the BusinessObjects monitoring probes section in this guide.
Note:

The following is only an example. Your system components and monitoring requirements may differ from this example.
Monitoring activity CMS Availability 24/7 Monitor CMS process Run CMS Ping probe Monitor Input FRS process Run Crystal Reports Service through Page and Cache Server probe on noninstance report Monitor Output FRS process Run Crystal Reports Service through Page and Cache Server probe on noninstance report

Component

Metric

Target

Input FRS Availability 24/7

Output FRS Availability 24/7

BusinessObjects Enterprise XI 3.0 Monitoring Guide

127

Components and metrics reference Availability monitoring example

Component

Metric

Target

Monitoring activity Monitor Crystal Reports Cache Server process Run Crystal Reports Service through Page and Cache Server probe Monitor Crystal Reports Page Server process Run Crystal Reports Service through Page and Cache Server probe

Crystal Reports Cache Server

Availability 24/7

Crystal Reports Page Server

Availability 24/7

Crystal Reports Job Server

Availability

24/7

Monitor Crystal Reports Job Server process Monitor Report Application Server process Run Crystal Reports through RAS probe

Report Application Availability Server

24/7

Desktop IntelliAvailability gence Job Server

24/7

Monitor Desktop Intelligence Job Server process

128

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Components and metrics reference Availability monitoring example

Component

Metric

Target

Monitoring activity Monitor Desktop Intelligence Cache Server process Run Desktop Intelligence Server probe Monitor Desktop Intelligence Report Server process Run Desktop Intelligence Server probe Monitor Web Intelligence Report Server process Run Web Intelligence Service probe

Desktop Intelligence Cache Server

Availability

24/7

Desktop Intelligence Report Server

Availability

24/7

Web Intelligence Report Server

Availability

24/7

Web Intelligence Job Server

Availability

24/7

Monitor Web Intelligence Job Server process Monitor List of Values Job Server process Monitor the Server Intelligence Agent process

List of Values Job Availability Server

24/7

Server Intelligence Availability Agent (XI 3.0 only)

24/7

BusinessObjects Enterprise XI 3.0 Monitoring Guide

129

Components and metrics reference Availability monitoring example

Component Web application server

Metrics

Target

Monitoring activity Send HTTP request for a static file that belongs to the InfoView web application. Example: http://<server
name>:<serverport>/In foViewApp/res/schema.blie/ban ner_log.gif

Availabili- 24/7 ty

Send HTTP request for a dynamic file that belongs to the InfoView web application. Example: http://<server
name>:<serverport>/In foViewApp/jsp/list ing/blank.jsp

Component

Metrics

Target

Monitoring activity Run CMS Logon Logoff probe using Windows AD authentication

Authentication server Availabili- 24/7 ty

Component

Metrics

Target

Monitoring activity Run CMS database connection probe

CMS database server Availabili- 24/7 ty

Component Corporate database server Related Topics

Metrics

Target

Monitoring activity Run SQL query outside of BusinessObjects

Availabili- 24/7 ty

Staging your monitoring implementation on page 22

130

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring probe reference

Monitoring probe reference CMS Logon Logoff probe

CMS Logon Logoff probe

Description

The CMS Logon Logoff probe tests the availability of the Central Management Server (CMS) and the ability of users to log on to the system through client applications. The probe logs on a single user, tests session validity, and logs off the user.
Probe attributes

user, password, system, authtype, classname

Probe parameters

None
Sample command line usage

Specifying attributes and parameters dynamically:

monitoring.bat -probeconfig "<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeLogonLogoff' />"

Calling a configuration file:

monitoring.bat -probefile template_probe1.xml

Note:

On UNIX, monitoring.sh is used instead of monitoring.bat.

template_probe1.xml is the name of the monitoring probe configuration

file.

Sample web usage

Specifying attributes and parameters dynamically:

http://webserver:8080/monitoring/monitoring?probecon fig=http://webserver:8080/monitoring/monitoring?probecon

132

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring probe reference Crystal Reports service through Page and Cache Server probe

fig=<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeLogonLogoff' />

where webserver:8080 is the name and port number where the monitoring web application component (monitoring.war) is deployed. Calling a configuration file:
http://webserver:8080/monitoring/monitoring?probefile=tem plate_probe1.xml

Note:
template_probe1.xml is the name of the monitoring probe configuration

file.

Sample configuration file

<probeconfig user='bobjuser' password='bobjpassword' system='servername' authtype='secEnterprise' classname='ProbeLogonLogoff' />

Related Topics

Monitoring probe attributes and parameters on page 46

Crystal Reports service through Page and Cache Server probe

Description

This probe tests the availability of the Crystal Reports service through Crystal Reports Page Servers and Cache Servers. Using the Crystal Reports Page and Cache Servers, the probe opens a report, refreshes the report, optionally exports the report to PDF format, and closes the report.
Probe attributes

user, password, system, authtype, classname

Probe parameters

Document ID

BusinessObjects Enterprise XI 3.0 Monitoring Guide

133

Monitoring probe reference Crystal Reports service through Page and Cache Server probe

Document name Refresh document PDF export

Sample command line usage

Specifying attributes and parameters dynamically:

monitoring.bat -probeconfig "<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeCRPageServer'><param type='int' value='656'/> <param type='boolean' value='true'/><param type='boolean' val ue='true' /> </probeconfig>"

Calling a configuration file:

monitoring.bat -probefile template_probe2.xml

Note:

On UNIX, monitoring.sh is used instead of monitoring.bat.

template_probe2.xml is the name of the monitoring probe configuration

file.

Sample web usage

Specifying attributes and parameters dynamically:

http://webserver:8080/monitoring/monitoring?probecon fig=http://webserver:8080/monitoring/monitoring?probecon fig=<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeCRPageServer'><param type='int' value='656'/> <param type='boolean' value='true'/><param type='boolean' val ue='true' /> </probeconfig>

where webserver:8080 is the name and port number where the monitoring web application component (monitoring.war) is deployed. Calling a configuration file:
http://webserver:8080/monitoring/monitoring?probefile=tem plate_probe2.xml

134

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring probe reference Crystal Reports service through Page and Cache Server probe

Sample configuration file

<probeconfig user='bobjuser' password='bobjpassword' sys tem='servername' authtype='secEnterprise' classname='ProbeCR PageServer'> <!-- Uncomment one of the search options: cuid, docid, name-> <!-- Enter in the correct value afterwards--> <!-- CUID identifier for document--> <!-<param type='java.lang.String' value='ASHeDJIWZSBAmtwnFIWGybs' /> --> <!-- DOCID identifier for document--> <!-<param type='int' value='656' /> --> <!-- NAME of document--> <param type='java.lang.String' value='Mail Labels' /> <!--Document display options--> <!-- REFRESH document select true or false --> <param type='boolean' value='false' /> <!-- PDFEXPORT document select true or false --> <param type='boolean' value='false' /> </probeconfig>

Note:

The monitoring probe searches for a report to run using one of the following three search options: CUID, document name, or document ID. Use only one search option by uncommenting it and providing the required value. In the example above, the document name option is used.
Related Topics

Monitoring probe attributes and parameters on page 46

BusinessObjects Enterprise XI 3.0 Monitoring Guide

135

Monitoring probe reference Crystal Reports Service through Report Application Server

Crystal Reports Service through Report Application Server

Description

This probe tests the availability of the Crystal Report service through the Report Application Servers. Using the Report Application Servers, the probe opens a report, optionally exports the report to PDF format, and closes the report.
Probe attributes

user, password, system, authtype, classname

Probe parameters

Document ID Document name Refresh document PDF export

Sample command line usage

Specifying attributes and parameters dynamically:

monitoring.bat -probeconfig "<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeCRRAS'><param type='int' value='656'/> <param type='boolean' value='true'/><param type='boolean' val ue='true' /> </probeconfig>"

Calling a configuration file:

monitoring.bat -probefile template_probe3.xml

Note:

On UNIX, monitoring.sh is used instead of monitoring.bat.

136

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring probe reference Crystal Reports Service through Report Application Server

template_probe3.xml is the name of the monitoring probe configuration

file.

Sample web usage

Specifying attributes and parameters dynamically:

http://webserver:8080/monitoring/monitoring?probecon fig=http://webserver:8080/monitoring/monitoring?probecon fig=<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeCRRAS'><param type='int' value='656'/> <param type='boolean' value='true'/><param type='boolean' val ue='true' /> </probeconfig>

where webserver:8080 is the name and port number where the monitoring web application component (monitoring.war) is deployed. Calling a configuration file:
http://webserver:8080/monitoring/monitoring?probefile=tem plate_probe3.xml

Sample configuration file

<probeconfig user='bobjuser' password='bobjpassword' sys tem='servername' authtype='secEnterprise' classname='ProbeCR RAS'> <!-- Uncomment one of the search options: cuid, docid, name-> <!-- Enter in the correct value afterwards--> <!-- CUID identifier for document--> <!-<param type='java.lang.String' value='ASHeDJIWZSBAmtwnFIWGybs' /> --> <!-- DOCID identifier for document--> <!-<param type='int' value='656' /> --> <!-- NAME of document--> <param type='java.lang.String' value='Mail Labels' /> <!--Document display options--> <!-- REFRESH document select true or false -->

BusinessObjects Enterprise XI 3.0 Monitoring Guide

137

Monitoring probe reference Desktop Intelligence Service probe

<param type='boolean' value='false' /> <!-- PDFEXPORT document select true or false --> <param type='boolean' value='false' /> </probeconfig>

Note:

The monitoring probe searches for a report to run using one of the following three search options: CUID, document name, or document ID. Use only one search option by uncommenting it and providing the required value. In the example above, the document name option is used.
Related Topics

Monitoring probe attributes and parameters on page 46

Desktop Intelligence Service probe

Description

This probe tests the availability of the Desktop Intelligence service through Desktop Intelligence Report Servers. The probe opens a Desktop Intelligence document, refreshes it, optionally exports the document to XLS and PDF format, and closes the document.
Probe attributes

user, password, system, authtype, classname

Probe parameters

Document ID Document name Refresh document PDF export Excel Spreadsheet (.xls) export

Sample command line usage

Specifying attributes and parameters dynamically:

monitoring.bat -probeconfig "<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise'

138

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring probe reference Desktop Intelligence Service probe

classname='ProbeDeski'><param type='int' value='656'/> <param type='boolean' value='true'/><param type='boolean' val ue='true' /> </probeconfig>"

Calling a configuration file:

monitoring.bat -probefile template_probe4.xml

Note:

On UNIX, monitoring.sh is used instead of monitoring.bat.

template_probe4.xml is the name of the monitoring probe configuration

file.

Sample web usage

Specifying attributes and parameters dynamically:

http://webserver:8080/monitoring/monitoring?probecon fig=http://webserver:8080/monitoring/monitoring?probecon fig=<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeDeski'><param type='int' value='656'/> <param type='boolean' value='true'/><param type='boolean' val ue='true' /> </probeconfig>

where webserver:8080 is the name and port number where the monitoring web application component (monitoring.war) is deployed. Calling a configuration file:
http://webserver:8080/monitoring/monitoring?probefile=tem plate_probe4.xml

Sample configuration file

<probeconfig user='bobjuser' password='bobjpassword' sys tem='servername' authtype='secEnterprise' classname='ProbeDes ki'> <!-- Uncomment one of the search options: cuid, docid, name-> <!-- Enter in the correct value afterwards-->

BusinessObjects Enterprise XI 3.0 Monitoring Guide

139

Monitoring probe reference Web Intelligence Service probe

<!-- CUID identifier for document--> <!-<param type='java.lang.String' value='ASHeDJIWZSBAmtwnFIWGybs' /> --> <!-- DOCID identifier for document--> <param type='int' value='5852' /> <!-- NAME of document--> <!-<param type='java.lang.String' value='Mail Labels' /> --> <!--Document display options--> <!-- REFRESH document select true or false --> <param type='boolean' value='true' /> <!-- PDFEXPORT document select true or false --> <param type='boolean' value='false' /> <!-- XLSEXPORT document select true or false --> <param type='boolean' value='false' /> </probeconfig>

Note:

The monitoring probe searches for a report to run using one of the following three search options: CUID, document name, or document ID. Use only one search option by uncommenting it and providing the required value. In the example above, the document name option is used.
Related Topics

Monitoring probe attributes and parameters on page 46

Web Intelligence Service probe

Description

This probe tests the availability of the Web Intelligence service through Web Intelligence Report Servers. The probe opens a Web Intelligence document, refreshes it, optionally exports the document to XLS and PDF format, and closes the document.
Probe attributes

user, password, system, authtype, classname

140

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring probe reference Web Intelligence Service probe

Probe parameters

Document ID Document name Refresh document PDF export Excel Spreadsheet (.xls) export

Sample command line usage

Specifying attributes and parameters dynamically:

monitoring.bat -probeconfig "<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeWebi'><param type='int' value='656'/> <param type='boolean' value='true'/><param type='boolean' val ue='true' /> </probeconfig>"

Calling a configuration file:

monitoring.bat -probefile template_probe5.xml

Note:

On UNIX, monitoring.sh is used instead of monitoring.bat.

template_probe5.xml is the name of the monitoring probe configuration

file.

Sample web usage

Specifying attributes and parameters dynamically:

http://webserver:8080/monitoring/monitoring?probecon fig=http://webserver:8080/monitoring/monitoring?probecon fig=<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeWebi'><param type='int' value='656'/> <param type='boolean' value='true'/><param type='boolean' val ue='true' /> </probeconfig>

where webserver:8080 is the name and port number where the monitoring web application component (monitoring.war) is deployed.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

141

Monitoring probe reference Web Intelligence Service probe

Calling a configuration file:

http://webserver:8080/monitoring/monitoring?probefile=tem plate_probe5.xml

Sample configuration file

<probeconfig user='bobjuser' password='bobjpassword' sys tem='servername' authtype='secEnterprise' classname='ProbeWebi'> <!-- document id --> <!-- Uncomment one of the search options: cuid, docid, name-> <!-- Enter in the correct value afterwards--> <!-- CUID identifier for document--> <!-<param type='java.lang.String' value='ASHeDJIWZSBAmtwnFIWGybs' /> --> <!-- DOCID identifier for document--> <param type='int' value='6506' /> <!-- NAME of document--> <!-<param type='java.lang.String' value='Mail Labels' /> --> <!--Document display options--> <!-- REFRESH document select true or false --> <param type='boolean' value='true' /> <!-- PDFEXPORT document select true or false --> <param type='boolean' value='false' /> <!-- XLSEXPORT document select true or false --> <param type='boolean' value='false' /> </probeconfig>

Note:

The monitoring probe searches for a report to run using one of the following three search options: CUID, document name, or document ID. Use only one search option by uncommenting it and providing the required value. In the example above, the document name option is used.
Related Topics

Monitoring probe attributes and parameters on page 46

142

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring probe reference CMS ping probe

CMS ping probe

Description

This probe sends an empty query to the CMS. The test is considered successful if the CMS returns a parse failure error. Because query parsing is part of CMS core functionality, the test is expected to complete quickly.
Probe attributes

user, password, system, authtype, classname

Probe parameters

None
Sample command line usage

Specifying attributes and parameters dynamically:

monitoring.bat -probeconfig "<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeCMSQuery1' />"

Calling a configuration file:

monitoring.bat -probefile template_probe6.xml

Note:

On UNIX, monitoring.sh is used instead of monitoring.bat.

template_probe6.xml is the name of the monitoring probe configuration

file.

Sample web usage

Specifying attributes and parameters dynamically:

http://webserver:8080/monitoring/monitoring?probecon fig=http://webserver:8080/monitoring/monitoring?probecon

BusinessObjects Enterprise XI 3.0 Monitoring Guide

143

Monitoring probe reference CMS cache probe

fig=<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeCMSQuery1' />

where webserver:8080 is the name and port number where the monitoring web application component (monitoring.war) is deployed. Calling a configuration file:
http://webserver:8080/monitoring/monitoring?probefile=tem plate_probe6.xml

Sample configuration file

<probeconfig user='bobjuser' password='bobjpassword' system='servername' authtype='secEnterprise' classname='ProbeCMSQuery1' />

Related Topics

Monitoring probe attributes and parameters on page 46

CMS cache probe

Description

This probe tests the availability and health of the CMS cache by executing the following query:
select SI_NAME from CI_SYSTEMOBJS where SI_ID=4

This query returns the system InfoObject that contains the CMS cluster name. After a warm-up period, it is expected that the CMS retrieves the system InfoObject from the cache rather than the repository database. If the query fails, the cache may not be functioning properly or the cluster definition may be incorrect.
Probe attributes

user, password, system, authtype, classname

Probe parameters

None

144

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring probe reference CMS cache probe

Sample command line usage

Specifying attributes and parameters dynamically:

monitoring.bat -probeconfig "<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeCMSQuery2' />"

Calling a configuration file:

monitoring.bat -probefile template_probe7.xml

Note:

On UNIX, monitoring.sh is used instead of monitoring.bat.

template_probe7.xml is the name of the monitoring probe configuration

file.

Sample web usage

Specifying attributes and parameters dynamically:

http://webserver:8080/monitoring/monitoring?probecon fig=http://webserver:8080/monitoring/monitoring?probecon fig=<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeCMSQuery2' />

where webserver:8080 is the name and port number where the monitoring web application component (monitoring.war) is deployed. Calling a configuration file:
http://webserver:8080/monitoring/monitoring?probefile=tem plate_probe7.xml

Sample configuration file

<probeconfig user='bobjuser' password='bobjpassword' system='servername' authtype='secEnterprise' classname='ProbeCMSQuery2' />

Related Topics

Monitoring probe attributes and parameters on page 46

BusinessObjects Enterprise XI 3.0 Monitoring Guide

145

Monitoring probe reference CMS database connection probe

CMS database connection probe

Description

This probe tests the availability of the repository database by executing the following query:
select SI_NAME from CI_SYSTEMOBJS where SI_OBTYPE=13

This query returns the system InfoObject which contains the CMS cluster name. The CMS retrieves the system InfoObject from the repository database. If this query fails there may be a connection problem between the CMS server and repository database.
Probe attributes

user, password, system, authtype, classname

Probe parameters

None
Sample command line usage

Specifying attributes and parameters dynamically:

monitoring.bat -probeconfig "<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeCMSQuery3' />"

Calling a configuration file:

monitoring.bat -probefile template_probe8.xml

Note:

On UNIX, monitoring.sh is used instead of monitoring.bat.

template_probe8.xml is the name of the monitoring probe configuration

file.

146

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Monitoring probe reference CMS database connection probe

Sample web usage

Specifying attributes and parameters dynamically:

http://webserver:8080/monitoring/monitoring?probecon fig=http://webserver:8080/monitoring?probeconfig=<probeconfig user='jdoe' password='jdoepwd' system='plbvm01' authtype='secEnterprise' classname='ProbeCMSQuery3' />

where webserver:8080 is the name and port number where the monitoring web application component (monitoring.war) is deployed. Calling a configuration file:
http://webserver:8080/monitoring/monitoring?probefile=tem plate_probe8.xml

Sample configuration file

<probeconfig user='bobjuser' password='bobjpassword' system='servername' authtype='secEnterprise' classname='ProbeCMSQuery3' />

Related Topics

Monitoring probe attributes and parameters on page 46

BusinessObjects Enterprise XI 3.0 Monitoring Guide

147

Monitoring probe reference CMS database connection probe

148

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Get More Help

Get More Help

Online documentation library

Business Objects offers a full documentation set covering all products and their deployment. The online documentation library has the most up-to-date version of the Business Objects product documentation. You can browse the library contents, do full-text searches, read guides on line, and download PDF versions. The library is updated regularly with new content as it becomes available. To access the online documentation library, visit http://help.sap.com/ and click Business Objects at the top of the page.
Additional developer resources

https://boc.sdn.sap.com/developer/library/
Online customer support

The Business Objects Customer Support web site contains information about Customer Support programs and services. It also has links to a wide range of technical information including knowledgebase articles, downloads, and support forums. http://www.businessobjects.com/support/
Looking for the best deployment solution for your company?

Business Objects consultants can accompany you from the initial analysis stage to the delivery of your deployment project. Expertise is available in relational and multidimensional databases, in connectivities, database design tools, customized embedding technology, and more. For more information, contact your local sales office, or contact us at: http://www.businessobjects.com/services/consulting/
Looking for training options?

From traditional classroom learning to targeted e-learning seminars, we can offer a training package to suit your learning needs and preferred learning style. Find more information on the Business Objects Education web site: http://www.businessobjects.com/services/training

150

BusinessObjects Enterprise XI 3.0 Monitoring Guide

Get More Help

Send us your feedback

Do you have a suggestion on how we can improve our documentation? Is there something you particularly like or have found useful? Drop us a line, and we will do our best to ensure that your suggestion is included in the next release of our documentation: [email protected]
Note:

If your issue concerns a Business Objects product and not the documentation, please contact our Customer Support experts. For information about Customer Support visit: http://www.businessobjects.com/support/.

Business Objects product information

For information about the full range of Business Objects products, visit: http://www.businessobjects.com.

BusinessObjects Enterprise XI 3.0 Monitoring Guide

151

Get More Help

152

BusinessObjects Enterprise XI 3.0 Monitoring Guide