Project

General

Profile

TracWorkflow » History » Version 2

Anonymous, 04/18/2009 07:09 PM

1 2
2
h1. The Trac Ticket Workflow System
3
4 1
[[TracGuideToc]]
5
6
The Trac issue database provides a configurable workflow.
7
8 2
9
h2. The Default Ticket Workflow ==
10
 Environments upgraded from 0.10 ===
11
When you run @trac-admin <env> upgrade@, your @trac.ini@ will be modified to include a @[ticket-workflow]@ section.
12 1
The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10.
13
14
Graphically, that looks like this:
15
16
[[Image(htdocs:../common/guide/original-workflow.png)]]
17
18
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?
19
So you will probably want to migrate to "basic" workflow; [trac:source:trunk/contrib/workflow/migrate_original_to_basic.py contrib/workflow/migrate_original_to_basic.py] may be helpful.
20
21
22 2
h3. Environments created with 0.11
23
24
When a new environment is created, a default workflow is configured in your trac.ini.  This workflow is the basic workflow (described in @basic-workflow.ini@), which is somewhat different from the workflow of the 0.10 releases.
25
26 1
Graphically, it looks like this:
27
28
[[Image(htdocs:../common/guide/basic-workflow.png)]]
29
30
31 2
h2. Additional Ticket Workflows
32 1
33
34 2
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.
35 1
36 2
Here are some "diagrams":http://trac.edgewall.org/wiki/WorkFlow/Examples of the above examples.
37
38
39
h2. Basic Ticket Workflow Customization
40
41
42 1
Note: Ticket "statuses" or "states" are not separately defined. The states a ticket can be in are automatically generated by the transitions defined in a workflow. Therefore, creating a new ticket state simply requires defining a state transition in the workflow that starts or ends with that state.
43
44 2
Create a @[ticket-workflow]@ section in @trac.ini@.
45 1
Within this section, each entry is an action that may be taken on a ticket. 
46 2
For example, consider the @accept@ action from @simple-workflow.ini@:
47
<pre>
48 1
accept = new,accepted -> accepted
49
accept.permissions = TICKET_MODIFY
50
accept.operations = set_owner_to_self
51 2
</pre>
52
The first line in this example defines the @accept@ action, along with the states the action is valid in (@new@ and @accepted@), and the new state of the ticket when the action is taken (@accepted@).
53
The @accept.permissions@ line specifies what permissions the user must have to use this action.
54
The @accept.operations@ line specifies changes that will be made to the ticket in addition to the status change when this action is taken.  In this case, when a user clicks on @accept@, the ticket owner field is updated to the logged in user.  Multiple operations may be specified in a comma separated list.
55 1
56
The available operations are:
57
 - del_owner -- Clear the owner field.
58
 - set_owner -- Sets the owner to the selected or entered owner.
59 2
   - _actionname_@.set_owner@ may optionally be set to a comma delimited list or a single value.
60 1
 - set_owner_to_self -- Sets the owner to the logged in user.
61
 - del_resolution -- Clears the resolution field
62
 - set_resolution -- Sets the resolution to the selected value.
63 2
   - _actionname_@.set_resolution@ may optionally be set to a comma delimited list or a single value.
64
<pre>
65 1
Example:
66
67
resolve_new = new -> closed
68
resolve_new.name = resolve
69
resolve_new.operations = set_resolution
70
resolve_new.permissions = TICKET_MODIFY
71
resolve_new.set_resolution = invalid,wontfix
72 2
</pre>
73 1
 - leave_status -- Displays "leave as <current status>" and makes no change to the ticket.
74 2
*Note:* Specifying conflicting operations (such as @set_owner@ and @del_owner@) has unspecified results.
75 1
76 2
<pre>
77 1
resolve_accepted = accepted -> closed
78
resolve_accepted.name = resolve
79
resolve_accepted.permissions = TICKET_MODIFY
80
resolve_accepted.operations = set_resolution
81 2
</pre>
82 1
83 2
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@.
84 1
85 2
For actions that should be available in all states, @*@ may be used in place of the state.  The obvious example is the @leave@ action:
86
<pre>
87 1
leave = * -> *
88
leave.operations = leave_status
89
leave.default = 1
90 2
</pre>
91
This also shows the use of the @.default@ attribute.  This value is expected to be an integer, and the order in which the actions are displayed is determined by this value.  The action with the highest @.default@ value is listed first, and is selected by default.  The rest of the actions are listed in order of decreasing @.default@ values.
92
If not specified for an action, @.default@ is 0.  The value may be negative.
93 1
94 2
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.
95 1
96 2
While creating or modifying a ticket workfow, @contrib/workflow/workflow_parser.py@ may be useful.  It can create @.dot@ files that "GraphViz":http://www.graphviz.org understands to provide a visual description of the workflow.
97 1
98
This can be done as follows (your install path may be different).
99 2
<pre>
100 1
cd /var/local/trac_devel/contrib/workflow/
101
sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
102 2
</pre>
103
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).
104 1
105
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.
106
107
108 2
h2. Example: Adding optional Testing with Workflow
109
110
111 1
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.
112
113 2
<pre>
114 1
testing = new,accepted,needs_work,assigned,reopened -> testing
115
testing.name = Submit to reporter for testing
116
testing.permissions = TICKET_MODIFY
117
118
reject = testing -> needs_work
119
reject.name = Failed testing, return to developer
120
121
pass = testing -> closed
122
pass.name = Passes Testing
123
pass.operations = set_resolution
124
pass.set_resolution = fixed
125 2
</pre>
126 1
127
128 2
h2. Example: Add simple optional generic review state
129 1
130
131 2
Sometimes Trac is used in situations where "testing" can mean different things to different people so you may want to create an optional workflow state that is between the default workflow's @assigned@ and @closed@ states, but does not impose implementation-specific details. The only new state you need to add for this is a @reviewing@ state. A ticket may then be "submitted for review" from any state that it can be reassigned. If a review passes, you can re-use the @resolve@ action to close the ticket, and if it fails you can re-use the @reassign@ action to push it back into the normal workflow.
132
133
The new @reviewing@ state along with its associated @review@ action looks like this:
134
135
<pre>
136 1
review = new,assigned,reopened -> reviewing
137
review.operations = set_owner
138
review.permissions = TICKET_MODIFY
139 2
</pre>
140 1
141 2
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:
142 1
143 2
<pre>
144 1
accept = new,reviewing -> assigned
145
[…]
146
resolve = new,assigned,reopened,reviewing -> closed
147 2
</pre>
148 1
149 2
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.
150 1
151 2
<pre>
152 1
reassign_reviewing = reviewing -> *
153
reassign_reviewing.name = reassign review
154
reassign_reviewing.operations = set_owner
155
reassign_reviewing.permissions = TICKET_MODIFY
156 2
</pre>
157 1
158 2
The full @[ticket-workflow]@ configuration will thus look like this:
159 1
160 2
<pre>
161 1
[ticket-workflow]
162
accept = new,reviewing -> assigned
163
accept.operations = set_owner_to_self
164
accept.permissions = TICKET_MODIFY
165
leave = * -> *
166
leave.default = 1
167
leave.operations = leave_status
168
reassign = new,assigned,reopened -> new
169
reassign.operations = set_owner
170
reassign.permissions = TICKET_MODIFY
171
reopen = closed -> reopened
172
reopen.operations = del_resolution
173
reopen.permissions = TICKET_CREATE
174
resolve = new,assigned,reopened,reviewing -> closed
175
resolve.operations = set_resolution
176
resolve.permissions = TICKET_MODIFY
177
review = new,assigned,reopened -> reviewing
178
review.operations = set_owner
179
review.permissions = TICKET_MODIFY
180
reassign_reviewing = reviewing -> *
181
reassign_reviewing.operations = set_owner
182
reassign_reviewing.name = reassign review
183
reassign_reviewing.permissions = TICKET_MODIFY
184 2
</pre>
185 1
186
187 2
h2. Example: Limit the resolution options for a new ticket
188 1
189 2
190
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.
191
192
<pre>
193 1
resolve_new = new -> closed
194
resolve_new.name = resolve
195
resolve_new.operations = set_resolution
196
resolve_new.permissions = TICKET_MODIFY
197
resolve_new.set_resolution = invalid,wontfix,duplicate
198
199
resolve = assigned,accepted,reopened -> closed
200
resolve.operations = set_resolution
201
resolve.permissions = TICKET_MODIFY
202 2
</pre>
203 1
204
205 2
h2. Advanced Ticket Workflow Customization
206
207
208 1
If the customization above is not extensive enough for your needs, you can extend the workflow using plugins.  These plugins can provide additional operations for the workflow (like code_review), or implement side-effects for an action (such as triggering a build) that may not be merely simple state changes.  Look at [trac:source:trunk/sample-plugins/workflow sample-plugins/workflow] for a few simple examples to get started.
209
210 2
But if even that is not enough, you can disable the ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
211 1
212
213 2
h2. Adding Workflow States to Milestone Progress Bars
214 1
215
216 2
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]]].
217 1
218 2
219
h2. some ideas for next steps
220
221
222
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 [th:wiki:AdvancedTicketWorkflowPlugin] as it provides experimental operations.
223
224 1
If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket.
225
226 2
* the "operation" could be on the nodes, possible operations are:
227
*** *preops*: automatic, before entering the state/activity
228
*** *postops*: automatic, when leaving the state/activity
229
*** *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.
230
_This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement._
231 1
232 2
* operations could be anything: sum up the time used for the activity, or just write some statistical fields like 
233
_A workflow plugin can add an arbitrary workflow operation, so this is already possible._
234 1
235 2
* set_actor should be an operation allowing to set the owner, e.g. as a "preop":
236
*** either to a role, a person
237
*** entered fix at define time, or at run time, e.g. out of a field, or select.
238
_This is either duplicating the existing @set_owner@ operation, or needs to be clarified._
239 1
240 2
* Actions should be selectable based on the ticket type (different Workflows for different tickets)
241
_Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s @triage@ operation._