Vacation plugin (vacation + official & local holidays)

Features

• Set the vacation entitlement per user via Custom-fields plugin
• Let users create a vacation application based on their vacation days budget
• Admins can grant, deny or cancel vacation applications
• See in one view a summary of all users vacation days
• German public holidays can be automatically imported based on the state
• Manual creation of public/local holidays is also possible
• Fully configurable via GUI
• Support for multiple working times (e.g. 40 h/week, 15 h/week - fully configurable per user)
• Full history of every request

Requires

• Custom-fields plugin to save the vacation entitlement per user
• Kimai v1.12+

Documentation

Setup

Recommended Setup: watch the youtube video at the bottom!

Create two custom fields for users using the custom-fields plugin:

• One for the amount of vacation days in the first year in which the users started working (integer)
• The other one for the daily working time (duration)

If you’re logged in as super-admin you will see an item in the menu called “Vacation view”. In it there is a settings-tab. Here you can select the state for public holidays, the activities that will be used as public holidays and vacations.

The last two inputs are dropdowns with all meta-fields. Select the ones you created earlier.

Permissions

The install-command will create two permissions:

• vacation
• vacation_admin

Users with none of the permissions won’t see the vacation tab in the menu.

If you assign the vacation permission to a user they will see the leave-application tab in the menu.

Super-admins and users with the vacation_admin permission have full control over this plugin.

Video Tutorial

Copy files

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

var/plugins/VacationBundle/

The file structure needs to like like this afterwards:

var/plugins/
├── VacationBundle
│   ├── VacationBundle.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:

bin/console kimai:reload --env=prod

rm -r var/cache/prod/*

You might have to set file permissions afterwards:

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

Create database

Run the following command:

bin/console bin/console kimai:bundle:vacation:install

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

Updating the plugin works exactly like the installation:

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