Sample Messages

The Administration Service is exposed as a web service. If you have Process Server deployed on your localhost running on port 8080, the WSDL for the service can be found at: http://localhost:8080/active-bpel/services/ActiveBpelAdmin?wsdl.

The Administration Service exposes the operations shown in the table below. You can use the SOAP-UI or a similar tool (such as the Web Services Explorer included in the Process Developer) to interact with the Administration Service. For most operations, a sample SOAP request and response are shown. Some operations, such as the operations concerning breakpoints, are exposed for remote debugging and sample messages are not provided.

Operation

Description

AddAttachment

Adds an attachment to the variable specified at a variable path in a process.

AddBreakpointListener

Adds a listener for engine breakpoint notification events.

DeployBPR

Deploys a BPR file.

GetAPIVersion

Returns the API version for the BPEL administration service.

GetConfiguration

Gets the current engine configuration as XML.

GetProcessCount

Returns a count of processes currently running on the BPEL engine.

GetProcessDef

Returns the process definition (BPEL XML) for a process.

GetProcessDetail

Returns the process detail for the a process ID or null if the process does not exist on the server.

GetProcessDigest

Returns the message digest code of the deployed BPEL file within a process.

GetProcessList

Returns a list of processes currently running on the BPEL engine.

GetProcessLog

Returns the process log for the a process if logging is enabled on the server.

GetProcessState

Returns the state of the process specified by a process ID.

GetServerLogList

Returns the list of logs.

GetVariable

Returns the data for the variable being referenced by the variable path.

IsInternalWorkManager

Returns True if using the native ActiveBPEL WorkManager and False if using a server provided WorkManager.

RemoveAttachments

Removes one or more attachments for the variable specified by a variable path in a process.

RemoveBreakpointListener

Remove a listener for engine breakpoint notification events.

RemoveEngineListener

Removes a listener from receiving engine notification events.

RemoveProcessListener

Removes the passed listener from list of those notified of process events for a PID.

ResumeProcess

Resumes the business process identified by a PID.

ResumeProcessContainer

Resumes the business process identified by a PID for the passed suspended location container.

ResumeProcessObject

Resumes the business process identified by a PID for the passed suspended location.

RetryActivity

Retries the activity associated with the passed location path or its enclosing scope.

SetConfiguration

Sets properties for the engine configuration.

SetCorrelationSetData

Sets the correlation set data for a PID and location path.

SetPartnerLinkData

Sets the partner link data for a PID and location path.

SetVariable

Sets the variable specified by a variable path in a process.

SuspendProcess

Suspends the business process identified by an PID.

TerminateProcess

Terminates the business process identified by an PID.

UpdateBreakpointList

Updates the list of breakpoints defined by the user for remote debugging.

AddAttachment

This operation adds an attachment to the variable specified by its variable path in a process. A sample SOAP request looks similar to the following message.

Note: The attachment is a base 64 encoded document that is added to the request as a SOAP attachment.

This operation returns a list of processes currently running on the BPEL engine. The list of processes returned can be controlled by a filter. The comments in the sample SOAP request shown below provide values for the processState and advancedQuery elements.

Note: You can easily create a valid value for the xmlns="http://www.w3.org/1999/xhtml">advancedQuery element by using the expression builder of the Advanced Query option on the Active Processes page of the Process Console.

The following SOAP message shows two ways to return a list of completed processes.

•Setting the act:processState element to 2

•Setting the advancedQuery element to getProcessProperty("State")=3.

More information on using the process filter can be found by searching for Active Processes elsewhere in this help.