Changes between Version 1 and Version 2 of TracWorkflow


Ignore:
Timestamp:
May 30, 2008 2:26:52 PM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v1 v2  
    1111Graphically, that looks like this:
    1212
    13 [[Image(htdocs:../common/original-workflow.png)]]
     13[[Image(htdocs:../common/guide/original-workflow.png)]]
    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?
     
    2121Graphically, it looks like this:
    2222
    23 [[Image(htdocs:../common/basic-workflow.png)]]
     23[[Image(htdocs:../common/guide/basic-workflow.png)]]
    2424
    2525== Additional Ticket Workflows ==
     
    9292After 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.
    9393
     94== Example: Adding optional Testing with Workflow ==
     95
     96By 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{{{
     99testing = new,accepted,needs_work -> testing
     100testing.name = Submit to reporter for testing
     101testing.permissions = TICKET_MODIFY
     102
     103reject = testing -> needs_work
     104reject.name = Failed testing, return to developer
     105
     106pass = testing -> closed
     107pass.name = Passes Testing
     108pass.operations = set_resolution
     109pass.set_resolution = fixed
     110}}}
     111
     112== Example: Limit the resolution options for a new ticket ==
     113
     114The 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{{{
     117resolve_new = new -> closed
     118resolve_new.name = resolve
     119resolve_new.operations = set_resolution
     120resolve_new.permissions = TICKET_MODIFY
     121resolve_new.set_resolution = invalid,wontfix,duplicate
     122
     123resolve = assigned,accepted,reopened -> closed
     124resolve.operations = set_resolution
     125resolve.permissions = TICKET_MODIFY
     126}}}
     127
    94128== Advanced Ticket Workflow Customization ==
    95129
    96 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 `sample-plugins/workflow` for a few simple examples to get started.
     130If 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.
    97131
    98132But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
    99133
     134== some ideas for next steps ==
     135
     136New 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
     138If 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.
     144This 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
     147A 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.
     152This 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)
     155This 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.