Approvals Workflow Configuration

For the impatient If you are evaluating the plugin, you can just: Install the plugin Assign the Default Theme, Approvals Workflow Plugin ready theme (2.6.x, 2.7.x and 2.8.x), either by selecting it when creating the space, or through Browse Space -> Space Admin -> Themes The Approvals Workflow Plugin ready themes use the default Confluence layout and include all the required layout changes required for the approvals.

Table of Contents

• Upgrade information
• Adding the approvals line Once you have installed the plugin, you have to make a change on the Page layout decorator to enable the Approvals line and messages view.
  • If you use the Theme Builder see Theme Builder Configuration
  • Customizing Published view
• Enabling the workflow macros You need to enable the workflow macros if you are going to create workflows
• Restricting Page notifications
• Clustering Notes
• L10n

Upgrade information

If you have 1.1 installed, you need to update the approvals line. See below

Adding the Approvals line

Usually most pages do not require to be subject to an approval process, therefore, you might want to make these changes in those spaces using the plugin. Alternatively, you could make the change globally, but use a different layout in those Spaces where you expect high traffic.

Theme Builder If you are not able to change the layout, or if you just want to test it, you can use the {workflow-include} macro instead. See below for configuration with the Theme Builder

Go to Look and Feel - Layouts (either from the Space or Global Administration)

If you have never modified the page layout, you'll have to create it:

if you have, then you have to edit it:

Upgrading to 1.1 If you have 1.0.x installed, you have to update the line to include the extra parameter ($mode)

You have to add $!workflow.include($page,$mode) right after the #parse ("/labels/labels-include.vm") line, in the #VIEW section, as described below:

It should look like this:

Alternatively, you can hide either the approvals list or the messages:

Tip: If all users that are responsible for approving content on your wiki are in a special group, for example content-approvers, you can hide the approvals line from regular users to reduce interface clutter: #if($userAccessor.hasMembership($userAccessor.getGroup("content-approvers"), $remoteUser)) $!workflow.include($page,$mode,false,true) #end

Clustering If you are installing in a cluster environment, you have to repeat this on each node. The change on the template will be there, you just need to save the change.

Adding the Approvals line for blog posts

To add the approvals line in blog posts, you have to follow a similar procedure, but to modify the Blog Post Layout.

You have to add $!workflow.include($blog,$mode) right after the #parse ("/labels/labels-include.vm") line, in the #VIEW section, as described below:

It should look like this:

Theme Builder Configuration

If you are using the Theme Builder You can add the approvals line by adding the {workflow-include} macro in any of the builder's panels. The obvious place would be in the Title panel, right after the {builder-labels} macro:

Links to Page Approvals and Space Approvals

This is what you have to do to add the menu links to the Page Approval and Space Approvals Tabs
Theme builder 2

{menuitem}{menulink:webui|key=space-approvals|location=system.space}Approvals{menulink}{menuitem}
{menuitem}{menulink:webui|key=page-approvals|location=system.page}Approvals{menulink}{menuitem}

Theme builder 3

{compound-menuitem:webui|key=space-approvals|location=system.space|caption=Approvals}
 {compound-menuitem:webui|key=page-approvals|location=system.page|caption=Approvals}

Customizing Published view

The Published View is an alternate page view mode that is enabled when a Page receives an approval that has been defined Final. You can further customize the mode by updating the same page layout.

First you have to include the mode released in the same section of the view mode:

You might want to exclude the editreport as it shows informstion on the latest version not the approved version:

If you don't want the version information shown, you can exclude it:

Enabling disabled-by-default macros

The workflow and a couple of Action macros are disabled by default.

This plugin was intended for a intranet/enterprise trusted environment. However, you still have to be careful when enabling this feature, as not only malicious but also faulty workflows could cause damage to the system. Therefore it is strongly recommended that you enable the workflows only for a trusted group of users You can do so by enabling the plugin for a couple of specific spaces, and the restrict access to those spaces (described below).

To enable the workflow macro, you have to go Configuration - Plugins and selected the Approvals Workflow module:

Then, you have to enable the {workflow} macro:

Once you have enabled the {workflow} macro you have to define in what spaces workflows can be define. You can do this using the Approvals Workflow administration console:

You can configure there in what spaces page approvals and workflows can be defined.

Restricting Page notifications

Restricting notifications of non-approved pages requires installing the plugin manually and restart the servers:
1. Uninstall the plugin
2. Locate the confluence installation directory (CONFLUENCE-BASE)
3. Copy the plugin jar file into CONFLUENCE-BASE/confluence/WEB-INF/lib
4. Make backup copies of the following files

• CONFLUENCE-BASE/confluence/WEB-INF/classes/plugins/core-listeners.xml
• CONFLUENCE-BASE/confluence/WEB-INF/classes/eventSubsystemContext.xml

5. Replace the Page Notifications Listener'class with com.comalatech.confluence.workflow.mail.notifications.listeners.FilteredPagedNotificationsListener in CONFLUENCE-BASE/confluence/WEB-INF/classes/plugins/core-listeners.xml

6. Replace the changeNotificationBean class with com.comalatech.confluence.workflow.mail.FilteredChangeDigestNotificationBean in CONFLUENCE-BASE/confluence/WEB-INF/classes/eventSubsystemContext.xml

6. Restart server and make the same changes in the other nodes

Clustering notes

To make sure the changes are properly propagated to the cluster nodes, you are better off restarting the nodes after making any changes on page layout and other changes made in the configuration files.

L10n

See L10n