A Kimai 2 plugin, which allows to configure additional fields for timesheets, customers, projects and activities.
Configure additional fields in various formats for the following data types:
You can create as many fields as you want for each data type, where each field:
The custom fields will be shown on the “create and edit entity” forms and can have the following types:
boolean(use: 1 = checked/true or 0 = unchecked/false)
choice-list(add entries comma separated into default-value field)
The custom-field data is then available in:
More information about custom fields can be found in the documentation.
This plugin is compatible with the following Kimai releases:
|Bundle version||Kimai 2 version|
|1.4||1.6 (due to a mistake)|
|1.2||1.1, 1.2, 1.3|
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 like like this afterwards:
var/plugins/ ├── MetaFieldsBundle │ ├── MetaFieldsBundle.php | └ ... more files and directories follow here ...
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:
FTP users: please have a look at this documentation.
Before Kimai 1.8 you have to use:
bin/console cache:clear --env=prod bin/console cache:warmup --env=prod
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):
chown -R :www-data . chmod -R g+r . chmod -R g+rw var/ chmod -R g+rw public/avatars/
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
Run the following command:
This will install all required databases.
When logged in as
SUPER_ADMIN, you should now see the custom-fields administration screen at
If this was successful, you can now think about giving permissions to other users as well.
This bundle ships a new permission, which limit access to certain functions:
configure_meta_fields- allows to administrate the custom field definitions
By default, it is assigned to each user with the role
Read how to assign these permission to your user roles in the permission documentation.
This is a proposal if you use the bundle in a multi-user environment:
kimai: permissions: roles: ROLE_SUPER_ADMIN: ['configure_meta_fields'] ROLE_ADMIN: ['configure_meta_fields']
After changing the permissions in local.yaml, you need to clear the application cache.
Records detailed change/audit logs for timesheets, customers, projects and activities and displays them in a per-item timeline.
Create free configurable additional (optional and mandatory) fields for timesheets, customers, projects and activities in various formats.
Keep track of your expenses based on customer, project and activity. These spendings can be categorized and included in your invoices.
Create tasks, start/stop/pause them, assign them to users and teams - a todo-list management plugin that is connected to your time-tracker and features two new dashboard widgets
|Custom CSS plugin||
|Installation & Update support||
|Recalculate rates plugin||