pp108 : ExecuteProcess

ExecuteProcess


The ExecuteProcess SOAP method is used to create a new process instance or to trigger an existing process instance. This method is a part of the the Method Set Process Execution 4.2 interface with the namespace http://schemas.cordys.com/bpm/execution/1.0.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <ExecuteProcess type="" xmlns="http://schemas.cordys.com/bpm/execution/1.0">
            <type>definition</type>
            <receiver>Business Process Models/EmployeeRecruitmentProcess_vcmdemo10.bpm</receiver>
            <source>Run from Studio</source>
            <modelSpace>organization</modelSpace>
            <monitor activityMonitorLevel="" activityMonitoring="" level="">OFF</monitor>
            <crashRecovery>OFF</crashRecovery>
            <priority>1</priority>
            <message/>
        </ExecuteProcess>
    </SOAP:Body>
</SOAP:Envelope>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

type

Execution type of the business process

Yes
  • definition: to trigger a new process
  • instance: to trigger an existing process instance

receiver

Unique identifier of the process

Yes
  • Fully qualified name of the business process
  • Business Process instance ID

source

Custom process instantiation type used by applications to specify their identity for better process monitoring and data filtering

No

modelSpace

Space from which the business process must be executed

Note: This parameter is currently deprecated. If it is not provided, the 'Organization space' is considered; if the expected model is not found in the organization space, then the 'Shared space' is considered automatically.

No
  • isv
  • organization (default)

monitor

Option to enable or disable the monitoring and administration for a particular instance of the business process

Note: The value of this parameter overrides the settings for the process monitoring and administration specified at the business process model level. The monitoring for all the business process instances is disabled if it is disabled at the service or SOAP Processor level.

No
  • ON
  • OFF
monitor/@level Option to set the level of monitoring to the business process No
  • BASIC
  • INTERMEDIATE
  • COMPLETE
  • COMPLETE_ON_ERROR
  • COMPLETE_ON_ERROR_NONE_ON_COMPLETION

monitor/@activityMonitoring

Option to enable or disable the monitoring for all the activities of a particular instance of the business process

Note: The setting of this option overrides the monitoring settings specified for all the activities in the business process model.

No
  • ON
  • OFF

monitor/@activityMonitorLevel

Monitoring level to be set to all the activities of a particular instance of the business process

Note: For the attribute value to be considered, the @activityMonitoring attribute must be set to ON.

No
  • BASIC
  • INTERMEDIATE
  • COMPLETE
  • COMPLETE_ON_ERROR
  • COMPLETE_ON_ERROR_NONE_ON_COMPLETION

crashRecovery

Option to enable or disable the crash recovery for the business process

No
  • ON
  • OFF

priority

Execution priority to be set to the business process

No
  • 1 - Low
  • 2 - Below Normal
  • 3 - Normal (default)
  • 4 - Above Normal
  • 5 - High

message

Input message to trigger the business process

No

SOAP Response

<data>
    <ExecuteProcessResponse type="" xmlns="http://schemas.cordys.com/bpm/execution/1.0">
        <data>
            <instance_id>{CEB228D8-5A99-48A8-9686-49FEAB32262D}</instance_id>
            <message>[Any XML message (if required) from the process]</message>
        </data>
    </ExecuteProcessResponse>
</data>
Response Parameters

Parameter

Description

instance_id

Unique ID of the process instance

message

Output message returned from the business process of the type Short Lived
headerOutputMessages Header response message from the business process. It is available only in the case of contract first micro-processes having output messages defined in the SOAP header.
PAGEFLOWDATA Message returned from the business process of the type Page Flow