Custom-fields plugin

• Features
• Purchase
  • Compatibility
• Installation
  • Copy files
  • Clear cache
  • Create database
• Usage
  • Permissions
• Screenshot

A Kimai 2 plugin, which allows to configure additional fields for timesheets, customers, projects and activities.

Features

Configure additional fields in various formats for the following data types:

• Timesheets
• Customers
• Projects
• Activities
• User

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 fields will be shown on the “create and edit entity” forms and can have the following types:

• string
• integer
• number
• duration
• money
• checkbox
• language
• currency
• country
• color
• date
• datetime
• 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:

• 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 only)

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 form 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.

More information about custom fields can be found in the documentation.

Purchase

Compatibility

This plugin is compatible with the following Kimai releases:

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 like 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:

bin/console kimai:reload

bin/console cache:clear --env=prod
bin/console cache:warmup --env=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 kimai:bundle:metafields:install

This will install all required databases.

Usage

When logged in as SUPER_ADMIN, you should now see the custom-fields administration screen at /en/expenses/.

If this was successful, you can now think about giving permissions to other users as well.

Permissions

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 ROLE_SUPER_ADMIN.

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.

Screenshot