Changes between Version 4 and Version 5 of TracWorkflow


Ignore:
Timestamp:
Aug 3, 2021, 7:27:01 PM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v4 v5  
    77== The Default Ticket Workflow
    88
    9 When a new environment is created, a default workflow is configured in your trac.ini. This workflow is the basic workflow, as specified in [trac:source:/trunk/trac/ticket/workflows/basic-workflow.ini basic-workflow.ini]:
     9When a new environment is created, a default workflow is configured in your trac.ini. This workflow is the basic workflow, as specified in [trac:source:branches/1.4-stable/trac/ticket/workflows/basic-workflow.ini basic-workflow.ini]:
    1010
    1111{{{#!Workflow width=700 height=300
     
    4141== Additional Ticket Workflows
    4242
    43 There are example workflows provided in the Trac source tree, see [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.
     43There are example workflows provided in the Trac source tree, see [trac:source:branches/1.4-stable/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.
    4444
    4545Here are some [trac:WorkFlow/Examples diagrams] of the above examples.
     
    4949'''Note''': 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.
    5050
    51 In the `[ticket-workflow]` section of `trac.ini`, each entry is an action that may be taken on a ticket. 
     51In the `[ticket-workflow]` section of `trac.ini`, each entry is an action that may be taken on a ticket.
    5252For example, consider the `accept` action from `simple-workflow.ini`:
    5353
     
    6969 - ''actionname''`.set_owner` may optionally specify a comma delimited list of users that will be used to populate the select, or a single user. Groups and permissions may also be included in the list //(Since 1.1.3)//. When groups or permissions are specified the select is populated with all members of the group or all users that possess the permission.
    7070- **set_owner_to_self** -- Sets the owner to the logged in user.
    71 - **may_set_owner** -- Sets the owner to the selected or entered owner. Defaults to the existing owner. //(Since 1.1.2)//. 
     71- **may_set_owner** -- Sets the owner to the selected or entered owner. Defaults to the existing owner. //(Since 1.1.2)//.
    7272- **del_resolution** -- Clears the resolution field.
    7373- **set_resolution** -- Sets the resolution to the selected value.
    74  - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example:
     74 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. The resolution(s) specified in this attribute must be defined in the database. Example:
    7575 {{{#!ini
    7676resolve_new = new -> closed
     
    102102}}}
    103103
     104The transition to `*` (`-> *`) means the workflow operation determines the next status. The only configurable ticket workflow operation that determines the next status is `leave_status`. However, another workflow controller can operate on an action with new status `*` and determine the next status.
     105
    104106This 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.
    105107If not specified for an action, `.default` is 0. The value may be negative.
     
    146148Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro].
    147149
    148 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):
     150Workflows can also be visualized using the `contrib/workflow/workflow_parser.py` script. The script outputs `.dot` files that [https://www.graphviz.org GraphViz] understands. The script can be used as follows (your install path may be different):
    149151
    150152{{{#!sh
     
    197199reassign_reviewing = reviewing -> *
    198200reassign_reviewing.label = reassign review
    199 reassign_reviewing.operations = set_owner
     201reassign_reviewing.operations = set_owner, leave_status
    200202reassign_reviewing.permissions = TICKET_MODIFY
    201203}}}
     
    230232review.permissions = TICKET_MODIFY
    231233reassign_reviewing = reviewing -> *
    232 reassign_reviewing.operations = set_owner
     234reassign_reviewing.operations = set_owner, leave_status
    233235reassign_reviewing.label = reassign review
    234236reassign_reviewing.permissions = TICKET_MODIFY
     
    237239== Advanced Ticket Workflow Customization
    238240
    239 If the customizations above do not meet your needs, you can extend the workflow with plugins. 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 examples to get started.
     241If the customizations above do not meet your needs, you can extend the workflow with plugins. 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:branches/1.4-stable/sample-plugins/workflow sample-plugins/workflow] for a few examples to get started.
    240242
    241243But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. See also the [https://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin], which provides additional operations.
     
    247249== Ideas for next steps
    248250
    249 Enhancement ideas for the workflow system should be filed as enhancement tickets against the [trac:query:?status=assigned&status=new&status=reopened&keywords=~workflow&component=ticket+system ticket system] component.  You can also document ideas on the [trac:TracIdeas/TracWorkflow TracIdeas/TracWorkflow] page. 
     251Enhancement ideas for the workflow system should be filed as enhancement tickets against the [trac:query:?status=assigned&status=new&status=reopened&keywords=~workflow&component=ticket+system ticket system] component.  You can also document ideas on the [trac:TracIdeas/TracWorkflow TracIdeas/TracWorkflow] page.