Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page properties
hiddentrue



Status
Tech review

Status
colourGreen
titletododone

Style guide

Status
colourGreen
titletododone

Status
titletodo
Status
colourYellow
titleReady for review
Status
colourGreen
titledone
Status
colourRed
titleflagged



Page properties
hiddentrue


numberThis function adds or subtracts time to/from any given date.

Short description

Adds timeToBeAdded to and returns a

Status
subtletrue
title
Output

Status
subtletrue
titlenumber




UI Text Box
sizemedium
typeinfo

This function adds timeToBeAdded to and returns a

Status
subtletrue
titlenumber
with the difference that weekends do not count in the sum.

UI Text Box
typetip

or subtracts time to/from any given date.

Weekends will not be counted as working daysUse negative values at timeToBeAdded for subtracting time from t.



Code Block
languagebash
titleSyntax
linenumberstrue
addTimeSkippingWeekends(number ttimestamp, number timeToBeAdded, timeZone time_zone) #Output: Number


UI Expand
titleExamples


Parser expressionDescription


Code Block
languagebash
linenumberstrue
timeToBeAdded =
addTimeSkippingWeekends({issue.duedate}, 1 * {MONTH} + 2 * {HOUR}
UI Text Box
typeinfo

t represents a date-time which coincides with a Saturday

The function will return a date-time for next Monday at 02:00
, LOCAL)


This function adds 1 month and 2 hours to the issue's due date.

Weekends won't be taken into account.


Code Block
languagebash
linenumberstrue
addTimeSkippingWeekends({issue.created}, 3 * {DAY} + 1 * {HOUR}, LOCAL)


This function adds 3 days and 1 hour to the issue's creation date.

Weekends won't be taken into account.


Code Block
languagebash
linenumberstrue
addTimeSkippingWeekends({issue.duedate}, - 1 * {YEAR}, LOCAL)


This function subtracts 1 year from the issue's due date.

Weekends won't be taken into account.



UI Expand
titleAdditional information

Parameters used in this function

title

ParameterInput (data type)Description
timestamp

Status
subtletrue
titlenumber

The parameter must be valid timestamp. Usually this value is retrieved from a field (e.g. due date, created date).
numberOfDaystimeToBeAdded

Status
subtletrue
titlenumber

The number defined here will be the offset in days. 

Negative values are used to substract days.

Internally JWT multiplies this value with the time macro  {DAY} to add full days to the timestamp. of time. The offset can be built with the different time macros. Learn more about time macros.

Negative values are used to subtract time.

timeZone

Status
subtletrue
titletimezone

The time zone used for the calculation. 

Expand
Learn more about timezones
Excerpt Include
Dates, times and time zonesDates, times and time zones
nopaneltrue


UI Text Box
typetip

Work days might depend on the time zone - it might be Sunday on the west coast of the US while at the same time it's already Monday in Australia. 



UI Expand
titleOutput

The function returns a

Status
subtletrue
titlenumber
with the difference that weekends do not count in the sum.

UI Text Box
typetip

The output can be written into any Jira field of type Date Picker or Date Time Picker.

Another very common use case is to use this function in a JWT calculated date-time field.

If you want to convert the number into a string, you might want to take a look at the dateTimeToString() function.





UI Text Box
sizemedium
typeinfo

The function returns a

Status
subtletrue
titlenumber
with a custom defined weekend.
beginning_of_weekend and end_of_weekend take the following values : {MONDAY} , {TUESDAY} ... {SUNDAY}.


Code Block
languagebash
titleSyntax
linenumberstrue
addTimeSkippingWeekends(number ttimestamp, number timeToBeAdded, timeZone time_zone, number beginning_of_weekendstartOfWeekend, number end_of_weekendendOfWeekend) #Output: Number


UI Expand
titleExamples


Parser expressionDescription


Code Block
languagebash
linenumberstrue
addTimeSkippingWeekends({
..
system.currentDateTime}, 12 * {HOUR}, LOCAL, {FRIDAY}, {SATURDAY})
The


This function adds 12 hours to the current

local time, and taking into consideration a weekend that begins with a Friday and ends with a Saturday

date and time.

Fridays and Saturdays are not counted.


Code Block
languagebash
linenumberstrue
addTimeSkippingWeekends({system.currentDateTime}, -2 * {DAY}, LOCAL, {SATURDAY}, {SUNDAY})


This function subtracts 2 days from the current date and time.

Saturdays and Sundays are not counted.



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
timestamp

Status
subtletrue
titlenumber

The parameter must be valid timestamp. Usually this value is retrieved from a field (e.g. due date, created date).
numberOfDays

Status
subtletrue
titlenumber

The number defined here will be the offset in days. 

Negative values are used to substract days.

Internally JWT multiplies this value with the time macro  {DAY} to add full days to the timestamp. Learn more about time macros.

timeZone

Status
subtletrue
titletimezone

The time zone used for the calculation. 

expand

startOfWeekend

Status
subtletrue
title

Learn more about timezones
Excerpt Include
Dates, times and time zonesDates, times and time zones
nopaneltrue

number

The parameter will take values in the format of {MONDAY}{TUESDAY} ... {SUNDAY}
endOfWeekend

Status
subtletrue
titlenumber

The parameter will take values in the format of {MONDAY}{TUESDAY} ... {SUNDAY}


UI Text Box
typetip

Work days might depend on the time zone - it might be Sunday on the west coast of the US while at the same time it's already Monday in Australia. 



UI Expand
titleOutput

The function returns a

Status
subtletrue
titlenumber
with  with a custom defined weekend and the difference that weekends do not count in the sum.

UI Text Box
typetip

The output can be written into any Jira field of type Date Picker or Date Time Picker.

Another very common use case is to use this function in a JWT calculated date-time field.

If you want to convert the number into a string, you might want to take a look at the dateTimeToString() function.