Work Flow Add-On

Usage

The work flow is represented by a state machine captured in a table topic. This state machine relates the current step in the work flow with action that could be taken and the resulting next step in the work flow (if any). It also allows to control who is able to perform a given action (users not able to perform an action are not given that option).

To create a work flow (the images are taken using the sample application)

1. Create the topic defining the state machine.
2. Add the topic into the WEBFLOWS preference variable. E.g., for the example use
   • Set WEBFLOWS = WebFlowStates
3. Create the topic controlled by the work flow
4. Add form, and select the topic defining the state machine
   • Save the topic before applying state changes.
5. When editing the topic, one can also change state: Next to the preview button will be either
   • a button (if there is only one possible action in this state)
   • or a select with a "Change State" button (if there are several possible actions)
6. Walk the topic through the work flow: 1, 2, 3
   • The form available at each state is controlled by the state machine

Note that the appearance of the buttons mentioned in (5) above depend on the skin chosen. For example, under PatternSkin these are rendered as links in the place where the Add/change form link normally appears.

Add-On Installation Instructions

Note: You do not need to install anything on the browser to use this add-on. The following instructions are for the administrator who installs the add-on on the server where TWiki is running.

• Download the file workflow.diff from this topic.
• Apply the diff against the Cairo release. Files affected: File:Description:lib/TWiki/Form.pmlib/TWiki/UI/Edit.pmlib/TWiki/UI/Preview.pmlib/TWiki/UI/Save.pmtemplates/changeform.pattern.tmpltemplates/changeform.tmpltemplates/edit.iejs.tmpltemplates/edit.pattern.tmpltemplates/edit.tmpltemplates/preview.pattern.tmpltemplates/preview.tmpl
• Test if the installation was successful:
  • Unzip the attached example in a web and create a work flow.

Add-On Info

• Set SHORTDESCRIPTION = Implements a simple workflow management system.

Related Topic:

-- TWiki:Main/ThomasWeigert - 05 Feb 2004