StartWorkflow Method

Start the workflow.

Syntax

spworkflow.startWorkflow([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Invoking this method will start the workflow specified by the WorkflowIndex property. The item is specified by the ItemURL property.

If input is necessary for the particular workflow to begin execution, the WorkflowParams property must be populated with the correct input values.