Developing and deploying a custom Java probe in BI Platform 4.0: Tutorial & Sample

public IHealthProbeResult executeHealthProbe(IEnterpriseSession session)

{

    HealthProbeResult probeResult = new HealthProbeResult(getProbeInfoObject());

    Socket socket = null;

    boolean available = false;

Step #6 -  To parameterize your probe you need to create a new java.util.Map object. Call getInputParameters( ) to create a map of the probe parameters that have been selected by the administrator in the Central Management Console (see Step #4).  In this example, there are two parameters (Web Server Host Name, Port Number)

Map<String,Object> inputParams = null;

try

{
     inputParams = probeObject.getInputParameters();
}
catch(Exception e)
{
     System.err.println(e);
     e.printStackTrace();
}

String hostname = (String) inputParams.get("hostname");

String portnum = (String) inputParams.get("portnum");
int portnumint = Integer.parseInt(portnum);

Step #7 -  This example attempts to create a connection to the specified host and port number.  If it succeeds, our probe executes probeSucceeded( ).  If it fails, an exception is thrown and the probe executes probeFailed( ).  The probeResult specifies to the Probe Scheduling Service if the health probe itself was a success or failure.

try

{

                       //String, int

   socket = new Socket(hostname, portnumint);

   probeResult.probeSucceeded();

}

catch (Exception e)

{

   probeResult.probeFailed();

}

return probeResult;

Compile and register your probe

1. Add the required jar files to your CLASSPATH.  I have attached my CLASSPATH to this document as an example (classpath.txt).  The BI 4.0 Java SDK libraries are located in the directory <BOBJ_HOME>\SAP BusinessObjects Enterprise XI 4.0\java\lib.
2. Compile your Java class. 
3. Identify each BI4 node in your landscape hosting a Monitoring Service (Adaptive Processing Server) and a Probe Scheduling Service (Adaptive Job
   Server)
4. Stop the Monitoring Service (Adaptive Processing Server) and Probe Scheduling Service (Adaptive Job Server)
5. Make a backup of procProbe.jar located in <BOBJHOME>:\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\java\lib.  Don't forget, this jar file may get overwritten by Support Pack or Patch updates.
6. Open procProbe.jar with winRAR and browse to procProbe.jar\com\businessobjects\monitoring\probe
7. Drag your compiled class file into winRAR in the location procProbe.jar\com\businessobjects\monitoring\probe then close winRAR
8. Restart the Monitoring Service (Adaptive Processing Server) and Probe Scheduling Service (Adaptive Job Server)
9. Repeat steps 5,6,7, and 8 for each node running the Monitoring Service and Probe Scheduling Service
10. Register your custom probe as per the BI4 Java SDK Developer's Guide or via the Central Management Console > Monitoring Application.
11. During registration, specify the class name including the package name as com.businessobjects.monitoring.probe.yourClassName.
12. Configure the input parameters to match the name and data type as defined in the java.util.Map in your source code.
13. For an example, refer to Image A

Image A

Schedule the custom probe

1. In the Central Management Console browse to Monitoring > Probe tab and locate your new probe.
2. Right click on the probe and choose properties then check your input parameters (Image B)
3. Schedule the probe to Run Now and see the results (Image C and Image D)

Image B

Image C

Image D