...
Universal Controller supports a number of functions that can be specified in free-text fields. They are resolved when a task instance runs or when a Creating a Set Variable Action within a Task or Workflow action containing a function is executed.
...
Anchor |
---|
| Conditional Functions |
---|
| Conditional Functions |
---|
|
Conditional Functions
Return Conditional Value Depending on Equality of String Parameters
...
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 if value is true.else_value Required; Return value if value is false.
|
---|
Example |
Panel |
---|
${_ifTrue(${__isToday('Mon', 'E')},'20:00','22:00')} |
|
---|
Anchor |
---|
| Credential Functions |
---|
| Credential Functions |
---|
|
Credential Functions
Anchor |
---|
| Return Key Location |
---|
| Return Key Location |
---|
|
Return Key Location of a Credential
...
Description | Returns a token representing the Credentials#Resolvable Credentials Runtime Password that you want to embed. |
---|
Syntax | ${_credentialPwd('<credential_name>') }
|
---|
Parameters | credential_name Required; Name of the Credential.
|
---|
Example |
Panel |
---|
${_credentialPwd('RCredentialXYZ')} → $(ops_unv_cred_pwd_c89e7b2caf4247909bc46041df8a2643)
|
|
---|
Anchor |
---|
| Database Connection Functions |
---|
| Database Connection Functions |
---|
|
Database Connection Functions
Returns Property of a Database Connection
Description | Returns a token representing the property associated with a Database connection. |
---|
Syntax | ${_databaseConnection('<database_connection_name>', '<property_name>') }
|
---|
Parameters | |
---|
Example |
Panel |
---|
${_databaseConnection('db1', 'type')}→ $(ops_unv_db_connection_type_3ac17d7f3ecb4df0b81aec9c7a24a38c)
|
|
---|
Anchor |
---|
| Date Functions |
---|
| Date Functions |
---|
|
Date Functions
Checks if Date Argument Equals Today's Date
...
Description | Return the difference of the subtrahend subtracted from the minuend. |
---|
Syntax | ${_subtract(minuend, subtrahend) }
|
---|
Parameters | minuend Integer from which the subtrahend is being subtracted.subtrahend Integer being subtracted from the minuend .
|
---|
Example |
Panel |
---|
${_subtract('77','33')} --> 44
${_subtract('33','77')} --> -44 |
Using Variables for minuend and subtrahend (${minuend} = 100, ${subtrahend} = 5): Panel |
---|
${_subtract('${minuend}','${ subtrahend }')} --> 95 |
|
---|
Anchor |
---|
| Other Task Functions |
---|
| Other Task Functions |
---|
|
Other Task Functions
Anchor |
---|
| Business Services List |
---|
| Business Services List |
---|
|
Business Services Membership
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.
|
---|
Example | If a task instance is a member of business services A, B, and C. Panel |
---|
| ${_businessServices()}
A, B, C
|
Panel |
---|
| ${_businessServices('\n')} A B C
|
If a task instance is not a member of any business service, the function will evaluate to empty. |
---|
Anchor |
---|
| Output Functions |
---|
| Output Functions |
---|
|
Output Functions
(For Web Service output, see Web Service Functions.)
...
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.
Note |
---|
When using a JsonPath function, the output must be ONLY a JSON formatted string. If the output contains leading or trailing text, the function will fail to work properly. |
|
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.
Note |
---|
When using a JsonPath function, the output must be ONLY a JSON formatted string. If the output contains leading or trailing text, the function will fail to work properly. |
|
Syntax | ${_outputJsonPathFromTask('siblingName', 'outputType', 'pathExpression'[, '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.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.
Note |
---|
When using a JsonPath function, the output must be ONLY a JSON formatted string. If the output contains leading or trailing text, the function will fail to work properly. |
|
Syntax | ${_outputJsonPathAsArray('outputType', 'pathExpression'[, 'defaultValue', 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 ('').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!"
]
|
...
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.
Note |
---|
When using a JsonPath function, the output must be ONLY a JSON formatted string. If the output contains leading or trailing text, the function will fail to work properly. |
|
Syntax | ${_outputJsonPathFromTask('siblingName', 'outputType', 'pathExpression'[, 'defaultValue', prettyPrint])} |
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 [
{
"message" : "Hello",
"code" : 10
},
{
"message" : "World!",
"code" : 20
}
]
Function
${_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. - $(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 | ${_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.
|
---|
Example |
Code Block |
---|
language | text |
---|
linenumbers | true |
---|
|
| Code Block |
---|
language | application.exe -file ${_outputPath('STDOUT')}
> application.exe -file $(ops_output_path_1638302212442528629FTPBE4AJQV2FT_stdout_txt) |
Code Block |
---|
language | text |
---|
linenumbers | true |
---|
| application.exe -file ${_outputPath('SQL')}
> application.exe -file $(ops_output_path_1639503212294078671DNPMULGSEVMHT_sql_csv) |
Code Block |
---|
language | text |
---|
linenumbers | true |
---|
| application.exe -file ${_outputPath('SQL', 'tsv')}
> application.exe -file $(ops_output_path_1639503212294078671DNPMULGSEVMHT_sql_tsv) |
Code Block |
---|
language | text |
---|
linenumbers | true |
---|
| application.exe -file ${_outputPath('EXTENSION', 'json')}
> application.exe -file $(ops_output_path_1639503212294187671OAI9SM79CNC2V_extension_json) |
|
---|
Anchor |
---|
| Sibling Task Instance Output Path |
---|
| Sibling Task Instance Output Path |
---|
|
Sibling Task Instance Output Path
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 | ${_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.
|
---|
Example | Code Block |
---|
---|
language | text |
---|
linenumbers | true |
Code Block |
---|
language | text |
---|
linenumbers | true |
---|
| application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'STDERR')}
> application.exe -file $(ops_output_path_1639503212294128671YL1B04U3OT55P_stderr_txt) |
Code Block |
---|
language | text |
---|
linenumbers | true |
---|
| application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'STOREDPROC')}
> application.exe -file $(ops_output_path_1639503212294197671Q13UV8MSH6355_storedproc_csv) |
Code Block |
---|
language | text |
---|
linenumbers | true |
---|
| application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'STOREDPROC', 'tsv')}
> application.exe -file $(ops_output_path_1639503212294197671Q13UV8MSH6355_storedproc_tsv) |
Code Block |
---|
language | text |
---|
linenumbers | true |
---|
| Code Block |
---|
language | text |
---|
linenumbers | true |
---|
| Code Block |
---|
language | text |
---|
linenumbers | true |
---|
| application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'WEBSERVICE', 'json')}
> application.exe -file $(ops_output_path_1639503212294088671CAWMP3VNQ468B_webservice_json) |
|
SAP Connection Functions
Anchor |
---|
| SAP Connection Function |
---|
| SAP Connection Function |
---|
|
Returns Property of an SAP Connection
Description | Returns a token representing the property associated with an SAP connection |
---|
Syntax | ${_sapConnection('<sap_connection_name>', '<property_name>')}
|
---|
Parameters | |
---|
Example | ${_sapConnection('sap1', 'sap_connection_type')}
→ $(ops_unv_sap_connection_sap_connection_type_3ac17d7f3ecb4df0b81aec9c7a24a38c)
|
---|
Anchor |
---|
| Script Functions |
---|
| Script Functions |
---|
|
Script Functions
Anchor |
---|
| Returns Path to Data Script |
---|
| Returns Path to Data Script |
---|
|
Returns Path to Data Script
...
Note |
---|
|
_scriptPath requires Agent 6.4.0.0 or later.
|
Anchor |
---|
| SQL/Stored Procedure Functions |
---|
| SQL/Stored Procedure Functions |
---|
|
SQL/Stored Procedure Functions
Return Column Names for SQL Results from Current Task
...
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 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.
Note |
---|
When using a JsonPath function, the output must be ONLY a JSON formatted string. If the output contains leading or trailing text, the function will fail to work properly. |
|
---|
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
|
---|
...
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.
Note |
---|
When using a JsonPath function, the output must be ONLY a JSON formatted string. If the output contains leading or trailing text, the function will fail to work properly. |
|
---|
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!"
]
|
---|
...
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 Glossary#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 |
|
---|
...