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

== Basic Ticket Workflow Customization ==

30

31

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

32

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

33

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

34

{{{

35

accept = new,accepted -> accepted

36

accept.permissions = TICKET_MODIFY

37

accept.operations = set_owner_to_self

38

}}}

39

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

40

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

41

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.

42

43

The available operations are:

44

- del_owner -- Clear the owner field.

45

- set_owner -- Sets the owner to the selected or entered owner.

46

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

47

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

48

- del_resolution -- Clears the resolution field

49

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

50

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

51

{{{

52

Example:

53

54

resolve_new = new -> closed

55

resolve_new.name = resolve

56

resolve_new.operations = set_resolution

57

resolve_new.permissions = TICKET_MODIFY

58

resolve_new.set_resolution = invalid,wontfix

59

}}}

60

- leave_status -- Displays "leave as <current status>" and makes no change to the ticket.

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

71

72

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

73

{{{

74

leave = * -> *

75

leave.operations = leave_status

76

leave.default = 1

77

}}}

78

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.

79

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

80

81

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.

82

83

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.

84

85

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

86

{{{

87

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

88

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

89

}}}

90

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

91

92

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.

93

94

== Example: Adding optional Testing with Workflow ==

95

96

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.

97

98

{{{

99

testing = new,accepted,needs_work -> testing

100

testing.name = Submit to reporter for testing

101

testing.permissions = TICKET_MODIFY

102

103

reject = testing -> needs_work

104

reject.name = Failed testing, return to developer

105

106

pass = testing -> closed

107

pass.name = Passes Testing

108

pass.operations = set_resolution

109

pass.set_resolution = fixed

110

}}}

111

112

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

113

114

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.

115

116

{{{

117

resolve_new = new -> closed

118

resolve_new.name = resolve

119

resolve_new.operations = set_resolution

120

resolve_new.permissions = TICKET_MODIFY

121

resolve_new.set_resolution = invalid,wontfix,duplicate

122

123

resolve = assigned,accepted,reopened -> closed

124

resolve.operations = set_resolution

125

resolve.permissions = TICKET_MODIFY

126

}}}

127

128

== Advanced Ticket Workflow Customization ==

129

130

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.

131

132

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

133

134

== some ideas for next steps ==

135

136

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.

137

138

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

139

140

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

141

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

142

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

143

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

144

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

145

146

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

147

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

148

149

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

150

* either to a role, a person

151

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

152

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

153

154

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

155

This is becoming a frequent request, with clear usecases. The closest the current implementation will allow is to have a plugin provide a `triage` action that sets the next state based on the ticket type, so a `new` ticket would move to `new_task`, `new_defect`, etc., and the workflow graph would separate at that point.