Returns a conditional value depending on the equality of two string parameters.
 
(Returns if_value if string value1 is equal to string value2; otherwise, else_value is returned.)

${_ifEqual('value1', 'value2', 'if_value', 'else_value'[, ignore_case])}

• value1
  Required; First string.
• value2
  Required; Second string.
• if_value
  Required; Return value if value1 equals value2.
• else_value
  Required; Return value if value1 does not equal value2.
• ignore_case
  Optional; Specification (true or false) whether or not to ignore case when comparing value1 and value2. Default is false.

Returns a conditional value depending on the value of a boolean parameter.
 
Returns if_value if value is true; otherwise, else_value is returned.

${_ifTrue(value, 'if_value', 'else_value')}

• value
  Required; Boolean value (true or false).
• if_value
  Required; Return value if value is true.
• else_value
  Required; Return value if value is false.

Returns a token representing the Resolvable Credential Key Location that you want to embed.

${_credentialKeyLoc('<credential_name>')}

• credential_name
  Required; Name of the Credential.

Returns a token representing the Resolvable Credential Passphrase that you want to embed.

${_credentialPassphrase('<credential_name>')}

• credential_name
  Required; Name of the Credential.

Returns a token representing the Resolvable Credential Token that you want to embed.

${_credentialToken('<credential_name>')}

• credential_name
  Required; Name of the Credential.

Returns a token representing the Resolvable Credential Runtime User that you want to embed.

${_credentialUser('<credential_name>')}

• credential_name
  Required; Name of the Credential.

Returns a token representing the Resolvable Credential Runtime Password that you want to embed.

${_credentialPwd('<credential_name>')}

• credential_name
  Required; Name of the Credential.

Checks if a date argument is equal to today's date in the specified format.
 
Returns true if date is equal to today's date in the specified format; otherwise, false is returned.

${_isToday('date'[, 'format', is_relative])}

• date
  Required; Date to compare to today's date.
• format
  Optional; Format of today's date. Default is yyyy-MM-dd.
• is_relative
  Optional; Specification (true or false) for whether today's date is relative to the trigger/launch time of the task instance. Default is false.

Resolves to the current date and time.

${_date(['format', day_offset, hour_offset, minute_offset])}

Resolves to the current date and time.

${_dateadv(['format', year_offset, month_offset, day_offset, hour_offset, minute_offset])}

Resolves to the current time in milliseconds since Wed Dec 31 1969 19:00:00 GMT-0500 (EST) – the start of Unix epoch time.

${_currentTimeMillis}

n/a

${_formatDate(['date_time', 'format', day_offset, use_business_days, hour_offset, minute_offset, timezone])}

${_formatDateAdv(['date_time', 'format', year_offset, month_offset, day_offset, use_business_days, hour_offset, minute_offset, timezone])}

${_formatDateTz('date_time', 'target_time_zone'[, 'output_format'])}

Returns the day of week for the specified date as a number.

${_dayOfWeek(['date', 'first_dow', first_dow_value])}

${_daysBetween('date1', 'date2')}

${_nonBusinessDayOfMonth(index, ['date', 'format', reverse])}

${_businessDayOfMonth(index, ['date', 'format', reverse])}

Returns the Nth day of month for the month of the date specified. Optionally, can start from the end of the month.

${_dayOfMonth(index, ['date', 'format', reverse])}

${_businessDaysBetween('date1', 'date2')}

Return the sum of the augend added with the addend.

${_add(augend, addend)}

• augend
  Integer to which the addend is being added.
• addend
  Integer being added to the augend.

Return the quotient of the dividend divided by divisor.

${_divide(dividend, divisor)}

• dividend
  Integer being divided by the divisor.
• divisor
  Integer being used to divide the dividend.

Return the product of the multiplicand multiplied with the multiplier.

${_multiply(multiplicand, multiplier)}

• multiplicand
  Integer being multiplied by the multiplier.
• multiplier
  Integer being used to multiply the multiplicand.

Return the absolute value of the parameter.

{_abs(parameter)}

• parameter
  Integer (positive or negative value).

Return the modulo (remainder) of the dividend divided by divisor.

${_mod(dividend, divisor)}

• dividend
  Integer being divided by the divisor.
• divisor
  Integer being used to divide the dividend.

Return the difference of the subtrahend subtracted from the minuend.

${_subtract(minuend, subtrahend)}

• minuend
  Integer from which the subtrahend is being subtracted.
• subtrahend
  Integer being subtracted from the minuend.

Resolves to a delimited list of business service names the task instance is a member of.

${_businessServices(['resultDelimiter'])}

• resultDelimiter
  Optional; Delimiter to use when concatenating business service names. If not specified, ", " will be used.

Resolves to the output data, of the specified outputType, of the task instance that is resolving the function.

• If the output record of the specified ouptutType cannot be found, the function will remain unresolved.

${_output('outputType'[, 'defaultValue'])}

• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
• defaultValue
  Optional; Default value to return if the output data is not found. Default is empty ('').

Resolves to the output data, of the specified outputType, of the task instance specified by the siblingName parameter.
 
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 of the specified outputType cannot be found, the function will remain unresolved.

${_outputFromTask('siblingName', 'outputType'[, 'defaultValue'])}

• siblingName
  Required; Name of a sibling task instance.
• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
• defaultValue
  Optional; Default value to return if the output data is not found. Default is empty ('').

Resolves to the number of lines of output data, of the specified outputType, of the task instance that is resolving the function.

• If the output record of the specified ouptutType cannot be found, the function will remain unresolved.

${_outputNumberOfLines('outputType')}

• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

${_outputNumberOfLines('STDOUT')}
> 6

Resolves to the number of lines of output data, of the specified outputType, of the task instance specified by the siblingName parameter.

• 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 of the specified outputType cannot be found, the function will remain unresolved.

${_outputNumberOfLinesFromTask('siblingName', 'outputType')}

• siblingName
  Required; Name of a sibling task instance.
• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

${_outputNumberOfLinesFromTask('test', 'STDOUT')}
> 8

Resolves to the specified line(s) of output data, of the specified outputType, of the task instance that is resolving the function.

• If the output record of the specified ouptutType cannot be found, the function will remain unresolved.

${_outputLines('outputType', startLine, numberOfLines[, 'defaultValue', 'resultDelimiter'])}

• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
• startLine
  Required; Start line, where 1 is the first line and -1 is the last line.
• numberOfLines
  Required; Number of lines to return starting from the startLine.
• defaultValue
  Optional; Default value to return if no lines qualify. Default is empty ('')
• resultDelimiter
  Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.

Resolves to the specified line(s) of output data, of the specified outputType, of the task instance specified by the siblingName parameter.
 
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 of the specified outputType cannot be found, the function will remain unresolved.

${_outputLinesFromTask('siblingName', 'outputType', startLine, numberOfLines[, 'defaultValue', 'resultDelimiter'])}

• siblingName
  Required; Name of a sibling task instance.
• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
• startLine
  Required; Start line, where 1 is the first line and -1 is the last line.
• numberOfLines
  Required; Number of lines to return starting from the startLine.
• defaultValue
  Optional; Default value to return if no lines qualify. Default is empty ('').
• resultDelimiter
  Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.

Resolves to the line(s) of output data that match the specified regular expression, of the specified outputType, of the task instance that is resolving the function by specifying a regular expression.

• The complete output line is returned.
• If the output record of the specified ouptutType cannot be found, the function will remain unresolved.

${_outputLinesByRegex('outputType', 'regexPattern'[, maxCount, numberOfLinesBefore, numberOfLinesAfter, 'defaultValue', 'resultDelimiter'])}

• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
• regexPattern
  Required; Regular expression used for determining if a line matches. Regular expression must match the whole line (see Example, below).
• maxCount
  Optional; Maximum number of matching lines to return. Default is 1.
• numberOfLinesBefore
  Optional; Number of lines before each matching line to return along with the matching line. Default is 0.
• numberOfLinesAfter
  Optional; Number of lines after each matching line to return along with the matching line. Default is 0.
• defaultValue
  Optional; Default value to return if no lines match the regular expression. Default is empty ('').
• resultDelimiter
  Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.

STDOUT contains:
Some_Text
ABC=Some_String
More_Text
 
${_outputLinesByRegex('STDOUT', '^ABC=')} Returns empty (the whole Line was not matched)
${_outputLinesByRegex('STDOUT', '^ABC=.*')} Returns ABC=Some_String

Resolves to the line(s) of output data that match the specified regular expression, of the specified outputType, of the task instance specified by the siblingName parameter.
 
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 of the specified outputType cannot be found, the function will remain unresolved.

${_outputLinesByRegexFromTask('siblingName', 'outputType', 'regexPattern'[, maxCount, numberOfLinesBefore, numberOfLinesAfter, 'defaultValue', 'resultDelimiter'])}

• siblingName
  Required; Name of a sibling task instance.
• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
• regexPattern
  Required; Regular expression used for determining if a line matches.
• maxCount
  Optional; Maximum number of matching lines to return. Default is 1.
• numberOfLinesBefore
  Optional; Number of lines before each matching line to return along with the matching line. Default is 0.
• numberOfLinesAfter
  Optional; Number of lines after each matching line to return along with the matching line. Default is 0.
• defaultValue
  Optional; Default value to return if no lines match the regular expression. Default is empty ('').
• resultDelimiter
  Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.

Resolves to the XML output data of the task instance that is resolving the function, corresponding to the evaluated XPath 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.

${_outputXPath('outputType', 'xPathExpression'[, 'defaultValue', 'delimiter', prettyPrint])}

• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
• xPathExpression
  Required; XPath expression. https://www.w3schools.com/xml/xpath_intro.asp
• defaultValue
  Optional; Default value to return if the result is not found. Default is empty ('').
• delimiter
  Optional; If xPathExpression 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 XML output will be pretty printed (indented). Default is false.

XML

<message>
  <code>10</code>
</message>

Function

${_outputXPath('STDOUT', '//code/text()')}

Result

10

Resolves to the XML output data of the task instance specified by the siblingName, corresponding to the evaluated XPath 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.

${_outputXPathFromTask('siblingName', 'outputType', 'xPathExpression'[, 'defaultValue', 'delimiter', prettyPrint])}

• siblingName
  Required; Name of a sibling task instance.
• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
• xPathExpression
  Required; XPath expression. https://www.w3schools.com/xml/xpath_intro.asp
• defaultValue
  Optional; Default value to return if the result is not found. Default is empty ('').
• delimiter
  Optional; If xPathExpression 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 XML output will be pretty printed (indented). Default is false.

XML

<message>
  <code>10</code>
</message>

Function

10

Resolves to the JSON output data of the 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.

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

• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
• 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.

JSON

{
  "code": 10
}

Function

${_outputJsonPath('STDOUT', '$.code')}

Result

10

Resolves to the JSON output data of the 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

• siblingName
  Required; Name of a sibling task instance.
• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
• 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.

JSON

{
  "code": 10
}

Function

${_outputJsonPathFromTask('Sibling_With_JSON_Output', 'STDOUT', '$.code')}

Result

10

Resolves to the JSON output data of the 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.

• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
• 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.

JSON

[
  {
    "message" : "Hello",
    "code" : 10
  },
  {
    "message" : "World!",
    "code" : 20
  }
]

Function

${_outputJsonPathAsArray('STDOUT', '$[*].message', '', true)}

Result

[
    "Hello",
    "World!"
]

Resolves to the JSON output data of the 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.

• siblingName
  Required; Name of a sibling task instance.
• outputType
  Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
• 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.

JSON

[
  {
    "message" : "Hello",
    "code" : 10
  },
  {
    "message" : "World!",
    "code" : 20
  }
]

Function

${_outputJsonPathAsArrayFromTask('Sibling_With_JSON_Output', 'STDOUT', '$[*].message')}

Result
["Hello","World!"]

Returns a token representing the path to a temporary file containing the specified task instance output data.

${_outputPath('outputType'[, 'fileExtension'])}


• outputType
  Required; Type of output to create a temporary file for: STDOUT, STDERR, FILE, EXTENSION, JOBLOG, WEBSERVICE, SQL, STOREDPROC.
• fileExtension
  Optional; The extension to use for the temporary file. Can be a maximum of 10 characters.
  • For SQL and STOREDPROC outputType, the result set is translated to comma-separated values (csv), or tab-separated values (tsv), and, therefore, only csv (default) and tsv are supported file extensions.
  • For any other outputType, the default file extension is txt.

Returns a token representing the path to a temporary file containing the specified sibling task instance output data.

${_outputPathFromTask('siblingName', 'outputType'[, 'fileExtension'])}


• siblingName
  Required; Name of a sibling task instance.
• outputType
  Required; Type of output to create a temporary file for: STDOUT, STDERR, FILE, EXTENSION, JOBLOG, WEBSERVICE, SQL, STOREDPROC.
• fileExtension
  Optional; The extension to use for the temporary file. Can be a maximum of 10 characters.
  • For SQL and STOREDPROC outputType, the result set is translated to comma-separated values (csv), or tab-separated values (tsv), and, therefore, only csv (default) and tsv are supported file extensions.
  • For any other outputType, the default file extension is txt.

Returns a token representing the path to a Data Script that you want to embed.

${_scriptPath('script_name')}

• script_name
  Required; Name of the Data Script.

Returns the column names for the SQL results from the current SQL or Stored Procedure task. Column names are separated by the specified separator.

${_resultsColumnNames(['separator'])}

• separator
  Optional; Column name separator. Default is comma (,).

Returns the column names for the SQL results from a sibling SQL or Stored Procedure task, within the same workflow. Column names are separated by the specified separator.

${_resultsColumnNamesFromTask('name'[, 'separator'])}

• name
  Required; Name of the sibling task that the results should come from. The task must be within the same workflow.
• separator
  Optional; Column name separator. Default is comma (,).

Returns all SQL results from the current SQL or Stored Procedure task. Columns are separated by the specified separator and rows are separated by a new line.

${_resultsAll(['separator', 'rowSeparator'])}

• separator
  Optional; Column separator. Default is comma (,).
• rowSeparator
  Optional; Overrides default New Line character.

Returns all SQL results from a sibling SQL or Stored Procedure task, within the same workflow. Columns are separated by the specified separator and rows are separated by a new line.

${_resultsAllFromTask('name'[, 'separator', 'rowSeparator'])}

• name
  Required; Name of the task that the results should come from. The task must be within the same workflow.
• separator
  Optional; Column separator. Default is comma (,).
• rowSeparator
  Optional; Overrides default New Line character.

Returns all SQL warnings from the current SQL or Stored Procedure task. Columns are separated by the specified separator and rows are separated by a new line.

${_SQLWarnings(['separator'])}

• separator
  Optional; Column separator. Default is comma (,).

Returns all SQL warnings from a sibling SQL or Stored Procedure task, within the same workflow. Columns are separated by the specified separator and rows are separated by a new line.

${_SQLWarningsFromTask('name'[, 'separator'])}

• name
  Required; Name of the sibling task that the warnings should come from. The task must be within the same workflow.
• separator
  Optional; Column separator. Default is comma (,).

Returns the string value of a row/column from a previously executed SQL task within the same workflow, or from the current SQL task.

${_resultsColumn('name', 'colname'[, rownum, 'default_value'])}

• name
  Required; Name of a sibling SQL task within the same workflow from which you want the function to fetch results. If you want to execute the function against the current task, use an empty string for the name parameter.
• colname
  Required; Name of column to retrieve.
• rownum
  Optional; Numeric row number in result set to retrieve. Default is 1.
• default_value
  Optional; Default value to return if result not found.

Returns the string value of a row/column from a previously executed SQL task within the same workflow, or from the current SQL task.

${_resultsColumnByNo('name', colnum[, rownum, 'default_value'])}

• name
  Required; Name of a sibling SQL task within the same workflow from which you want the function to fetch results. If you want to execute the function against the current task, use an empty string for the name parameter.
• colnum
  Required; Number of column to retrieve. First column in result is 1, second is 2, and so on.
• rownum
  Optional; Numeric row number in result set to retrieve. Default is 1.
• default_value
  Optional; Default value to return if result not found.

Returns the string values of columns in a specific row in CSV (comma-separated values) format, from a previously executed SQL task within the same workflow, or from the current SQL task.

${_resultsColumnsCSV('name'[, rownum])}

• name
  Required; Name of a sibling SQL task within the same workflow from which you want the function to fetch results. If you want to execute the function against the current task, use an empty string for the name parameter.
• rownum
  Optional; Numeric row number in result set to retrieve. Default is 1.

\t

Insert a tab in the text at this point.

\b

Insert a backspace in the text at this point.

\n

Insert a newline in the text at this point.

\r

Insert a carriage return in the text at this point.

\f

Insert a formfeed in the text at this point.

\'

Insert a single quote character in the text at this point.

\"

Insert a double quote character in the text at this point.

\\

Insert a backslash character in the text at this point.

Converts all of the characters in the value to lower case using the rules of the default locale.

${_toLowerCase('value')}

• value
  Required; String to convert to lower case.

Converts all of the characters in the variable to lower case using the rules of the default locale.

${_varToLowerCase('variableName')}

• variableName
  Required; Name of the variable being passed into the function.

Converts all of the characters in the value to upper case using the rules of the default locale.

${_toUpperCase('value')}

• value
  Required; String to convert to upper case.

Converts all of the characters in the variable to upper case using the rules of the default locale.

${_varToUpperCase('variableName')}

• variableName
  Required; Name of the variable being passed into the function.

Escapes the characters in a variable value using XML entities.

${_varEscapeXml('variableName')}

• variableName
  Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into XML.

Escapes the characters in a variable value using JSON string values.

${_varEscapeJson('variableName')}

• variableName
  Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into JSON.

Escapes the characters in a variable value using JavaScript String rules.

${_varEscapeJavaScript('variableName')}

• variableName
  Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into JavaScript.

Escapes the characters in a variable value using HTML entities. (Supports all known HTML 4.0 entities.)

${_varEscapeHtml('variableName')}

• variableName
  Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into HTML.

Returns a literal regular expression pattern String for the value of the specified variable.
 
This method produces a String that can be used to create a Pattern that would match the String as if it were a literal pattern.

${_varLiteralPattern('variableName')}

• variableName
  Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into a regular expression as a literal pattern.

Randomly generates a String with a specified length.

${_randomString(length[, 'excludeCharacters', 'defaultCharacters'])}

Replaces each substring of value that matches the specified regular expression, regex, with the specified replacement.

${_replaceAll('value', 'regex', 'replacement')}

• value
  Required; Input string.
• regex
  Required; Regular expression.
• replacement
  Required; Replacement string.

Replaces each substring of variableName that matches the specified regular expression, regex, with the specified replacement.

${_varReplaceAll('variableName', 'regex', 'replacement')}

• variableName
  Required; Name of the variable being passed into the function.
• regex
  Required; Regular expression.
• replacement
  Required; Replacement string.

Returns the value of the specified variable encoded using the Base64 encoding scheme.

${_varEncodeBase64('variableName'[, 'charset'])}

• variableName
  Required; Name of the variable whose value will be encoded using the Base64 encoding scheme.
• charset
  Optional; Name of the charset; default UTF-8.

Returns a copy of value, with leading and trailing whitespace omitted.

${_trim('value')}

• value
  Required; String to trim.

Returns a copy of variableName, with leading and trailing whitespace omitted.

${_varTrim('variableName')}

• variableName
  Required; Name of the variable being passed into the function.

Returns the index within the string value of the first occurrence of the specified substring, str.

${_indexOf('value', 'str')}

Returns the index within the string variable of the first occurrence of the specified substring, str.

${_varIndexOf('variableName', 'str')}

Returns the index within this string of the first occurrence of the specified substring plus the specified offset. The integer returned is the smallest value.

${_indexOfWithOffset('value', 'str', offset)}

Returns the index within this string of the first occurrence of the specified substring plus the specified offset. The integer returned is the smallest variable.

${_varIndexOfWithOffset('variableName', 'str', offset)}

Returns the index within the string value of the rightmost occurrence of the specified substring, str.

${_lastIndexOf('value', 'str')}

Returns the index within the string variable of the rightmost occurrence of the specified substring, str.

${_varLastIndexOf('variableName', 'str')}

Returns the index within this string of the rightmost occurrence of the specified substring, plus the specified offset. The returned index is the largest value.

${_lastIndexOfWithOffset('value', 'str', offset)}

Returns the index within this string of the rightmost occurrence of the specified substring, plus the specified offset. The returned index is the largest variable.

${_varLastIndexOfWithOffset('variableName', 'str', offset)}

Returns the length of value.

${_length('value')}

• value
  Required; Any string.

Returns the length of variableName.

${_varLength('variableName'[, useEmptyForUndefined])}

Returns a new string that is a substring of value. The substring begins at beginIndex and extends to the character at endIndex -1.

${_substring('value', beginIndex[, endIndex])}

Returns a new string that is a substring of variableName. The substring begins at beginIndex and extends to the character at endIndex -1.

${_varSubstring('variableName', beginIndex[, endIndex])}

Returns a URL-encoded string according to the ASCII Encoding Reference for UTF-8; all non-alphanumeric characters are replaced with their equivalent hexadecimal escape sequences.

${_varEncodeUrl('variableName')}

• variableName
  Required; Name of the variable whose value will be converted to a URL encoded string.

Displays all the defined and built-in variables associated with the task instance.

${_scope}

(none)

Generates a random number between max (inclusive) and min (inclusive)

${_random([max, min])}

• max
  Optional; Upper bound (inclusive) on the random number. Default is 9.
• min
  Optional; Lower bound (inclusive) on the random number. Default is 0.

Resolves to a 32-byte GUID (Globally Unique ID).

${_guid}

(none)

Resolves to the hostname of the machine running the Controller, if available.

${_hostname}

(none)

Resolves to the IP address of the machine running the Controller.

${_ipaddress}

(none)

Resolves to the sys_id of the first task instance found within the same workflow specified by the sibling name.

${_siblingid('sibling_name')}

• sibling_name
  Required; Sibling name.

Locates the specified variable in the specified sibling task instance within the same workflow and resolves to the variable value.

${_varLookup('sibling_name', 'variable_name'[,'def'])}

• sibling_name
  Required; Name of the sibling task instance from which the function is collecting the variable value.
• variable_name
  Required; Name of the variable being collected by the function.
• def
  Optional; Default value to return if the variable is not defined in the sibling task instance.

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

${_resolve('variable_name', 'default_value')}

• variable_name
  Required; Variable name.
• default_value
  Required; Default value to use if the variable cannot be resolved.

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

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

• 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 Functions#_resolve.)

${_convertArrayFieldVariable('arrayFieldVariableName'[,'delimiter', 'separator', 'keyQuote', 'valueQuote'])}

• arrayFieldVariableName
  Required; Name of the variable for the Array Field; for example, ops_af_p2.
• delimeter
  Optional; Value to be used to delimit the Name from the Value. Default is =.
• separator
  Optional; Value to be used to separate one entry/row from the next. Default is comma (,).
• keyQuote
  Optional; Quoting to be used around the Name. Default is "no quoting."
• valueQuote
  Optional; Quoting to be used around the Value. Default is "no quoting."

${_getArrayFieldVariableValue('arrayFieldVariableName', 'name')}

• arrayFieldVariableName
  Required; Name of the variable for the Array Field; for example, ops_af_p1.
• name
  Required; Name of the entry for which the value is to be returned.

Resolves to the raw output data of the Web Service task instance that is resolving the function.

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

${_responseRaw(['default_value'])}

• default_value
  Optional; Default value to return if the result is not found. Default is empty ('').

Resolves to the raw output data of the Web Service task instance specified by the siblingName parameter.
 
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.

${_responseRawFromTask('siblingName'[,'defaultValue'])}

• siblingName
  Required; Name of a sibling task instance.
• default_value
  Optional; Default value to return if the result is not found. Default is empty ('').

Resolves to the XML output data of the Web Service task instance that is resolving the function, corresponding to the evaluated xPath 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.

${_responseXPath('xPathExpression'[,'defaultValue','delimiter',prettyPrint])}

• xPathExpression
  Required; xPath expression, https://www.w3schools.com/xml/xpath_intro.asp
• defaultValue
  Optional; Default value to return if the result is not found. Default is empty ('').
• delimiter
  Optional; If xPathExpression 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 XML output will be pretty printed (indented). Default is false.

Resolves to the XML output data of the Web Service task instance specified by the siblingName, corresponding to the evaluated xPath 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.

${_responseXPathFromTask('siblingName','xPathExpression'[,'defaultValue','delimiter',prettyPrint])}

• siblingName
  Required; Name of a sibling task instance.
• xPathExpression
  Required; xPath expression, https://www.w3schools.com/xml/xpath_intro.asp
• defaultValue
  Optional; Default value to return if the result is not found. Default is empty ('').
• delimiter
  Optional; If xPathExpression 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 XML output will be pretty printed (indented). Default is false.

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.

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

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

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.

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

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

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.

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

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

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.

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

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