create new tag
view all tags


Displays ApprovalPlugin states in a table


This Plugin is kind of an extension to the ApprovalPlugin. It reads the "ApprovalDef" states of a topic and displays them in a table.

Syntax Rules

Adding table to topic


Approval Definition of Topic

  • The states in the state table must be in the order in which they shall appear in the table
  • Every state consists actually of two states in the StateTable (e.g., "Start" and "StartApproval")
    • One with the name of the state
    • One with the name of the state plus "Approval" ( to simulate the decision-phase)
  • There must be a state "PAUSED" defined at the end of the state table ( Red led )
  • For every state three phases are existing: Edit ( REFACTOR ), Decision ( PICK ), Completed ( DONE )


Adding table to topic

  • %APPROVALTABLE% expands to:
StateOne DONE
PAUSED Red led

Approval Definition of Topic

The State Table

State Allow Edit Message
StateOne   Needs approval for StateTwo
StateOneApproval   Approval for StateTwo
StateTwo   Needs approval for StateThree
StateTwoApproval   Approval for StateThree
StateThree   StateThree achieved
PAUSED   This flow is paused

The Transition Table

State Action Next StateSorted ascending Allowed Notify Sign Off's (%)
StateOneApproval Pause PAUSED      
StateTwoApproval Pause PAUSED      
PAUSED Send back to StateOne StateOne      
StateOne Send for approval StateOneApproval      
StateTwoApproval Approve StateThree StateThree      
StateOneApproval Approve StateTwo StateTwo      
PAUSED Send back to StateTwo StateTwo      
StateTwo Send for approval StateTwoApproval      

Plugin Installation & Configuration

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 TWiki server.

  • For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

  • Or, follow these manual installation steps:
    • Download the ZIP file from the Plugins home (see below).
    • Unzip ApprovalTablePlugin.zip in your twiki installation directory. Content:
File: Description:
data/TWiki/ApprovalTablePlugin.txt Plugin topic
lib/TWiki/Plugins/ApprovalTablePlugin.pm Plugin Perl module
    • Set the ownership of the extracted directories and files to the webserver user.
    • Install the dependencies (if any).

  • Plugin configuration and testing:
    • Run the configure script and enable the plugin in the Plugins section.
    • Configure additional plugin settings in the Extensions section if needed.
    • Test if the installation was successful: See example above.


Plugin Info

Plugin Author: TWiki:Main.JohannesHartig
Copyright: � 2012 TWiki:Main.JohannesHartig
� 2012 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 2012-04-28 (V0.1)
Change History:
2012-04-28: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
CPAN Dependencies: none
Other Dependencies: ApprovalPlugin
Perl Version: 5.005
TWiki:Plugins.Benchmark: GoodStyle nn%, FormattedSearch nn%, ApprovalTablePlugin nn%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/ApprovalTablePlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/ApprovalTablePluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/ApprovalTablePluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

Edit | Attach | Watch | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 2012-04-29 - JohannesHartig
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.ApprovalTablePlugin.