When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section.

9

The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10.

10

11

Graphically, that looks like this:

12

13

[[Image(htdocs:../common/guide/original-workflow.png)]]

14

15

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?

16

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.

17

18

=== Environments created with 0.11 ===

19

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.

20

21

Graphically, it looks like this:

22

23

[[Image(htdocs:../common/guide/basic-workflow.png)]]

24

25

== Additional Ticket Workflows ==

26

27

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.

28

29

Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples.

30

31

== Basic Ticket Workflow Customization ==

32

33

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.

12

The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10:

13

14

{{{#!Workflow width=500 height=240

15

leave = * -> *

16

leave.operations = leave_status

17

leave.default = 1

18

accept = new -> assigned

19

accept.permissions = TICKET_MODIFY

20

accept.operations = set_owner_to_self

21

resolve = new,assigned,reopened -> closed

22

resolve.permissions = TICKET_MODIFY

23

resolve.operations = set_resolution

24

reassign = new,assigned,reopened -> new

25

reassign.permissions = TICKET_MODIFY

26

reassign.operations = set_owner

27

reopen = closed -> reopened

28

reopen.permissions = TICKET_CREATE

29

reopen.operations = del_resolution

30

}}}

31

32

There are some significant caveats in this, such as accepting a ticket sets it to 'assigned' state, and assigning a ticket sets it to 'new' state. So you will probably want to migrate to "basic" workflow, see contrib/workflow/migrate_original_to_basic.py.

33

34

=== Environments created with 0.11

35

36

When a new environment is created, a default workflow is configured in your trac.ini. This workflow is the basic workflow, such as specified in `basic-workflow.ini`, which is somewhat different from the workflow of the 0.10 releases:

37

38

{{{#!Workflow width=700 height=300

39

leave = * -> *

40

leave.operations = leave_status

41

leave.default = 1

42

accept = new,assigned,accepted,reopened -> accepted

43

accept.permissions = TICKET_MODIFY

44

accept.operations = set_owner_to_self

45

resolve = new,assigned,accepted,reopened -> closed

46

resolve.permissions = TICKET_MODIFY

47

resolve.operations = set_resolution

48

reassign = new,assigned,accepted,reopened -> assigned

49

reassign.permissions = TICKET_MODIFY

50

reassign.operations = set_owner

51

reopen = closed -> reopened

52

reopen.permissions = TICKET_CREATE

53

reopen.operations = del_resolution

54

}}}

55

56

== Additional Ticket Workflows

57

58

There are example workflows provided in the Trac source tree, see [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.

59

60

Here are some [trac:WorkFlow/Examples diagrams] of the above examples.

61

62

== Basic Ticket Workflow Customization

63

64

'''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.

34

65

35

66

Create a `[ticket-workflow]` section in `trac.ini`.

36

67

Within this section, each entry is an action that may be taken on a ticket.

37

68

For example, consider the `accept` action from `simple-workflow.ini`:

38

{{{

69

70

{{{#!ini

39

71

accept = new,accepted -> accepted

40

72

accept.permissions = TICKET_MODIFY

41

73

accept.operations = set_owner_to_self

42

74

}}}

75

43

76

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`).

44

77

The `accept.permissions` line specifies what permissions the user must have to use this action.

- ''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 field

53

- set_resolution -- Sets the resolution to the selected value.

54

- ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value.

55

{{{

56

Example:

57

81

- **del_owner** -- Clear the owner field.

82

- **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.

83

- ''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.

84

- **set_owner_to_self** -- Sets the owner to the logged in user.

85

- **del_resolution** -- Clears the resolution field.

86

- **set_resolution** -- Sets the resolution to the selected value.

87

- ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example:

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`.

75

76

For actions that should be available in all states, `*` may be used in place of the state. The obvious example is the `leave` action:

77

{{{

78

leave = * -> *

79

leave.operations = leave_status

80

leave.default = 1

81

}}}

82

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.

83

If not specified for an action, `.default` is 0. The value may be negative.

84

85

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.

86

87

While 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.

88

89

This can be done as follows (your install path may be different).

90

{{{

108

For actions that should be available in all states, `*` may be used in place of the state. The obvious example is the `leave` action:

109

{{{#!ini

110

leave = * -> *

111

leave.operations = leave_status

112

leave.default = 1

113

}}}

114

115

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.

116

If not specified for an action, `.default` is 0. The value may be negative.

117

118

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.

119

120

The special `_reset` action is added by default for tickets that are in states that are no longer defined. This allows tickets to be individually "repaired" after the workflow is changed, although it's recommended that the administrator perform the action by batch modifying the affected tickets. By default the `_reset` action is available to users with the `TICKET_ADMIN` permission and reset tickets are put in the //new// state. The default `_reset` action is equivalent to the following `[ticket-workflow]` action definition:

121

122

{{{#!ini

123

_reset = -> new

124

_reset.name = reset

125

_reset.operations = reset_workflow

126

_reset.permissions = TICKET_ADMIN

127

_reset.default = 0

128

}}}

129

130

Since [trac:milestone:1.0.3] the `_reset` action can be customized by redefining the implicit action. For example, to allow anyone with `TICKET_MODIFY` to perform the `_reset` action, the workflow action would need to be defined:

131

132

{{{#!ini

133

_reset = -> new

134

_reset.name = reset

135

_reset.operations = reset_workflow

136

_reset.permissions = TICKET_MODIFY

137

_reset.default = 0

138

}}}

139

140

== Workflow Visualization

141

142

Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro].

143

144

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):

145

146

{{{#!sh

91

147

cd /var/local/trac_devel/contrib/workflow/

92

148

sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini

93

149

}}}

94

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).

95

96

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

98

== Example: Adding optional Testing with Workflow ==

99

100

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

102

{{{

150

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.

151

152

After you have changed a workflow, you need to restart your webserver for the changes to take effect.

153

154

== Example: Adding optional Testing with Workflow

155

156

By adding the following to your [ticket-workflow] section of trac.ini you get optional testing. When the ticket has status `new`, `accepted` or `needs_work`, 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 is 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.

=== How to combine the `tracopt.ticket.commit_updater` with the testing workflow

173

174

The [[trac:source:trunk/tracopt/ticket/commit_updater.py|tracopt.ticket.commit_updater]] is the optional component that [[TracRepositoryAdmin#trac-post-commit-hook|replaces the old trac-post-commit-hook]], in Trac 0.12.

175

176

By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action.

177

178

If you have a more complex workflow, like the testing stage described above and you want the ''closes'' keyword to move the ticket to the ''testing'' status instead of the ''closed'' status, you need to adapt the code a bit.

179

180

Have a look at the [[trac:wiki:0.11/TracWorkflow#How-ToCombineSVNtrac-post-commit-hookWithTestWorkflow|Trac 0.11 recipe]] for the `trac-post-commit-hook`, this will give you some ideas about how to modify the component.

181

182

== Example: Add simple optional generic review state

117

183

118

184

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.

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.

137

138

{{{

202

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:

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.

176

177

{{{

239

== Example: Limit the resolution options for a new ticket

240

241

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.

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.

255

== Advanced Ticket Workflow Customization

256

257

If the customizations above do not meet your needs, you can extend the workflow with plugins. 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 examples to get started.

192

258

193

259

But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.

194

260

195

== Adding Workflow States to Milestone Progress Bars ==

196

197

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].

198

199

== some ideas for next steps ==

200

201

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.

202

203

If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket.

204

205

* the "operation" could be on the nodes, possible operations are:

206

* '''preops''': automatic, before entering the state/activity

207

* '''postops''': automatic, when leaving the state/activity

208

* '''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.

209

''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.''

210

211

* operations could be anything: sum up the time used for the activity, or just write some statistical fields like

212

''A workflow plugin can add an arbitrary workflow operation, so this is already possible.''

213

214

* set_actor should be an operation allowing to set the owner, e.g. as a "preop":

215

* either to a role, a person

216

* entered fix at define time, or at run time, e.g. out of a field, or select.

217

''This is either duplicating the existing `set_owner` operation, or needs to be clarified.''

218

219

* Actions should be selectable based on the ticket type (different Workflows for different tickets)

220

''Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s `triage` operation.''

261

== Adding Workflow States to Milestone Progress Bars

262

263

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].

264

265

== Ideas for next steps

266

267

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.

268

269

Some of the ideas described here are originally proposed in [trac:NewWorkflow].