| 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. |
| | 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 | {{{#!Workflow width=500 height=240 |
| | 12 | leave = * -> * |
| | 13 | leave.operations = leave_status |
| | 14 | leave.default = 1 |
| | 15 | accept = new -> assigned |
| | 16 | accept.permissions = TICKET_MODIFY |
| | 17 | accept.operations = set_owner_to_self |
| | 18 | resolve = new,assigned,reopened -> closed |
| | 19 | resolve.permissions = TICKET_MODIFY |
| | 20 | resolve.operations = set_resolution |
| | 21 | reassign = new,assigned,reopened -> new |
| | 22 | reassign.permissions = TICKET_MODIFY |
| | 23 | reassign.operations = set_owner |
| | 24 | reopen = closed -> reopened |
| | 25 | reopen.permissions = TICKET_CREATE |
| | 26 | reopen.operations = del_resolution |
| | 27 | }}} |
| | 28 | |
| | 29 | 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. |
| 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)]] |
| | 32 | 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: |
| | 33 | |
| | 34 | {{{#!Workflow width=700 height=300 |
| | 35 | leave = * -> * |
| | 36 | leave.operations = leave_status |
| | 37 | leave.default = 1 |
| | 38 | accept = new,assigned,accepted,reopened -> accepted |
| | 39 | accept.permissions = TICKET_MODIFY |
| | 40 | accept.operations = set_owner_to_self |
| | 41 | resolve = new,assigned,accepted,reopened -> closed |
| | 42 | resolve.permissions = TICKET_MODIFY |
| | 43 | resolve.operations = set_resolution |
| | 44 | reassign = new,assigned,accepted,reopened -> assigned |
| | 45 | reassign.permissions = TICKET_MODIFY |
| | 46 | reassign.operations = set_owner |
| | 47 | reopen = closed -> reopened |
| | 48 | reopen.permissions = TICKET_CREATE |
| | 49 | reopen.operations = del_resolution |
| | 50 | }}} |
| 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 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 | | |
| | 75 | - **del_owner** -- Clear the owner field. |
| | 76 | - **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. |
| | 77 | - ''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. |
| | 78 | - **set_owner_to_self** -- Sets the owner to the logged in user. |
| | 79 | - **del_resolution** -- Clears the resolution field. |
| | 80 | - **set_resolution** -- Sets the resolution to the selected value. |
| | 81 | - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example: |
| | 82 | {{{#!ini |
| 64 | | - leave_status -- Displays "leave as <current status>" and makes no change to the ticket. |
| 65 | | '''Note:''' Specifying conflicting operations (such as `set_owner` and `del_owner`) has unspecified results. |
| 66 | | |
| 67 | | {{{ |
| | 89 | - **leave_status** -- Displays "leave as <current status>" and makes no change to the ticket. |
| | 90 | - **reset_workflow** -- Resets the status of tickets that are in states no longer defined. |
| | 91 | '''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results. |
| | 92 | |
| | 93 | 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`. |
| | 94 | |
| | 95 | {{{#!ini |
| 74 | | 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 | | {{{ |
| | 102 | For actions that should be available in all states, `*` may be used in place of the state. The obvious example is the `leave` action: |
| | 103 | {{{#!ini |
| | 104 | leave = * -> * |
| | 105 | leave.operations = leave_status |
| | 106 | leave.default = 1 |
| | 107 | }}} |
| | 108 | 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. |
| | 109 | If not specified for an action, `.default` is 0. The value may be negative. |
| | 110 | |
| | 111 | 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. |
| | 112 | |
| | 113 | 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: |
| | 114 | {{{#!ini |
| | 115 | _reset = -> new |
| | 116 | _reset.name = reset |
| | 117 | _reset.operations = reset_workflow |
| | 118 | _reset.permissions = TICKET_ADMIN |
| | 119 | _reset.default = 0 |
| | 120 | }}} |
| | 121 | |
| | 122 | 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: |
| | 123 | {{{#!ini |
| | 124 | _reset = -> new |
| | 125 | _reset.name = reset |
| | 126 | _reset.operations = reset_workflow |
| | 127 | _reset.permissions = TICKET_MODIFY |
| | 128 | _reset.default = 0 |
| | 129 | }}} |
| | 130 | |
| | 131 | == Workflow Visualization |
| | 132 | |
| | 133 | Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro]. |
| | 134 | |
| | 135 | 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): |
| | 136 | {{{#!sh |
| | 162 | === How to combine the `tracopt.ticket.commit_updater` with the testing workflow === |
| | 163 | |
| | 164 | 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. |
| | 165 | |
| | 166 | By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action. |
| | 167 | |
| | 168 | 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. |
| | 169 | |
| | 170 | 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. |
| | 171 | |
| 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.'' |
| | 253 | 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]. |
| | 254 | |
| | 255 | == Ideas for next steps == |
| | 256 | |
| | 257 | 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. |
