Plugin Compatibility

Please note that the code of Tasklist plugins might need to be migrated when updating Camunda Platform to a higher version (e.g. CSS styles).

Tasklist uses the concept of plugins to add own functionality without having to extend or hack the Tasklist web application.

For further details about the concepts behind plugins, please read the Cockpit plugins section.

Difference between Cockpit and Tasklist plugins:

  • To publish the plugin with Tasklist, its class name must be put into a file called org.camunda.bpm.tasklist.plugin.spi.TasklistPlugin that resides in the directory META-INF/services.
  • The plugin mechanism of Tasklist does not allow to provide additional SQL queries by using MyBatis mappings.
  • Tasklist frontend modules depend on requireJS and angularJS to register Plugins.

Structure of a Frontend Module

This is how a sample plugin.js could look like:

define(['angular'], function(angular) {

  var ngModule = angular.module('tasklist.cats', []);

  ngModule.config(['ViewsProvider', function(ViewsProvider) {
    ViewsProvider.registerDefaultView('tasklist.task.detail', {
      id: 'tasklist.cats',
      priority: 9001,
      label: 'Cats!',
      template: '<h1>Cats!</h1><img src="" width="400" />',

  return ngModule;

As the file is loaded as a RequireJS module, dependencies (in terms of other RequireJS modules) may be specified. The plugin must register itself with the ViewsProvider via a module configuration hook.

Plugin Points

Here you can see the various points at which you are able to add your own plugins.

Name: tasklist.navbar.action.

Name: tasklist.task.action.

Name: tasklist.header.

Name: tasklist.task.detail.

Name: tasklist.list.

Name: tasklist.card.

Configure where to place your plugin as shown in the following example:

var ViewConfig = [ 'ViewsProvider', function(ViewsProvider) {
  ViewsProvider.registerDefaultView('tasklist.task.detail', {
    id: 'sub-tasks',
    priority: 20,
    label: 'Sub Tasks'

For more information on creating and configuring your own plugin, please have a look at the following examples:

On this Page: