Predefined variables

Predefined variables

Time Zones in variables:

Cloud: If it’s scheduled execution, variables are interpolated using scheduled job's timezone (which is set while creating SJ). When it’s manual execution, user’s timezone is being used.

Server & Data Center: System timezone is always used (both in manual and scheduled executions)

The Scheduler has a feature of predefined variables which can be used in any text field. When Scheduled Issue is fired those variables are converted into corresponding values.

Most of the variables can be replaced through formatted usage of the formatted variables for created date ( ${createdDate.format("dd-MM-yyyy HH:mm")} ) and due date ( ${dueDate.format("dd-MM-yyyy HH:mm")} ). For ease of use, there are other variables which are more user friendly and easier to read. In table below you can see all currently available variables with hosting option visible.

Since Scheduler v6.4.3 for Server & Data Center - you can uses same variables as in Cloud version.

List of predefined variables

Legend: - available

- not available (additional information about replacement)

Variable

Cloud

Server (DC) >= 6.4.3

Server (DC) < 6.4.3

Meaning

Result

Variable

Cloud

Server (DC) >= 6.4.3

Server (DC) < 6.4.3

Meaning

Result

${fireCount}

Fire count, number of executions of Scheduled Issue

5

${createdDate}

${createdDate.format("yyyy-MM-dd HH:mm z")}

Creation date in format yyyy-MM-DD HH:mm timezone

2017-02-02 14:41 Europe/Warsaw

${createdDate.day}

${createdDate.format("dd")}

Creation day

2

${createdDate.month}

Creation month

February

${createdDate.shortMonth}

${createdDate.format("M")}

Creation month in number form

2

${createdDate.year}

Creation year

2017

${createdDate.date}

Creation date in format yyyy-MM-DD

02.02.2017

${createdDate.time}

${createdDate.format("HH:mm")}

Creation time in 24 hour format

14:41

${createdDate.timezone}

${createdDate.format("z")}

Creation date timezone

Europe/Warsaw

${createdDate.timezoneOffset}

${createdDate.format("Z")}

Creation date timezone as time offset

GTM+01:00

+0100 (for server version)

${createdDate.weekOfMonth}

Creation date week of month

2

${createdDate.weekOfWeekYear}

${createdDate.format("w")}

Creation date week of week-based-year

28

${createdDate.weekYear}

Creation date week-based-year (should be used with .weekOfWeekYear)

2017

${dueDate}

Due date in format yyyy-MM-DD

02.02.2017

${dueDate.day}

Due date day

2

${dueDate.month}

Due date month

February

${dueDate.shortMonth}

Due date month in number form

2

${dueDate.year}

Due date year

2017

${dueDate.weekOfMonth}

Due date week of month

2

${dueDate.weekOfWeekYear}

Due date week of week-based-year

28

${dueDate.weekYear}

Due date week-based-year (should be used with .weekOfWeekYear)

2017

${createdDate.nextDay}

Creation next day based on today

22

${createdDate.nextMonth}

Creation next month based on today

August

${createdDate.nextWeekOfMonth}

Creation next week of month based on today

5

${createdDate.nextWeekOfWeekYear}

Creation next week of week year based on today

31

${createdDate.nextYear}

Creation next year based on today

2021

${createdDate.previousDay}

Creation previous day based on today

20

${createdDate.previousMonth}

Creation previous month based on today

June

${createdDate.previousWeekOfMonth}

Creation previous week of month based on today

3

${createdDate.previousWeekOfWeekYear}

Creation previous week of week year based on today

29

${createdDate.previousYear}

Creation previous year based on today

2019

${dueDate.nextDay}

Due date next day

22

${dueDate.nextMonth}

Due date next month

August

${dueDate.nextWeekOfMonth}

Due date next week of month

6

${dueDate.nextWeekOfWeekYear}

Due date next week of week-based-year

31

${dueDate.nextYear}

Due date next year

2021

${dueDate.previousDay}

Due date previous day

21

${dueDate.previousMonth}

Due date previous month

June

${dueDate.previousWeekOfMonth}

Due date previous week of month

4

${dueDate.previousWeekOfWeekYear}

Due date previous week of week-based-year

29

${dueDate.previousYear}

Due date previous year

2019

${createdDate.nextShortMonth}

Creation next month in number form based on today

8

${createdDate.previousShortMonth}

Creation previous month in number form based on today

6

${dueDate.nextShortMonth}

Due date next month in number form

8

${dueDate.previousShortMonth}

Due date previous month in number form

6

${createdDate.completeDateTime}

${createdDate.format("dd/MM/yyyy h:mm a")}

Creation date in format dd/MMM/YY hh:mm

10/Feb/15 2:05 PM

${dueDate.completeDateTime}

Due date in format dd/MMM/yy hh:mm

10/Feb/15 2:05 PM

${createdDate.format("dd-MM-YYYY HH:mm")}

Creation date in custom format

10-02-2015 14:05

${dueDate.format("dd-MM-YYYY HH:mm")}

Due date in custom format

10-02-2015 14:05

${dueDate.diff("createdDate").[unit].[formatter]

Returns the amount of time between dueDate and createdDate, in the unit specified. If createdDate is earlier than dueDate, the value returned will be negative.

prettyPrint: 2 days 3 hours

abd: 2

${createdDate.isAfter("dueDate")}

Returns true if createdDate is after dueDate, and false if not.

True

${createdDate.isBefore("dueDate")}

Returns true if createdDate is before dueDate, and false if not.

False

${createdDate.plus[unit]("[number]")}

Adds to createdDate number in specified unit

2025-03-07 14:40 Poland

${createdDate.minus[unit]("[number]")}

Removes from createdDate number in specified unit

2025-03-03 14:40 Poland

${createdDate.toBusinessDay}

Takes createdDate and returns the next business date. If the given date is a business day, then it will return the given date.

2025-03-10 14:40 Poland

${createdDate.toBusinessDayBackwards}

Takes createdDate and returns the previous business date.

2025-03-7 14:40 Poland

${createdDate.setTimeZone("Australia/Sydney")}

Takes the time and sets (not converts) to the given zone.

2025-03-7 14:40 Australia/Sydney

${createdDate.ofTheMonth("2,1")}

Takes the date, and returns the nth day of that month.

2025-03-10 11:50 Poland

${createdDate.lastOfTheMonth("input")}

${createdDate.lastOfTheMonth("1")}

Takes the date, and returns the last day of the month.

2025-03-31 00:00 Poland

${createdDate.firstOfTheMonth("input")}

${createdDate.firstOfTheMonth("1")}

Takes the date, and returns the first day of the month.

2025-03-03 00:00 Poland

${createdDate.lastBusinessDayOfMonth}

Feel free to tell us what topic should be covered: thescheduler@psc-software.atlassian.net