WorkflowPlugin

This implements a workflow model. The workflow is (currently) contains two tables:

• a state table containing tuples of (statename, permissions, message)
• a transition table containing tuples of (statename, action, nextstate, permissions).

The main problem at the moment is that the control for changing states is in the topic text, and it really needs to be outside of it. Also, the general edit button should reflect the workflow edit permissions, and it doesn't

Syntax Rules

• %WORKFLOWSTATEMESSAGE% is replaced by the current state's message
• %WORKFLOWTRANSITION% is replaced by a control allowing one to change to a permissible next state
• %WORKFLOWEDITTOPIC% is replaced by either an edit link or a crossed out edit.

Examples

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %INTERWIKIPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = one line description here

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Plugin Installation Instructions

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

• Download the ZIP file from the Plugin web (see below)
• Unzip WorkflowPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/WorkflowPlugin.txt	Plugin topic
  data/TWiki/WorkflowPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/WorkflowPlugin.pm	Plugin Perl module

• Test if the installation was successful:
  • enter samples here

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main.MeredithLesly - 26 Jan 2006