Set up your projects to receive a fixed amount of budget on a regular basis (e.g. 05:00 hours every month). Ideal for contracts with a regular budget bonus (e.g. maintenance agreements, SLAs etc.).
This plugin works on a per-project basis. Each Kimai project has to be configured individually if you want to set it up for recurring budgets.
To set up a project you do the following:
The project is now set up and is considered when the console command is executed.
The budget addition and calculation for all projects is done via the command:
The budget calculation works in three steps:
The command comes with a set of special parameters that let you restrict execution to a specific project or time period or lets you recalculate previous budget intervals (e.g. after you adjusted some timesheet entries for a project).
The full parameter list can be seen with:
bin/console recurring-budget:calculate --help
This plugin provides two new overview tables in the Kimai main menu.
Lists all projects with their currently available (time or money) budgets and total budgets. It also shows the budget credited for each budget interval.
In the “responsible” column you can see the name of the user who is the team lead of the team that is assigned to the project. Currently, it only reads the team lead of the first team in the list.
This view is ideal for companies with multiple projects and project leads. It easily shows where the budget is positive and additional work may need to be done.
Project budgets history
Lists all completed budget intervals and shows statistics for each of them. Here you can track the history of budget credits, how much of a project budget was used and how much was remaining for each interval.
This plugin extends the Kimai export functionality with two views.
Export menu you have the new “Customer budget” dropdown. Here you have two options:
Both options create an export view with three budget summary blocks for the selected export period:
This is intended for your internal documents or as information for you customers.
If you require support for the usage or setup of this plugin or find any bugs please contact firstname.lastname@example.org.
The following table contains a comparison between plugin and required minimum Kimai version.
|Bundle version||Minimum Kimai version|
Extract the ZIP file and upload the included directory and all files to your Kimai installation to the new directory:
The file structure needs to look like this afterwards:
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:
It is not advised, but in case the above command fails you could try:
You might have to set file permissions afterwards:
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):
Test Kimai before executing these commands (they are likely not required in a shared-hosting environment).
You probably need to prefix them with
the group might be called different than
Run the following command:
This will create the required database tables and update them to the latest version.
There are no commands defined in the "kimai:bundle:XYZ" namespace., then either the directory has a wrong name (must be var/plugins/RecurringBudgetBundle/) or you forgot to clear the cache (look above).
Updating the plugin works exactly like the installation: