Updates the process variables of a particular process.
Setting process variables sends a "GOSS_ProcessVariablesSet" message to the relevant executions (ie the process instance where the variables were set). The " GOSS_ProcessVariablesSet" message reference can be defined in your workflow message events. This functionality could be used to trigger a message event when variables are set/updated.
Parameters
| Name | Type | Description |
|---|---|---|
| processInstanceBusinessKey | String | The business key of the process instance |
| processInstanceId | String | The ID of the process instance |
| variables | Object | Map of process variables to update where the keys are process variable names and the values are the values of those variables |
| 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 an example see the startProcess function |
| 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 |
| processInstanceId or processInstanceBusinessKey, and variables are required | ||
Last modified on 19 August 2026
