Page Comparison

Panel

Table of Contents

maxlevel	2

...

Description

Returns the date after applying offsets. Optionally, can specify the output format.

Note
Whether a holiday is treated as a business day or a non-business day is specified by the Properties#Exclude #Exclude Holidays for Business Days Universal Controller system property.

Syntax

${_formatDate(['date_time', 'format', day_offset, use_business_days, hour_offset, minute_offset, timezone])}

Parameters

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.html
day_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.

Note
Whether a holiday is treated as a business day or a non-business day is specified by the Properties#Exclude Exclude Holidays for Business Days Universal Controller system property.

Syntax

${_formatDateAdv(['date_time', 'format', year_offset, month_offset, day_offset, use_business_days, hour_offset, minute_offset, timezone])}

Parameters

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.html
year_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.

Note
Whether a holiday is treated as a business day or a non-business day is specified by the Properties#Exclude Exclude Holidays for Business Days Universal Controller system property.

Syntax

${_nonBusinessDayOfMonth(index, ['date', 'format', reverse])}

Parameters

index
Required; Nth non-business day of month.
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.html
- reverse
  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.

Note
Whether a holiday is treated as a business day or a non-business day is specified by the Properties#Exclude Exclude Holidays for Business Days Universal Controller system property.

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.html
reverse
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.

Note
Whether a holiday is treated as a business day or a non-business day is specified by the Properties#Exclude Exclude Holidays for Business Days Universal Controller system property.

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 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

borderStyle	solid

${_scriptPath('MyDataScript')} --> $(ops_unv_script_path_507ffdbd0eba4b62b0e31e0fd22f6bec)

Note

title	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 Scripts#Embedding Embedding a Data Script.

Note

title	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

title	Note

The following characters are included in the default character set, in addition to the space character.

ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890`-=~!@#$%^&*()_+[]\{}|;':",./<>?

Example

Panel
${_randomString(24, '', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890@#$%')} --> 5L8T1RN#$AQWEKPA@BQ19JD

...

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

...

Versions Compared

Old Version 5

New Version 6

Key

Resolve to the Sibling SYS_ID