app.businesscalendar.yaml
[engineDir]/configuration/reference/app.businesscalendar.yaml
1# yaml-language-server: $schema=https://json-schema.axonivy.com/app/0.0.1/app.json
2#
3# -------------------------------------------
4# Axon Ivy Business Calendar Configuration
5# -------------------------------------------
6#
7# This file shows configurations of a Business Calendar.
8# https://developer.axonivy.com/doc/11.2/engine-guide/configuration/advanced-configuration.html#business-calendar
9#
10# Copy contents of this reference file to 'configuration/<APPNAME>/app.yaml' before adjusting them to your needs.
11# https://developer.axonivy.com/doc/11.2/engine-guide/configuration/files/app-yaml.html
12#
13# Business calendars are organized as trees, with one root / default calendar and an arbitrary number of child calendars.
14# Child business calendars inherit the values of their parent. A parent can be the root calendar or any child calendar.
15#
16# At least one root calendar needs to be defined. If non is configured, a root / default calendar will be created automatically
17# with following default values:
18# - Parent is empty
19# - First day of week is: Monday
20# - Working times are: 'morning: 8:00 - 12:00' and 'afternoon: 13:00 - 17:00'
21#
22# You can reference a business calendars in a ivy projects by its name. E.g ivy.cal.get("myRootBusinessCalendar")
23
24
25# Currently active business calendar for this application.
26BusinessCalendar: ""
27
28
29BusinessCalendars:
30
31 # This is an example configuration of a business calendar with the name myRootBusinessCalendar.
32 myRootBusinessCalendar:
33
34 # Name of the parent business calendar.
35 # If empty or not existing this business calendar will be the root calendar for this application.
36 # Only one root calendar is allowed.
37 Parent:
38
39 # First day of the week.
40 # If empty or not existing the parent calendar's value is inherited.
41 # If not defined by any parent the value is retrieved from the current locale settings
42 # Possible values (case insensitive): monday, tuesday, wednesday, thursday, friday, saturday, sunday
43 FirstDayOfWeek: monday
44
45 # Name-value pairs of working times during a business day.
46 # At least one working time needs to be defined here or in any of the parents for business calendar calculations to work.
47 #
48 # Warning:
49 # Ensure that your working times in your calendar tree do not overlap.
50 # Otherwise the business calendar calculations may not work correctly!
51 #
52 # Value format is : HH:mm-HH:mm
53 WorkingTimes:
54
55 # This is an example configuration of a working time with name myMorning from 8 to 12 in the morning.
56 myMorning: 8:00-12:00
57
58 # This is an example configuration of a working time with name myMorning from 1 to 5 in the afternoon.
59 myAfternoon: 13:00-17:00
60
61 # Name-value pairs of non-working days.
62 # There are four different types of non-working days:
63 # - Weekdays
64 # - Yearly Days
65 # - Days relative to Easter
66 # - Fixed dates.
67 FreeDays:
68 # - Weekdays: Days that are always off during a week, e.g. Saturday and Sunday.
69 # Possible values (case insensitive): monday, tuesday, wednesday, thursday, friday, saturday, sunday
70 WeekendStart: saturday
71 WeekendEnd: sunday
72
73 # - Yearly Days: Recurring non-working days during a year, falling on the same date, e.g. Jan. 1 or Christmas.
74 # Format: MM-dd, e.g. 01-01 (New Year), 12-25 (Christmas Day)
75 "New Year": 01-01
76 "Christmas Day": 12-25
77
78 # - Relative Easter Days: Recurring non-working days relative to Easter Sunday, e.g. Good Friday or Pentecost.
79 # Format (case insensitive): easter +/- Number, e.g. 'easter - 2' (Good Friday), 'easter + 50' (Pentecost Monday)
80 "Good Friday": easter - 2
81 "Easter Monday": easter + 1
82 "Pentecost Monday": easter + 50
83
84 # - Fixed Dates: Once-off non-working days, e.g. a company celebration day or a special local public holiday.
85 # Format: YYYY-MM-dd
86 "50 Years Ivyteam": 2043-04-07
87
88 # This is an example configuration of a child business calendar
89 # It defines the root calendar as its parent and extends it by one non-working day (Ascension Day).
90 myLocalBusinessCalendar:
91 Parent: myRootBusinessCalendar
92 FreeDays:
93 "Ascension Day": easter + 39