Changes between Version 4 and Version 5 of TracWorkflow
- Timestamp:
- Apr 26, 2017, 6:22:04 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracWorkflow
v4 v5 2 2 [[TracGuideToc]] 3 3 4 The Trac issue databaseprovides a configurable workflow.4 The Trac ticket system provides a configurable workflow. 5 5 6 6 == The Default Ticket Workflow == … … 11 11 Graphically, that looks like this: 12 12 13 [[Image(htdocs:../common/guide/original-workflow.png)]] 13 {{{#!Workflow width=500 height=240 14 leave = * -> * 15 leave.operations = leave_status 16 leave.default = 1 17 accept = new -> assigned 18 accept.permissions = TICKET_MODIFY 19 accept.operations = set_owner_to_self 20 resolve = new,assigned,reopened -> closed 21 resolve.permissions = TICKET_MODIFY 22 resolve.operations = set_resolution 23 reassign = new,assigned,reopened -> new 24 reassign.permissions = TICKET_MODIFY 25 reassign.operations = set_owner 26 reopen = closed -> reopened 27 reopen.permissions = TICKET_CREATE 28 reopen.operations = del_resolution 29 }}} 14 30 15 31 There are some significant "warts" in this; such as accepting a ticket sets it to 'assigned' state, and assigning a ticket sets it to 'new' state. Perfectly obvious, right? … … 21 37 Graphically, it looks like this: 22 38 23 [[Image(htdocs:../common/guide/basic-workflow.png)]] 39 {{{#!Workflow width=700 height=300 40 leave = * -> * 41 leave.operations = leave_status 42 leave.default = 1 43 accept = new,assigned,accepted,reopened -> accepted 44 accept.permissions = TICKET_MODIFY 45 accept.operations = set_owner_to_self 46 resolve = new,assigned,accepted,reopened -> closed 47 resolve.permissions = TICKET_MODIFY 48 resolve.operations = set_resolution 49 reassign = new,assigned,accepted,reopened -> assigned 50 reassign.permissions = TICKET_MODIFY 51 reassign.operations = set_owner 52 reopen = closed -> reopened 53 reopen.permissions = TICKET_CREATE 54 reopen.operations = del_resolution 55 }}} 24 56 25 57 == Additional Ticket Workflows == … … 27 59 There are several example workflows provided in the Trac source tree; look in [trac:source:trunk/contrib/workflow contrib/workflow] for `.ini` config sections. One of those may be a good match for what you want. They can be pasted into the `[ticket-workflow]` section of your `trac.ini` file. However if you have existing tickets then there may be issues if those tickets have states that are not in the new workflow. 28 60 29 Here are some [ http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples.61 Here are some [trac:WorkFlow/Examples diagrams] of the above examples. 30 62 31 63 == Basic Ticket Workflow Customization == … … 36 68 Within this section, each entry is an action that may be taken on a ticket. 37 69 For example, consider the `accept` action from `simple-workflow.ini`: 38 {{{ 70 {{{#!ini 39 71 accept = new,accepted -> accepted 40 72 accept.permissions = TICKET_MODIFY … … 46 78 47 79 The available operations are: 48 - del_owner-- Clear the owner field.49 - set_owner -- Sets the owner to the selected or entered owner.50 - ''actionname''`.set_owner` may optionally be set to a comma delimited list or a single value.51 - set_owner_to_self-- Sets the owner to the logged in user.52 - del_resolution-- Clears the resolution field53 - set_resolution-- Sets the resolution to the selected value.54 55 {{{80 - **del_owner** -- Clear the owner field. 81 - **set_owner** -- Sets the owner to the selected or entered owner. Defaults to the current user. When `[ticket] restrict_owner = true`, the select will be populated with users that have `TICKET_MODIFY` permission and an authenticated session. 82 - ''actionname''`.set_owner` may optionally be set to a comma delimited list of users that will be used to populate the select, or a single user. 83 - **set_owner_to_self** -- Sets the owner to the logged in user. 84 - **del_resolution** -- Clears the resolution field 85 - **set_resolution** -- Sets the resolution to the selected value. 86 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example: 87 {{{#!ini 56 88 resolve_new = new -> closed 57 89 resolve_new.name = resolve … … 59 91 resolve_new.permissions = TICKET_MODIFY 60 92 resolve_new.set_resolution = invalid,wontfix 61 62 - leave_status-- Displays "leave as <current status>" and makes no change to the ticket.93 }}} 94 - **leave_status** -- Displays "leave as <current status>" and makes no change to the ticket. 63 95 '''Note:''' Specifying conflicting operations (such as `set_owner` and `del_owner`) has unspecified results. 64 96 65 {{{ 97 In this example, we see the `.name` attribute used. The action here is `resolve_accepted`, but it will be presented to the user as `resolve`. 98 99 {{{#!ini 66 100 resolve_accepted = accepted -> closed 67 101 resolve_accepted.name = resolve … … 70 104 }}} 71 105 72 In this example, we see the `.name` attribute used. The action here is `resolve_accepted`, but it will be presented to the user as `resolve`.73 74 106 For actions that should be available in all states, `*` may be used in place of the state. The obvious example is the `leave` action: 75 {{{ 107 {{{#!ini 76 108 leave = * -> * 77 109 leave.operations = leave_status … … 83 115 There are a couple of hard-coded constraints to the workflow. In particular, tickets are created with status `new`, and tickets are expected to have a `closed` state. Further, the default reports/queries treat any state other than `closed` as an open state. 84 116 85 W hile creating or modifying a ticket workfow, `contrib/workflow/workflow_parser.py` may be useful. It can create `.dot` files that [http://www.graphviz.org GraphViz] understands to provide a visual description of the workflow.86 87 This can be done as follows (your install path may be different). 88 {{{ 117 Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro]. 118 119 Workflows can also be visualized using the `contrib/workflow/workflow_parser.py` script. The script outputs `.dot` files that [http://www.graphviz.org GraphViz] understands. The script can be used as follows (your install path may be different): 120 {{{#!sh 89 121 cd /var/local/trac_devel/contrib/workflow/ 90 122 sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini … … 92 124 And then open up the resulting `trac.pdf` file created by the script (it will be in the same directory as the `trac.ini` file). 93 125 94 An online copy of the workflow parser is available at http://foss.wush.net/cgi-bin/visual-workflow.pl95 96 126 After you have changed a workflow, you need to restart apache for the changes to take effect. This is important, because the changes will still show up when you run your script, but all the old workflow steps will still be there until the server is restarted. 97 127 … … 100 130 By adding the following to your [ticket-workflow] section of trac.ini you get optional testing. When the ticket is in new, accepted or needs_work status you can choose to submit it for testing. When it's in the testing status the user gets the option to reject it and send it back to needs_work, or pass the testing and send it along to closed. If they accept it then it gets automatically marked as closed and the resolution is set to fixed. Since all the old work flow remains, a ticket can skip this entire section. 101 131 102 {{{ 132 {{{#!ini 103 133 testing = new,accepted,needs_work,assigned,reopened -> testing 104 134 testing.name = Submit to reporter for testing … … 130 160 The new `reviewing` state along with its associated `review` action looks like this: 131 161 132 {{{ 162 {{{#!ini 133 163 review = new,assigned,reopened -> reviewing 134 164 review.operations = set_owner … … 138 168 Then, to integrate this with the default Trac 0.11 workflow, you also need to add the `reviewing` state to the `accept` and `resolve` actions, like so: 139 169 140 {{{ 170 {{{#!ini 141 171 accept = new,reviewing -> assigned 142 172 […] … … 146 176 Optionally, you can also add a new action that allows you to change the ticket's owner without moving the ticket out of the `reviewing` state. This enables you to reassign review work without pushing the ticket back to the `new` status. 147 177 148 {{{ 178 {{{#!ini 149 179 reassign_reviewing = reviewing -> * 150 180 reassign_reviewing.name = reassign review … … 155 185 The full `[ticket-workflow]` configuration will thus look like this: 156 186 157 {{{ 187 {{{#!ini 158 188 [ticket-workflow] 159 189 accept = new,reviewing -> assigned … … 183 213 == Example: Limit the resolution options for a new ticket == 184 214 185 The above resolve_newoperation allows you to set the possible resolutions for a new ticket. By modifying the existing resolve action and removing the new status from before the `->` we then get two resolve actions. One with limited resolutions for new tickets, and then the regular one once a ticket is accepted.186 187 {{{ 215 The above `resolve_new` operation allows you to set the possible resolutions for a new ticket. By modifying the existing resolve action and removing the new status from before the `->` we then get two resolve actions. One with limited resolutions for new tickets, and then the regular one once a ticket is accepted. 216 217 {{{#!ini 188 218 resolve_new = new -> closed 189 219 resolve_new.name = resolve … … 207 237 If you add additional states to your workflow, you may want to customize your milestone progress bars as well. See [TracIni#milestone-groups-section TracIni]. 208 238 209 == some ideas for next steps == 210 211 New enhancement ideas for the workflow system should be filed as enhancement tickets against the `ticket system` component. If desired, add a single-line link to that ticket here. Also look at the [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin] as it provides experimental operations. 212 213 If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket. 214 215 * the "operation" could be on the nodes, possible operations are: 216 * '''preops''': automatic, before entering the state/activity 217 * '''postops''': automatic, when leaving the state/activity 218 * '''actions''': can be chosen by the owner in the list at the bottom, and/or drop-down/pop-up together with the default actions of leaving the node on one of the arrows. 219 ''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.'' 220 221 * operations could be anything: sum up the time used for the activity, or just write some statistical fields like 222 ''A workflow plugin can add an arbitrary workflow operation, so this is already possible.'' 223 224 * set_actor should be an operation allowing to set the owner, e.g. as a "preop": 225 * either to a role, a person 226 * entered fix at define time, or at run time, e.g. out of a field, or select. 227 ''This is either duplicating the existing `set_owner` operation, or needs to be clarified.'' 228 229 * Actions should be selectable based on the ticket type (different Workflows for different tickets) 230 ''Look into the [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin]'s `triage` operation.'' 231 232 * I'd wish to have an option to perform automatic status changes. In my case, I do not want to start with "new", but with "assigned". So tickets in state "new" should automatically go into state "assigned". Or is there already a way to do this and I just missed it? 233 ''Have a look at [http://trac-hacks.org/wiki/TicketCreationStatusPlugin TicketCreationStatusPlugin] and [http://trac-hacks.org/wiki/TicketConditionalCreationStatusPlugin TicketConditionalCreationStatusPlugin]'' 234 235 * I added a 'testing' state. A tester can close the ticket or reject it. I'd like the transition from testing to rejected to set the owner to the person that put the ticket in 'testing'. The [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin] is close with set_owner_to_field, but we need something like set_field_to_owner. 236 237 * I'd like to track the time a ticket is in each state, adding up 'disjoints' intervals in the same state. 239 == Ideas for next steps == 240 241 New enhancement ideas for the workflow system should be filed as enhancement tickets against the `ticket system` component. You can also document ideas on the [trac:TracIdeas/TracWorkflow TracIdeas/TracWorkflow] page. Also look at the [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin] as it provides experimental operations.
