Task management plugin

• Features
• Purchase
• New widgets
  • My times widget
  • Pending tasks widget
  • Compatibility
• Installation
  • Copy files
  • Clear cache
  • Create database
• Permissions
• Updating the plugin
• Screenshots

A Kimai 2 plugin, which allows you to plan your work and distribute tasks among your users and teams. It features two new dashboard widgets and a new “Task management” view in the left navigation.

Features

• Add “tasks” which are used to start and group timesheet records
• Each task consists of a
  • Title
  • End date (optional)
  • User (optional: if left empty, the task can be self-assigned from the “pending tasks” widget)
  • Team (optional: if given, only users from this team see this task and can assign it)
  • Customer (will be copied to the started timesheets)
  • Project (will be copied to the started timesheets)
  • Activity (will be copied to the started timesheets)
  • Description (will be copied to the started timesheets)

With the help of the dashboard widgets every user can manage their work.

Or you configure the permissions in a way, that the user only see the “My times widget”. A teamlead can then prepare a list of tasks / work schedule for the users, who then utilize the widget to start/pause/stop the tasks. When the work on a task is finished, the user can either close the it (if allowed) or the teamlead does it after reviewing the results.

Purchase

New widgets

This bundle introduces two new dashboard widgets

My times widget

• Displays all tasks that:
  • are not “closed”
  • that are assigned to you

This widget features the following UI elements (if permissions are set for the user):

• a checkbox to close the task (moving to status done will stop all related timesheet entries)
• a title (colored “green” if end date is set but not yet reached, colored “red” if end date is overdue)
• a “Play” or “Pause” button (pause means that you already recorded times for the task)
• an “Edit” button to change the task fields
• an “Unassign” button (will stop all related timesheet entries and move the task to the “Pending tasks widget”)
• a “Delete” button (will remove the task entirely, but keep the related timesheet entries)
• a “Create” button (create a new task for the currently logged-in user)

Pending tasks widget

• Displays all tasks that:
  • that are not assigned to a user
  • that are in “pending” status
  • that can be seen by the user (via team assignment or completely unassigned tasks)

This widget features the following UI elements (if permissions are set for the user):

• a title (colored “green” if end date is set but not yet reached, colored “red” if end date is overdue)
• an “Edit” button
• an “Assign” button (move the task back to the “My times widget”)
• a “Delete” button (will remove the task entirely, but keep the related timesheet entries)
• a “Create” button (create a new pending task)

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

The file structure needs to like like this afterwards:

var/plugins/
├── TaskManagementBundle
│   ├── TaskManagementBundle.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:tasks:install

This will install all required databases.

Permissions

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

This bundle ships a pre-configured permission set for all default user roles.

Access to tasks for other users is also limited by the permission view_other_timesheet. If a user has the task_view permission, but NOT view_other_timesheet, he will only see own tasks. Be aware, that the data for non-admin users is additionally limited by the team assignments.

Updating the plugin

Updating the bundle works the same way as the installation does.

• Delete the directory var/plugins/TaskManagementBundle/
• Execute all installation steps again:
  • Copy files
  • Clear cache
  • Update database with bin/console kimai:bundle:tasks:install

Screenshots

The overview page of all tasks:

The task widget:

When creating a new task, you can record the following fields: