Logo - Keleo

Keleo

Software development company founded by Kevin Papst

Try it

You can test this plugin in our dedicated plugin demo:

  • Username: susan_super
  • Password: kitten

Find more testing accounts here.

Records detailed change/audit logs for timesheets, customers, projects and activities and displays them in a per-item timeline.
Last update: 21 May 2019

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:

Permission Name Description
audit_logs see the audit log page with all entries
audit_customer see all changes for the customer objects
audit_project see all changes for the project objects
audit_activity see all changes for the activity objects
audit_own_timesheet see all changes for own timesheet records (only via team timesheets, audit logs are not shown in user timesheet panel)
audit_other_timesheet see all changes in other users timesheet records (only via team timesheets, audit logs are not shown in user timesheet panel)

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

Purchase

Screenshots

Installation

Compatibility

The plugin is compatible with the following Kimai releases:

Bundle version Kimai version
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

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:

How to reload Kimai cache

bin/console kimai:reload --env=prod

FTP users: please have a look at this documentation.

If you are running an older version of Kimai (before 1.8) you have to use:

bin/console cache:clear --env=prod
bin/console cache:warmup --env=prod

You might have to set file permissions afterwards:

Fix Kimai 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/
chmod -R g+rw public/avatars/

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

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

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

All items by Keleo

Audit-Trail plugin

Records detailed change/audit logs for timesheets, customers, projects and activities and displays them in a per-item timeline.
plugin
29€

Custom-fields plugin

Create free configurable additional (optional and mandatory) fields for timesheets, customers, projects and activities in various formats.
plugin
49€

Expenses plugin

Keep track of your expenses based on a customer, project and activity. These expenses can be categorized and included in your invoices.
plugin
49€

Kiosk plugin
New

Attendance time-tracking in an environment, where the user has no access to Kimai (eg. in a warehouse) by using a barcode or RFID scanner to start and stop timesheets.
plugin
199€

Task management plugin

Create tasks, start/stop/pause them, assign them to users and teams - a todo-list management plugin that is connected to your time-tracker and adds two new dashboard widgets
plugin
49€
Console client (PHAR)
client
free
Custom CSS plugin
plugin
free
Custom plugin development
development
support
Fail2Ban plugin
plugin
free
Grandtotal plugin
3rd party
free
Installation & Update support
support
Recalculate rates plugin
plugin
free