Initiate¶

Initiates a new workflow instance with the specified arguments.

$Domain.Initiate(inputData: ( string | Xml ), process: string, options: InitiateOptions):WorkItem

Parameters¶

( string | Xml ) inputData
Specifies the input data of the new instance, as an XML string or Xml node.

string process
Specifies the process of the new instance, either by name or ID number. If not specified, the current process is used.

InitiateOptions options
Specifies the options for the new instance.

The first work item of the initiated workflow.

Culture : string
Culture of new instance. If not specified uses the current instance culture.

Initiator : string
Identity of initiator. If not specified null value used.

Parent : string
Parent work item. If not specified current work item is set as parent.

Task : string
Name or Id of task to be initiated. If not specified, uses the Initiator task if found only one exist, otherwise throws error.

TestMode : boolean
Specifies the initiate in test mode or not. If not specified uses the current instance's test mode state.

Version : string
Version of process to initiate