Kimai logo Kimai Docs User manual

Audit trail logs

Logging entity changes in Kimai

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.
  • Certain batch updates (e.g. setting the exported flag of multiple timesheets during export) cannot be recorded, as those are executed directly via database

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 customers
audit_project see all changes for projects
audit_activity see all changes for activities
audit_user see all changes for users
audit_configuration see all changes for system configurations
audit_invoice see all changes for invoices
audit_own_timesheet see all changes for own timesheet records
audit_other_timesheet see all changes in other users timesheet records (only via team timesheets)

Please note: audit_own_timesheet are only available 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.

Top