...
Description | Returns a conditional value depending on the equality of two string parameters. (Returns if_value if string value1 is equal to string value2 ; otherwise, else_value is returned.) |
---|
Syntax | ${_ifEqual('value1', 'value2', 'if_value', 'else_value'[, ignore_case]) }
|
---|
Parameters | value1 Required; First string.value2 Required; Second string.if_value Required; Return value if value1 equals value2 .else_value Required; Return value if value1 does not equal value2 .ignore_case Optional; Specification (true or false) whether or not to ignore case when comparing value1 and value2 . Default is false.
|
---|
Examples |
Panel |
---|
${_ifEqual('abc','def','YES','NO')}
${_ifEqual('abc','ABC','YES','NO',true)}
${_ifEqual('2015-08-15','${__date('yyyy-MM-dd')}','17:00','18:00')} |
|
---|
Return Conditional Value Depending on Value of Boolean Parameter
...
Description | Returns the date after applying offsets. Optionally, can specify the output format.
|
---|
Syntax | ${_formatDate(['date_time', 'format', day_offset, use_business_days, hour_offset, minute_offset, timezone]) }
|
---|
Parameters | date_time Date and time in any of the following formats:- yyyy-MM-dd
- yyyy-MM-dd HH:mm
- yyyy-MM-dd HH:mm:ss
- yyyy-MM-dd HH:mm Z
- yyyy-MM-dd HH:mm:ss Z.
- yyyy-MM-dd HH:mm:ss.SSS
- yyyy-MM-dd HH:mm:ss.SSS Z.
Default is the current date and time.format Format of returned date. If date_time specifies a time, the default format is yyyy-MM-dd HH:mm; otherwise, the default format is yyyy-MM-dd. For details on the format parameter, see https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.htmlday_offset +/- number of days to offset.use_business_days Specification (true or false ) for whether day_offset is for business days. Default is false.hour_offset +/- number of hours to offset.minute_offset +/- number of minutes to offset.timezone Time Zone that the date is formatted in.
|
---|
Example |
Panel |
---|
${_formatDate} --> 2018-08-24 15:37
${_formatDate()} --> 2018-08-24 15:37
${_formatDate('','MMddyyyy',5)} --> 08292018
${_formatDate('2018-09-01','',5)} --> 2018-09-06
${_formatDate('2018-09-01','',-5)} --> 2018-08-27
${_formatDate('2018-10-13 12:13:14 -0400','',5,true,0,0,'Australia/Sydney')} --> 2018-10-14 03:13:14 +1100 |
|
---|
...
Description | Returns the date after applying offsets. Optionally, can specify the output format.
|
---|
Syntax | ${_formatDateAdv(['date_time', 'format', year_offset, month_offset, day_offset, use_business_days, hour_offset, minute_offset, timezone]) }
|
---|
Parameters | date_time Date and time in any of the following formats:- yyyy-MM-dd
- yyyy-MM-dd HH:mm
- yyyy-MM-dd HH:mm:ss
- yyyy-MM-dd HH:mm Z
- yyyy-MM-dd HH:mm:ss Z.
- yyyy-MM-dd HH:mm:ss.SSS
- yyyy-MM-dd HH:mm:ss.SSS Z.
Default is the current date and time.format Format of returned date. If date_time specifies a time, the default format is yyyy-MM-dd HH:mm; otherwise, the default format is yyyy-MM-dd. For details on the format parameter, see https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.htmlyear_offset Optional; +/- number of years to offset.month_offset Optional; +/- number of months to offset.day_offset Optional; +/- number of days to offset.use_business_days Optional; Specification (true or false) for whether day_offset is for business days. Default is false.hour_offset +/- number of hours to offset.minute_offset +/- number of minutes to offset.timezone Time Zone that the date is formatted in.
|
---|
Examples |
Panel |
---|
${_formatDateAdv} --> 2012-08-24 15:55
${_formatDateAdv()} --> 2012-08-24 15:55
${_formatDateAdv('','MMddyyyy',1)} --> 08242013
${_formatDateAdv('2012-09-01','',0,1)} --> 2012-10-01
${_formatDateAdv('2012-09-01','',0,-1)} --> 2012-08-01
${_formatDateAdv('2012-09-01','',0,0,5,false)} --> 2012-09-06 |
|
---|
...
Description | Returns the Nth non-business day of month for the month of the date specified. Optionally, can start from the end of the month.
|
---|
Syntax | ${_nonBusinessDayOfMonth(index, ['date', 'format', reverse]) }
|
---|
Parameters | index Required; Nth non-business day of month.date
Date (and time) is specified in any of the following formats:- yyyy-MM-dd
- yyyy-MM-dd HH:mm
- yyyy-MM-dd HH:mm:ss
- yyyy-MM-dd HH:mm Z
- yyyy-MM-dd HH:mm:ss Z.
- yyyy-MM-dd HH:mm:ss.SSS
- yyyy-MM-dd HH:mm:ss.SSS Z.
Default is the current date.format Optional; Format of returned date. Default is yyyy-MM-dd. For details on the format parameter, see https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.htmlreverse Optional; Specification (true or false) for starting from the end of the month. Default is false.
|
---|
Examples |
Panel |
---|
${_nonBusinessDayOfMonth(1)} --> 2012-08-04
${_nonBusinessDayOfMonth(1,'2012-09-01')} --> 2012-09-01
${_nonBusinessDayOfMonth(1,'2012-09-01','',true)} --> 2012-09-30 |
|
---|
...
Description | Returns the Nth business day of month for the month of the date specified. Optionally, can start from the end of the month.
|
---|
Syntax | ${_businessDayOfMonth(index, ['date', 'format', reverse]) }
|
---|
Parameters | index Required; Nth business day of month.date Date (and time) is specified in any of the following formats:- yyyy-MM-dd
- yyyy-MM-dd HH:mm
- yyyy-MM-dd HH:mm:ss
- yyyy-MM-dd HH:mm Z
- yyyy-MM-dd HH:mm:ss Z.
- yyyy-MM-dd HH:mm:ss.SSS
- yyyy-MM-dd HH:mm:ss.SSS Z.
Default is the current date.format Optional; Format of returned date. Default is yyyy-MM-dd. For details on the format parameter , see https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.htmlreverse Optional; Specification (true or false ) for starting from the end of the month. Default is false.
|
---|
Examples |
Panel |
---|
${_businessDayOfMonth(1)} --> 2012-08-01
${_businessDayOfMonth(1,'2012-09-01')} --> 2012-09-04
${_businessDayOfMonth(1,'2012-09-01','',true)} --> 2012-09-28 |
|
---|
...
Description | Returns the number of business days between date1 and date2. - If return value is > 0,
date2 is after date1 . - If return value is < 0,
date2 is before date1 . - If return value is 0,
date1 is equal to date2 .
The start date is inclusive, but the end date is not.
|
---|
Syntax | ${_businessDaysBetween('date1', 'date2') }
|
---|
Parameters | date1 Required.date2 Required.
date1 and date2 are specified in any of the following formats: - yyyy-MM-dd
- yyyy-MM-dd HH:mm
- yyyy-MM-dd HH:mm:ss
- yyyy-MM-dd HH:mm Z
- yyyy-MM-dd HH:mm:ss Z.
- yyyy-MM-dd HH:mm:ss.SSS
- yyyy-MM-dd HH:mm:ss.SSS Z.
|
---|
Example |
Panel |
---|
${_businessDaysBetween('2012-08-01','2012-09-01')} --> 23 |
|
---|
...
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 |
---|
| 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) |
|
---|
...
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 |
---|
| 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 |
---|
| application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'WEBSERVICE', 'json')}
> application.exe -file $(ops_output_path_1639503212294088671CAWMP3VNQ468B_webservice_json) |
|
---|
...
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
Description | Returns a token representing the path to a Scripts#Data Data Scripts that you want to Scripts#Embedding Embedding a Data Script. |
---|
Syntax | ${_scriptPath('script_name')}
|
---|
Parameters | script_name Required; Name of the Data Script.
|
---|
Example | Script Name: MyDataScript Script UUID: 507ffdbd0eba4b62b0e31e0fd22f6bec Panel |
---|
| ${_scriptPath('MyDataScript')} --> $(ops_unv_script_path_507ffdbd0eba4b62b0e31e0fd22f6bec)
|
|
---|
Note |
---|
|
_scriptPath requires Agent 6.4.0.0 or later.
|
...
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 | 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 | variableName Required; The variable to create a temporary file for.
fileExtension Optional; The extension to use for the temporary file. Can be a maximum of 10 characters. Default is txt.
|
---|
Example | application.exe -file ${_varPath('my_variable')}
> application.exe -file $(ops_variable_path_my_variable_txt)
application.exe -file ${_varPath('my_variable', 'csv')}
> application.exe -file $(ops_variable_path_my_variable_csv)
|
---|
...
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 |
|
---|
...