Starts a new process instance.
Parameters
| Name | Type | Description |
|---|---|---|
| businessKey | String | A unique identifier for the workflow; if this is not specified one will be generated automatically |
| objectType | String | An optional iCM Form Data object type, if this is specified the worker will attempt to save the workflow variables in a new iCM object of this type |
| processDefinition | String | The process definition for the new process |
| userId | String | The name of the user starting the process; the process definition must specify that this user or a group to which they belong has the right to start process instances using this definition |
| proxyUserId | String | Name of the logged in user if assisting another user via the Assited Service template (userId holds the name of the user being proxied) |
| variables | Object | Map of process variables to create where the keys are process variable names and the values are the values of those variables; if an objectType has been specified the worker will attempt to save any variables beginning with form_ in a new iCM Form Data object of the specified type |
| fileReferences | Object | Map of field names to file reference objects. The supplied files will be referenced by the workflow and remain available until it completes. For example:"fileReferences": { |
| replaceExistingFiles | Boolean | True by default. If this property is true, files named in the "fileReferences" parameter replace any existing files provided under that name which will no longer be referenced by the workflow. Otherwise the new file and and any previous files referenced under that name will be kept |
| historyRecording | Object | See Recording History |
| processDefinition and userId are mandatory | ||
Last modified on October 29, 2021
Share this page
