Kimai - Open Source time-tracker Kimai
Installation Start for free

Budget Watcher

Get notified whenever a certain amount of your projects budget is used

Helsinki Systems GmbH
Offered by
Helsinki Systems GmbH

Description

BudgetWatcher plugin for Kimai is a plugin that allows you to keep track of your projects’ budgets. It sends notifications to a user group when a certain amount of the project budget is used up. Both the user group and the budget amounts at which you want to be notified are fully customizable. You can set default amounts that apply to all projects, or individual amounts for individual projects. You can also set as many amounts as you want. For example, you can set the default amounts to 50%, 75%, and 95%, and for another project to 80% and 95%. Whenever the budget is exhausted up to this percentage, the specified user group receives an email that this amount of the budget has been used up, and you can adjust the budget accordingly if necessary.

Video

English:

German:

Support

If you need help setting this plugin up or have any feature requests our commercial support is available at kunden@helsinki-systems.de

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/Budget Watcher/

The file structure needs to look like this afterwards:

var/plugins/
├── Budget Watcher
│   ├── Budget Watcher.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/
Test Kimai before executing these commands (they are likely not required in a shared-hosting environment). You probably need to prefix them with sudo and the group might be called different than www-data.

Create database

Run the following command:

bin/console kimai:bundle:budgetwatcher: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/Budget Watcher/
  • Execute all installation steps again:
    • Copy files
    • Clear cache
    • Update database with bin/console kimai:bundle:budgetwatcher:install

Compatibility

The following table contains a comparison between plugin and required minimum Kimai version.

Bundle version Minimum Kimai version
1.0 2.0
Offered by

Helsinki Systems GmbH

Network and IT-Solutions

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