Audit-Trail plugin

Find out who changed what and when: a Kimai plugin to record and visualize the changes on timesheets, customers, projects, activities, users, system configurations and invoices.

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
• Invoices

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, delete)
• changed fields (see list below)

The change history will be recorded for the following fields:

• Timesheet: begin, end, duration, timezone, user, activity, project, description, rate, fixedRate, hourlyRate, exported, billable, internalRate, category, modifiedAt
• Customer: name, number, comment, visible, company, contact, address, country, currency, phone, fax, mobile, email, homepage, timezone, fixedRate, color, budget, timeBudget, vatId
• Project: customer, name, orderNumber, comment, visible, budget, fixedRate, hourlyRate, color, budget, timeBudget, start, end, timezone
• Activity: project, name, comment, visible, fixedRate, hourlyRate, color, budget, timeBudget
• User: username, email, enabled’, roles, alias, title, avatar, password_requested_at, auth, registration_date
• System configuration: name, value
• Invoice: customer, user, invoiceNumber, createdAt, timezone, total, tax, currency, status, dueDays, vat, invoiceFilename

Be aware:

• This bundle needs to be installed and activated to keep track of the change history, previous changes are not available.
• Not all entities and fields will be recorded, please read the above list carefully.
• The “Audit logs” link is not available under “My timsheets” to prevent potential information leaks.

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 of the above items.

Permissions

This bundle introduces new permissions, which limit access to certain functions:

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

Compatibility

Plugins should always be compatible with higher Kimai versions, the following list contains the plugin version and the required minimum Kimai version.

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 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/AuditTrailBundle/
• Execute all installation steps again:
  • Copy files
  • Clear cache
  • Update database with bin/console kimai:bundle:audittrail:install