Versions Compared

Key

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


UI Text Box
sizemedium
typeinfo

This function checks whether, a given timestamp (e.g. the due date of an issue) falls into a time frame defined in a JWT calendar specification.


Code Block
languagebash
titleSyntax
linenumberstrue
inSchedulewithinCalendar(timestamp, calendarName, timeZone) #Output: Boolean


UI Expand
titleExamples

Include Page
DECADIS:_snip_my_schedule_calendar
DECADIS:_snip_my_schedule_calendar

Parser expressionDescription


Code Block
languagebash
linenumberstrue
inSchedulewithinCalendar(2020/12/01 8:00, "my_schedulecalendar", LOCAL)


This example returns: 

true

UI Text Box
typeinfo

December 1st of 2020 is a Tuesday.



Code Block
languagebash
linenumberstrue
inSchedulewithinCalendar(2020/12/01 17:00, "my_schedulecalendar", LOCAL)


This example returns: 

false

UI Text Box
typeinfo

December 1st of 2020 is a Tuesday.




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).
calendarName

Status
subtletrue
titletext

The name of the used JWT calendar.
timeZone

Status
subtletrue
titletimezone

The time zone used for the calculation.



UI Expand
titleOutput

This function returns a

Status
subtletrue
titlenumber
representing a timestamp.
boolean




UI Text Box
sizemedium
typeinfo

Variant of the function where you can additionally define additional terms, which is a string containing extra JWT calendar. that will be attached to the calendar.This functions is useful to add personal holidays to an existing calendardefine an additional JWT calendar specification.


Code Block
languagebash
titleSyntax
linenumberstrue
addTime(base_instant, offsetwithinCalendar(timestamp, calendarName, additional_termsadditionalSpecifier, timeZone) #Output: NumberBoolean


UI Expand
titleExamples

Include Page
DECADIS:_snip_my_schedule_calendar
DECADIS:_snip_my_schedule_calendar

inSchedule(01 17:00, "my_schedule
Parser expressionDescription


Code Block
languagebash
linenumberstrue
inSchedulewithinCalendar(2020/12/0104 89:00, "my_schedulecalendar", LOCAL)

This example returns: 

true

Code Block
languagebash
linenumberstrue
"2020/12/
04 {;}", LOCAL)


This example returns: 

false


ui-text-box
typeinfo

The additional specifier {;} excludes December 4th from the calendar.




ui-expand
titleAdditional information

Parameters used in this function:

ParameterInput(data type)Description
base_instant
timestamp

Status
subtletrue
titlenumber

offset

Status
subtletrue
titlenumber

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

Status
subtletrue
titletext

The name of the
used
used JWT calendar.
additional_terms
additionalSpecifier

Status
subtletrue
titletext

A text
containing extra
containing an additional JWT calendar specification. 
timeZone

Status
subtletrue
titletimezone

The time zone used for the calculation.



UI Expand
titleOutput

This function returns a

Status
subtletrue
titlenumber
representing a timestamp.
boolean


UI Text Box
typetip

This function is usually used in a validators or the conditional execution parameter of post functions.



Image AddedUse cases and examples

Page properties report
firstcolumnUse case
headingsJWT feature, Workflow function, Field type, Automated action, Parser functions
cqllabel = "parser_func_withincalendar" and space = currentSpace()


Page properties
hiddentrue
id1


Parser function cloud
Map(error)
NotesNot possible because JWT's Calendars are not implemented in the Cloud version

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

Another very common use case is to use this function in one of the JWT calculated date-time fields
.




Page properties
hiddentrue



Status
Tech review

Status
colourYellowGreen
titleReady for reviewdone

Style guide

Status
colourYellowGreen
titleReady for reviewdone

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



Page properties
hiddentrue


Short descriptionAdds or subtracts days to or from any given calendarChecks whether a timestamp falls into a time frame defined in a JWT calendar specification.
Output

Status
subtletrue
titlenumberboolean

Available since

Status
subtletrue
colourRed
titleneeds lookup

Label

Status
colourRed
titlestaff pick