ProcessMonitor MBean

IBM Business Process Manager provides a programming interface for accessing process monitor data.

ObjectName:

com.lombardisoftware:Scope=ENVIRONMENT_SERVER,Name=ProcessMonitor,cell=[cell],Type=ProcessMonitor,node=[node],process=[server]

Information on the management interface of the MBean

Data retrieved complies to the following schema:

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema attributeFormDefault="unqualified"
	elementFormDefault="qualified" targetNamespace="http://www.ibm.com/bpm/v1/process_monitor" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.ibm.com/bpm/v1/process_monitor">
	<xsd:element name="processMonitor" type="tns:processMonitorType" />

	<xsd:complexType name="processMonitorType">
		<xsd:sequence>
			<xsd:element name="process" type="tns:processType" minOccurs="0" maxOccurs="unbounded"/>
			<xsd:element name="service" type="tns:serviceType"  minOccurs="0" maxOccurs="unbounded"/>
		</xsd:sequence>
		<xsd:attribute type="xsd:string" name="server" />
		<xsd:attribute type="xsd:string" name="id" />
		<xsd:attribute type="xsd:boolean" name="showDetails" />
		<xsd:attribute type="xsd:long" name="durationExceededInSeconds" />
		<xsd:attribute type="xsd:long" name="stepExceeded" />
	</xsd:complexType>

	<xsd:complexType name="stepType">
		<xsd:attribute type="xsd:string" name="name"/>
		<xsd:attribute type="xsd:string" name="type"/>
		<xsd:attribute type="xsd:dateTime" name="lastEnterTime" />
		<xsd:attribute type="xsd:string" name="lastDuration"/>
		<xsd:attribute type="xsd:string" name="totalDuration"/>
		<xsd:attribute type="xsd:long" name="steps"/>
	</xsd:complexType>

	<xsd:complexType name="serviceType">
		<xsd:sequence>
			<xsd:element name="step" type="tns:stepType" minOccurs="0" maxOccurs="unbounded"/>
		</xsd:sequence>
		<xsd:attribute type="xsd:string" name="processApplication"/>
		<xsd:attribute type="xsd:string" name="name" />
		<xsd:attribute type="xsd:string" name="state"  />
		<xsd:attribute type="xsd:string" name="contextID"  />
		<xsd:attribute type="xsd:dateTime" name="lastEnterTime"/>
		<xsd:attribute type="xsd:string" name="duration"/>
		<xsd:attribute type="xsd:string" name="lastDuration"/>
		<xsd:attribute type="xsd:string" name="totalDuration"/>
		<xsd:attribute type="xsd:long" name="steps"/>
	</xsd:complexType>

	<xsd:complexType name="processType">
		<xsd:sequence>
			<xsd:element name="step" type="tns:stepType" minOccurs="0" maxOccurs="unbounded"/>
			<xsd:element name="service" type="tns:serviceType" minOccurs="0" maxOccurs="unbounded"/>
		</xsd:sequence>
		<xsd:attribute type="xsd:string" name="processApplication"/>
		<xsd:attribute type="xsd:string" name="name"/>
		<xsd:attribute type="xsd:long" name="instanceID"/>
		<xsd:attribute type="xsd:string" name="state"/>
		<xsd:attribute type="xsd:dateTime" name="lastEnterTime"/>
		<xsd:attribute type="xsd:string" name="totalDuration"/>
		<xsd:attribute type="xsd:long" name="steps"/>
	</xsd:complexType>
</xsd:schema>

Monitoring

public boolean Monitoring

DisplayName

public java.lang.String DisplayName

ParentObjectName

public javax.management.ObjectName ParentObjectName

startMonitoring

public void startMonitoring()

stopMonitoring

public void stopMonitoring()

retrieveMonitorAll

public java.lang.String retrieveMonitorAll()
                                    throws AdminException

Return all process monitor data

Returns:

all process monitor data as XML

Throws:

AdminException

retrieveMonitorByFilter

public java.lang.String retrieveMonitorByFilter(boolean showDetails,
                                                long durationExceededInSeconds,
                                                long stepExceeded)
                                         throws AdminException

Return a selected set process monitor data

Parameters:

showDetails - show information about individual steps in process instance/service

durationExceededInSeconds - only show process instance/service that exceeded a certain time in seconds

stepExceeded - only show process instance/service that exceeded a certain steps

Returns:

all process monitor data as XML

Throws:

AdminException

retrieveMonitorAllAsJSON

public java.lang.String retrieveMonitorAllAsJSON()
                                          throws AdminException

Return all process monitor data

Returns:

all process monitor data as JSON

Throws:

AdminException

retrieveMonitorByFilterAsJSON

public java.lang.String retrieveMonitorByFilterAsJSON(boolean showDetails,
                                                      long durationExceededInSeconds,
                                                      long stepExceeded)
                                               throws AdminException

Return a selected set process monitor data

Parameters:

showDetails - show information about individual steps in process instance/service

durationExceededInSeconds - only show process instance/service that exceeded a certain time in seconds

stepExceeded - only show process instance/service that exceeded a certain steps

Returns:

all process monitor data as JSON

Throws:

AdminException

haltProcess

public void haltProcess(java.lang.String processInstanceID)
                 throws AdminException

Attempt to halt running of a process instance. This will fail if the process is not active, or is in the middle of executing a task.

Throws:

AdminException

haltProcessAndAssociatedServices

public void haltProcessAndAssociatedServices(java.lang.String processInstanceID)
                                      throws AdminException

Attempt to halt running of a process instance. This will fail if the process is not active, or is in the middle of executing a task.

Throws:

AdminException

haltService

public void haltService(java.lang.String serviceContextID)
                 throws AdminException

Attempt to halt running of a service execution. This will fail if the service is not active, or is in the middle of executing a step.

Throws:

AdminException