Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Functions are listed alphabetically within the following categories on this page:

Anchor
Conditional Functions
Conditional Functions
Conditional Functions

...

(For Web Service output, see Web Service Functions 63472595.)
 

Note
titleNote

A prerequisite for the use of these functions is that Automatic Output Retrieval and Wait For Output are selected at task level, with the exception of the EXTENSION output type.

...

Note
titleNote

When using String functions that accept a String value parameter directly, you should be aware of expectations with respect to escape characters and escape sequences (see Escape Sequences 63472595, below).


For String functions that accept a variable name parameter, the fully resolved value of the variable by the specified name will be used as the String value argument. The variable must be fully resolvable and must not contain an unresolved function.

...

Description

Resolves the variable specified by the variable_name parameter and substitutes the default value if the variable cannot be resolved.

Syntax

${_resolveadv('variable_name', 'default_value', [use_default_if_blank])}

Parameters

  • variable_name
    Required; Variable name.
  • default_value
    Required; Default value to use if the variable cannot be resolved.
  • use_default_if_blank
    Optional; Specification (true or false) for whether or not to use the default value if the variable is empty or blank. (If use_default_if_blank is false, _resolveadv behaves like _resolve 63472595.)

Anchor
Universal Task Functions
Universal Task Functions
Universal Task Functions

...

Description

Resolves to the JSON output data of the Web Service task instance that is resolving the function, corresponding to the evaluated JsonPath expression.

  • If the output record cannot be found, the function will remain unresolved.
  • If the output record is found but the path expression does not yield a result, the function will resolve to the default value.

Syntax

${_responseJsonPath('pathExpression'[,'defaultValue','delimiter',prettyPrint])}

Parameters

  • pathExpression
    Required; JsonPath expression. https://github.com/json-path/Jsonpath
  • defaultValue
    Optional; Default value to return if the result is not found. Default is empty ('').
  • delimiter
    Optional; If pathExpression evaluates to multiple results, the delimiter to be used to separate those results. Default is new line character (\n).
  • prettyPrint
    Optional; Specification (true or false) for whether or not JSON output will be pretty printed (indented). Default is false.

...

Description

Resolves to the JSON output data of the Web Service task instance specified by the siblingName, corresponding to the evaluated JsonPath expression.
 
The sibling task instance must be within the same workflow and the Execution User of the task instance that is resolving the function must have Read permission for the sibling task instance.

  • If the output record cannot be found, the function will remain unresolved.
  • If the output record is found but the path expression does not yield a result, the function will resolve to the default value.

Syntax

${_responseJsonPathFromTask('siblingName','pathExpression'[,'defaultValue','delimiter',prettyPrint])}

Parameters

  • siblingName
    Required; Name of a sibling task instance.
  • pathExpression
    Required; JsonPath expression. https://github.com/json-path/Jsonpath
  • defaultValue
    Optional; Default value to return if the result is not found. Default is empty ('').
  • delimiter
    Optional; If pathExpression evaluates to multiple results, the delimiter to be used to separate those results. Default is new line character (\n).
  • prettyPrint
    Optional; Specification (true or false) for whether or not JSON output will be pretty printed (indented). Default is false.

...

Description

Resolves to the JSON output data of the Web Service task instance that is resolving the function, corresponding to the evaluated JsonPath expression.

  • If the output record cannot be found, the function will remain unresolved.
  • If the output record is found but the path expression does not yield a result, the function will resolve to the default value.

Syntax

${_responseJsonPathAsArray('pathExpression'[,'defaultValue',prettyPrint])}

Parameters

  • pathExpression
    Required; JsonPath expression. https://github.com/json-path/Jsonpath
  • defaultValue
    Optional; Default value to return if the result is not found. Default is empty ('').
  • prettyPrint
    Optional; Specification (true or false) for whether or not JSON output will be pretty printed (indented). Default is false.

...

Description

Resolves to the JSON output data of the Web Service task instance specified by the siblingName, corresponding to the evaluated JsonPath expression.
 
The sibling task instance must be within the same workflow and the Execution User of the task instance that is resolving the function must have Read permission for the sibling task instance.

  • If the output record cannot be found, the function will remain unresolved.
  • If the output record is found but the path expression doesn't yield a result, the function will resolve to the default value.

Syntax

${_responseJsonPathAsArrayFromTask('siblingName','pathExpression'[,'defaultValue',prettyPrint])}

Parameters

  • siblingName
    Required; Name of a sibling task instance.
  • pathExpression
    Required; JsonPath expression. https://github.com/json-path/Jsonpath
  • defaultValue
    Optional; Default value to return if the result is not found. Default is empty ('').
  • prettyPrint
    Optional; Specification (true or false) for whether or not JSON output will be pretty printed (indented). Default is false.

...