Working hours, vacation, sickness, public holidays

Employee management: Working hours & overtime. Vacations, sickness and PTO. Public holiday management and calendar integration. Monthly approvals with PDF.

Kevin Papst
Offered by
Kevin Papst

Introduction

Features

Certain features are not yet here, but already planned (see Roadmap below). Your feedback will be incorporated.

  • It enhances the Working times view with
    • Manual bookings (adjust the time account with plus or minus hours)
    • Overview of the entire year with results per day, the ability to close a month, download result PDF and more
    • See if a user has overtimes or minus hours (since first day in company, per year/month/day)
    • Monthly approvals (per user) with PDF handouts that contain the working-hour details for the entire month
    • See if your users have missing days (no times entered on days where they had to work)
  • It adds the Absence view, which allows to
    • Create holidays (half-days possible)
    • Take time-off (if account has overtime)
    • Create sickness days
    • Create other absences (e.g. unpaid leave)
    • Automatically adds the times absent to the user’s timesheet based on their daily working time
    • Export absences per user to Excel
  • And it adds the new Public holiday management view
    • Allows to create different groups (e.g. for different countries or states) and add public holidays to each of them
    • Import and manual creation of public (local) holidays
    • Public holidays will automatically be added to the user’s timesheet (a user can only be in one public-holiday group)
    • Public holidays can be imported automatically (check if your country is supported).
  • Per user contract settings
    • Expected working hours per day of the week: Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday
    • Vacation entitlement per user for the calendar year
    • The “starting day” limits the working hours calculation from that date until “now”
  • You can import data from the MR plugins (Controlling, Sickday, Vacation)
  • The user calendar will show all absences (sickness, vacation…) and public-holidays

Roadmap

These features will be added in the future, but there is no guarantee when or in which order.

- Settings
  - Last day of work for a user, to stop calculating afterwards
  - Allow to reach a configurable amount of negative hours for time-off ([#159](https://github.com/kimai/Paid-plugins/issues/159))
- Approval workflow for Absences 
    - Allow to "Sent for approval" to Supervisor
    - Allow to "Reject" or "Approve" by Supervisor
    - Only calculate approved or locked absences (new ones are for planning)
- Notification
  - Sent notifications to supervisor for new "absences to be approved"
  - Sent notifications to user for approved/rejected absences
- Absence calendar
    - Display all users / teams
    - Allow export as ical (or similar format) for use in external calendars (e.g. Outlook)
- Monthly contract PDF
    - Include: total working time sum
    - Include: total holiday sum
    - Include: holidays at start of month sum
    - Include: start of month working-time sum
    - Include: manual bookings
- Finalize year
  - Allow automatic adjustments of time and holiday account of next year, e.g. from a list-overview
- Working Times
  - Different colors for holiday / sickness / PTO
- API 
    - methods to read absences (date-range, user, absence type)

Ideas

This list is a collection of feature wishes from users, which might or might not be added. If you need one of these features, do not rely on them being added, but contact me upfront to discuss your needs. If I decide to add one of these feature, it will be moved to the “Roadmap” section.

- Preview of the "locked month" PDF without actually closing the month as email
- Prevent that certain days can be booked for vacation
- Add first start- and last end-time as begin and end times to the PDF
- Working times
  - Allow to configure a [dedicated project](https://github.com/kevinpapst/kimai-plugins/discussions/112) that will be exclusively used for calculating attendance time 
  - Allow to configure a dedicated project that will be ignored when calculating the attendance time
- Validations
  - Configure if timesheets should be prohibited during absence (type)
  - Configurable rule to deactivate time-records on public holidays
- API 
  - Methods to read absences
  - Methods to write absences (e.g. when using a HR tool for holiday planning)
- Management view for all users
  - showing statistics for absences
  - pending holidays (approved), used holidays, available
- Monthly approvals
  - Allow to close months partially, in case there is a change in the contract within the month
- Absences
  - Add holiday for multiple users (e.g. for forced company vacations)
  - Types of absences (Workaround: use comment field)
    - Configurable for sickness and other
    - Show type in PDF
    - paid/not paid
  - Sum of sickness and other days on Absence screen
- Breaks (Pause)
  - Support calculation of breaks (e.g. display in calendar)
  - Use all breaks between first entry of the day and last entry of the day as pause
- Dashboard
  - Existing widgets do not show public holidays, sickness, vacation ... make it configurable or create new widgets that include these hours/days
  - Widgets for total numbers, to show "status" more prominent
- Working time requirements (Arbeitszeitvorgaben)
  - Maximum working time (per day, in one session) and breaks
  - Configure fixed rules per country
  - Allow one custom rule
  - Configure default rule (country or custom) per user
- Holidays
  - Lockdown method for vacations (define periods where no vacations can be booked)
  - Automatic calculation of holidays according to the working-time duration (e.g. 30 days per year for a 40h week) 
- Contracts 
  - Multiple working contracts per user (configured with start and end time)
  - Define arbitrary date ranges with attached working-time profiles

Installation

Copy files

Extract the ZIP file and upload the included directory and all files to your Kimai installation to the new directory:

var/plugins/WorkContractBundle/

The file structure needs to look like this afterwards:

var/plugins/
├── WorkContractBundle
│   ├── WorkContractBundle.php
|   └ ... more files and directories follow here ...

Clear cache

After uploading the files, Kimai needs to know about the new plugin. It will be found once the cache was re-built. Call these commands from the Kimai directory:

How to reload Kimai cache

bin/console kimai:reload --env=prod

It is not advised, but in case the above command fails you could try:

rm -r var/cache/prod/*

You might have to set file permissions afterwards:

Adjust file permission

You have to allow PHP (your webserver process) to write to var/ and it subdirectories.

Here is an example for Debian/Ubuntu, to be executed inside the Kimai directory:

chown -R :www-data .
chmod -R g+r .
chmod -R g+rw var/

You might not need these commands in a shared-hosting environment. And you probably need to prefix them with sudo and/or the group might be called different from www-data.

Create database

Run the following command:

bin/console kimai:bundle:workcontract:install

This will create the required database tables and update them to the latest version.

Updates

Updating the plugin works exactly like the installation:

  • Delete the directory var/plugins/WorkContractBundle/
  • Execute all installation steps again:
    • Copy files
    • Clear cache
    • Update database with bin/console kimai:bundle:workcontract:install

Changelog

Version 1.15.0

Compatibility: requires minimum Kimai 2.24.0

  • Configure the users last working day
  • Preview the “Monthly approval PDF” before locking the month
  • Rename migration config for compatibility with new plugin installer

Version 1.14.0

Compatibility: requires minimum Kimai 2.22.0

  • New working-hours calculation modes: “Hours per month” and “Hours per week”
  • Fixed: using an Absence with duration caused plus hours

Version 1.13.0

Compatibility: requires minimum Kimai 2.21.0

  • Allow to define a duration for “other” absences
  • Improved responsiveness on public-holiday screen
  • Fixed: last half-day of vacation can’t be booked
  • Refactoring: namespaces, unused services, repository methods

Version 1.12.0

Compatibility: requires minimum Kimai 2.17.0

  • Fixed: booking vacation on “half-day” public holidays wasn’t possible
  • Fixed: raise max vacation days from 20 to 30
  • Fixed: approved timesheets can be deleted
  • Fixed: edit dialog for approved timesheets can be opened
  • Added: new configuration to disable timesheet booking on non-working days
  • Added: new permission workdays_override_timesheet to skip the above validation, e.g. for admins

Version 1.11.0

Compatibility: requires minimum Kimai 2.17.0

  • Added: new API methods to fetch public holidays
  • Removed: public holidays from Absence API
  • Fixed: showing own absences in other users calendar
  • Fixed: use new hours_other_profile permission from core

Version 1.10.0

Compatibility: requires minimum Kimai 2.12.0

  • Changed: support attribute caching in Voter
  • Fixed: permission check for PDF download
  • Fixed: public holidays in calendar missing

Version 1.9.0

Compatibility: requires minimum Kimai 2.12.0

  • Added: system configuration to set absence comment-field optional
  • Added: allow to assign half days for user contract “holidays per year”
  • Added: allow to use half days in “manual bookings”
  • Added: allow to set duration for “sickness”
  • Added: auto-approve all open days of the year before the lock date
  • Changed: single line comment field for “manual bookings” form
  • Fixed: use correct base class for migration - removes Doctrine deprecation warning

Version 1.8.0

Compatibility: requires minimum Kimai 2.11.0

  • Added: absence types have a color
  • Added: use type colors on absence screen and for calendar entries
  • Fixed: translate calendar entries in current locale, instead of absence users locale
  • Fixed: do not show error on calendar if absences permission is deactivated for a user
  • Changed: use refactored language vs locale from user for email generation

Version 1.7.0

Compatibility: requires minimum Kimai 2.10.0

  • Added: send notification email to supervisor for new absences
  • Added: cross-link absence and work-contract page
  • Added: trigger event when absences are created
  • Fixed: editing absences could show fields (like “half day” for sickness) that should not be there

Version 1.6.0

Compatibility: requires minimum Kimai 2.9.0

  • Fixed: export of absences caused 500
  • Changed: replaced DateTime with DateTimeInterface / DateTimeImmutable

Version 1.5.0

Compatibility: requires minimum Kimai 2.8.0

  • Added: new category to book “unpaid holiday” absences
  • Added: generic calculation logic to prevent required adjustments for new categories
  • Added: different duration limitation for absence types (e.g. 75 days in one booking for parental leave)
  • Added: command bin/console kimai:bundles:workcontract:absence-types to debug absence types
  • Fixed: time calculation for new “child is sick” and “parental leave” categories
  • Fixed: deprecation by using DateTimeImmutable

Version 1.4.0

Compatibility: requires minimum Kimai 2.7.0

  • Added: manual adjustments for holidays, e.g. top up available days with remaining days from last year
  • Added: added category to book “child is sick” absences
  • Added: added category to book “parental leave” absences
  • Added: prevent booking absences across a time-range of two years
  • Added: limit selectable time-range to selected year
  • Fixed: day calculation of vacations with public holidays in between

Version 1.3.0

Compatibility: requires minimum Kimai 2.5.0

  • Fixed: adapted collapsible boxes for Kimai 2.5.0
  • Fixed: allow booking holidays with public holidays within the selected date-range

Version 1.2.0

Compatibility: requires minimum Kimai 2.1.0

  • Fixed: some users could not see public holidays in the calendar
  • Fixed: route mapping type changed to attribute
  • Fixed: Homepage link in extension screen

Version 1.1.0

Compatibility: requires minimum Kimai 2.0.34

  • Added: data migration from MR plugins
  • Added: show absences in calendar
  • Added: show public-holidays in calendar
  • Added: export absences to excel
  • Fix: possible pagination issue

Demo

You can test this plugin at demo.kimai.org:

Username: susan_super
Password: password

Find more test accounts here.

Screenshots

Screenshot
List of all holidays and groups, with the possibility to import and edit the holidays
Screenshot
There is a large list of countries and regions for which you can import holidays per year
Screenshot
For each user, one hourly target can be stored per weekday. In addition, you can configure the holiday group, the first working day and the number of holidays.
Screenshot
The summary shows the target and actual hours per month and year, including another line for manual bookings
Screenshot
Manual bookings allow the adjustment of the hours account, e.g. to carry over hours from the previous year or to write off paid hours
Screenshot
Daily evaluation of hours worked and owed, including display of all absences (holiday, sickness, etc.), with the option of month-end closing
Screenshot
The selected user has no contract settings saved on the profile and Kimai can therefore only display the hours worked

FAQ

These FAQs are provided by the developer of this offer.

You can buy the plugin via the Marketplaces 'Lemon Squeezy' or 'Gumroad' and pay with Credit Card or PayPal. Both offer instant access to the purchases.

Support-questions, bug-reports and feature-requests will be answered in this Github repository

Offered by

Kevin Papst

Building Kimai since 2009

If you have any question, please use the following contact information to get in touch with the developer directly.
Top