$Domain.Initiate

Overview

Initiates a new workflow instance with specified arguments.

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

Arguments

( string | Xml ) inputData

Specifies the input data of new instance. Can be specified as xml string or Xml | xml node.

string process

Specifies the process of new instance. Can be Name or Id number of process. If not specified current process is used.

InitiateOptions options

Specifies the options of new instance.

Types

InitiateOptions

{ // Culture of new instance. If not specified uses the current instance culture. Culture : string // Identity of initiator. If not specified null value used. Initiator : string // Parent work item. If not specified current work item is set as parent. Parent : string // Name or Id of task to be initiated. If not specified, uses the Initiator task if found only one exist, otherwise throws error. Task : string // Specifies the initiate in test mode or not. If not specified uses the current instance's test mode state. TestMode : boolean // Version of process to initiate Version : string }

See Also

Copyright © 2010 - 2023 Emakin. All rights reserved.