SpawnWithParametersEx
Create a workflow instance from a model, and invoke the method StartWithParameters or SimulateWithParameters on this instance.
Number instanceId = SpawnWithParametersEx (
String workflowId,
Boolean simulation,
XML parameters
)
String workflowId,
Boolean simulation,
XML parameters
)
Parameters
workflowId
Identifier or internal name of the workflow template.
simulation
If true, the newly created wotkflow is started in simulation mode.
parameters
<bpt id="1"><para></bpt>Parameters to pass to the instance. These parameters will become the instance variables of the workflow.<ept id="1"></para></ept><bpt id="2"><para></bpt>This argument is an XML element whose name must be <bpt id="3"><varname></bpt>variables<ept id="3"></varname></ept> and may only include attributes.<ept id="2"></para></ept> <bpt id="4"><para></bpt><bpt id="5"><emphasis></bpt>Example:<ept id="5"></emphasis></ept><ept id="4"></para></ept> <bpt id="6"><programlisting></bpt><variables foo="abc" bar="def"><ept id="6"></programlisting></ept>
<bpt id="7"><para></bpt>The JavaScript scripts within the workflow may access these variables from the <bpt id="8"><varname></bpt>instance.vars<ept id="8"></varname></ept> object:<ept id="7"></para></ept> <bpt id="9"><programlisting></bpt>
var foo = instance.vars.foo // "abc"
var bar = instance.vars.bar // "def"
<ept id="9"></programlisting></ept>
Return values
instanceId
Identifier of the instance created from the template.
Remarks
The command is executed in asynchronous mode and does not have an immediate effect after the return of the method.
The workflow is started with the calling operators' account, except if a specific login is linked to the template in the workflow login table, in which case this login is used.
Features