WorkflowParamXML Property

The full XML of the workflow parameters.

Syntax

 spworkflow.getWorkflowParamXML([callback])
 spworkflow.setWorkflowParamXML( workflowParamXML, [callback])

Default Value

""

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 the getWorkflowParamXML([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setWorkflowParamXML([callback]) 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

When the namespace is not recognized for the class to parse and populate the WorkflowParams property, this property will be populated with the full XML as returned by the server.

The XML may be modified or set before calling StartWorkflow for unrecognized schemas as well, such as using custom workflows.

Data Type

String