...
Functions are entered using the following formats:
Panel | ||
---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
...
Functions are listed alphabetically within the following categories on this page:
- Conditional functions
- Credential functions
- Date functions
- Mathematical functions
- Output functions
- Other Task functions
- Script functions
- SQL/Stored Procedure functions
- String functions
- System functions
- Universal Task functions
- Web Service Functions
...
Return Conditional Value Depending on Equality of String Parameters
...
Description
...
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.)
...
Syntax
...
${_ifEqual('value1', 'value2', 'if_value', 'else_value'[, ignore_case])
}
...
Parameters
...
value1
Required; First string.value2
Required; Second string.if_value
Required; Return value ifvalue1
equalsvalue2
.else_value
Required; Return value ifvalue1
does not equalvalue2
.ignore_case
Optional; Specification (true or false) whether or not to ignore case when comparingvalue1
andvalue2
. Default is false.
...
Examples
...
Return Conditional Value Depending on Value of Boolean Parameter
...
Description
...
Returns a conditional value depending on the value of a boolean parameter.
Returns if_value
if value
is true; otherwise, else_value
is returned.
...
Syntax
...
${_ifTrue(value, 'if_value', 'else_value')
}
...
Parameters
...
value
Required; Boolean value (true or false).if_value
Required; Return value ifvalue
is true.else_value
Required; Return value ifvalue
is false.
...
Example
...
Description
...
Returns a token representing the Resolvable Credential Key Location that you want to embed.
...
Syntax
...
${_credentialKeyLoc('<credential_name>')
}
...
Parameters
...
credential_name
Required; Name of the Credential.
...
Panel |
---|
|
...
Description
...
Returns a token representing the Resolvable Credential Passphrase that you want to embed.
...
Syntax
...
${_credentialPassphrase('<credential_name>')
}
...
Parameters
...
credential_name
Required; Name of the Credential.
...
Panel |
---|
${_credentialPassphrase('RCredentialXYZ')} → $(ops_unv_cred_passphrase_c89e7b2caf4247909bc46041df8a2643) |
...
Description
...
Returns a token representing the Resolvable Credential Token that you want to embed.
...
Syntax
...
${_credentialToken('<credential_name>')
}
...
Parameters
...
credential_name
Required; Name of the Credential.
...
Panel |
---|
${_credentialToken('RCredentialXYZ')} → $(ops_unv_cred_token_c89e7b2caf4247909bc46041df8a264 |
Return User Name of a Credential
...
Description
...
Returns a token representing the Resolvable Credential Runtime User that you want to embed.
...
Syntax
...
${_credentialUser('<credential_name>')
}
...
Parameters
...
credential_name
Required; Name of the Credential.
...
Panel |
---|
|
Return User Password of a Credential
...
Description
...
Returns a token representing the Resolvable Credential Runtime Password that you want to embed.
...
Syntax
...
${_credentialPwd('<credential_name>')
}
...
Parameters
...
credential_name
Required; Name of the Credential.
...
Panel |
---|
|
...
Checks if Date Argument Equals Today's Date
...
Description
...
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.
...
Syntax
...
${_isToday('date'[, 'format', is_relative])
}
...
Parameters
...
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.
...
Examples
...
Description
...
Resolves to the current date and time.
...
Syntax
...
${_date(['format', day_offset, hour_offset, minute_offset])
}
...
Parameters
...
...
Examples
...
Resolve to Current Date and Time (Advanced)
...
Description
...
Resolves to the current date and time.
...
Syntax
...
${_dateadv(['format', year_offset, month_offset, day_offset, hour_offset, minute_offset])
}
...
Parameters
...
...
Examples
...
Resolve to Current Unix Epoch Time
...
Description
...
Resolves to the current time in milliseconds since Wed Dec 31 1969 19:00:00 GMT-0500 (EST) – the start of Unix epoch time.
...
Syntax
...
${_currentTimeMillis}
...
Parameters
...
n/a
Return Date with Offsets
...
Description
...
Returns the date after applying offsets. Optionally, can specify the output format.
Note |
---|
Whether a holiday is treated as a business day or a non-business day is specified by the Exclude Holidays for Business Days Universal Controller system property. |
...
Syntax
...
${_formatDate(['date_time', 'format', day_offset, use_business_days, hour_offset, minute_offset, timezone])
}
...
Parameters
...
...
Example
...
Return Date with Offsets (Advanced)
...
Description
...
Returns the date after applying offsets. Optionally, can specify the output format.
Note |
---|
Whether a holiday is treated as a business day or a non-business day is specified by the Exclude Holidays for Business Days Universal Controller system property. |
...
Syntax
...
${_formatDateAdv(['date_time', 'format', year_offset, month_offset, day_offset, use_business_days, hour_offset, minute_offset, timezone])
}
...
Parameters
...
...
Examples
...
Return Date with Time Zone
...
Syntax
...
${_formatDateTz('date_time', 'target_time_zone'[, 'output_format'])
}
...
Parameters
...
Examples
...
Return Day of Week
...
Description
...
Returns the day of week for the specified date as a number.
...
Syntax
...
${_dayOfWeek(['date', 'first_dow', first_dow_value])
}
...
Parameters
...
Example
...
Return Days between Dates
...
Description
...
Returns the number of days between date1 and date2.
The start date is inclusive, but the end date is not.
...
Syntax
...
${_daysBetween('date1', 'date2')
}
...
Parameters
...
Example
...
Return Non-Business Day of Month
...
Description
...
Returns the Nth non-business day of month for the month of the date specified. Optionally, can start from the end of the month.
Note |
---|
Whether a holiday is treated as a business day or a non-business day is specified by the Exclude Holidays for Business Days Universal Controller system property. |
...
Syntax
...
${_nonBusinessDayOfMonth(index, ['date', 'format', reverse])
}
...
Parameters
Html bobswift |
---|
<ul>
<li> Functions <i>must</i> be written either:
<ul>
<li> In all lower-case characters.
<li> Exactly as shown in the tables on this page.
</ul>
<li> Functions have zero, one, or multiple parameters.
<li> Each function parameter is one of three specific types:
<ul>
<li> String
<li> Integer
<li> Boolean
</ul>
<li> String parameters <i>must</i> be enclosed in <b>single or double</b> quotation marks.
<li> Integer and Boolean parameters <i>can</i> be enclosed in <b>single or double</b> quotation marks.
<li> Optional parameters are identified on this page by being enclosed in [square brackets]. When copying a function from the documentation, be sure to remove the square brackets; otherwise, the function will not resolve.
<li> If a function has more than one optional parameter, any optional parameters preceding a specified optional parameter must be included in the function's parameter list. For example:
<ul>
<li> For function <code>${_responseJsonPath('pathExpression'[,'defaultValue','delimiter',prettyPrint])}</code>, usage <code>${_responseJsonPath('.outputData','','',true)}</code> would be valid, whereas <code>${_responseJsonPath('.outputData',,,true)}</code> would not be valid.
<li> For function <code>${_formatDate(['date_time', 'format', day_offset, use_business_days, hour_offset, minute_offset, timezone])}</code>, usage <code>${_formatDate('2018-09-01','',0,true)}</code> would be valid, whereas <code>${_formatDate('2018-09-01','',,true)}</code> would not be valid.
</ul>
<li> All functions allow nesting to two levels. That is, a function can be an argument to another function, which itself can be an argument to another function.
<ul>
<li> You must use a double underscore preceding the name of a first-level nested function.
<li> You must use a triple underscore preceding the name of a second-level nested function.
</ul><br>
For example, for 2nd day of next month less one Business Day:
</ul> |
Panel | ||
---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Functions are listed alphabetically within the following categories on this page:
- Conditional functions
- Credential functions
- Date functions
- Mathematical functions
- Output functions
- Other Task functions
- Script functions
- SQL/Stored Procedure functions
- String functions
- System functions
- Universal Task functions
- Web Service Functions
Anchor | ||||
---|---|---|---|---|
|
Return Conditional Value Depending on Equality of String Parameters
Description | Returns a conditional value depending on the equality of two string parameters. | ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
| ||||
Examples |
|
Return Conditional Value Depending on Value of Boolean Parameter
Description | Returns a conditional value depending on the value of a boolean parameter. | ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
| ||||
Example |
|
Anchor | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a token representing the Resolvable Credential Key Location that you want to embed. | ||
---|---|---|---|
Syntax |
| ||
Parameters |
| ||
Example |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a token representing the Resolvable Credential Passphrase that you want to embed. | ||
---|---|---|---|
Syntax |
| ||
Parameters |
| ||
Example |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a token representing the Resolvable Credential Token that you want to embed. | ||
---|---|---|---|
Syntax |
| ||
Parameters |
| ||
Example |
|
Return User Name of a Credential
Description | Returns a token representing the Resolvable Credential Runtime User that you want to embed. | ||
---|---|---|---|
Syntax |
| ||
Parameters |
| ||
Example |
|
Return User Password of a Credential
Description | Returns a token representing the Resolvable Credential Runtime Password that you want to embed. | ||
---|---|---|---|
Syntax |
| ||
Parameters |
| ||
Example |
|
Anchor | ||||
---|---|---|---|---|
|
Checks if Date Argument Equals Today's Date
Description | Checks if a date argument is equal to today's date in the specified format. | ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
| ||||
Examples |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Resolves to the current date and time. |
---|---|
Syntax |
|
Parameters |
...
Examples
...
Return Nth Day of Month
...
Description
...
Returns the Nth day of month for the month of the date specified. Optionally, can start from the end of the month.
...
Syntax
...
${_dayOfMonth(index, ['date', 'format', reverse])
}
...
Parameters
...
Examples
...
Return Number of Business Days between Dates
...
Description
...
Returns the number of business days between date1 and date2.
The start date is inclusive, but the end date is not.
Note |
---|
Whether a holiday is treated as a business day or a non-business day is specified by the Exclude Holidays for Business Days Universal Controller system property. |
...
Syntax
...
${_businessDaysBetween('date1', 'date2')
}
...
Parameters
...
Example
...
Add
Description | Return the sum of the augend added with the addend
https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html | Examples | |||
---|---|---|---|---|---|
Panel |
Return Nth Business Day of Month
...
Description
...
Returns the Nth business day of month for the month of the date specified. Optionally, can start from the end of the month.
Note |
---|
Whether a holiday is treated as a business day or a non-business day is specified by the Exclude Holidays for Business Days Universal Controller system property. |
...
Syntax
...
${_businessDayOfMonth(index, ['date', 'format', reverse])
}
...
Parameters
...
| |||||
Examples |
|
---|
Resolve to Current Date and Time (Advanced)
Description | Resolves to the current date and time. | |||
---|---|---|---|---|
Syntax |
| |||
Parameters |
| Example | ||
Panel | ||||
Panel |
Divide
...
Description
...
Return the quotient of the dividend divided by divisor.
...
Syntax
...
${_divide(dividend, divisor)
}
...
Parameters
...
dividend
Integer being divided by thedivisor
.divisor
Integer being used to divide thedividend
.
...
Example
...
Using Variables for dividend and divisor (${dividend} = 100, ${divisor} = 5)
...
Multiply
...
Description
...
Return the product of the multiplicand multiplied with the multiplier.
...
Syntax
...
${_multiply(multiplicand, multiplier)
}
...
Parameters
...
multiplicand
Integer being multiplied by themultiplier
.multiplier
Integer being used to multiply themultiplicand
.
...
Example
...
Using Variables for multiplicand and multiplier (${multiplicand} = 100, ${multiplier} = 5):
...
Return Absolute Value
...
Description
...
Return the absolute value of the parameter.
...
Syntax
...
{_abs(parameter)
}
...
Parameters
...
parameter
Integer (positive or negative value).
...
Example
...
Using Variables for parameter (${parameter} = -100):
...
Return Modulo
...
Description
...
Return the modulo (remainder) of the dividend divided by divisor.
...
Syntax
...
${_mod(dividend, divisor)
}
...
Parameters
...
dividend
Integer being divided by thedivisor
.divisor
Integer being used to divide thedividend
.
...
Example
...
Using Variables for dividend and divisor (${dividend} = 23, ${divisor} = 5):
...
Subtract
...
Description
...
Return the difference of the subtrahend subtracted from the minuend.
...
Syntax
...
${_subtract(minuend, subtrahend)
}
...
Parameters
...
minuend
Integer from which thesubtrahend
is being subtracted.subtrahend
Integer being subtracted from theminuend
.
...
Example
...
Using Variables for minuend and subtrahend (${minuend} = 100, ${subtrahend} = 5):
...
Description
...
Resolves to a delimited list of business service names the task instance is a member of.
...
Syntax
...
${_businessServices(['resultDelimiter'])
}
...
Parameters
...
resultDelimiter
Optional; Delimiter to use when concatenating business service names. If not specified, ", " will be used.
...
If a task instance is a member of business services A, B, and C.
Panel | ||
---|---|---|
| ||
|
Panel | ||
---|---|---|
| ||
|
If a task instance is not a member of any business service, the function will evaluate to empty.
...
(For Web Service output, see Web Service Functions.)
Note | ||
---|---|---|
| ||
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. |
...
Description
...
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.
...
Syntax
...
${_output('outputType'[, 'defaultValue'])
}
...
Parameters
...
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 ('').
Sibling Task Instance Output
...
Description
...
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.
...
Syntax
...
${_outputFromTask('siblingName', 'outputType'[, 'defaultValue'])
}
...
Parameters
...
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 ('').
...
Description
...
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.
...
Syntax
...
${_outputNumberOfLines('outputType')}
...
Parameters
...
outputType
Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
...
${_outputNumberOfLines('STDOUT')
} > 6
...
Description
...
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.
...
Syntax
...
${_outputNumberOfLinesFromTask('siblingName', 'outputType')}
...
Parameters
...
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
...
Description
...
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.
...
Syntax
...
${_outputLines('outputType', startLine, numberOfLines[, 'defaultValue', 'resultDelimiter'])
}
...
Parameters
...
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 thestartLine
.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.
Sibling Task Instance Output by Specific Line(s)
...
Description
...
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.
...
Syntax
...
${_outputLinesFromTask('siblingName', 'outputType', startLine, numberOfLines[, 'defaultValue', 'resultDelimiter'])
}
...
Parameters
...
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 thestartLine
.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.
...
Description
...
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.
...
Syntax
...
${_outputLinesByRegex('outputType', 'regexPattern'[, maxCount, numberOfLinesBefore, numberOfLinesAfter, 'defaultValue', 'resultDelimiter'])
}
...
Parameters
...
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.
...
Example
...
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
Sibling Task Instance Output by Line(s) Matching Regular Expression
...
Description
...
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.
...
Syntax
...
${_outputLinesByRegexFromTask('siblingName', 'outputType', 'regexPattern'[, maxCount, numberOfLinesBefore, numberOfLinesAfter, 'defaultValue', 'resultDelimiter'])
}
...
Parameters
...
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.
...
Description
...
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.
...
Syntax
...
${_outputXPath('outputType', 'xPathExpression'[, 'defaultValue', 'delimiter', prettyPrint])}
...
Parameters
...
outputType
Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.xPathExpression
Required; XPath expression. https://www.w3schools.com/xml/xpath_intro.aspdefaultValue
Optional; Default value to return if the result is not found. Default is empty ('').delimiter
Optional; IfxPathExpression
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.
...
Example
XML
...
10
Sibling Task Instance Output By XPath
...
Description
...
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.
...
Syntax
...
${_outputXPathFromTask('siblingName', 'outputType', 'xPathExpression'[, 'defaultValue', 'delimiter', prettyPrint])}
...
Parameters
...
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.aspdefaultValue
Optional; Default value to return if the result is not found. Default is empty ('').delimiter
Optional; IfxPathExpression
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.
...
Example
XML
...
10
...
Description
...
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.
...
Syntax
...
${_outputJsonPath('outputType', 'pathExpression'[, 'defaultValue', 'delimiter', prettyPrint])}
...
Parameters
...
outputType
Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.PathExpression
Required; JsonPath expression. https://github.com/json-path/JsonpathdefaultValue
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.
...
Example
JSON
{
"code": 10
}
Function
${_outputJsonPath('STDOUT', '$.code')}
Result
10
Sibling Task Instance Output By JsonPath
...
Description
...
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
...
Syntax
...
Parameters
...
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/JsonpathdefaultValue
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.
...
Example
JSON
{
"code": 10
}
Function
${_outputJsonPathFromTask('Sibling_With_JSON_Output', 'STDOUT', '$.code')}
Result
10
...
Description
...
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.
...
Syntax
...
Parameters
...
outputType
Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.PathExpression
Required; JsonPath expression. https://github.com/json-path/JsonpathdefaultValue
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.
...
Example
JSON
...
[
"Hello",
"World!"
]
Sibling Task Instance Output By JsonPath As Array
...
Description
...
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.
...
Syntax
...
Parameters
...
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/JsonpathdefaultValue
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.
...
Example
JSON
...
${_outputJsonPathAsArrayFromTask(
'Sibling_With_JSON_Output',
'STDOUT', '$[*].message')}
Result
["Hello","World!"]
...
Description
...
Returns a token representing the path to a temporary file containing the specified task instance output data.
...
Syntax
...
${_outputPath('outputType'[, 'fileExtension'])}
...
Parameters
...
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.
- For SQL and STOREDPROC
...
Example
...
Code Block | ||||
---|---|---|---|---|
| ||||
application.exe -file ${_outputPath('STDOUT')}
> application.exe -file $(ops_output_path_1638302212442528629FTPBE4AJQV2FT_stdout_txt) |
Code Block | ||||
---|---|---|---|---|
| ||||
application.exe -file ${_outputPath('SQL')}
> application.exe -file $(ops_output_path_1639503212294078671DNPMULGSEVMHT_sql_csv) |
Code Block | ||||
---|---|---|---|---|
| ||||
application.exe -file ${_outputPath('SQL', 'tsv')}
> application.exe -file $(ops_output_path_1639503212294078671DNPMULGSEVMHT_sql_tsv) |
Code Block | ||||
---|---|---|---|---|
| ||||
application.exe -file ${_outputPath('EXTENSION', 'json')}
> application.exe -file $(ops_output_path_1639503212294187671OAI9SM79CNC2V_extension_json) |
...
Description
...
Returns a token representing the path to a temporary file containing the specified sibling task instance output data.
...
Syntax
...
${_outputPathFromTask('siblingName', 'outputType'[, 'fileExtension'])}
...
Parameters
...
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.
- For SQL and STOREDPROC
...
Example
...
Code Block | ||||
---|---|---|---|---|
| ||||
application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'STDERR')}
> application.exe -file $(ops_output_path_1639503212294128671YL1B04U3OT55P_stderr_txt) |
Code Block | ||||
---|---|---|---|---|
| ||||
application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'STOREDPROC')}
> application.exe -file $(ops_output_path_1639503212294197671Q13UV8MSH6355_storedproc_csv) |
Code Block | ||||
---|---|---|---|---|
| ||||
application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'STOREDPROC', 'tsv')}
> application.exe -file $(ops_output_path_1639503212294197671Q13UV8MSH6355_storedproc_tsv) |
Code Block | ||||
---|---|---|---|---|
| ||||
application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'WEBSERVICE', 'json')}
> application.exe -file $(ops_output_path_1639503212294088671CAWMP3VNQ468B_webservice_json) |
...
Description
...
Returns a token representing the path to a Data Script that you want to embed.
...
Syntax
...
${_scriptPath('script_name')}
...
Parameters
...
script_name
Required; Name of the Data Script.
...
Example
...
Script Name: MyDataScript
Script UUID: 507ffdbd0eba4b62b0e31e0fd22f6becPanel | ||
---|---|---|
| ||
|
Note | ||
---|---|---|
| ||
The Agent will replace the resolved token with a path to a temporary file containing the content of the Data Script. For additional details, refer to Embedding a Data Script. |
Note | ||
---|---|---|
| ||
|
...
Return Column Names for SQL Results from Current Task
...
Description
...
Returns the column names for the SQL results from the current SQL or Stored Procedure task. Column names are separated by the specified separator
.
...
Syntax
...
${_resultsColumnNames(['separator'])
}
...
Parameters
...
separator
Optional; Column name separator. Default is comma (,).
Return Column Names for SQL Results from Sibling Task
...
Description
...
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
.
...
Syntax
...
${_resultsColumnNamesFromTask('name'[, 'separator'])
}
...
Parameters
...
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 (,).
Return SQL Results from Current Task
...
Description
...
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.
...
Syntax
...
${_resultsAll(['separator', 'rowSeparator'])
}
...
Parameters
...
separator
Optional; Column separator. Default is comma (,).rowSeparator
Optional; Overrides default New Line character.
Return SQL Results from Sibling Task
...
Description
...
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.
...
Syntax
...
${_resultsAllFromTask('name'[, 'separator', 'rowSeparator'])
}
...
Parameters
...
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.
Return SQL Warnings from Current Task
Description | Returns all SQL warnings from the current SQL or Stored Procedure task. Columns are separated by the specified |
---|---|
Syntax |
|
Parameters |
|
Return SQL Warnings from Sibling Task
...
Description
...
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.
...
Syntax
...
${_SQLWarningsFromTask('name'[, 'separator'])
}
...
Parameters
...
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 (,).
Return String Value of Row/Column by Column Name
...
Description
...
Returns the string value of a row/column from a previously executed SQL task within the same workflow, or from the current SQL task.
...
Syntax
...
${_resultsColumn('name', 'colname'[, rownum, 'default_value'])
}
...
Parameters
...
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.
Return String Value of Row/Column by Column Number
...
Description
...
Returns the string value of a row/column from a previously executed SQL task within the same workflow, or from the current SQL task.
...
Syntax
...
${_resultsColumnByNo('name', colnum[, rownum, 'default_value'])
}
...
Parameters
...
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.
Return String Values of Columns
...
Description
...
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.
...
Syntax
...
${_resultsColumnsCSV('name'[, rownum])
}
...
Parameters
...
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 thename
parameter.rownum
Optional; Numeric row number in result set to retrieve. Default is 1.
...
String Functions can accept:
- String content in a String parameter.
- Variable name in a String parameter (prefixed with _var) from which string content can be obtained.
- Integer and Boolean parameters.
For String functions that accept a String value parameter directly, the value parameter can be specified using hard-coded text, variables, functions, or any combination of the three.
Note | ||
---|---|---|
| ||
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, 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.
Note | ||
---|---|---|
| ||
Indexing functions use zero-based numbering; that is, the initial element is assigned the index 0. |
...
An escape character preceded by a backslash (\) is an escape sequence (see the following table for a list of escape sequences).
If you are using a String function to manipulate a String value that potentially may contain an escape sequence, you should use the String function that accepts a variable name parameter to allow for passing the value to the function without the escape sequence being interpreted.
...
Escape Sequences
...
Escape Sequence Description
...
\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.
...
Description | Converts all of the characters in the |
---|---|
Syntax |
|
Parameters |
|
...
Description | Converts all of the characters in the variable to lower case using the rules of the default locale. |
---|---|
Syntax |
|
Parameters |
|
...
Description
...
Converts all of the characters in the value
to upper case using the rules of the default locale.
...
Syntax
...
${_toUpperCase('value')
}
...
Parameters
...
value
Required; String to convert to upper case.
...
Description | Converts all of the characters in the variable to upper case using the rules of the default locale. |
---|---|
Syntax |
|
Parameters |
|
...
Description
...
Escapes the characters in a variable value using XML entities.
...
Syntax
...
${_varEscapeXml('variableName')
}
...
Parameters
...
variableName
Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into XML.
...
Example
...
Variable Name:
escape_me
Variable Value:
`1234567890\E-=[]\;',./ ~!@#$%^&*()_+{}|:"<>?
Panel |
---|
&apos & " < > |
...
Description | Escapes the characters in a variable value using JSON string values. | ||
---|---|---|---|
Syntax |
| ||
Parameters |
| ||
Example | Variable Name:
|
...
Description
...
Escapes the characters in a variable value using JavaScript String rules.
...
Syntax
...
${_varEscapeJavaScript('variableName')
}
...
Parameters
...
variableName
Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into JavaScript.
...
Example
...
Variable Name:
escape_me
Variable Value:
`1234567890\E-=[]\;',./ ~!@#$%^&*()_+{}|:"<>?
Panel |
---|
<> |
...
Description | Escapes the characters in a variable value using HTML entities. (Supports all known HTML 4.0 entities.) | ||||
---|---|---|---|---|---|
Syntax | ${_varEscapeHtml
https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html
| ||||
Examples |
|
Resolve to Current Unix Epoch Time
Description | Resolves to the current time in milliseconds since Wed Dec 31 1969 19:00:00 GMT-0500 (EST) – the start of Unix epoch time. |
---|---|
Syntax |
|
Parameters | n/a |
Return Date with Offsets
Description | Returns the date after applying offsets. Optionally, can specify the output format.
| ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html
| ||||
Example |
|
Return Date with Offsets (Advanced)
Description | Returns the date after applying offsets. Optionally, can specify the output format.
| ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html
| ||||
Examples |
|
Return Date with Time Zone
Description | Returns the Date and Time in another time zone. | ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
| ||||
Examples |
|
Return Day of Week
Description | Returns the day of week for the specified date as a number. | ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
| ||||
Example |
|
Return Days between Dates
Description | Returns the number of days between date1 and date2.
The start date is inclusive, but the end date is not. | ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
| ||||
Example |
|
Return Non-Business Day of Month
Description | Returns the Nth non-business day of month for the month of the date specified. Optionally, can start from the end of the month.
| ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html
| ||||
Examples |
|
Return Nth Business Day of Month
Description | Returns the Nth business day of month for the month of the date specified. Optionally, can start from the end of the month.
| ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html
| ||||
Examples |
|
Return Nth Day of Month
Description | Returns the Nth day of month for the month of the date specified. Optionally, can start from the end of the month. | ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
| ||||
Examples |
|
Return Number of Business Days between Dates
Description | Returns the number of business days between date1 and date2.
The start date is inclusive, but the end date is not.
| ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
| ||||
Example |
|
Anchor | ||||
---|---|---|---|---|
|
Add
Description | Return the sum of the augend added with the addend. | ||||||||
---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||
Parameters |
| ||||||||
Example |
|
Divide
Description | Return the quotient of the dividend divided by divisor. | ||||||||
---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||
Parameters |
| ||||||||
Example |
|
Multiply
Description | Return the product of the multiplicand multiplied with the multiplier. | ||||||||
---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||
Parameters |
| ||||||||
Example |
|
Return Absolute Value
Description | Return the absolute value of the parameter. | ||||||||
---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||
Parameters |
| ||||||||
Example |
|
Return Modulo
Description | Return the modulo (remainder) of the dividend divided by divisor. | ||||||||
---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||
Parameters |
| ||||||||
Example |
|
Subtract
Description | Return the difference of the subtrahend subtracted from the minuend. | ||||||||
---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||
Parameters |
| ||||||||
Example |
|
Anchor | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Description | Resolves to a delimited list of business service names the task instance is a member of. | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||||
Parameters |
| ||||||||||
Example | If a task instance is a member of business services A, B, and C.
If a task instance is not a member of any business service, the function will evaluate to empty. |
Anchor | ||||
---|---|---|---|---|
|
(For Web Service output, see Web Service Functions.)
Note | ||
---|---|---|
| ||
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. |
Anchor | ||||
---|---|---|---|---|
|
Description | Resolves to the output data, of the specified
|
---|---|
Syntax |
|
Parameters |
|
Sibling Task Instance Output
Description | Resolves to the output data, of the specified
|
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Resolves to the number of lines of output data, of the specified outputType, of the task instance that is resolving the function.
|
---|---|
Syntax |
|
Parameters |
|
Example |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Resolves to the number of lines of output data, of the specified outputType, of the task instance specified by the siblingName parameter.
|
---|---|
Syntax |
|
Parameters |
|
Example | ${ |
Anchor | ||||
---|---|---|---|---|
|
Description | Resolves to the specified line(s) of output data, of the specified
|
---|---|
Syntax |
|
Parameters |
|
Sibling Task Instance Output by Specific Line(s)
Description | Resolves to the specified line(s) of output data, of the specified
|
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Resolves to the line(s) of output data that match the specified regular expression, of the specified
|
---|---|
Syntax |
|
Parameters |
|
Example | STDOUT contains: |
Sibling Task Instance Output by Line(s) Matching Regular Expression
Description | Resolves to the line(s) of output data that match the specified regular expression, of the specified
|
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Resolves to the XML output data of the task instance that is resolving the function, corresponding to the evaluated XPath expression.
|
Syntax |
|
Parameters |
|
Example |
|
Sibling Task Instance Output By XPath
Description | Resolves to the XML output data of the task instance specified by the 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.
|
Syntax |
|
Parameters |
|
Example |
${_outputXPathFromTask('Sibling_With_XML_Output', 'STDOUT', '//code/text()')}
|
Anchor | ||||
---|---|---|---|---|
|
Description | Resolves to the JSON output data of the task instance that is resolving the function, corresponding to the evaluated JsonPath expression.
|
Syntax |
|
Parameters |
|
Example |
|
Sibling Task Instance Output By JsonPath
Description | Resolves to the JSON output data of the task instance specified by the 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.
|
Syntax | ${_outputJsonPathFromTask('siblingName', 'outputType', 'pathExpression'[, 'defaultValue', 'delimiter', prettyPrint])} |
Parameters |
|
Example |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Resolves to the JSON output data of the task instance that is resolving the function, corresponding to the evaluated JsonPath expression.
|
Syntax | ${_outputJsonPathAsArray('outputType', 'pathExpression'[, 'defaultValue', prettyPrint])} |
Parameters |
|
Example |
|
Sibling Task Instance Output By JsonPath As Array
Description | Resolves to the JSON output data of the task instance specified by the 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.
|
Syntax | ${_outputJsonPathFromTask('siblingName', 'outputType', 'pathExpression'[, 'defaultValue', prettyPrint])} |
Parameters |
|
Example | JSON
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a token representing the path to a temporary file containing the specified task instance output data. | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||||||||||||||||||||||
Parameters |
| ||||||||||||||||||||||||||||
Example |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a token representing the path to a temporary file containing the specified sibling task instance output data. | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||||||||||||||||||||||
Parameters |
| ||||||||||||||||||||||||||||
Example |
|
Anchor | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a token representing the path to a Data Script that you want to embed. | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||||
Parameters |
| ||||||||||
Example | Script Name: MyDataScript Script UUID: 507ffdbd0eba4b62b0e31e0fd22f6bec
|
Note | ||
---|---|---|
| ||
|
Anchor | ||||
---|---|---|---|---|
|
Return Column Names for SQL Results from Current Task
Description | Returns the column names for the SQL results from the current SQL or Stored Procedure task. Column names are separated by the specified |
---|---|
Syntax |
|
Parameters |
|
Return Column Names for SQL Results from Sibling Task
Description | 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 |
---|---|
Syntax |
|
Parameters |
|
Return SQL Results from Current Task
Description | Returns all SQL results from the current SQL or Stored Procedure task. Columns are separated by the specified |
---|---|
Syntax |
|
Parameters |
|
Return SQL Results from Sibling Task
Description | Returns all SQL results from a sibling SQL or Stored Procedure task, within the same workflow. Columns are separated by the specified |
---|---|
Syntax |
|
Parameters |
|
Return SQL Warnings from Current Task
Description | Returns all SQL warnings from the current SQL or Stored Procedure task. Columns are separated by the specified |
---|---|
Syntax |
|
Parameters |
|
Return SQL Warnings from Sibling Task
Description | Returns all SQL warnings from a sibling SQL or Stored Procedure task, within the same workflow. Columns are separated by the specified |
---|---|
Syntax |
|
Parameters |
|
Return String Value of Row/Column by Column Name
Description | Returns the string value of a row/column from a previously executed SQL task within the same workflow, or from the current SQL task. |
---|---|
Syntax |
|
Parameters |
|
Return String Value of Row/Column by Column Number
Description | Returns the string value of a row/column from a previously executed SQL task within the same workflow, or from the current SQL task. |
---|---|
Syntax |
|
Parameters |
|
Return String Values of Columns
Description | 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. |
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
String Functions can accept:
- String content in a String parameter.
- Variable name in a String parameter (prefixed with _var) from which string content can be obtained.
- Integer and Boolean parameters.
For String functions that accept a String value parameter directly, the value parameter can be specified using hard-coded text, variables, functions, or any combination of the three.
Note | ||
---|---|---|
| ||
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, 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.
Note | ||
---|---|---|
| ||
Indexing functions use zero-based numbering; that is, the initial element is assigned the index 0. |
Anchor | ||||
---|---|---|---|---|
|
An escape character preceded by a backslash (\) is an escape sequence (see the following table for a list of escape sequences).
If you are using a String function to manipulate a String value that potentially may contain an escape sequence, you should use the String function that accepts a variable name parameter to allow for passing the value to the function without the escape sequence being interpreted.
Escape Sequences | Escape Sequence Description |
---|---|
\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. |
Anchor | ||||
---|---|---|---|---|
|
Description | Converts all of the characters in the |
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Converts all of the characters in the variable to lower case using the rules of the default locale. |
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Converts all of the characters in the |
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Converts all of the characters in the variable to upper case using the rules of the default locale. |
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Escapes the characters in a variable value using XML entities. | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||||||||
Parameters |
| ||||||||||||||
Example | Variable Name:
|
Anchor | ||||
---|---|---|---|---|
|
Description | Escapes the characters in a variable value using JSON string values. | ||||||
---|---|---|---|---|---|---|---|
Syntax |
| ||||||
Parameters |
| ||||||
Example | Variable Name:
|
Anchor | ||||
---|---|---|---|---|
|
Description | Escapes the characters in a variable value using JavaScript String rules. | ||||||
---|---|---|---|---|---|---|---|
Syntax |
| ||||||
Parameters |
| ||||||
Example | Variable Name:
|
Anchor | ||||
---|---|---|---|---|
|
Description | Escapes the characters in a variable value using HTML entities. (Supports all known HTML 4.0 entities.) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||||||
Parameters |
| ||||||||||||
Example | Variable Name:
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a literal regular expression pattern String for the value of the specified variable. | ||||||
---|---|---|---|---|---|---|---|
Syntax |
| ||||||
Parameters |
| ||||||
Example | Variable Name:
|
Anchor | ||||
---|---|---|---|---|
|
Description | Randomly generates a String with a specified length. | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Syntax |
| |||||||||||
Parameters |
| |||||||||||
Example |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Replaces each substring of value that matches the specified regular expression, regex, with the specified replacement. |
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Replaces each substring of |
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns the value of the specified variable encoded using the Base64 encoding scheme. | ||
---|---|---|---|
Syntax |
| ||
Parameters |
| ||
Example | Where Variable rawstring contains a value of "Test String":
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a copy of |
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a copy of |
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns the index within the string value of the first occurrence of the specified substring, | ||
---|---|---|---|
Syntax |
| ||
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns the index within the string variable of the first occurrence of the specified substring, | ||
---|---|---|---|
Syntax |
| ||
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | 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. | ||
---|---|---|---|
Syntax |
| ||
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | 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. | ||
---|---|---|---|
Syntax |
| ||
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns the index within the string value of the rightmost occurrence of the specified substring, | ||
---|---|---|---|
Syntax |
| ||
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns the index within the string variable of the rightmost occurrence of the specified substring, | ||
---|---|---|---|
Syntax |
| ||
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | 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. | ||
---|---|---|---|
Syntax |
| ||
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | 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. | ||
---|---|---|---|
Syntax |
| ||
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns the length of |
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns the length of | ||
---|---|---|---|
Syntax |
| ||
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a new string that is a substring of | ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
| ||||
Example |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a new string that is a substring of | ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
| ||||
Examples | If the value of the
|
Anchor | ||||
---|---|---|---|---|
|
Description | 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. | ||
---|---|---|---|
Syntax |
| ||
Parameters |
| ||
Example | Variable Name:
|
...
Description
...
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.
...
Syntax
...
${_varLiteralPattern('variableName')
}
...
Parameters
...
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.
...
Example
...
Variable Name:
escape_me
Variable Value:
`1234567890\E-=[]\;',./ ~!@#$%^&*()_+{}|:"<>?
Panel |
---|
<> |
...
Description
...
Randomly generates a String with a specified length.
...
Syntax
...
${_randomString(length[, 'excludeCharacters', 'defaultCharacters'])
}
...
Parameters
...
Note | ||
---|---|---|
| ||
The following characters are included in the default character set, in addition to the space character. <> |
...
Example
...
Description
...
Replaces each substring of value that matches the specified regular expression, regex, with the specified replacement.
...
Syntax
...
${_replaceAll('value', 'regex', 'replacement')
}
...
Parameters
...
value
Required; Input string.regex
Required; Regular expression.replacement
Required; Replacement string.
...
Description
...
Replaces each substring of variableName
that matches the specified regular expression, regex, with the specified replacement.
...
Syntax
...
${_varReplaceAll('variableName', 'regex', 'replacement')
}
...
Parameters
...
variableName
Required; Name of the variable being passed into the function.regex
Required; Regular expression.replacement
Required; Replacement string.
...
Description
...
Returns the value of the specified variable encoded using the Base64 encoding scheme.
...
Syntax
...
${_varEncodeBase64('variableName'[, 'charset'])}
...
Parameters
...
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.
...
Where Variable rawstring contains a value of "Test String":
Panel |
---|
|
...
Description
...
Returns a copy of value
, with leading and trailing whitespace omitted.
...
Syntax
...
${_trim('value')
}
...
Parameters
...
value
Required; String to trim.
...
Description
...
Returns a copy of variableName
, with leading and trailing whitespace omitted.
...
Syntax
...
${_varTrim('variableName')
}
...
Parameters
...
variableName
Required; Name of the variable being passed into the function.
...
Description
...
Returns the index within the string value of the first occurrence of the specified substring, str
.
...
Syntax
...
${_indexOf('value', 'str')
}
...
Parameters
...
Description
...
Returns the index within the string variable of the first occurrence of the specified substring, str
.
...
Syntax
...
${_varIndexOf('variableName', 'str')
}
...
Parameters
...
Description
...
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.
...
Syntax
...
${_indexOfWithOffset('value', 'str', offset)
}
...
Parameters
...
Description
...
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.
...
Syntax
...
${_varIndexOfWithOffset('variableName', 'str', offset)
}
...
Parameters
...
Description
...
Returns the index within the string value of the rightmost occurrence of the specified substring, str
.
...
Syntax
...
${_lastIndexOf('value', 'str')
}
...
Parameters
...
Description
...
Returns the index within the string variable of the rightmost occurrence of the specified substring, str
.
...
Syntax
...
${_varLastIndexOf('variableName', 'str')
}
...
Parameters
...
Description
...
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.
...
Syntax
...
${_lastIndexOfWithOffset('value', 'str', offset)
}
...
Parameters
...
Description
...
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.
...
Syntax
...
${_varLastIndexOfWithOffset('variableName', 'str', offset)
}
...
Parameters
...
Description
...
Returns the length of value
.
...
Syntax
...
${_length('value')
}
...
Parameters
...
value
Required; Any string.
...
Description
...
Returns the length of variableName
.
...
Syntax
...
${_varLength('variableName'[, useEmptyForUndefined])
}
...
Parameters
...
Description
...
Returns a new string that is a substring of value
. The substring begins at beginIndex
and extends to the character at endIndex
-1.
...
Syntax
...
${_substring('value', beginIndex[, endIndex])
}
...
Parameters
...
Example
...
Description
...
Returns a new string that is a substring of variableName
. The substring begins at beginIndex
and extends to the character at endIndex
-1.
...
Syntax
...
${_varSubstring('variableName', beginIndex[, endIndex])
}
...
Parameters
...
Examples
If the value of the food
variable is hamburger, and the value of the face
variable is smiles:
...
Description
...
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.
...
Syntax
...
${_varEncodeUrl('variableName')}
...
Parameters
...
variableName
Required; Name of the variable whose value will be converted to a URL encoded string.
...
Where Variable rawstring contains a value of “ABC$%^----DEF
":
Panel |
---|
|
...
Display Variables
...
Description
...
Displays all the defined and built-in variables associated with the task instance.
...
Syntax
...
${_scope}
...
Parameters
...
(none)
...
Example
...
Generate Random Number
...
Description
...
Generates a random number between max
(inclusive) and min
(inclusive)
...
Syntax
...
${_random([max, min])
}
...
Parameters
...
max
Optional; Upper bound (inclusive) on the random number. Default is 9.min
Optional; Lower bound (inclusive) on the random number. Default is 0.
Resolve to GUID (Globally Unique ID)
Description | Resolves to a 32-byte GUID (Globally Unique ID). |
---|---|
Syntax |
|
Parameters | (none) |
Resolve to Host Name
Description | Resolves to the hostname of the machine running the Controller, if available. |
---|---|
Syntax |
|
Parameters | (none) |
Resolve to IP Address
Description | Resolves to the IP address of the machine running the Controller. |
---|---|
Syntax |
|
Parameters | (none) |
Resolve to SYS_ID
...
Description
...
Resolves to the sys_id of the first task instance found within the same workflow specified by the sibling name.
...
Syntax
...
${_siblingid('sibling_name')
}
...
Parameters
...
sibling_name
Required; Sibling name.
...
Example
...
Resolve to Variable Value
...
Description
...
Locates the specified variable in the specified sibling task instance within the same workflow and resolves to the variable value.
...
Syntax
...
${_varLookup('sibling_name', 'variable_name'[,'def'])
}
...
Parameters
...
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.
Resolve Variable
...
Description
...
Resolves the variable specified by the variable_name
parameter and substitutes the default_value
if the variable cannot be resolved.
...
Syntax
...
${_resolve('variable_name', 'default_value')
}
...
Parameters
...
variable_name
Required; Variable name.default_value
Required; Default value to use if the variable cannot be resolved.
Resolve Variable (Advanced)
...
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. (Ifuse_default_if_blank
is false,_resolveadv
behaves like _resolve.)
...
Where Variable rawstring contains a value of “
|
Anchor | ||||
---|---|---|---|---|
|
Display Variables
Description | Displays all the defined and built-in variables associated with the task instance. | ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters | (none) | ||||
Example |
|
Generate Random Number
Description | Generates a random number between |
---|---|
Syntax |
|
Parameters |
|
Resolve to GUID (Globally Unique ID)
Description | Resolves to a 32-byte GUID (Globally Unique ID). |
---|---|
Syntax |
|
Parameters | (none) |
Resolve to Host Name
Description | Resolves to the hostname of the machine running the Controller, if available. |
---|---|
Syntax |
|
Parameters | (none) |
Resolve to IP Address
Description | Resolves to the IP address of the machine running the Controller. |
---|---|
Syntax |
|
Parameters | (none) |
Resolve to SYS_ID
Description | Resolves to the sys_id of the first task instance found within the same workflow specified by the sibling name. | ||||
---|---|---|---|---|---|
Syntax |
| ||||
Parameters |
| ||||
Example |
|
Resolve to Variable Value
Description | Locates the specified variable in the specified sibling task instance within the same workflow and resolves to the variable value. |
---|---|
Syntax |
|
Parameters |
|
Resolve Variable
Description | Resolves the variable specified by the |
---|---|
Syntax |
|
Parameters |
|
Resolve Variable (Advanced)
Description | Resolves the variable specified by the |
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Convert Array Field Variable
Description | Given the variable name representing the Array field, generate a String of delimited Array field entry data.
| |||||
---|---|---|---|---|---|---|
Syntax |
| |||||
Parameters |
| |||||
Example |
|
Get Array Field Variable Value
Description | Given the variable name representing the Array field , generate a String of delimited Array field entry dataand the name of an entry in the Array field, return the value for the entry.
| |||||
---|---|---|---|---|---|---|
Syntax |
| |||||
Parameters | ||||||
Description | Given the variable name representing the Array field and the name of an entry in the Array field, return the value for the entry.
| |||||
Syntax |
| |||||
Parameters |
| |||||
Example | Panel |
| Example | |||
Panel |
Get Array Field Variable Value
| |||||
Example |
|
---|
Anchor | ||||
---|---|---|---|---|
|
...
Description | Resolves to the XML output data of the Web Service task instance that is resolving the function, corresponding to the evaluated xPath expression.
| ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||||||||
Parameters |
| ||||||||||||||
Examples | If you want to obtain the Panel | Panel | the
Select the info node in the document no matter where it is.
Select the info node from a specific path in the document, starting from the root node. |
...