Initiate¶

Initiates a new instance using the specified arguments.

1

myWorkItem.Initiate(inputData: ( string | Xml ), process?: string, options?: InitiateOptions):WorkItem

Parameters¶

( string | Xml ) inputData
    The input data to pass to the new workflow instance, as an XML string or XML object.

string process optional
    Specifies the process of the new instance. Can be the name or ID of the process. If not specified, the current process is used.

InitiateOptions options optional
    Specifies the options for the new instance.

Returns¶

The first work item of the initiated workflow in the Created or Waiting state.

Remarks¶

Basic Usage¶

1
2

var formData = '<Root><Name>Lady</Name><Surname>Gaga</Surname></Root>';
var childWorkItem = $WorkItem.Initiate(formData, 'My Process');

Initiate by Task Name¶

1
2
3
4

var formData = '<Root><Name>Lady</Name><Surname>Gaga</Surname></Root>';
var childWorkItem = $WorkItem.Initiate(formData, 'My Process', {
      task : 'My Task'
});

Initiate with User and Culture¶

1
2
3
4
5
6
7

var formData = '<Root><Name>Lady</Name><Surname>Gaga</Surname></Root>';
var initiator = $Membership.Administrator;
var childWorkItem = $WorkItem.Initiate(formData, 'My Process', {
        task : 'My Task',
        initiator : initiator.Id,
        culture: 'tr-TR'
});

See Also¶

• $Domain.Initiate
• WorkItem