Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Excerpt

Adds a new task to a process instance.

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
Processes("myProcess").addTask(task, taskName, scope);

Parameters

ParameterTypeMandatoryNotesPulse Version
task

FunctionTask

Array of FunctionTasks

(tick)

The task function, or an array of task functionstasks.

If an array of tasks is used, each task in the array will be added in sequence with the other parameters applied to it. The taskName for each task will be appended with the array index (see below).

0.1
taskNameString(error)

Optionally specify a name for the task(s).

If no name is specified, the function name will be used if possible, otherwise the name will default to "AnonymousTask".

If an array of tasks was passed in on the 'task' parameter, each task will be given a name in the form: "taskName_i" where "i" is the index of the task in the array.

It's recommended to always name your tasks (or make sure they are named functions) to aid with diagnostics.

0.1
scopeObject(error)

Optionally specify an object scope in which the task(s) should be run.

This is ideal for scripts that use OO programming OOP as you can run the task(s) as if it were a method on some object.

Defaults to global scope.

0.1

Return value

ValueTypeNotesPulse Version
<trigger><instance>TriggerProcess Instance

The trigger process instance to which the task is added is returned, so you can chain more trigger instance methods, eg:

Code Block
themeRDark
languagejavascript
linenumberstrue
trigger.addTask(...).addTask(...).startrun();
0.1
<error>ErrorIf invalid parameters are passed to .addTask(), an error will be thrown.Planned for 0.2

Examples

 

Div
classbox

Availability

Requires:

  • Warzone 3.1 or above
  • Pulse Process 0.1 or above

Some changes are planned to the return value in Pulse Process v0.2.

Div
classbox

See also

Essential reading:to follow.