...
Functions are listed alphabetically within the following categories on this page:
Anchor |
---|
| Conditional Functions |
---|
| Conditional Functions |
---|
|
Conditional Functions
...
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 | 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. - If an index is invalid, the function will resolve to 0.
|
---|
Syntax | ${_varCsvRecordValueCount('variableName', recordIndex)} |
---|
Parameters | |
---|
Example | my_variable="A","B","C","D"\n
"E","F","G","H"
${_varCsvRecordValueCount('my_variable','1')}
> 4
|
---|
...
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. - If the variable is undefined, or the variable value is blank, the function will resolve to nullremain unresolved.
- If an index is invalid, the function will remain unresolved.
|
---|
Syntax | ${_varCsvRecordValue('variableName', recordIndex, valueIndex)} |
---|
Parameters | variableName Required; Name of the variable.
recordIndex Required; record index number.
valueIndex Required; record index number.
|
---|
Example | my_variable="A","B","C","D"\n
"E","F","G","H"
${_varCsvRecordValue('my_variable','1', '2')}
> G
|
---|
...
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. - If an index is invalid, the function will resolve to 0.
|
---|
Syntax | ${_varTsvRecordValueCount('variableName', recordIndex)} |
---|
Parameters | |
---|
Example | my_variable="A","B","C","D"\n
"E","F","G","H"
${_varTsvRecordValueCount('my_variable','1')}
> 4
|
---|
...
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. - If the variable is undefined, or the variable value is blank, the function will remain unresolved.
- If an index is invalid, the function will resolve to nullremain unresolved.
|
---|
Syntax | ${_varTsvRecordValue('variableName', recordIndex, valueIndex)} |
---|
Parameters | variableName Required; Name of the variable.
recordIndex Required; record index number.
valueIndex Required; record index number.
|
---|
Example | my_variable="A","B","C","D"\n
"E","F","G","H"
${_varTsvRecordValue('my_variable','1', '2')}
> G
|
---|
...
Description | Resolves to the record count of CSV data for the specified output Type. outputType is unresolved- output record of the specified ouptutType cannot be found, the function will remain unresolved.
- If the
outputTypeis undefined, - output is blank, the function will resolve to
the default value |
---|
Syntax | ${_outputCsvRecordCount('<outputType>')} |
---|
Parameters | outputType Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
|
---|
Example | data="A","B","C","D"\n
"E","F","G","H"
${_outputCsvRecordCount('STDERR')}
> 2
|
---|
...
Description | Resolves to the count of CSV data for the specified record index of the specified outputType. outputType is unresolved- output record of the specified ouptutType cannot be found, the function will remain unresolved.
- If the
outputType undefined, - blank, the function will resolve to
the default value 0.- 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
|
---|
...
Description | Resolves to the value of CSV data for the specified record index & value index of the specified outputType. outputType is unresolved- output record of the specified ouptutType cannot be found, the function will remain unresolved.
- If the
outputType undefined, resolve to the default value null- remain unresolved.
- If an index is invalid, the function will remain unresolved.
|
---|
Syntax | ${_outputCsvRecordValue('outputType', recordIndex, valueIndex)} |
---|
Parameters | 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"
${_varCsvRecordValue('STDOUT','1', '2')}
> G
|
---|
...
Description | Resolves to the record count of TSV data for the specified outputType value. outputType is unresolved, the - output record of the specified ouptutType cannot be found, the function will remain unresolved.
- If the
outputType undefined, - blank, the function will resolve to
the default value |
---|
Syntax | ${_outputTsvRecordCount('<outputType>')} |
---|
Parameters | |
---|
Example | data="A" "B" "C" "D"\n
"E" "F" "G" "H"
${_outputTsvRecordCount('STDERR')}
> 2
|
---|
...
Description | Resolves to the count of TSV data for the specified record index of the specified outputType. the outputType is unresolved- the output record of the specified ouptutType cannot be found, the function will remain unresolved.
- If the
outputType undefined, - blank, the function will resolve to
the default value - 0.
- If an index is invalid, the function will resolve to 0.
|
---|
Syntax | ${_outputTsvRecordValueCount('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"
${_outputTsvRecordValueCount('STDERR','1')}
> 4
|
---|
...
Description | Resolves to the value of TSV data for the specified record index & value index of the specified outputType. the outputType is unresolved- the output record of the specified ouptutType cannot be found, the function will remain unresolved.
- If the
outputType undefined, resolve to the default value null- remain unresolved.
- If an index is invalid, the function will remain unresolved.
|
---|
Syntax | ${_outputTsvRecordValue('outputType', recordIndex, valueIndex)} |
---|
Parameters | 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"
${_outputTsvValue('my_variable','1', '2')}
> G
|
---|
...
Description | Resolves to the record count of CSV 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 | ${_outputCsvRecordCountFromTask('siblingName', 'outputType')} |
---|
Parameters | siblingName Required; Name of a sibling task instance.
outputType Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
|
---|
Example | data="A","B","C","D"\n
"E","F","G","H"
${_outputCsvRecordCountFromTask('task-1','STDERR')}
> 2
|
---|
...
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. |
---|
Syntax | ${_outputCsvRecordValueCountFromTask('siblingName', 'outputType', 'recordIndex')} |
---|
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.
|
---|
Example | data="A","B","C","D"\n
"E","F","G","H"
${_outputCsvRecordValueCountFromTask('task-1','STDERR','1')}
> 4
|
---|
...
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. |
---|
Syntax | ${_outputCsvRecordValueFromTask('siblingName','outputType', recordIndex, valueIndex)} |
---|
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
|
---|
...
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. |
---|
Syntax | ${_outputTsvRecordCountFromTask('siblingName','outputType')} |
---|
Parameters | |
---|
Example | data="A" "B" "C" "D"\n
"E" "F" "G" "H"
${_outputTsvRecordCountFromTask('task-1','STDERR')}
> 2
|
---|
...
Description | Resolves to the value count of TSV 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. |
---|
Syntax | ${_outputTsvRecordValueCountFromTask('siblingName','outputType', 'recordIndex')} |
---|
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.
|
---|
Example | data="A" "B" "C" "D"\n
"E" "F" "G" "H"
${_outputTsvRecordValueCountFromTask('task-1','STDERR','1')}
> 4
|
---|
...
Description | Resolves to the value of TSV 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. |
---|
Syntax | ${_outputTsvRecordValueFromTask('siblingName','outputType', recordIndex, valueIndex)} |
---|
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"
${_outputTsvRecordValueFromTask('task-1','STDOUT','1', '2')}
> G
|
---|
...
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 | outputType Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
delimiter Optional;delimiter to split the output. default delimiter is comma(,).
|
---|
Example | data="A","B","C","D"
${_outputDelimitedValueCount('STDOUT',':')}
> 4
|
---|
...
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 | outputType Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
valueIndex Required; record index number.
delimiter Optional; delimiter to split the output. default delimiter is comma(,).
|
---|
Example | data="A","B","C","D"
${_outputDelimitedValue('STDOUT','2',':')}
> C
|
---|
...
Description | Resolves to the count of comma delimited output data, of the specified outputType, of the task instance specified by the siblingName parameter. |
---|
Syntax | ${_outputDelimitedValueCountFromTask('siblingName','outputType', [delimiter])} |
---|
Parameters | siblingName Required; Name of a sibling task instance.
outputType Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG. delimiter Optional;delimiter to split the output. default delimiter is comma(,).
|
---|
Example | data="A","B","C","D"
${_outputDelimitedValueCountFromTask('task-1','STDOUT',',')}
> 4
|
---|
...
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 | siblingName Required; Name of a sibling task instance.
outputType Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
valueIndex Required; record index number.
delimiter Optional;delimiter to split the output. default delimiter is comma(,).
|
---|
Example | data="A":"B":"C":"D"
${_outputDelimitedValueFromTask('task-1','STDOUT','2',':')}
> C
|
---|
...
Description | Resolves to the indexed value of delimited values 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 nullremain unresolved. - If an index is invalid, the function will remain unresolved.
|
---|
Syntax | ${_varDelimitedValue('variableName', valueIndex,[delimiter])} |
---|
Parameters | variableName Required; The name of the variable to return the indexed value of delimited strings.
valueIndex Required; record index number.
delimiter Optional;delimiter to split the output. default delimiter is comma(,).
|
---|
Example | data="A":"B":"C":"D"
${_varDelimitedValue('my_variable','2',':')}
> C
|
---|
...
Description | Resolves to the IP address of the machine running the Controller. |
---|
Syntax | ${_ipaddress}
|
---|
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 | ${_siblingid('sibling_name') }
|
---|
Parameters | sibling_name Required; Sibling name.
|
---|
Example |
Panel |
---|
${_siblingid('Timer 60')} --> 5dbaaab943d26172015e10ab3e894e10 |
|
---|
...