Changes between Version 12 and Version 13 of WorkFlow

Timestamp:

Jan 29, 2006, 4:18:07 AM (18 years ago)

Author:

Alec Thomas

Comment:

Documented TracIni configurable workflow and basics of extension point

WorkFlow

@@ +1 @@
+[[PageOutline]]
 = Workflow Discussion =
 
@@ -20 +21 @@
  * Remove `ticket_custom_props()` macro? It does not appear to be referenced.
  * There are a number of locations in the ticket code where permissions are hard coded. As an example, the `TICKET_CREATE` permission is required to create a new ticket. Should this be overridable by `ITicketWorkflow` implementors?
+
+== Basic Configurable Workflow ==
+Basic workflow configuration is possible in TracIni through two new sections,
+`ticket-status` and `ticket-actions`. This configurability is limited to defining
+ticket actions and status states and their transitions with basic permission
+enforcement.
+
+=== Defining available actions for a status ===
+Each key under the `ticket-status` section is a ticket status and the value associated with each key is the actions available.
+
+{{{
+[ticket-status]
+assigned = leave resolve reassign
+closed = leave reopen retest
+new = leave resolve reassign accept
+reopened = leave resolve reassign
+resolved = leave reassign reopen verify
+verified = leave reassign reopen retest close
+}}}
+
+=== Mapping actions to resulting statuses ===
+
+The `ticket-actions` section defines what the status resulting from an action
+will be, in addition to the permission required for that action.
+
+{{{
+[ticket-actions]
+accept = assigned
+close = closed
+close.permission = TRAC_ADMIN
+reassign = new
+reopen = reopened
+reopen.permission = TICKET_ADMIN
+resolve = resolved
+retest = resolved
+retest.permission = TICKET_ADMIN
+verify = verified
+}}}
+
+== Plugabble Workflow ==
+For more complex ticket workflow requirements an extension point is available,
+allowing full control of the ticket workflow process.
+
+{{{
+#!python
+class ITicketWorkflow(Interface):
+    """ This interface controls what actions can be performed on a ticket and
+        also a list of the available ticket fields. """
+
+    # Control ticket actions
+    def get_ticket_actions(req, ticket):
+        """ Return the actions that are available given the current state of
+            ticket and the request object provided. """
+
+    def get_ticket_action(req, ticket, action):
+        """ Return a trac.ticket.field.Field object for ticket action. """
+
+    def apply_ticket_action(req, ticket, action):
+        """ Perform action on ticket. """
+
+    # Control ticket fields
+    def filter_ticket_fields(req, ticket, fields):
+        """ Given a list of ticket.Field objects and a ticket, return the
+            filtered list of fields. This method must enforce permission
+            control on all fields. """
+
+    def update_ticket_fields(req, ticket):
+        """ Apply changes in req to ticket. By default this should simply be
+            `ticket.populate(req.args)`. """
+}}}
 
 == Available Field Types and Options ==