Audit-Trail plugin

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

Find out who changed their records, what and when: a Kimai 2 plugin to record and visualize the changes on timesheets, customers, projects and activities.

Features

Adds a global audit-trail page, listing all recorded changes with username, change datetime, item type and link to detail page.

Adds new actions to each of the following items in the admin section:

• Timesheets
• Customers
• Projects
• Activities

Introduces a new screen for each of the above items, with all recorded changes and each log entry containing the following information:

• username
• date-time
• type of change (create, update)
• changed fields (see list below)

The following fields are recorded for changes:

• Timesheet: begin, end, duration, timezone, user, activity, project, description, rate, fixedRate, hourlyRate, exported
• Activity: project, name, comment, visible, fixedRate, hourlyRate, color, budget, timeBudget
• Project: customer, name, orderNumber, comment, visible, budget, fixedRate, hourlyRate, color, budget, timeBudget
• Customer: name, number, comment, visible, company, contact, address, country, currency, phone, fax, mobile, email, homepage, timezone, fixedRate, color, budget, timeBudget

Be aware:

• History is only available for all changes from the moment on when this bundle was installed, previous changes are not available.
• Not all fields (eg. tags and custom fields) are recorded, please read the above list carefully.

Purchase

Compatibility

Please make sure to use the correct version of the plugin, which must be compatible with your Kimai version:

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

The file structure needs to like like this afterwards:

var/plugins/
├── AuditTrailBundle
│   ├── AuditTrailBundle.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 --env=prod

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:audittrail:install

This will install all required databases.

Usage

When logged in as SUPER_ADMIN, you will now see the overview page at /en/audit/ and the items audit log screens in the “action” dropdown menus.

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

Permissions

This bundle ships a couple of new permissions, which limits the access to certain functions:

By default, these are assigned to each user with the role ROLE_SUPER_ADMIN.

Screenshots

The overview page of all audit trail logs:

A audit trail can look like this, but each change will be recorded and you might see more entries in a object timeline:

You access an objects audit trail either via the overview page or the data-table “Actions” dropdown of each item: