Changes between Version 2 and Version 3 of TracWorkflow


Ignore:
Timestamp:
11/26/08 05:26:10 (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v2 v3  
    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. 
     28 
     29Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples. 
    2830 
    2931== Basic Ticket Workflow Customization == 
     
    110112}}} 
    111113 
     114== Example: Add simple optional generic review state == 
     115 
     116Sometimes 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. 
     117 
     118The new `reviewing` state along with its associated `review` action looks like this: 
     119 
     120{{{ 
     121review = new,assigned,reopened -> reviewing 
     122review.operations = set_owner 
     123review.permissions = TICKET_MODIFY 
     124}}} 
     125 
     126Then, 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: 
     127 
     128{{{ 
     129accept = new,reviewing -> assigned 
     130[…] 
     131resolve = new,assigned,reopened,reviewing -> closed 
     132}}} 
     133 
     134Optionally, 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. 
     135 
     136{{{ 
     137reassign_reviewing = reviewing -> * 
     138reassign_reviewing.name = reassign review 
     139reassign_reviewing.operations = set_owner 
     140reassign_reviewing.permissions = TICKET_MODIFY 
     141}}} 
     142 
     143The full `[ticket-workflow]` configuration will thus look like this: 
     144 
     145{{{ 
     146[ticket-workflow] 
     147accept = new,reviewing -> assigned 
     148accept.operations = set_owner_to_self 
     149accept.permissions = TICKET_MODIFY 
     150leave = * -> * 
     151leave.default = 1 
     152leave.operations = leave_status 
     153reassign = new,assigned,reopened -> new 
     154reassign.operations = set_owner 
     155reassign.permissions = TICKET_MODIFY 
     156reopen = closed -> reopened 
     157reopen.operations = del_resolution 
     158reopen.permissions = TICKET_CREATE 
     159resolve = new,assigned,reopened,reviewing -> closed 
     160resolve.operations = set_resolution 
     161resolve.permissions = TICKET_MODIFY 
     162review = new,assigned,reopened -> reviewing 
     163review.operations = set_owner 
     164review.permissions = TICKET_MODIFY 
     165reassign_reviewing = reviewing -> * 
     166reassign_reviewing.operations = set_owner 
     167reassign_reviewing.name = reassign review 
     168reassign_reviewing.permissions = TICKET_MODIFY 
     169}}} 
     170 
    112171== Example: Limit the resolution options for a new ticket == 
    113172 
     
    132191But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. 
    133192 
     193== Adding Workflow States to Milestone Progress Bars == 
     194 
     195If you add additional states to your workflow, you may want to customize your milestone progress bars as well.  See [TracIni#milestone-groups-section TracIni]. 
     196 
    134197== some ideas for next steps == 
    135198 
    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. 
     199New 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. 
    137200 
    138201If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket. 
     
    142205   * '''postops''': automatic, when leaving the state/activity 
    143206   * '''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. 
     207''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.'' 
    145208 
    146209 * 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. 
     210''A workflow plugin can add an arbitrary workflow operation, so this is already possible.'' 
    148211 
    149212 * set_actor should be an operation allowing to set the owner, e.g. as a "preop": 
    150213   * either to a role, a person 
    151214   * 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. 
     215''This is either duplicating the existing `set_owner` operation, or needs to be clarified.'' 
    153216 
    154217 * 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. 
     218''Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s `triage` operation.''