Skip to Content

This Quick Tutorial is the first in a three part series that also includes:




BusinessObjects recently released a Monitoring Add-On for BusinessObjects Enterprise. The Monitoring Add-On is a set of scripts (a.k.a “monitoring probes”) you can use to monitor functionality and performance of your BusinessObjects Enterprise system.

The BusinessObjects Enterprise Monitoring Add-On is currently available for download at:

This “Quick Tutorial” is in three parts:

• Part 1: A brief introduction to monitoring probes
• Part 2: Deploying the monitoring probes to a Windows system
• Part 3: Running a monitoring probe




Part 1: A brief Introduction to monitoring probes

There are eight monitoring probes that can be used to monitor different aspects of your system. These include:


(1) CMS Logon Logoff probe: Monitor if a user can successfully log on to the BusinessObjects system and how long it takes

(2) Crystal Reports service through Page and Cache Server probe:  Monitor the availability and performance of the Crystal Reports service (through the page and cache servers)

(3) Crystal Reports service through Report Application Server probe: Monitor the availability and performance of the Crystal Reports service (through RAS)

(4) Desktop Intelligence Service probe: Monitor the availability and performance of the Desktop Intelligence Service through the report servers

(5) Web Intelligence Service Monitoring probe: Test the availability and performance of the Web Intelligence Service through the report servers

(6) CMS Ping probe: Test the core functionality of the CMS

(7) CMS Cache probe: Test the availability of the CMS cache

(8) CMS Database Connection probe: Test the connection to the CMS repository


  • You can run the monitoring probes from a command line or through a web browser (i.e. web mode).
  • Monitoring probes have attributes for defining user name, password, authentication type, etc.
  • Monitoring probes for Crystal Reports, Desktop Intelligence, and Web Intelligence require a report to run. These probes include report-related parameters.
  • Monitoring probe attributes and parameters are defined in a “monitoring probe configuration file”

In Part 2 of this tutorial we will deploy the Monitoring Add-On package to a BusinessObjects Enterprise system.




Part 2: Deploying the monitoring probes to a Windows system

The Monitoring Add-On is available for both UNIX and Windows systems. In this tutorial, we deploy the XI 3 Monitoring-Add-On package on a Windows system.

The Monitoring Add-on package is a zip file. To deploy it, you simply unzip the package to the root directory of your BusinessObjects installation. Follow these steps:

1. Download the Monitoring Add-On package ( from htttp://

2. Extract the contents of the file to the BusinessObjects root installation directory. The default BusinessObjects root installation directory is: C:Program FilesBusiness Objects  (Note: your installation directory may differ).

Extracting the contents of the deploys the following:

• a monitoring.jar file to C:Program FilesBusiness Objectscommon4.0javalib
• a monitoring.war file C:Program FilesBusiness Objects\BusinessObjects
Enterprise 12.0javaapplications
• a monitoring folder to C:Program FilesBusiness Objects

Locate the monitoring.bat file in the C:Program FilesBusiness Objectsmonitoring 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 (Note: if your root installation directory is the default, you do not have to modify anything here):

rem —- BOE_HOME : root folder of your Business Objects
Enterprise installation
set BOE_HOME=C:Program FilesBusiness Objects
rem —- JAVA_DIR : root folder of your JDK
set JAVA_DIR=%BOE_HOME%javasdk

4. Save and exit the file.

The Monitoring Add-On is now deployed.

In Part 3 of this tutorial we will configure and run a monitoring probe.




Part 3: Running a monitoring probe 

Monitoring probes can be run from a command line or from a web browser. In this tutorial, we will run the CMS Logon Logoff monitoring probe from the command line. If you want to run a probe in web mode, refer to this blog after completing this tutorial: BusinessObjects Enterprise Monitoring Probes Quick Tutorial 2: Running a Probe in Web Mode.

To run the monitoring probe, you will modify the probe’s configuration file and then run the probe command (monitoring.bat) with a call to the configuration file. Follow these steps:

1. Locate the configuration file for the CMS Logon Logoff probe
(template_probe1.xml). Probe configuration files are located in C:Program FilesBusiness Objects monitoringprobes.

2. Open the template_probe1.xml file in a text editor. The content of the template file appears as follows:


For the probe to run successfully, you must provide a valid BusinessObjects user name, password, and system name. We will use the default authentication option of “secEnterprise” and we don’t need to touch the classname attribute.

4. Save and exit the configuration file.
5. From the monitoring directory, run the monitoring command, calling the
CMS Logon Logoff probe configuration file:

monitoring.bat -probefile template_probe1.xml

If successful, the monitoring probe result output should appear similar to the


The output shows a success flag, a start time, no error, and the
time it took for the probe to complete (in milliseconds).


Now, a few notes about running monitoring probes:

• Template configuration files are provided for each monitoring probe in the C:Program FilesBusiness Objects monitoringprobes directory.

• The CMS Logon Logoff probe does not require a report to run. Crystal Reports, Web Intelligence, and Desktop Intelligence probes do. If you look at the configuration files for these probes, you will see a number of report-related parameters

• The “authtype” attribute is provided to allow you run probes under other types of user authentication. In this example, we used the default BOE Enterprise authentication. You can configure monitoring probes to use Windows AD or LDAP authentication.

• Monitoring probe configuration files and output are in XML format. The reason for this is to facilitate integration of monitoring probes with enterprise monitoring solutions.


Fore more in depth information about BusinessObjects monitoring probes, download the Monitoring Add-On package from the link above. The package contains the BusinessObjects Enterprise Monitoring Guide. Alternatively, you can access the guide directly here:

To report this post you need to login first.


You must be Logged on to comment or reply to a post.

  1. Alexander Schuchman
    Just the other day I was trying to figure out how to use the APIs to do some type of monitoring.  Did a quick search on SDN and found this Labs package, it’s great.  Saved me the time of developing it myself.

    We even created an ABAP Program to call the probes and send out email alerts when the probes detect an error.

    Everyone focuses on cool new functionality, but none of this is as important as making sure your server/application is working!

  2. Shane Schimpf
    How do I deploy probes in a  cluster?  I have the probes on one server and they are working fine. However when I cluster another server the probes start working intermittently.  Do I need to deploy the probes on the other server as well, or do I just need to fill in the cluster name where the probe template asks for the service?
  3. Sivakanth Panchagnula
    This is regarding deplying the Monitoring add-on for SAP
    BusinessObjects from SAP Innovation Center. I have downloaded the tool
    and tried to Configure this tool on our BOXI Server  : SAP BOE XI 3.1
    SP2  FP 1, Windows 2003 Server.
    I’m follwing the documentation correctly but unable to deploy it on the
    Tomcat. I have attached a screen shot of War file , as I suspect some
    files in the War file are missing and the size shows 2Kb.
    1. Poh Wong
      Hello Sivakanth,.

      Did you ever got this issue fixed?  I am also trying to depoly this add-on on a 3.1 Windows 2003 server.  I am getting a HTTP Status 500.

      Poh Wong

  4. sr ch
    Where Can i download  the Monitoring Add on full version. The link provided supplies only trail version.


  5. B. Heerings

    Thanks for the overview. We run boxi 3.1 sp3 on windows 2003 sp2. with tomcat.
    two questions: there any kind of support for the probes?

    2.Kan i turn on a trace to see if the probes are working for the tivoli universal agent? all the steps discribed in the manual went fine, except, i do not se output in the tivoli universal agent.



Leave a Reply