Workflow- Scoped

The scoped Workflow API provides methods that can be used in an activity definition script.

There are no constructors for creating an instance of a scoped workflow object. Instead, use the global workflow object available in activity scripts. This workflow object is available in any script location inside a workflow.

Parent Topic:Server API reference

Scoped Workflow - debug(String message, Object args)

Adds a debug message to the log.

var loggedMessage = workflow.debug("All is well");

Scoped Workflow - error(String message, Object args)

Adds an error message to the log.

var loggedMessage = workflow.error("An error has occurred. ");

Scoped Workflow - getVariable(String name)

Returns the specified variable's value.

var value = workflow.getVariable("task");

Scoped Workflow - info(String message, Object args)

Adds an informational message to the log.

var loggedMessage = workflow.info("All is well");

Scoped Workflow - inputs

Object that contains the workflow variables.

This is not a method, but rather a way to reference the variables in a workflow object, such as the user. Workflow variables are defined in the properties of the workflow or by scripted activities.

var user = workflow.inputs.u_user;

Scoped Workflow - name()

Returns the workflow name.

var name = workflow.name();

Scoped Workflow - removeVariable(String name)

Removes the specified variable from the workflow.

var value = workflow.removeVariable("task");

Scoped Workflow - result

Element of the workflow object that contains the workflow results.

This is not a method, but rather the element in the workflow object that contains the results of a workflow.

var wfResult = workflow.result;

Scoped Workflow - scratchpad()

Returns the workflow's scratchpad object.

var scratchpad = workflow.scratchpad();

Scoped Workflow - setResult(String result)

Sets the workflow's result.

workflow.setResult("Success");

Scoped Workflow - setVariable(String name, Object value)

Sets the specified variable to the specified value.

workflow.setVariable("task", "terrible");

Scoped Workflow - warn(String message, Object args)

Adds a warning message to the log.

var loggedMessage = workflow.warn("Check your permissions.");