Skip to content
Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
57 lines (45 sloc) 2.44 KB
title description toc
Calendar
Manage your timesheet records in a calendar view
true

Kimai 2 provides a calendar view, which displays your timesheet entries in a easy readable format. You can choose between a monthly, weekly and daily view.

The calendar view look and feel is configured with the config keys below kimai.calendar in kimai.yaml / your [local.yaml]({% link _documentation/configurations.md %}):

kimai:
    calendar:
        week_numbers: true
        day_limit: 4
        businessHours:
            days: [1, 2, 3, 4, 5]
            begin: '08:00'
            end: '20:00'
  • week_numbers - whether week numbers should be displayed in the monthly view (default: true)
  • day_limit defined the max amount of items to be displayed for one day in the monthly view (default: 4)
  • businessHours.days defines your working days, which will be highlighted in the weekly and daily view. counting starts with sunday and the index 0, so 1 = monday, ..., 6 = saturday. (default: 1-5 / monday to friday)
  • businessHours.begin the start time of your working day, which will be highlighted in the weekly and daily view (default: 08:00 / 8am)
  • businessHours.end the end time of your working day, which will be highlighted in the weekly and daily view (default: 20:00 / 8pm)

Initial view

The initial view for the calendar is month. It is a user specific setting and each user can configure it in his User profile at Preferences.

Available options are: month, agendaWeek, agendaDay (these might be called different if a translation is available)

Integrating google calender

If you want to embed Google calendars e.g. to display regional holidays or company events you can import (multiple) Google calendars.

  • read how to obtain your Google API key and find the Calender ID
  • add the optional kimai.calendar.google configuration
  • you can add any number of sources under the kimai.calendar.google.sources node, each must have its own name (like holidays and company in this example)
kimai:
    calendar:
        google:
            api_key: 'your-restricted-google-api-key'
            sources:
                holidays:
                    id: 'de.german#holiday@group.v.calendar.google.com'
                    color: '#ccc'
                company:
                    id: 'de.german#holiday@group.v.calendar.google.com'
                    color: '#cc0000'
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.