Custom fields

49 € (excl. VAT)

License and purchase details

Table of contents

Features
Purchase
Screenshots
Compatibility
Installation
Updates

Offered by

Kevin Papst

Software developer, PHP Freelancer - Kimai lead since 2007

If you have any question, visit the developers homepage or use the email for direct contact .

Try it

You can test this plugin at https://demo-plugins.kimai.org:

Username: susan_super
Password: kitten

Find more test accounts here.

Create free-configurable additional fields for timesheets, customers, projects, activities and users in various formats. Fields can be optional or mandatory and restricted by permissions.

Buy now

Full documentation available in the documentation

Allows configuration of additional (custom) fields for: Timesheets, Customers, Projects, Activities, Invoices, User, Expenses (see plugin).

Features

You can create as many fields as you want for each data type, where each field:

is either optional or mandatory
has its own visibility, so the access can be restricted:
- to certain customer/project/activity combinations (eg. a “location” field will only be shown for customer X and project Y)
- to users with certain permissions or roles
can be described with a name and help text
has a maximum length of 255 character

The custom-field data is then available in:

Data-tables will display all visible fields
Exports (HTML and Spreadsheets include all visible fields)
Timesheet exports (include visible timesheet fields)
API (collections and entities)
Invoice templates (custom templates have access to all fields)

You can change the “weight” of custom-fields, so they show up in the order you define.

Be aware:

Restricted fields won’t be visible on the create forms, as Kimai initially can’t know if the rule will apply: in these cases the fields will only be shown in the edit forms
Sensitive data can be configured as “invisible”, so it will not show up in the above mentioned places
Custom fields for users are not exported via the API (this is a limitation in the core application)

Field types

Custom fields can be of the following type: string, integer, number, duration, money, language, currency, country, color, date, datetime, email, textarea, invoice template, checkbox, choice-list

Purchase

Buy now

You can buy this item from the developer with a regular EU-invoice or via Gumroad (platform for selling digital goods). Please create a Gumroad account during your purchase to receive software updates. Read more about the license and purchase options.

There is a Github repository, where you get support and can post bug reports, feature requests or start a discussion.

Screenshots

Custom-field administration

The listing page shows all available item-types and their configured custom fields (fullscreen)

Create custom field (customer)

The dialog to create a new custom field for customers (fullscreen)

Edit custom field (project)

Editing an already existing custom field for projects (type boolean, see default value) (fullscreen)

All timesheets

The timesheet listing, displaying the visible custom-field called "Location" (fullscreen)

Edit timesheet

Editing a timesheet record with a new choice-list custom field (fullscreen)

Compatibility

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

This bundle does yet NOT confirm compatibility with the upcoming version 2.0

Bundle version	Minimum Kimai version
1.21 - 1.24	1.17
1.18 - 1.20	1.15
1.17	1.14
1.15 - 1.16	1.11
1.14	1.10.2
1.10 - 1.13	1.9
1.8 - 1.9	1.7
1.6 - 1.7	1.6.2
1.5	1.6
1.3.2 - 1.4.1	1.4
1.1.1 - 1.2	1.1
1.0	1.0

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/MetaFieldsBundle/

The file structure needs to look like this afterwards:

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

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

If you see an error like There are no commands defined in the "kimai:bundle:XYZ" namespace., then either the directory has a wrong name (must be var/plugins/MetaFieldsBundle/) or you forgot to clear the cache (look above).

Updates

Updating the plugin works exactly like the installation:

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