Operation: bpm::processSpawn2


General Description

Invoke this operation for spawning a business process. The process can be completed asynchronously or it can initiate tasks. The latter case the process will be suspended. Any task completion will resume the process and the depending on the process it can complete or wait for other tasks to be completed.

Operation Notes

System Privileges Mail Privileges Calendar Privileges Database Privileges
sys.a.canSpawnProcess -- -- db.[default_db].h_buz_icons.browse
db.[default_db].h_bpm_processes.browse
db.[default_db].h_bpm_processes.update
db.[default_db].h_bpm_instance.add
db.[default_db].h_bpm_instance.update

Request Message

Input Parameters

The processSpawn2 method takes the following input parameters. It is important to note that the parameters must be passed to the operation in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
application appNameType optional Specify the name of the application this operation relates to. If not specified then "system" is assumed.
name xs:string required once The name of the business process to spawn.
reference xs:anyURI optional An application defined reference, such as a URN to an entity or any other application-definable meaningful (to the application spawning the process) reference.
timePlan xs:string optional The Time Plan to use when measuring time events. If no timeplan is defined then time measurements will not be taken during the process lifecycle.
inputParam inputParameterType optional
minOccurs=0
maxOccurs=unbounded
The input parameters to the business process.

Input Data


Response Message

Output Parameters

Name Type Attributes Description
identifier xs:string required once The unique identifier of the spawned process.
version xs:unsignedInt required once The version of the business process that was spawned.
state bpmStateType required once This can be InProgress, Succeeded or Failed.
failureMessage xs:string optional The error message in the case of process failure.

Output Data


Code Generation & Samples

The links below will generate sample code in the respective languages. You can use these links as a convenient way of generating the correct code needed to invoke this method

JavaScript   PHP   C#   Java   C++   [ hide code ]  

Powered by Hornbill, for more information click here. (page served by , .)