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.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:addAttachmentDataInput>
<act:pid>202</act:pid>
<act:variablePath>/process/variables/variable[@name='TestSuspendRequest']
</act:variablePath>
</act:addAttachmentDataInput>
</soapenv:Body>
</soapenv:Envelope>
Example: The response contains one or more role names
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addAttachmentDataOutput
xmlns:ns2=
"http://schemas.active-endpoints.com/activebpeladmin/2007/01/
activebpeladmin.xsd"
xmlns:ns3=
"http://schemas.active-endpoints.com/logging/2009/05/logging.xsd"
xmlns:ns4=
"http://docs.active-endpoints/wsdl/activebpeladmin/2007/01/
activebpeladmin.wsdl">
<ns2:attachmentId>2</ns2:attachmentId>
<ns2:attachmentAttributes>
<ns2:attribute>
<ns2:attributeName>Attachment-Created-At</ns2:attributeName>
<ns2:attributeValue>1250256682654</ns2:attributeValue>
</ns2:attribute>
<ns2:attribute>
<ns2:attributeName>Content-Id</ns2:attributeName>
<ns2:attributeValue>1</ns2:attributeValue>
</ns2:attribute>
<ns2:attribute>
<ns2:attributeName>Content-Transfer-Encoding</ns2:attributeName>
<ns2:attributeValue>binary</ns2:attributeValue>
</ns2:attribute>
<ns2:attribute>
<ns2:attributeName>Content-Type</ns2:attributeName>
<ns2:attributeValue>application/octet-stream</ns2:attributeValue>
</ns2:attribute>
<ns2:attribute>
<ns2:attributeName>X-Size</ns2:attributeName>
<ns2:attributeValue>118</ns2:attributeValue>
</ns2:attribute>
</ns2:attachmentAttributes>
</ns2:addAttachmentDataOutput>
</S:Body>
</S:Envelope>
CompleteActivity
This operation steps resume the process and marks the activity associates with the passed location path as complete. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/2007/01/
activebpeladmin.xsd">
<soapenv:Header />
<soapenv:Body>
<act:completeActivityInput>
<act:pid>202</act:pid>
<act:locationPath>/process/sequence/extensionActivity/suspend
</act:locationPath>
</act:completeActivityInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response to this message
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body/>
</S:Envelope>
DeployBPR
This operation deploys a BPR file. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header />
<soapenv:Body>
<act:deployBprInput>
<act:bprFilename>riskAssessment.bpr</act:bprFilename>
<act:base64File>base 64 encoded bpr file string inserted here</act:base64File>
</act:deployBprInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response to this message
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deployBprOutput
xmlns:ns2=
"http://schemas.active-endpoints.com/activebpeladmin/2007/01/
activebpeladmin.xsd"
xmlns:ns3=
"http://schemas.active-endpoints.com/logging/2009/05/logging.xsd"
xmlns:ns4=
"http://docs.active-endpoints/wsdl/activebpeladmin/2007/01/
activebpeladmin.wsdl">
<ns2:response><![CDATA[
<deploymentSummary numErrors="0"
numWarnings="1">
<globalMessages>[riskAssessment.bpr] [riskAssessment.wsdl]
Replaced resource mapped to location hint:
project:/loan_approval_integrated/wsdl/riskAssessment.wsdl
[riskAssessment.bpr] [loanRequest.xsd] Replaced resource mapped to location
hint: project:/loan_approval_integrated/schema/loanRequest.xsd
[riskAssessment.bpr] [riskAssessmentPLT.wsdl] Replaced resource mapped to location
hint: project:/loan_approval_integrated/wsdl/riskAssessmentPLT.wsdl
[riskAssessment.bpr] [loanMessages.wsdl] Replaced resource mapped to location
hint: project:/loan_approval_integrated/wsdl/loanMessages.wsdl
</globalMessages>
<deploymentInfo deployed="true" numErrors="0" numWarnings="1"
pddName="riskAssessment.pdd" planId="26"
runningProcessDisposition="maintain"
version="1.0">
<log>[riskAssessment.bpr]
[riskAssessment.pdd] WARNING: Some rendering images refereneced in
metadata document do not exist. Rendering images will not be deployed.
If you have modified the process layout, please try re-creating the BPRD
deploy script.
[riskAssessment.bpr] [riskAssessment.pdd] Passed validation and was stored
in database.
</log>
</deploymentInfo>
</deploymentSummary>]]></ns2:response>
</ns2:deployBprOutput>
</S:Body>
</S:Envelope
GetAPIVersion
This operation returns the API version for the BPEL administration service. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:getAPIVersionInput/>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response contains the version of the administration API
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getAPIVersionOutput
xmlns:ns2=
"http://schemas.active-endpoints.com/activebpeladmin/2007/01/
activebpeladmin.xsd"
xmlns:ns3=
"http://schemas.active-endpoints.com/logging/2009/05/logging.xsd"
xmlns:ns4=
"http://docs.active-endpoints/wsdl/activebpeladmin/2007/01/
activebpeladmin.wsdl">
<ns2:response>6.0</ns2:response>
</ns2:getAPIVersionOutput>
</S:Body>
</S:Envelope>
GetConfiguration
This operation returns the current engine configuration as XML. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act=
"http://schemas.active-endpoints.com/activebpeladmin/2007/01/
activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:getConfigurationInput/>
</soapenv:Body>
</soapenv:Envelope>
A sample SOAP response contains the server configuration is can be found in the topic titled Sample SOAP response for a server configuration.
GetProcessCount
This operation returns a count of processes currently running on the BPEL engine. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/2007/01/
activebpeladmin.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<act:getProcessCountInput>
<act:filter>
<act:listStart>0</act:listStart>
<act:maxReturn>500</act:maxReturn>
<act:processCompleteEnd xsi:nil="true" />
<act:processCompleteStart xsi:nil="true" />
<act:processCreateEnd xsi:nil="true" />
<act:processCreateStart xsi:nil="true" />
<act:processName></act:processName>
<act:processState>0</act:processState>
</act:filter>
</act:getProcessCountInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response contains the process count
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getProcessCountOutput
xmlns:ns2="http://schemas.active-endpoints.com/activebpeladmin/2007/01/
activebpeladmin.xsd"
xmlns:ns3="http://schemas.active-endpoints.com/logging/2009/05/logging.xsd"
xmlns:ns4="http://docs.active-endpoints/wsdl/activebpeladmin/2007/01/
activebpeladmin.wsdl">
<ns2:response>7</ns2:response>
</ns2:getProcessCountOutput>
</S:Body>
</S:Envelope>
GetProcessDef
This operation returns the process definition (BPEL XML) for an process. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/2007/01/
activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:getProcessDefInput>
<act:pid>101</act:pid>
</act:getProcessDefInput>
</soapenv:Body>
</soapenv:Envelope>
A sample SOAP response that contains the process definition for a process with the process ID of 101 is in the topic titled Sample SOAP Response That Contains a Process Definition.
GetProcessDetail
This operation returns the process detail for a process ID or null if the process does not exist on the server. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/2007/01/
activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:getProcessDetailInput>
<act:pid>101</act:pid>
</act:getProcessDetailInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response contains the process detail for a process with a process id of 101
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getProcessDetailOutput
xmlns:ns2="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd"
xmlns:ns3="http://schemas.active-endpoints.com/logging/2009/05/logging.xsd"
xmlns:ns4="http://docs.active-endpoints/wsdl/activebpeladmin/
2007/01/activebpeladmin.wsdl">
<ns2:response>
<ns2:ended>2009-08-12T09:27:34.347-04:00</ns2:ended>
<ns2:name xmlns:ns5="http://docs.active-endpoints.com/activebpel/
sample/bpel/while/
2006/09/while.bpel">ns5:While</ns2:name>
<ns2:processId>101</ns2:processId>
<ns2:started>2009-08-12T09:27:33.347-04:00</ns2:started>
<ns2:state>3</ns2:state>
<ns2:stateReason>-1</ns2:stateReason>
</ns2:response>
</ns2:getProcessDetailOutput>
</S:Body>
</S:Envelope>
GetProcessDigest
This operation returns the message digest code of the deployed BPEL file for a process. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:getProcessDigestInput>
<act:pid>101</act:pid>
</act:getProcessDigestInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response contains the process digest for a process with the process id of 101
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getProcessDigestOutput
xmlns:ns2="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd"
xmlns:ns3="http://schemas.active-endpoints.com/logging/2009/05/logging.xsd"
xmlns:ns4="http://docs.active-endpoints/wsdl/activebpeladmin/
2007/01/activebpeladmin.wsdl">
<ns2:digest>Xgp1J8IDUUGrhJQv1i3QvA==</ns2:digest>
</ns2:getProcessDigestOutput>
</S:Body>
</S:Envelope>
GetProcessList
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.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header />
<soapenv:Body>
<act:getProcessListInput>
<act:filter>
<act:listStart>0</act:listStart>
<act:maxReturn>500</act:maxReturn>
<act:processCompleteEnd xsi:nil="true"/>
<act:processCompleteStart xsi:nil="true"/>
<act:processCreateEnd xsi:nil="true"/>
<act:processCreateStart xsi:nil="true"/>
<act:processName></act:processName>
<!-- property codes for processState
0 - Any
1 - Running
2 - Completed
3 - Faulted
4 - Completed and Faulted
5 - Suspended
6 - Suspended(Faulting)
7 - Suspended(Activity)
8 - Suspended(Manual)
9 - Compensatable
10 - Suspended(Invoke Recovery)
11 - Running and Suspended
-->
<act:processState>2</act:processState>
<!-- property codes for the "State" property as used in the
getProcessProperty("State") = '1' advancedQuery
1 - Running
2 - Suspended
3 - Completed
4 - Faulted
5 - Compensatable
-->
<act:advancedQuery>getProcessProperty("State")=3</act:advancedQuery>
</act:filter>
</act:getProcessListInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response containing a list of completed processes
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getProcessListOutput
xmlns:ns2="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd"
xmlns:ns3="http://schemas.active-endpoints.com/logging/2009/05/logging.xsd"
xmlns:ns4="http://docs.active-endpoints/wsdl/activebpeladmin/
2007/01/activebpeladmin.wsdl">
<ns2:response>
<ns2:totalRowCount>2</ns2:totalRowCount>
<ns2:completeRowCount>true</ns2:completeRowCount>
<ns2:rowDetails>
<ns2:item>
<ns2:ended>2009-08-27T09:04:04.338-04:00</ns2:ended>
<ns2:name xmlns:ns5="TerminateRunningProcesses">
ns5:TerminateRunningProcesses</ns2:name>
<ns2:processId>110</ns2:processId>
<ns2:started>2009-08-27T09:02:22.150-04:00</ns2:started>
<ns2:state>3</ns2:state>
<ns2:stateReason>2</ns2:stateReason>
</ns2:item>
<ns2:item>
<ns2:ended>2009-08-21T10:44:23.858-04:00</ns2:ended>
<ns2:name xmlns:ns5="http://www.example.org/helloWorld"
>ns5:helloWorld</ns2:name>
<ns2:processId>1</ns2:processId>
<ns2:started>2009-08-21T10:44:23.655-04:00</ns2:started>
<ns2:state>3</ns2:state>
<ns2:stateReason>-1</ns2:stateReason>
</ns2:item>
</ns2:rowDetails>
<ns2:empty>false</ns2:empty>
</ns2:response>
</ns2:getProcessListOutput>
</S:Body>
</S:Envelope>
GetProcessLog
This operation returns the process log for a process if logging is enabled on the server. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:getProcessLogInput>
<act:pid>101</act:pid>
</act:getProcessLogInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response contains the process log for a process with the process ID of 101
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getProcessLogOutput
xmlns:ns2="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd"
xmlns:ns3="http://schemas.active-endpoints.com/logging/2009/05/logging.xsd"
xmlns:ns4="http://docs.active-endpoints/wsdl/activebpeladmin/
2007/01/activebpeladmin.wsdl">
<ns2:response>[101][2009-08-12 09:27:33.550] Process : Executing [/process]
[101][2009-08-12 09:27:33.550] Flow : Executing [/process/flow]
[101][2009-08-12 09:27:33.550] Receive : Executing
[/process/flow/receive]
[101][2009-08-12 09:27:33.565] Message received on /process/flow/receive
[101][2009-08-12 09:27:33.581] Receive : Completed normally [/process/flow/receive]
[101][2009-08-12 09:27:33.581] Link L1:
status is true [/process/flow/links/link[@name='L1']]
[101][2009-08-12 09:27:33.581] Assign InitializeVariables: Executing
[/process/flow/assign[@name='InitializeVariables']]
...
[101][2009-08-12 09:27:33.628] Reply : Executing [/process/flow/reply]
[101][2009-08-12 09:27:34.347] Replied to message from /process/flow/reply
[101][2009-08-12 09:27:34.347] Reply : Completed normally [/process/flow/reply]
[101][2009-08-12 09:27:34.347] Flow : Completed normally [/process/flow]
[101][2009-08-12 09:27:34.347] Process : Completed normally [/process]<
/ns2:response>
</ns2:getProcessLogOutput>
</S:Body>
</S:Envelope>yyyy
You can find a more complete example in the topic titled Sample Soap Response.
GetProcessState
This operation returns the state of the process specified by a process ID. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:getProcessStateInput>
<act:pid>101</act:pid>
</act:getProcessStateInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response contains the process state for process 101
GetServerLogList
This operation returns the list of logs. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
</soapenv:Envelope>
Example: A sample SOAP response to this messasge
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
</soapenv:Envelope>
GetVariable
This operation returns the data for the variable being referenced by the variable path. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/2007/01/
activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:getVariableDataInput>
<act:pid>101</act:pid>
<act:variablePath>/process/variables/variable[@name='orderTotal']
</act:variablePath>
</act:getVariableDataInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response containing the contents of the orderTotal variable for a process with process id of 101
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getVariableDataOutput
xmlns:ns2="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd"
xmlns:ns3="http://schemas.active-endpoints.com/logging/2009/05/logging.xsd"
xmlns:ns4="http://docs.active-endpoints/wsdl/activebpeladmin/
2007/01/activebpeladmin.wsdl">
<ns2:response><variable dataIncluded="yes"
hasAttachments="false" hasData="true"
name="orderTotal"
type="{http://www.w3.org/2001/XMLSchema}float"
version="68">6985.8594</variable></ns2:response>
</ns2:getVariableDataOutput>
</S:Body>
</S:Envelope>
RemoveAttachments
This operation removes one or more attachments for a variable a process. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:removeAttachmentDataInput>
<act:pid>202</act:pid>
<act:variablePath>/process/variables/variable[@name='TestSuspendRequest']
</act:variablePath>
<act:itemNumbers>
<!--Zero or more repetitions:-->
<act:itemNumber>1</act:itemNumber>
</act:itemNumbers>
</act:removeAttachmentDataInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response to this message
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeAttachmentDataOutput
xmlns:ns2="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd"
xmlns:ns3="http://schemas.active-endpoints.com/logging/2009/05/logging.xsd"
xmlns:ns4="http://docs.active-endpoints/wsdl/activebpeladmin/
2007/01/activebpeladmin.wsdl">
<ns2:response/>
</ns2:removeAttachmentDataOutput>
</S:Body>
</S:Envelope>
ResumeProcess
This operation resumes the business process identified by the passed PID. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act=
"http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:resumeProcessInput>
<act:pid>203</act:pid>
</act:resumeProcessInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response to this message
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body/>
</S:Envelope>
ResumeProcessContainer
This operation resumes the business process identified by the passed PID for the passed suspended location container. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:resumeProcessContainerInput>
<act:pid>303</act:pid>
<act:location>/process/sequence/scope[@name='MyScope']</act:location>
</act:resumeProcessContainerInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response to this message
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body/>
</S:Envelope>
ResumeProcessObject
This operation resumes the business process identified by a PID for a suspended location. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:resumeProcessObjectInput>
<act:pid>303</act:pid>
<act:location>/process/sequence/scope[@name='MyScope']/flow/sequence/
extensionActivity/suspend</act:location>
</act:resumeProcessObjectInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response to this message
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body/>
</S:Envelope>
RetryActivity
This operation retries the activity associated with a location path or its enclosing scope. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:retryActivityInput>
<act:pid>303</act:pid>
<act:locationPath>/process/sequence/scope[@name='MyScope']/flow/
sequence/empty[@name='EmptyActivity_1']</act:locationPath>
<act:atScope>true</act:atScope>
</act:retryActivityInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response to this message
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body/>
</S:Envelope>
SetConfiguration
This operation sets the engine configuration properties.
Note: You should retrieve the current configuration using the GetConfiguration operation and make changes to the message returned by that operation prior to setting the configuration.
Example: A sample SOAP response to this message:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body/>
</S:Envelope>
SetCorrelationSetData
This operation sets the correlation set data for a process id and location path. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:setCorrelationDataInput>
<act:pid>301</act:pid>
<act:locationPath>/process/correlationSets/correlationSet[@name='CS1']</
act:locationPath>
<act:data>
<![CDATA[
<property name="QuoteRefId"
namespaceURI="http://docs.active-endpoints.com/activebpel/demo/
quoteRequest/2008/06/
QuoteRequest.wsdl"
value="301a"/>
]]>
</act:data>
</act:setCorrelationDataInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response to this message
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<setCorrelationDataInputResponse
xmlns="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd"/>
</soapenv:Body>
</soapenv:Envelope>
SetPartnerLinkData
This operation sets the partner link data for a process ID and location path. A sample SOAP is looks similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:setPartnerLinkDataInput>
<act:pid>301</act:pid>
<act:partnerRole>true</act:partnerRole>
<act:locationPath>/process/partnerLinks/partnerLink[@name='Rules_Service']</
act:locationPath>
<act:data>
<![CDATA[
<partnerRole>
<wsa:EndpointReference xmlns:wsa="http://schemas.xmlsoap.org/ws/2003/
03/addressing"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:ns5="http://www.active-endpoints.com/demo/wsdl/QuoteRules/
2008/06/QuoteRules.wsdl"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<wsa:Address>http://localhost:9080/active-bpel/services/
QuoteRulesService2</wsa:Address>
<wsa:ServiceName PortName="QuoteRulesPort">ns5:QuoteRulesService</
wsa:ServiceName>
</wsa:EndpointReference>
</partnerRole>
]]>
</act:data>
</act:setPartnerLinkDataInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response to this message
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<setPartnerLinkDataInputResponse
xmlns="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd"/>
</soapenv:Body>
</soapenv:Envelope>
SetVariable
This operation sets the variable specified by a variable path a process with the given data. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:setVariableDataInput>
<act:pid>302</act:pid>
<act:variablePath>/process/variables/
variable[@name='TestSuspendRequest']</act:variablePath>
<act:variableData>
<![CDATA[
<wsdl:part xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
<TestSuspendRequest xmlns="urn:testSuspendRequest">
<pid>302</pid>
</TestSuspendRequest>
</wsdl:part>
]]>
</act:variableData>
</act:setVariableDataInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response to this message
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:setVariableDataOutput
xmlns:ns2="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd"
xmlns:ns3="http://schemas.active-endpoints.com/logging/2009/05/logging.xsd"
xmlns:ns4="http://docs.active-endpoints/wsdl/activebpeladmin/
2007/01/activebpeladmin.wsdl">
<ns2:response/>
</ns2:setVariableDataOutput>
</S:Body>
</S:Envelope>
SuspendProcess
This operation suspends the business process identified by a PID. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:suspendProcessInput>
<act:pid>101</act:pid>
</act:suspendProcessInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response to this message
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body/>
</S:Envelope>
TerminateProcess
This operation terminates the business process identified by a PID. A sample SOAP request is similar to:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:act="http://schemas.active-endpoints.com/activebpeladmin/
2007/01/activebpeladmin.xsd">
<soapenv:Header/>
<soapenv:Body>
<act:terminateProcessInput>
<act:pid>101</act:pid>
</act:terminateProcessInput>
</soapenv:Body>
</soapenv:Envelope>
Example: A sample SOAP response to this messasge
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body/>
</S:Envelope>