Changes between Version 1 and Version 2 of TracWorkflow


Ignore:
Timestamp:
2009-03-31T20:06:23+02:00 (6 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.
     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`.
     
    97101
    98102{{{
    99 testing = new,accepted,needs_work -> testing
     103testing = new,accepted,needs_work,assigned,reopened -> testing
    100104testing.name = Submit to reporter for testing
    101105testing.permissions = TICKET_MODIFY
     
    108112pass.operations = set_resolution
    109113pass.set_resolution = fixed
     114}}}
     115
     116== Example: Add simple optional generic review state ==
     117
     118Sometimes 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.
     119
     120The new `reviewing` state along with its associated `review` action looks like this:
     121
     122{{{
     123review = new,assigned,reopened -> reviewing
     124review.operations = set_owner
     125review.permissions = TICKET_MODIFY
     126}}}
     127
     128Then, 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:
     129
     130{{{
     131accept = new,reviewing -> assigned
     132[…]
     133resolve = new,assigned,reopened,reviewing -> closed
     134}}}
     135
     136Optionally, 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{{{
     139reassign_reviewing = reviewing -> *
     140reassign_reviewing.name = reassign review
     141reassign_reviewing.operations = set_owner
     142reassign_reviewing.permissions = TICKET_MODIFY
     143}}}
     144
     145The full `[ticket-workflow]` configuration will thus look like this:
     146
     147{{{
     148[ticket-workflow]
     149accept = new,reviewing -> assigned
     150accept.operations = set_owner_to_self
     151accept.permissions = TICKET_MODIFY
     152leave = * -> *
     153leave.default = 1
     154leave.operations = leave_status
     155reassign = new,assigned,reopened -> new
     156reassign.operations = set_owner
     157reassign.permissions = TICKET_MODIFY
     158reopen = closed -> reopened
     159reopen.operations = del_resolution
     160reopen.permissions = TICKET_CREATE
     161resolve = new,assigned,reopened,reviewing -> closed
     162resolve.operations = set_resolution
     163resolve.permissions = TICKET_MODIFY
     164review = new,assigned,reopened -> reviewing
     165review.operations = set_owner
     166review.permissions = TICKET_MODIFY
     167reassign_reviewing = reviewing -> *
     168reassign_reviewing.operations = set_owner
     169reassign_reviewing.name = reassign review
     170reassign_reviewing.permissions = TICKET_MODIFY
    110171}}}
    111172
     
    132193But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
    133194
     195== Adding Workflow States to Milestone Progress Bars ==
     196
     197If 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
    134199== some ideas for next steps ==
    135200
    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.
     201New 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.
    137202
    138203If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket.
     
    142207   * '''postops''': automatic, when leaving the state/activity
    143208   * '''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.
     209''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.''
    145210
    146211 * 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.
     212''A workflow plugin can add an arbitrary workflow operation, so this is already possible.''
    148213
    149214 * set_actor should be an operation allowing to set the owner, e.g. as a "preop":
    150215   * either to a role, a person
    151216   * 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.
     217''This is either duplicating the existing `set_owner` operation, or needs to be clarified.''
    153218
    154219 * 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.
     220''Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s `triage` operation.''