Workflow - Scoped

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 2 minutes de lecture

    • 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.

    Scoped Workflow - debug(String message, Object args)

    Adds a debug message to the log.

    Tableau 1. Parameters
    Name Type Description
    message String The message to add to the log.
    args Object Arguments to add to the message.
    Tableau 2. Returns
    Type Description
    String The message added to the log. 
    var loggedMessage = workflow.debug("All is well");

    Scoped Workflow - error(String message, Object args)

    Adds an error message to the log.

    Tableau 3. Parameters
    Name Type Description
    message String The message to add to the log.
    args Object Arguments to add to the message.
    Tableau 4. Returns
    Type Description
    String The logged message 
    var loggedMessage = workflow.error("An error has occurred. ");

    Scoped Workflow - getVariable(String name)

    Returns the specified variable's value.

    Tableau 5. Parameters
    Name Type Description
    name String The variable name
    Tableau 6. Returns
    Type Description
    Object The variable's value 
    var value = workflow.getVariable("task");

    Scoped Workflow - info(String message, Object args)

    Adds an informational message to the log.

    Tableau 7. Parameters
    Name Type Description
    message String The message to add to the log.
    args Object Arguments to add to the message.
    Tableau 8. Returns
    Type Description
    String The message that is logged. 
    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.

    Tableau 9. Field
    Name Type Description
    inputs Object Workflow variables as name value pairs. The variables of a workflow object are custom to an integrator's implementation. 
    var user = workflow.inputs.u_user;

    Scoped Workflow - name()

    Returns the workflow name.

    Tableau 10. Parameters
    Name Type Description
    None
    Tableau 11. Returns
    Type Description
    String The workflow name 
    var name = workflow.name();

    Scoped Workflow - removeVariable(String name)

    Removes the specified variable from the workflow.

    Tableau 12. Parameters
    Name Type Description
    name String The variable name
    Tableau 13. Returns
    Type Description
    void 
    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.

    Tableau 14. Field
    Name Type Description
    result String Workflow results. 
    var wfResult = workflow.result;

    Scoped Workflow - scratchpad()

    Returns the workflow's scratchpad object.

    Tableau 15. Parameters
    Name Type Description
    None
    Tableau 16. Returns
    Type Description
    Object The scratchpad object. 
    var scratchpad = workflow.scratchpad();

    Scoped Workflow - setResult(String result)

    Sets the workflow's result.

    Tableau 17. Parameters
    Name Type Description
    result String The workflow's result
    Tableau 18. Returns
    Type Description
    void 
    workflow.setResult("Success");

    Scoped Workflow - setVariable(String name, Object value)

    Sets the specified variable to the specified value.

    Tableau 19. Parameters
    Name Type Description
    name String The variable name
    value Object The value to be assigned to the variable.
    Tableau 20. Returns
    Type Description
    void 
    workflow.setVariable("task", "terrible");

    Scoped Workflow - warn(String message, Object args)

    Adds a warning message to the log.

    Tableau 21. Parameters
    Name Type Description
    message String The message to add to the log.
    args Object Arguments to add to the message.
    Tableau 22. Returns
    Type Description
    String The logged message 
    var loggedMessage = workflow.warn("Check your permissions.");