Changes between Version 1 and Version 2 of TracWorkflow


Ignore:
Timestamp:
Nov 13, 2011, 3:47:23 AM (13 years ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v1 v2  
    1414
    1515There 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.
     16So 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.
    1717
    1818=== Environments created with 0.11 ===
     
    2525== Additional Ticket Workflows ==
    2626
    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.
     27There 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
     29Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples.
    2830
    2931== Basic Ticket Workflow Customization ==
     32
     33Note: 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.
    3034
    3135Create a `[ticket-workflow]` section in `trac.ini`.
     
    9094And then open up the resulting `trac.pdf` file created by the script (it will be in the same directory as the `trac.ini` file).
    9195
     96An online copy of the workflow parser is available at http://foss.wush.net/cgi-bin/visual-workflow.pl
     97
    9298After 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.
    9399
     
    97103
    98104{{{
    99 testing = new,accepted,needs_work -> testing
     105testing = new,accepted,needs_work,assigned,reopened -> testing
    100106testing.name = Submit to reporter for testing
    101107testing.permissions = TICKET_MODIFY
     
    108114pass.operations = set_resolution
    109115pass.set_resolution = fixed
     116}}}
     117
     118== Example: Add simple optional generic review state ==
     119
     120Sometimes 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.
     121
     122The new `reviewing` state along with its associated `review` action looks like this:
     123
     124{{{
     125review = new,assigned,reopened -> reviewing
     126review.operations = set_owner
     127review.permissions = TICKET_MODIFY
     128}}}
     129
     130Then, 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:
     131
     132{{{
     133accept = new,reviewing -> assigned
     134[…]
     135resolve = new,assigned,reopened,reviewing -> closed
     136}}}
     137
     138Optionally, 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.
     139
     140{{{
     141reassign_reviewing = reviewing -> *
     142reassign_reviewing.name = reassign review
     143reassign_reviewing.operations = set_owner
     144reassign_reviewing.permissions = TICKET_MODIFY
     145}}}
     146
     147The full `[ticket-workflow]` configuration will thus look like this:
     148
     149{{{
     150[ticket-workflow]
     151accept = new,reviewing -> assigned
     152accept.operations = set_owner_to_self
     153accept.permissions = TICKET_MODIFY
     154leave = * -> *
     155leave.default = 1
     156leave.operations = leave_status
     157reassign = new,assigned,reopened -> new
     158reassign.operations = set_owner
     159reassign.permissions = TICKET_MODIFY
     160reopen = closed -> reopened
     161reopen.operations = del_resolution
     162reopen.permissions = TICKET_CREATE
     163resolve = new,assigned,reopened,reviewing -> closed
     164resolve.operations = set_resolution
     165resolve.permissions = TICKET_MODIFY
     166review = new,assigned,reopened -> reviewing
     167review.operations = set_owner
     168review.permissions = TICKET_MODIFY
     169reassign_reviewing = reviewing -> *
     170reassign_reviewing.operations = set_owner
     171reassign_reviewing.name = reassign review
     172reassign_reviewing.permissions = TICKET_MODIFY
    110173}}}
    111174
     
    132195But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
    133196
     197== Adding Workflow States to Milestone Progress Bars ==
     198
     199If you add additional states to your workflow, you may want to customize your milestone progress bars as well.  See [TracIni#milestone-groups-section TracIni].
     200
    134201== some ideas for next steps ==
    135202
    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.
     203New 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.
    137204
    138205If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket.
     
    142209   * '''postops''': automatic, when leaving the state/activity
    143210   * '''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.
     211''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.''
    145212
    146213 * 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.
     214''A workflow plugin can add an arbitrary workflow operation, so this is already possible.''
    148215
    149216 * set_actor should be an operation allowing to set the owner, e.g. as a "preop":
    150217   * either to a role, a person
    151218   * 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.
     219''This is either duplicating the existing `set_owner` operation, or needs to be clarified.''
    153220
    154221 * 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.
     222''Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s `triage` operation.''