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