XWiki Publication Workflow Review Application - UI

Last modified by Admin on 2022/08/08 00:04

cogThis application is an improvement of the Publication Workflow Application so that the documents published through this extension feature a review date, a notification is sent to the publishers once the review date is reached.
TypeXAR
CategoryApplication
Developed by

Mohamed Boussaa

Active Installs3
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

This application is an improvement of the Publication Workflow Application so that the documents published through this extension feature a review date, a notification is sent to the publishers once the review date is reached.

Once this extension installed the following features will be introduced :
 

  • On the documents that are published through the Workflow Application a button will be added on the page menu in order to update the review date of the document, when the user click on the button a popup form is displayed with a date picker that allow selecting the review date. Note that if the review date is empty (not set) the popup will be shown each time the published document is loaded. See screenshots :

publication-workflow-review-button.png
Button

publication-workflow-review-form.png
Popup form

  • A listener which is listening to the publication of a document (org.xwiki.workflowpublication.DocumentPublishingEvent event), the listener is in charge of initializing the review date metadata on the published document, if a review date was set on the previous version of the document the review date will be kept on the new published version otherwise an empty date will be added.
  • A new entry "Publication workflow review" is added on the list applications that can send notifications on the notification settings page and on the wiki administration, see screenshot bellow :

publication-workflow-review-notification-settings.png
Notification settings

Note that the users must enable the notification for the "Publication workflow review" event in order to be able to receive notifications because custom notifications events behaves exactly the same as standard ones, this is the rule on XWiki notifications, see more details here.

  • A scheduler job which is executed every morning at 8:00 AM, the scheduler checks if there are documents that have their review date reached on that day and if yes, it sends a notification to the document associated publishers group. See screenshots of the live and emails notifications sent to the publishers :

publication-workflow-review-live-notification.png
Live notification

publication-workflow-review-email-notification.png
Email notification

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Dependencies

Dependencies for this extension (org.xwiki.contrib.workflow-publication:xwiki-workflow-publication-review-ui 1.0):

  • org.xwiki.contrib.workflow-publication:xwiki-workflow-publication-review-api 1.0
Tags:
    

Get Connected