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