Panel | ||||
---|---|---|---|---|
|
...
(For Web Service output, see 20152753 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. |
...
...
Output
...
CSV Record Count
Description | Resolves to the |
---|
outputType
, of the task instance that is resolving the functionrecord count of CSV data for the specified output Type.
| |
Syntax | ${_ |
---|
outputCsvRecordCount(' |
<outputType>')} | |
Parameters |
|
---|
defaultValue
Optional; Default value to return if the output data is not found. Default is empty ('').
...
Example |
|
---|
Output CSV Record Value Count
Description | Resolves to the |
---|
count of CSV data for the specified record index of the specified outputType |
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
.
|
outputType
| |
Syntax | ${_ |
---|
outputCsvRecordValueCount( |
'outputType' |
, |
recordIndex)} |
Parameters |
---|
siblingName
|
defaultValue
Description
outputType
, of the task instance that is resolving the function
|
...
| |
Example |
|
---|
Output CSV Record Value
Description | Resolves to the value of CSV data for the specified record index & value index of the specified outputType.
|
---|---|
Syntax | ${_ |
outputCsvRecordValue('outputType', recordIndex, valueIndex)} | |
Parameters |
|
---|
${_outputNumberOfLines('STDOUT')
} > 6
...
| |
Example |
|
---|
Output TSV Record Count
Description | Resolves to the |
---|
record count of TSV data for the specified outputType value.
|
| |
Syntax | ${_ |
---|
outputTsvRecordCount(' |
<outputType>')} |
Parameters |
---|
siblingName
|
Description
outputType
, of the task instance that is resolving the function
|
outputType
Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
${_outputNumberOfLinesFromTask
('test', '
')}STDOUT
> 8
...
Example |
|
---|
Output TSV Record Value Count
Description | Resolves to the count of TSV data for the specified record index of the specified outputType.
|
---|---|
Syntax | ${_ |
outputTsvRecordValueCount('outputType', |
recordIndex)} | |
Parameters |
|
---|
startLine
|
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.
...
| |
Example |
|
---|
Output TSV Record Value
Description | Resolves to the |
---|
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
value of TSV data for the specified record index & value index of the specified outputType.
|
outputType
cannot be found
| |
Syntax | ${_ |
---|
outputTsvRecordValue( |
'outputType', |
recordIndex, valueIndex)} |
Parameters |
---|
siblingName
Required; Name of a sibling task instance.
|
startLine
|
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.
...
Description
outputType
,
| |
Example |
|
---|
Output CSV Record Count From Task
Description | Resolves to the record count of CSV output data, of the specified outputType, of the task instance specified by the siblingName parameter. |
---|
must have Read permission for the sibling task instance.
|
ouptutType
| |
Syntax | ${_ |
---|
outputCsvRecordCountFromTask(' |
siblingName', ' |
Description
outputType
, outputType')} | |
Parameters |
|
---|
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
Example |
|
---|
Output CSV Record Value Count From Task
Description | Resolves to the value count of CSV output data, of the specified outputType, & recordIndexof the task instance specified by the siblingName parameter.
|
---|---|
Syntax | ${_outputCsvRecordValueCountFromTask('siblingName', 'outputType', 'recordIndex')} |
Parameters |
|
Example |
|
Output CSV Record Value From Task
Description | Resolves to the value of CSV output data, of the specified outputType, recordIndex & valueIndexof the task instance specified by the siblingName parameter.
|
---|---|
Syntax | ${_ |
outputCsvRecordValueFromTask('siblingName','outputType', |
recordIndex, valueIndex)} | |
Parameters |
|
---|
regexPattern
|
|
maxCount
|
|
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
|
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 |
|
---|
Output TSV Record Count From Task
Description | Resolves to the record count of TSV output data, of the specified outputType, of the task instance specified by the siblingName parameter.
|
---|
|
| |
Syntax | ${_ |
---|
outputTsvRecordCountFromTask(' |
siblingName',' |
outputType')} |
Parameters |
---|
outputType
|
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.
Example
XML
<message>
<code>10</code> </message>
Function${_outputXPath('STDOUT', '//code/text()')}
Result
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.
| |
Example |
|
---|
Output TSV Record Value Count From Task
Description | Resolves to the value count of TSV output data, of the specified outputType, & recordIndexof the task instance specified by the siblingName parameter.
|
---|
|
Syntax
| |
Syntax | ${_outputTsvRecordValueCountFromTask('siblingName','outputType', ' |
---|
recordIndex')} | |
Parameters |
|
---|
xPathExpression
|
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.
Example
XML
<message>
<code>10</code>
</message>Function${_outputXPathFromTask('Sibling_With_XML_Output', 'STDOUT', '//code/text()')}
Result
10
...
Description
| |
Example |
|
---|
Output TSV Record Value From Task
Description | Resolves to the value of TSV output data, of the specified outputType, recordIndex & valueIndexof the task instance specified by the siblingName parameter. |
---|
must have Read permission for the sibling task instance.
|
|
|
| |
Syntax | ${_ |
---|
outputTsvRecordValueFromTask(' |
siblingName',' |
outputType' |
, |
recordIndex, valueIndex)} | |
Parameters |
|
---|
PathExpression
|
defaultValue
Optional; Default value to return if the result is not found. Default is empty ('').
delimiter
Optional; If p
athExpression
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.
| |
Example |
|
---|
Output Delimited Value Count
Description | Resolves to the count of comma delimited output data, of the specified outputType, of the task instance that is resolving the function |
---|
.
|
|
| |
Syntax | ${_ |
---|
outputDelimitedValueCount(' |
outputType', |
[ |
delimiter |
])} |
Parameters |
---|
siblingName
|
outputType
Required; Type of
Description
|
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 p
athExpression
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
...
| |
Example |
|
---|
Output Delimited Value
Description | Resolves to the value of specified valueIndex for comma delimited output data, of the specified outputType, of the task instance that is resolving the function |
---|
.
|
|
|
| |
Syntax | ${_ |
---|
outputDelimitedValue('outputType', valueIndex, |
[delimiter])} | |
Parameters |
|
---|
PathExpression
|
defaultValue
|
|
|
prettyPrint
Optional; Specification (true or false) for whether or not JSON output will be pretty printed (indented). Default is false.
Example
JSON
[
{
"message" : "Hello",
"code" : 10
},
{
"message" : "World!",
"code" : 20
}
]
Function
${_outputJsonPathAsArray('STDOUT', '$[*].message', '', true)}
Result
[
"Hello",
"World!"
]
...
Example |
|
---|
Output Delimited Value Count From Task
Description | Resolves to the |
---|
count of comma delimited 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.
|
|
| |
Syntax | ${_ |
---|
outputDelimitedValueCountFromTask('siblingName','outputType', |
Description
Returns a token representing the path to a temporary file containing the specified task instance output data.
- $(ops_output_path_<instanceId>_<outputType>_<fileExtension>)
[delimiter])} | |
Parameters |
|
---|
PathExpression
Required; JsonPath expression. https://github.com/json-path/Jsonpath
defaultValue
Optional; Default value to return if the result is not found. Default is empty ('').
prettyPrint
Optional; Specification (true or false) for whether or not JSON output will be pretty printed (indented). Default is false.
Example
JSON
[
{
"message" : "Hello",
"code" : 10
},
{
"message" : "World!",
"code" : 20
}
]
Function
${_outputJsonPathAsArrayFromTask(
'Sibling_With_JSON_Output',
'STDOUT', '$[*].message')}
Result
["Hello","World!"]
...
| |
Example |
|
---|
Output Delimited Value From Task
Description | Resolves to the value of specified valueIndex for comma delimited output data, of the specified outputType, of the task instance specified by the siblingName parameter.
|
---|---|
Syntax | ${_ |
outputDelimitedValueFromTask(' |
siblingName' |
,' |
outputType', valueIndex,[delimiter])} | |
Parameters |
|
---|
|
fileExtension
|
|
|
- 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.
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.
- $(ops_output_path_<instanceId>_<outputType>_<fileExtension>)
The resolved token is supported within the Command, Parameters, and Script of a Windows and Linux/Unix Task.
Syntax
| |
Example |
|
---|
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 |
| 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) |
SAP Connection Functions
...
Description
...
Returns a token representing the property associated with an SAP connection
...
Syntax
...
${_sapConnection('<sapConnection_name>', '<property-name>')}
...
Parameters
...
sapConnection_name
Required; Name of the SAP Connection.property_name
Required; Name of the SAP Connection property.
...
${_sapConnection('sap1', 'sap_connection_type')}
→ $(ops_unv_sap_connection_sap_connection_type_3ac17d7f3ecb4df0b81aec9c7a24a38c)
...
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
...
Panel | ||
---|---|---|
| ||
|
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 20152753, 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 value
to lower case using the rules of the default locale.
...
Syntax
...
${_toLowerCase('value')
}
...
Parameters
...
value
Required; String to convert to lower case.
...
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
...
${_varToUpperCase('variableName')
}
...
Parameters
...
variableName
Required; Name of the variable being passed into the function.
...
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 |
---|
${_varEscapeXml('escape_me')} --> `1234567890\E-=[]\;',./ ~!@#$%^&*()_+{}|:"<>? |
...
Description
...
Escapes the characters in a variable value using JSON string values.
...
Syntax
...
${_varEscapeJson('variableName')
}
...
Parameters
...
variableName
Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into JSON.
...
Example
Variable Name:
escape_me
Variable Value:
`1234567890\E-=[]\;',./ ~!@#$%^&*()_+{}|:"<>?
Panel |
---|
${_varEscapeJson('escape_me')} --> `1234567890\\E-=[]\\;',.\/ ~!@#$%^&*()_+{}|:\"<>? |
...
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 |
---|
${_varEscapeJavaScript('escape_me')} --> `1234567890\\E-=[]\\;\',.\/ ~!@#$%^&*()_+{}|:\"<>? |
...
Description
...
Escapes the characters in a variable value using HTML entities. (Supports all known HTML 4.0 entities.)
...
Syntax
...
${_varEscapeHtml('variableName')
}
...
Parameters
...
variableName
Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into HTML.
...
Example
Variable Name:
escape_me
Variable Value:
`1234567890\E-=[]\;',./ ~!@#$%^&*()_+{}|:"<>?
Panel |
---|
${_varEscapeHtml('escape_me')} --> `1234567890\E-=[]\;',./ ~!@#$%^&*()_+{}|:"<>? |
...
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 |
---|
${_varLiteralPattern('escape_me')} --> \Q`1234567890\E\\E\Q-=[]\;',./ ~!@#$%^&*()_+{}|:"<>?\E |
...
Description
...
Randomly generates a String with a specified length.
...
Syntax
...
${_randomString(length[, 'excludeCharacters', 'defaultCharacters'])
}
...
Parameters
length
Required; String length.excludeCharacters
Optional; String containing characters to exclude from the default character set.defaultCharacters
Optional; String for overriding default character set.
Note | ||
---|---|---|
| ||
The following characters are included in the default character set, in addition to the space character. ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890`-=~!@#$%^&*()_+[]\{}|;':",./<>? |
...
Example
Panel |
---|
${_randomString(24, '', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890@#$%*')} --> 5*L8T1RN#$AQWEKPA@BQ19JD |
...
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
...
value
Any string.str
Substring to search for. If thestr
argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
...
Description
...
Returns the index within the string variable of the first occurrence of the specified substring, str
.
...
Syntax
...
${_varIndexOf('variableName', 'str')
}
...
Parameters
...
variableName
Required; Name of the variable being passed into the function.str
Required; Substring to search for. If thestr
argument occurs as a substring within the variable, the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
...
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
...
value
Required; Any string.str
Required; Substring to search for. If thestr
argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.offset
Required; Number (positive or negative) to offset the found index.
...
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
...
variableName
Required; Name of the variable being passed into the function.str
Required; Substring to search for. If thestr
argument occurs as a substring within the variable, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.offset
Required; Number (positive or negative) to offset the found index.
...
Description
...
Returns the index within the string value of the rightmost occurrence of the specified substring, str
.
...
Syntax
...
${_lastIndexOf('value', 'str')
}
...
Parameters
...
value
Required; Any string.str
Required; Substring to search for. If thestr
argument occurs one or more times as a substring within the value, then the index of the first character of the last such substring is returned. If it does not occur as a substring, -1 is returned.
...
Description
...
Returns the index within the string variable of the rightmost occurrence of the specified substring, str
.
...
Syntax
...
${_varLastIndexOf('variableName', 'str')
}
...
Parameters
...
variableName
Required; Name of the variable being passed into the function.str
Required; Substring to search for. If thestr
argument occurs one or more times as a substring within the variable, then the index of the first character of the last such substring is returned. If it does not occur as a substring, -1 is returned.
...
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
...
value
Required; Any string.str
Required; Substring to search for. If thestr
argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.offset
Required; Number (positive or negative) to offset the found index.
...
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
...
variableName
Required; Name of the variable being passed into the function.str
Required; Substring to search for. If thestr
argument occurs as a substring within the variable, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.offset
Required; Number (positive or negative) to offset the found index.
...
Description | Returns the length of |
---|---|
Syntax | ${_length
|
Anchor | ||||
---|---|---|---|---|
|
Description | Resolves to the number of lines of output data, of the specified
|
---|---|
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.
The resolved token is supported within the Command, Parameters, and Script of a Windows and Linux/Unix Task. | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||||||||||||||||||||||
Parameters |
| ||||||||||||||||||||||||||||
Example |
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a token representing the path to a temporary file containing the specified sibling task instance output data.
The resolved token is supported within the Command, Parameters, and Script of a Windows and Linux/Unix Task. | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Syntax |
| ||||||||||||||||||||||||||||
Parameters |
| ||||||||||||||||||||||||||||
Example |
|
SAP Connection Functions
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a token representing the property associated with an SAP connection |
---|---|
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 20152753, 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
...
|
Description | Converts all of the characters in the variable to lower case using the rules of the default locale. |
---|---|
Syntax |
|
Parameters |
useEmptyForUndefined Optional; Specification (true or false) for the handling of a missing variable name
useEmptyForUndefined = true, the function will return 0.useEmptyForUndefined = false, the function will remain unresolved if the variable name does not exist. |
Anchor | ||
---|---|---|
|
...
|
...
Description
...
|
Description | Converts all of the characters in the | ||
---|---|---|---|
Syntax |
| ||
Parameters |
beginIndex Required; Beginning index, inclusive. endIndex Optional; Ending index, exclusive. | Example | panel
|
Anchor | ||||
---|---|---|---|---|
|
Description | Converts all of the characters in the variable to upper case using the rules of the default locale. |
---|---|
Syntax |
|
Parameters |
|
Anchor | ||
---|---|---|
|
...
|
...
|
Description | Returns a new string that is a substring of | ||
---|---|---|---|
Syntax |
| ||
Parameters |
beginIndex Required; Beginning index, inclusive. endIndex Optional; Ending index, exclusive. | Examples | If the value of the food variable is hamburger, and the value of the face variable is smiles:
|
Example | Variable Name:
|
...
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
|
---|
Anchor | ||||
---|---|---|---|---|
|
Description
Resolves to the evaluated XPath expression applied to the value of the specified variable.
If the variable is unresolved, the function will remain unresolved.
Description | Escapes the characters in a variable value using JSON string values. | |
---|---|---|
Syntax |
| |
Parameters |
| |
Example |
Panel |
---|
|
Variable By XPath
Variable Name:
|
Anchor | ||||
---|---|---|---|---|
|
Description | Escapes the characters in a variable value using JavaScript String rules. |
---|---|
Syntax |
|
|
| |
Parameters |
|
---|
|
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 will be pretty printed (indented). Default is false.
Example
my_variable=
<message>
<code>10</code>
</message>
${_varXPath('my_variable', '//code/text()')}
> 10
Variable By JsonPath
...
Description
...
Resolves to the evaluated JsonPath expression applied to the value of the specified variable.
If the variable is unresolved, the function will remain unresolved.
If the variable is undefined, blank, or the path expression does not yield a result, the function will resolve to the default value.
...
Syntax
...
${_varJsonPath('variableName', 'pathExpression'[, 'defaultValue', 'delimiter', prettyPrint])}
...
Parameters
...
variableName
Required; The name of the variable to apply the JsonPath expression to.
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 will be pretty printed (indented). Default is false.
...
Example
...
my_variable=
{
"code": 10
}
${_varJsonPath('my_variable', '$.code')}
> 10
Variable By JsonPath As Array
...
Description
...
Resolves to the evaluated JsonPath expression applied to the value of the specified variable.
If the variable is unresolved, the function will remain unresolved.
If the variable is undefined, blank, or the path expression does not yield a result, the function will resolve to the default value.
...
Syntax
...
${_varJsonPathAsArray('variableName', 'pathExpression'[, 'defaultValue', prettyPrint])}
...
Parameters
...
variableName
Required; The name of the variable to apply the JsonPath expression to.
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 will be pretty printed (indented). Default is false.
...
Example
...
my_variable=
[
{
"message" : "Hello",
"code" : 10
},
{
"message" : "World!",
"code" : 20
}
]
${_varJsonPathAsArray('my_variable', '$[*].message', '', true)}
>
[
"Hello",
"World!"
]
Variable Number of Lines
Description
Resolves to the number of lines the value of the specified variable has.
If the variable is unresolved, the function will remain unresolved.
If the variable is undefined, or blank, the function will resolve to 0.
Syntax
| |||
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 |
|
|
Example
my_variable=
Line 1
Line 2
Line 3
${_varNumberOfLines('my_variable')}
> 3
Variable By Specific Line(s)
Description
Resolves to the specified line(s) of variable data for the specified variable.
If the variable is unresolved, the function will remain unresolved.
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns the value of the specified variable encoded using the Base64 encoding scheme. |
---|---|
Syntax |
|
|
|
|
| |
Parameters |
|
---|
|
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.
Example
my_variable=
Line 1
Line 2
Line 3
Line 4
${_varLines('my_variable', 2, 2)}
>
Line 2
Line 3
Variable By Line(s) Matching Regular Expression
Description
Resolves to the line(s) of variable data that match the specified regular expression, of the specified variable.
If the variable is unresolved, the function will remain unresolved.
| |||
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 |
|
---|
|
|
|
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 the result is not found. 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
my_variable=
Some_Text
ABC=Some_String
More_Text
${_varLinesByRegex('my_variable', '^ABC=')} /* Returns empty (the whole Line was not matched) */
>
${_varLinesByRegex('my_variable', '^ABC=.*')}
> ABC=Some_String
Variable Path
...
Description
Returns a token representing the path to a temporary file containing the value of the specified variable.
$(ops_variable_path_<variableName><fileExtension>)
...
Anchor | ||||
---|---|---|---|---|
|
Description | Returns the index within the string value of the first occurrence of the specified substring, |
---|---|
Syntax |
|
Parameters |
|
Anchor | ||||
---|---|---|---|---|
|
Description
Resolves to the CSV data record count for the specified variable.
If the variable name is undefined, the function will remain unresolved.
If the variable value is unresolved, the function will remain unresolved.
Description | Returns the index within the string variable of the first occurrence of the specified substring, |
---|---|
Syntax |
|
Parameters |
|
Example |
|
Variable CSV Record Count
|
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
variableName
Required; Name of the variable.
Example
my_variable="A","B","C","D"\n
"E","F","G","H"
${_varCsvRecordCount('my_variable')}
> 2
Variable CSV Record Value Count
Description
Resolves to the CSV record value count for the specified variable and record index.
If the variable name is undefined, the function will remain unresolved.
If the variable value is unresolved, the function will remain unresolved.
If the variable is undefined, or the variable value is blank, the function will resolve to 0.
| |
Parameters |
|
---|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns the index within the string value of the rightmost occurrence of the specified substring, |
---|---|
Syntax |
|
|
|
|
Parameters |
---|
variableName
|
|
recordIndex
|
Example
my_variable="A","B","C","D"\n
"E","F","G","H"
${_varCsvRecordValueCount('my_variable','1')}
> 4
Variable CSV Record Value
Description
Resolves to the CSV record value for the specified variable, record index, and variable index.
If the variable name is undefined, the function will remain unresolved.
If the variable value is unresolved, the function will remain unresolved.
|
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 |
---|
variableName
|
|
recordIndex
|
valueIndex
Required; record index number.
Example
my_variable="A","B","C","D"\n
"E","F","G","H"
${_varCsvRecordValue('my_variable','1', '2')}
> G
Variable TSV Record Count
...
Description
...
Resolves to the TSV data record count for the specified variable.
If the variable name is undefined, the function will remain unresolved.
If the variable value is unresolved, the function will remain unresolved.
If the variable is undefined, or the variable value is blank, the function will resolve to 0.
...
Syntax
...
${_varTsvRecordCount('<variableName>')}
...
Parameters
...
variableName
Required; Name of the variable.
...
Example
...
my_variable="A" "B" "C" "D"\n
"E" "F" "G" "H"
${_varTsvRecordCount('my_variable')}
> 2
Variable TSV Record Value Count
Description
Resolves to the TSV record value count for the specified variable and record index.
If the variable name is undefined, the function will remain unresolved.
If the variable value is unresolved, the function will remain unresolved.
If the variable is undefined, or the variable value is blank, the function will resolve to 0.
|
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 |
|
---|
recordIndex
|
Example
my_variable="A","B","C","D"\n
"E","F","G","H"
${_varTsvRecordValueCount('my_variable','1')}
> 4
Variable TSV Record Value
Description
Resolves to the value of TSV data for the specified record index & value index of the specified variable.
If the variable name is undefined, the function will remain unresolved.
If the variable value is unresolved, the function will remain unresolved.
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a new string that is a substring of |
---|---|
Syntax |
|
|
|
|
|
Parameters |
---|
variableName
|
|
recordIndex
|
|
|
valueIndex
|
|
|
|
Example |
---|
my_variable="A","B","C","D"\n
"E","F","G","H"
${_varTsvRecordValue('my_variable','1', '2')}
> G
Output CSV Record Count
Description
Resolves to the record count of CSV data for the specified output Type.
|
Anchor | ||||
---|---|---|---|---|
|
Description | Returns a new string that is a substring of |
---|---|
Syntax |
|
|
|
Parameters |
---|
outputType
|
Example
data="A","B","C","D"\n
"E","F","G","H"
${_outputCsvRecordCount('STDERR')}
> 2
Output CSV Record Value Count
...
Description
...
Resolves to the count of CSV data for the specified record index of the specified outputType.
- If the output record of the specified ouptutType cannot be found, the function will remain unresolved.
- If the output is blank, the function will resolve to 0.
- If an index is invalid, the function will resolve to 0
...
Syntax
...
${_outputCsvRecordValueCount('outputType', recordIndex)}
...
Parameters
...
outputType
Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.recordIndex
Required; record index number.
...
Example
...
data="A","B","C","D"\n
"E","F","G","H"
${_outputCsvRecordValueCount('STDERR','1')}
> 4
Output CSV Record Value
Description
Resolves to the value of CSV data for the specified record index & value index of the specified outputType.
If the output record of the specified ouptutType cannot be found
| |||
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 | Where Variable rawstring contains a value of “
|
Variable By XPath
Description | Resolves to the evaluated XPath expression applied to the value of the specified variable.
|
---|
|
| |
Syntax | ${_ |
---|
varXPath(' |
variableName', 'xPathExpression'[, 'defaultValue', |
'delimiter', prettyPrint])} |
Parameters |
---|
outputType
|
recordIndex
Required; record index number.
valueIndex
Required; record index number.
Example
data="A","B","C","D"\n
"E","F","G","H"
${_varCsvRecordValue('STDOUT','1', '2')}
> G
Output TSV Record Count
...
Description
...
Resolves to the record count of TSV data for the specified outputType value.
- If the output record of the specified ouptutType cannot be found, the function will remain unresolved.
- If the output is blank, the function will resolve to 0.
...
Syntax
...
${_outputTsvRecordCount('<outputType>')}
...
Parameters
...
outputType
Required; Name of the variable.
...
Example
...
data="A" "B" "C" "D"\n
"E" "F" "G" "H"
${_outputTsvRecordCount('STDERR')}
> 2
Output TSV Record Value Count
Description
Resolves to the count of TSV data for the specified record index of the specified outputType.
If the output record of the specified ouptutType cannot be foundThe name of the variable to apply the XPath expression to.
| |
Example |
|
---|
Variable By JsonPath
Description | Resolves to the evaluated JsonPath expression applied to the value of the specified variable.
|
---|
|
If an index is invalid
|
| |
Syntax | ${_ |
---|
Parameters
outputType
Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.recordIndex
Required; record index number.
Example
varJsonPath('variableName', 'pathExpression'[, 'defaultValue', 'delimiter', prettyPrint])} | |
Parameters |
|
---|---|
Example |
|
...
|
Variable By JsonPath As Array
Description | Resolves to the |
---|
evaluated JsonPath expression applied to the value of the specified variable.
|
|
|
|
| |
Syntax | ${_ |
---|
varJsonPathAsArray('variableName', ' |
pathExpression'[, |
'defaultValue', prettyPrint])} |
Parameters |
---|
outputType
|
recordIndex
Required; record index number.
valueIndex
Required; record index number.
Example
The name of the variable to apply the JsonPath expression to.
| |
Example |
|
---|
|
|
|
|
|
|
|
...
|
Variable Number of Lines
Description | Resolves to 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.If the output record of the specified outputType cannot be found
number of lines the value of the specified variable has.
|
| |
Syntax | ${_ |
---|
varNumberOfLines(' |
variableName')} |
Parameters |
---|
siblingName
|
outputType
Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG
The name of the variable to return the number of lines for. |
Example |
---|
|
|
|
Output CSV Record Value Count From Task
Description
Resolves to the value count of CSV output data, of the specified outputType, & recordIndexof 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.
|
Variable By Specific Line(s)
Description | Resolves to the specified line(s) of variable data for the specified variable.
|
---|
|
If an index is invalid, the function will resolve to 0.
| |
Syntax | ${_ |
---|
varLines(' |
variableName', startLine, numberOfLines[, ' |
defaultValue', ' |
resultDelimiter'])} |
Parameters |
---|
siblingName
|
outputType
Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
recordIndex
Required; record index number.
Example
data="A","B","C","D"\n
"E","F","G","H"
${_outputCsvRecordValueCountFromTask('task-1','STDERR','1')}
> 4
Output CSV Record Value From Task
Description
Resolves to the value of CSV output data, of the specified outputType, recordIndex & valueIndexof 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.
The name of the variable to apply the function to.
| |
Example |
|
---|
Variable By Line(s) Matching Regular Expression
Description | Resolves to the line(s) of variable data that match the specified regular expression, of the specified variable.
|
---|
|
| |
Syntax | ${_ |
---|
varLinesByRegex(' |
variableName', ' |
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.recordIndex
Required; record index number.valueIndex
Required; record index number.
Example
data="A","B","C","D"\n
"E","F","G","H"
${_outputCsvRecordValueFromTask('task-1','STDOUT','1', '2')}
> G
Output TSV Record Count From Task
Description
Resolves to the record count of TSV 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.
| |
Example |
|
Variable Path
Description | Returns a token representing the path to a temporary file containing the value of the specified variable.
The resolved token is supported within the Command, Parameters, and Script of a Windows and Linux/Unix Task. |
---|---|
Syntax | ${_ |
varPath(' |
variableName'[, ' |
fileExtension'])} |
Parameters |
---|
siblingName
|
The variable to create a temporary file for. |
outputType
|
Example
data="A" "B" "C" "D"\n
"E" "F" "G" "H"
${_outputTsvRecordCountFromTask('task-1','STDERR')}
> 2
...
Optional; The extension to use for the temporary file. Can be a maximum of 10 characters. Default is txt. | |
Example |
|
---|
Variable CSV Record Count
Description | Resolves to the value count of TSV output data, of the specified outputType, & recordIndexof the task instance specified by the siblingName parameter. CSV data record count for the specified variable.
| |
---|---|---|
Syntax | Example | data="A" "B" "C" ${_outputTsvRecordValueCountFromTask('siblingName','outputType', 'recordIndex')} |
Parameters |
| |
varCsvRecordCount('<variableName>')} | ||
Parameters |
| |
Example |
|
...
Variable CSV Record Value
...
Count
Description | Resolves to the value of TSV output data, of the specified outputType, recordIndex & valueIndexof the task instance specified by the siblingName parameter. CSV record value count for the specified variable and record index.
|
---|---|
Syntax | ${_outputTsvRecordValueFromTaskvarCsvRecordValueCount('siblingNamevariableName', 'outputType', recordIndex, valueIndex)} |
Parameters |
|
Example |
|
...
|
Variable CSV Record Value
Description | Resolves to the count of comma delimited 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 foundthe CSV record value for the specified variable, record index, and variable index.
|
---|---|
Syntax | ${_outputDelimitedValueCountvarCsvRecordValue('outputTypevariableName', recordIndex, [delimiter]valueIndex)} |
Parameters |
|
Example |
|
...
|
Variable TSV Record Count
Description | Resolves to the value of specified valueIndex for comma delimited 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 foundTSV data record count for the specified variable.
| ||
---|---|---|---|
Syntax | ${_outputDelimitedValuevarTsvRecordCount('outputType', valueIndex,[delimiter]<variableName>')} | ||
Parameters | data
| Example |
|
Example |
|
...
|
Variable TSV Record Value Count
...
Description | Resolves to the count of comma delimited output data, of the specified outputType, of the task instance specified by the siblingName parameter. If the output record of the specified ouptutType cannot be foundTSV record value count for the specified variable and record index.
| ||
---|---|---|---|
Syntax | ${_outputDelimitedValueCountFromTaskvarTsvRecordValueCount('siblingNamevariableName', 'outputType', [delimiter]recordIndex)} | ||
Parameters | data
| Example |
|
Example |
|
...
Variable TSV Record Value
Description | Resolves to the value of specified valueIndex for comma delimited output data, of the specified outputType, of the task instance specified by the siblingName parameter. If the output record of the specified ouptutType cannot be foundTSV data for the specified record index & value index of the specified variable.
|
---|---|
Syntax | ${_outputDelimitedValueFromTaskvarTsvRecordValue('siblingNamevariableName', 'outputType'recordIndex, valueIndex,[delimiter])} |
Parameters |
|
Example |
|
Var Delimited Value Count
...
Description | Resolves to the IP address of the machine running the Controller. |
---|---|
Syntax |
|
Parameters | (none) |
Resolve to the Sibling 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 |
|
...