Export

The export module allows you to export filtered timesheet data into several formats.

Difference between export and invoice

There are a couple of differences in these two Kimai modules, the most important ones:

  • Invoices can only be created for a dedicated customer, where an export can be created without selecting a customer
  • Invoices do more calculation (e.g. tax)
  • Invoices support self-created templates in more formats (e.g. XLSX, ODS, DOCX)

Security and privacy

Giving a user the permission create_export to export data, allows him to see most time related data in Kimai (like customer, projects, activities, rates, time worked per user and more).

Export state

Invoices and exports share the export state, which is used to mark timesheet records as processed. These records cannot be edited any longer by regular users and are excluded by default from further invoices and exports.

You need to activate the checkbox before creating the export, to automatically set the export state on all filtered timesheet records.

For further information read the timesheet documentation.


Adding export templates

Since Kimai 1.9 you can add templates for PDF and HTML exports.

Export documents are searched in two locations:

  • var/export/ - does not exist by default, please create it when you add a new template
  • templates/export/renderer/ - don’t change files in here, will be overwritten with te next update

Be aware of the following rules:

  • HTML templates have the file extension .html.twig
  • PDF templates have the file extension .pdf.twig
  • Templates are addressed by their filename
  • You can use every document name only once.
    • Having var/export/default.html.twig and templates/export/renderer/default.html.twig will lead to unpredictable results
    • Use unique filenames and prefix them with your company name, eg acme-export.html.twig
  • You should store your templates in var/export/, as this directory is not shipped with Kimai and not touched during updates
  • You can configure different search directories through the config key kimai.export.documents if you want to add additional template source directories
  • You can hide the default templates by setting the key kimai.export.defaults to an empty array / null

After you created a new or updated an existing template, you have to clear the cache to see the results:

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

Please copy & paste one of default templates to var/export/ as starting point and rename it afterwards.

You can translate the button for your template, by adding its name to the export translation file, eg. translations/export.en.xlf. Internally for each template a new ExportRenderer service is registered, called exporter_renderer.filename_EXT_twig (see ExportServiceCompilerPass).

PDF Templates

Since 1.13 you can customize the following values from within your PDF templates:


{%- set customer = query.customers|length == 1 ? query.customers.0 : null -%}
{%- set filename = 'ACME_' ~ (customer is not null ? customer.name|replace({' ': '-'}) ~ '_' : '') ~ query.begin|date_format('Y-m') -%}
{%- set option = pdfContext.setOption('filename', filename) -%}
{%- set option = pdfContext.setOption('format', 'A4-L') -%}

The variable name (here format and filename) must be one of the mPDF constructor options, ConfigVariables or FontVariables (see links above).