BPEL Management Service (Java CAPS Management and Monitoring APIs)

Java CAPS Management and Monitoring APIs

BPEL Management Service

The BPEL Management Service supports two types of API method names:

Java CAPS (non-JBI based components)
Java CAPS (JBI based components)

Note –

These APIs are in addition to the APIs exposed for BPEL from the configuration service.

Table 14 BPEL Management Service API Method Names and Descriptions (non-JBI Based Components)


API Method Name	Description
getBPELInstances	Obtains BPEL instances given optional BPEL process QName and/or an optional BPStatus or an optional instance ID. If instanceId is present, the BPEL process QName and BPStatus are ignored. The maximum instances to return is 1000, user specifies a lower number for maxRecords to limit the number of the instances returned. If the BPInstanceQueryResult.overflow is true, it indicates the number of qualifying instances is larger than 1000, no instances are returned in the result list, user should specify a maxRecords (<= 1000) and sortColumn and order.
getBPELInstanceActivityStatus	Obtains the list of ActivityStatus of a BPEL instance.
getBPELProcessIds	Obtains the list of BPEL process QName as String within a service unit.
getBPELInstanceFault	Obtains the fault detail of a faulted BPEL instance.
getInvokerInstance	Obtains the list of an invoker (parent) BPEL instance(s) that invoked a specific bpel instance
getInvokeeInstance	Obtains the list of invokee (sub) BPEL instance(s) that a specific BPEL instance invoked.
isMonitoringEnabled	Asks if Monitoring is enabled.
isPersistenceEnabled	Asks if Persistence is enabled.
resumeInstance	Resumes a Business Process Instance for a given Business Process Instance.
terminateInstance	Terminates a Business Process Instance for a given Business Process Instance
suspendInstance	Suspends a Business Process Instance for a given Business Process Instance
getBPELInstanceFault	Obtains the fault detail of a faulted BPEL instance.
suspendAllInstance	Suspends all instances of a BPEL process.
resumeAllInstance	Resumes all instances of a BPEL process.
terminateAllInstance	Terminates all instances of a BPEL process.
changeVariableValue	Changes the BPEL variable value. Note that, only the leaf node can be changed.
getVariableValue	Obtains the BPEL variable value. The content of the BPEL variable is returned.
listBPELVaraibles	Obtains the BPEL variable information for a BPEL instance.

Table 15 BPEL Management Service API Method Names and Descriptions (JBI Based Components)


API Method Name	Description
setBusinessProcessInstanceVariableValue	Sets the value for the property using XPath on a Part given a business process instance, container, part, the XPath expression, and value.