Leantime Task Organiser

This is a little project to give a better overview of important tasks to complete. It works by a widget on your Leantime Dashboard, where you can create different task lists that gets automatically ordered and prioritized based on your configurations.

There are several different "Sort Modules" that you can use to give a weight to a task. The higher the weight, the higher it will be in the dashboard task list. You can use sort modules to order based on values such as Status, Project, Effort, etc.

This plugin also support some of the other Leantime plugins:

• Custom Fields: If you have this plugin, you can use sort modules for Bool, Checkbox and Radio custom fields.
• Strategies: If you have this plugin, you can use sort modules for things like strategy names.
• Plans: If you have this plugin, you can use sort modules for things like plan names.

Compatible with Leantime v3.6.0.

Warning

If you disable, uninstall or update the plugin all caches and user settings will be reset!

Configuration

You can configure your task lists under Account Settings. There are a couple of fields that you can modify there:

• Title: The title of the task list
• Subtitle: A sentence shown below the title
• General
  • Max Tasks: The maximum tasks to show on each calculation
  • Persistency: For how long the tasks in the list should persist before considering new tasks in the list. The way it works, is that when you calculate a task list, only those tasks that is shown will be considered for reevaluation or reprioritization on later updates. (-1 for always recalculate the list)
  • Always Show: If the task list should always be expanded in the widget
  • Hide list when empty: If the task list should be hidden if there are no tasks in it.
  • Order: The order index of the list, a higher number means it will be earlier in the task lists
  • Show Weights: If you should be able to see the weight of each task in the widget.
  • Allow Ignoring: (This is only relevant if Persistency is larger than 0) If you should be allowed to ignore a task in the task list.
• Item Selection
  • Use Tasks: If the list should consider normal Tasks
  • Use subtasks: If the list should consider sub-tasks
  • Use bugs: If the list should consider bugs
• Modules
  • A JSON file with the configurations for the modules

API

You can interact with the widget by using the JsonRPC API that Leantime uses. The methods you can use are:

• leantime.rpc.TaskOrganiser.SettingsService.GetSettingsIndex To get settings for a given user.
• leantime.rpc.TaskOrganiser.SettingsService.SetSettingsIndex To set settings for a given user.
• leantime.rpc.TaskOrganiser.SortingService.Calculate To get all the task lists for a given user.
• leantime.rpc.TaskOrganiser.SortingService.ClearCache To clear the cache for a given task list.
• leantime.rpc.TaskOrganiser.SortingService.GetCacheExpirations To get how long a given lists cache is valid.

Installation

To install this plugin, simply download the latest release ZIP file under releases and unzip it into the Leantime plugin folder.

Development

For local development (on Windows) you can run the dockerInit.ps1 script to download the Leantime Docker git and run the compose file.

You can then subsequently execute dockerDeploy.ps1 to copy the current ./TaskOrganiser folder into the containers and restart them at the same time.