Versions Compared

Key

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


Page properties
hiddentrue


Tech review

Status
colourYellow
titleReady for review

Style guide

Status
colourYellow
titleReady for review

Page status

Status
colourGreen
titlecomplete

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




Panel

On this page

Table of Contents
exclude(On this page).*
typeflat
separatorpipe



UI Text Box
sizemedium
typeinfo

Each calendar configuration is highly flexible but the underlying specification must follow a dedicated syntax.


JWT calendars elements and syntax

A calendar is a system on which JWT will be able to do time calculations. Each calendars should be composed of at least one time specifier.

Time specifiers

A time specifier is composed of a time definition and a block in the following format: 

Code Block
<time_definition> { <block_content> }

Time definition

Defines a part of the time continuum (a set of real numbers).

Block

A block is written between braces {} and defines a scope where the lower level time specifiers can be written.

Levels

Time specifiers are ordered in five hierarchical levels:

  1. Global
  2. Year
  3. Month
  4. Week
  5. Day
UI Text Box
typeinfo
A time specifier of a particular level is always explicitly or implicitly contained in a time specifier of the immediately higher level. When the higher level time specifier is not configured, then it is implicitly contained in an unrestricted higher level time specifier.

Priority

Time specifiers each have a dedicated priority. In case that two or more time specifiers overlap in the same level, the one with the highest priority is applied.

Time specifiers with the same priority in the same level are not allowed to overlap, i.e., the intersection of their time definitions must be empty.

Category

Time specifiers can be classified into two categories:

Absolute: Defines the unique and specific parts of the time continuum. This category of time specifiers represents the ones in the global level.

Code Block
languagebash
2020/03/25 #this is a unique an specific date


Relative: Define parts of the time in the context of other time specifiers. The definition depends on the time specifier where it is contained. This category of time specifiers is contained in the all levels besides the global.

Code Block
languagebash
FRI {
    08:00 - 15:00; #the time specifier depends on the "container". In this a day of the week, which is Friday.
} 

Comments

JWT calendars supports single-line comments. Comments begin with a #. e.g.:

Code Block
languagebash
#Summer Calendar


Time specifier overview

The following table represents all the available time specifiers ordered by level and priority:


High priorityMedium priorityLow priority
Level


Global

Date list

Code Block
languagebash
2020/03/25, 2020/AUG/18
2017/01/01, 2017/05/01, 
2017/12/25-2017/12/31 #can contain intervals


Date

Code Block
languagebash
2018/JUN/15-2018/SEP/15
2018/01/01-2018/01/07, 2018/04/10-2018/04/20


Year list


Code Block
languagebash
2000, 2005, 2010
2000-2011
2010-2015, 2018, 2020-2025 #can contain intervals


Year

Month-Day list

Code Block
languagebash
JAN/1, MAY/1, JUL/4, DEC/25


Month-day

Code Block
languagebash
MAR/20-MAR/25
AUG/1-AUG/15, NOV/5-NOV-15


Month list

Code Block
languagebash
JAN, MAR, MAY, DEC
JAN-JUN, SEP-DEC #can contain intervals
MAY, JUL, OCT-DEC


Day

Whole day

Code Block
languagebash
00:00-00:00;


Time

Code Block
languagebash
8:00-15:00;
8:00-15:00, 16:00-19:00;
21:00-3:00;


Empty

Code Block
languagebash
; #Used for defining holidays


Month

Day of month list

Code Block
languagebash
1, 15, 30
1-5, 15, 25-3
1, 15-31
25-5 #can contain intervals




Week

Day of Week List

Code Block
languagebash
MON-THU
MON-WED, FRI
MON, WED, FRI
SAT-MON, WED #can contain intervals





Anchor
examplespecification
examplespecification
Example specifications

Get some inspiration by looking at the example specifications below.

Examples


CalendarDescription


Code Block
languagebash
linenumberstrue
08:00-15:00, 16:00-20:00;


Any date-time with time part between 08:00 and 15:00, or 16:00 and 20:00.

UI Text Box
typeinfo
By convention 15:00 and 20:00
time instants are out
(the outer limits of the time frame) are outside of the calendar definition.



Code Block
languagebash
linenumberstrue
MON-FRI{08:00-15:00, 16:00-20:00;}


Mondays to Fridays from 08:00 to 15:00 and from 16:00 to 20:00.


Code Block
languagebash
linenumberstrue
MON-THU{08:00-15:00, 16:00-20:00;} FRI{08:00-15:00;}


  • Mondays to Thursdays from 08:00 to 15:00 and from 16:00 to 20:00.
  • Fridays from 08:00 to 15:00.


Code Block
languagebash
linenumberstrue
# Winter Calendar
MON - THU {
   08:00 - 15:00,
   16:00 - 20:00;
}
 
FRI {
    08:00 - 15:00;
}
 
# Summer Calendar
JUN/15 - SEP/15 {
    MON - FRI {
        08:00 - 14:30;
    }
}


  • From June 15th to September 15th
, Mondays
  • : Mondays to Fridays from 8:00 to 14:30.
  • For the rest of the year, Mondays to Thursdays from 08:00 to 15:00 and from 16:00 to 20:00. Fridays from 08:00 to 15:00.


Code Block
languagebash
linenumberstrue
# Winter Calendar
MON - THU {
   08:00 - 15:00,
   16:00 - 20:00;
}
 
FRI {
    08:00 - 15:00;
}
 
# Summer Calendar
JUN/15 - SEP/15 {
    MON - FRI {
        08:00 - 14:30;
    }
}
 
# Annual Holidays
JAN/1, MAY/1, NOV/1, DEC/25 {;}
 
# 
2017
2021 Holidays
2017
2021/JAN/12, 
2017
2021/APR/13, 
2017
2021/APR/14, 
2017
2021/NOV/23 {;}
From June 15th to September 15th, Mondays to Fridays from 8:00 to 14:30.
For the rest of the year, Mondays to Thursdays from 08:00 to 15:00 and from 16:00 to 20:00. Fridays from 08:00 to 15:00.



UI Text Box
typeinfo
We added also

This calendar additionally contains a specification for:

  • annual holidays, i.e., holidays that have the same day every year
, and for
  • particular holidays per year
holidays
  • (
2017
  • 2021 in the example).




Code Block
languagebash
linenumberstrue
# NEW Calendar 
from
effective 1st December 
2017 on
2020
 
# Winter Calendar
MON-THU {
   08:30 - 15:30,
   16:00 - 19:30;
}
 
FRI {
   08:00 - 15:00;
}
 
# Summer Calendar
JUN/15 - SEP/15 {
   MON - FRI {
      08:00 - 14:30;
   }
}
 
# Annual Holidays
JAN/1, MAY/1, JUL/4, NOV/1, DEC/25 {;}
 
# 
2018
2021 Holidays
2018
2021/03/27 - 
2018
2021/03/30, 
2018
2021/10/22 {;}
 
# Current calendar 
Calendar
valid up to 30th November 
2017
2020

2000/01/01 - 
2017
2020/11/30 {
 
   # Winter Calendar
   MON-THU {
      08:00 - 15:00,
      16:00 - 20:00;
   }
 
   FRI {
      08:00 - 15:00;
   }
 
   # Summer Calendar
   JUN/15 - SEP/15 {
      MON - FRI {
         08:00 - 14:30;
      }
   }
 
   # Annual Holidays
   JAN/1, MAY/1, NOV/1, DEC/25 {;}
}
 
# 
2017
2020 Holidays
2017
2020/JAN/12, 
2017
2020/APR/13, 
2017
2020/APR/14, 
2017
2020/NOV/23 {;}



UI Text Box
typeinfo

This example combines two calendars.

future calendar coming into effect on December 1st of 2021 and the currently valid calendar.

Since the current calendar


#

additioonally :

  • annual holidays, i.e., holidays that have the same day every year
  • particular holidays per year (2021 in the example).

In this example we show how to introduce some modifications in the previous calendar that will be applied since  December 1st, 2017 on, keeping the old calendar valid only up to 30th November 2017.



Excerpt Include
DECADIS:Contact support
DECADIS:Contact support
nopaneltrue