Audit trail logs
Offered by
Kevin Papst
Kimai maintainer since 2007
Try it
You can test this plugin at https://demo-plugins.kimai.org:
Username: susan_super
Password: kitten
Find out who changed what and when: record and visualize the changes on timesheets, customers, projects, activities, users, system configurations and invoices.
Features
A global audit-trail page, listing all recorded changes with username, change datetime, item type and link to detail page.
Actions for each of the following items:
- 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.
Purchase
- Read more about the license for this item here.
- You can buy the plugin from the developer with a regular EU-invoice and bank-transfer or via Gumroad .
- In case you use Gumroad (a platform for selling digital goods), please create an account during your purchase to receive future software updates.
- There is a Github repository existing for support-questions, bug-reports and feature-requests.
Screenshots
Audit-logs
The overview page of all audit trail logs (fullscreen)
Audit-detail view
An audit trail can look like this, each change will be recorded and you might see more entries in a object timeline (fullscreen)
Access change history
You access a detailed audit log from the listing page or from the data-table 'Actions' dropdown of each item (fullscreen)
Compatibility
The following table contains a comparison between plugin and required minimum Kimai version.
| Bundle version | Minimum Kimai version |
|---|---|
| 1.14 - 1.15 | 1.16.10 |
| 1.12 - 1.13 | 1.15 |
| 1.11 - 1.11.1 | 1.14 |
| 1.10 | 1.11 |
| 1.9 | 1.10 |
| 1.6 - 1.8 | 1.7 |
| 1.5 | 1.6 |
| 1.4 | 1.4 |
| 1.3 | 1.3 |
| 1.2 | 1.2 |
| 1.1.1 | 1.1 |
| 1.0 | 1.0 |
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 look 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:
How to reload Kimai cache
bin/console kimai:reload --env=prodIt is not advised, but in case the above command fails you could try:
rm -r var/cache/prod/*You might have to set file permissions afterwards:
Adjust file permission
You have to allow PHP (your webserver process) to write to
var/ and it subdirectories.
Here is an example for Debian/Ubuntu (to be executed inside the Kimai directory):
chown -R :www-data .
chmod -R g+r .
chmod -R g+rw var/
Test Kimai before executing these commands (they are likely not required in a shared-hosting environment).
You probably need to prefix them with sudo and
the group might be called different than www-data.
Create database
Run the following command:
bin/console kimai:bundle:audittrail:installThis will create the required database tables and update them to the latest version.
There are no commands defined in the "kimai:bundle:XYZ" namespace.,
then either the directory has a wrong name (must be var/plugins/AuditTrailBundle/) or you forgot to clear the cache (look above).
Updates
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