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

More about those in the documentation.

A tabela a seguir contém uma comparação entre o plug-in e a versão mínima exigida pelo Kimai.

Copiar os arquivos

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

Limpar o 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 --env=prod

rm -r var/cache/prod/*

You might have to set file permissions afterwards:

chown -R :www-data .
chmod -R g+r .
chmod -R g+rw var/

Criar um novo banco de dados

Run the following command:

bin/console kimai:bundle:metafields:install

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

Updating the plugin works exactly like the installation:

• Delete the directory var/plugins/MetaFieldsBundle/
• Execute all installation steps again:
  • Copiar os arquivos
  • Limpar o cache
  • Update database with bin/console kimai:bundle:metafields:install