wiki:MultipleWorkflowPlugin

Workflow based on ticket type

Description

This plugin controls what actions can be performed on a ticket. The actions are specified in the [ticket-workflow] section of the TracIni file.

With MultipleWorkflowPlugin Trac can read the workflow based on the type of ticket. If a section for that ticket type doesn't exist, then it uses the default workflow, see Example below.

The plugin works with Trac 0.11, 0.12 and 1.0.

See also TypedTicketWorkflowPlugin.

Workflow editing

For changing the workflows an admin page is available in the Ticket System section.

Image of workflow editor

What's the difference to TypedTicketWorkflowPlugin?

With MultipleWorkflowPlugin you may have an exclusive workflow section for each ticket type like this:

[ticket-workflow]
# Default workflow
approve = new, reopened -> approved
approve.operations = del_resolution
...

[ticket-workflow-Foo]
# Workflow for ticket type 'Foo'
do_foo = new -> foo
...

[ticket-workflow-Bar]
# Workflow for ticket type 'Bar'
do_bar = new -> bar
...

With TypedTicketWorkflowPlugin you specify restrictions for ticket types in the default workflow by adding them to the transitions:

[ticket-workflow]
approve = new, reopened -> approved
approve.operations = del_resolution
# approve is only valid for ticket types 'defect' and 'feature'
approve.tickettype = defect, feature
...

The former is easier to manage if you have several ticket types with vastly different workflows.

See also #5287.

Bugs/Feature Requests

Existing bugs and feature requests for MultipleWorkflowPlugin are here.

If you have any issues, create a new ticket.

defect

9 / 10

enhancement

4 / 4

task

1 / 1

Download

Download the zipped source from here.

Source

You can check out MultipleWorkflowPlugin from here using Subversion, or browse the source with Trac.

The trunk is compatible with Trac 1.2.x. The 1.3 branch is compatible with Trac 1.0.x.

Installation

General instructions on installing Trac plugins can be found on the TracPlugins page.

Enable the plugin by adding the following to your trac.ini file:

[components]
multipleworkflow.* = enabled

Add the controller to the workflow controller list:

[ticket]
workflow = MultipleWorkflowPlugin

Example

To use it you should have the [ticket-workflow] section defined in your trac.ini file. When a custom section for a ticket type has not been defined, that one will be used.

To define a different workflow for a ticket with type Requirement create a section in trac.ini called [ticket-workflow-Requirement] and add your workflow items:

[ticket-workflow-Requirement]
leave = * -> *
leave.default = 1
leave.operations = leave_status

approve = new, reopened -> approved
approve.operations = del_resolution
approve.permissions = TICKET_MODIFY

reopen_verified = closed -> reopened
reopen_verified.name = Reopen
reopen_verified.operations = set_resolution
reopen_verified.set_resolution = from verified
reopen_verified.permissions = TICKET_MODIFY

reopen_approved = approved -> reopened
reopen_approved.name = Reopen
reopen_approved.operations = set_resolution
reopen_approved.set_resolution = from approved
reopen_approved.permissions = TICKET_CREATE

remove = new, reopened, approved, closed -> removed
remove.name = Remove this Requirement permanently
remove.operations = set_resolution
remove.set_resolution = removed
remove.permissions = TICKET_MODIFY

verify = approved -> closed
verify.name = Verify the Requirement and mark
verify.operations = set_resolution
verify.set_resolution = verified
verify.permissions = TICKET_MODIFY

This results in the following workflow:

Custom Workflow Statuses on Query Page

Starting with [14565] all defined statuses from typed workflows are available on the ticket query page for filtering.

Recent Changes

16598 by rjollos on 2017-05-18 05:17:04
MultipleWorkflowPlugin 1.4.0dev: Make compatible with Trac 1.2+

  • Simplify plugin design by using inheritance
  • Dynamiclaly refresh the available actions

Initial patch by Miklos Molnar.

Fixes #13106.

16597 by rjollos on 2017-05-18 05:03:41
Create branch for Trac 1.0.x-compatible plugin

The trunk will be compatible with Trac 1.2.x

Refs #13106.

16596 by rjollos on 2017-05-18 05:02:23
Add branches directory
(more)

Author/Contributors

Author: ermal
Maintainer: Cinc-th
Contributors:

Last modified 5 days ago Last modified on May 18, 2017, 3:17:40 PM

Attachments (1)

Download all attachments as: .zip