QualityFlow Comment Summary

Last modified by Mekhael Sawaya on 2026/07/09 10:21

cogStructured document review for xWiki — inline highlighting comments, role-based workflows, Comment Summary, APO approval gate
TypeXAR
CategoryApplication
Developed by

Mekhael Sawaya

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Description

QualityFlow Comment Summary

Structured document review for xWiki — inline highlighting, role-based workflows, APO approval gate.

QualityFlow adds a review sidebar to any xWiki page. Reviewers leave typed comments (Blocker, Suggestion, Question) that can be anchored to specific text passages. Quality Managers assign reviewers, track progress, and resolve comments. An Approval Authority (APO) provides a final approval gate once all blockers are cleared.

All data stays on-premise. No external APIs or third-party services are contacted.

Key Features

Inline comment sidebar injected onto any wiki page

Text-anchored comments with in-page highlighting (color-coded by type)

Role-based access: Reviewers, Quality Managers, APO

Comment types: Blocker, Suggestion, Question

Reviewer assignment and "Mark Done" tracking

APO approval/rejection gate (unlocks when all blockers are resolved)

Cross-document Comment Dashboard with CSV export

Admin health-check page with XObject counts

One-click enable/disable via URL paste

Prerequisites & Installation Instructions

Prerequisites

Requirement Details
xWiki version 14.10 or later
Programming rights The admin importing the XAR must have Programming rights (Groovy scripts require it)
User groups Three groups will need to be created: XWiki.QFReviewers, XWiki.QFQualityManagers, XWiki.QFAPO
No Java / No JAR Pure wiki-scripting application — no server restart needed

Installation
Download the latest QualityFlow-Comment.xar from the Releases page.

Import the XAR

Go to Administration → Content → Import
Upload QualityFlow-Comment.xar
Select all pages, choose "Add new versions" as the merge strategy
Click Import
Create the required groups (if they don't already exist)

XWiki.QFReviewers — add your reviewer users
XWiki.QFQualityManagers — add quality managers
XWiki.QFAPO — add approval authorities
Verify installation

Navigate to /bin/view/QualityFlow/Admin
All three XClass health checks should show green (CommentClass, ReviewerClass, ApprovalClass)
Enable on a document

Navigate to /bin/view/QualityFlow/EnableOnPage
Paste the URL of any wiki page and click Enable
The review sidebar will now appear on that page

How It Works

Go to Enable on a Page and paste any document URL → click Enable
Quality Manager assigns reviewers from the sidebar
Reviewers add comments (Blocker / Suggestion / Question), optionally anchored to text
Quality Manager resolves comments and marks reviewers Done
APO gives final approval once all blockers are resolved

Versions

Get Connected