Skip to main content

Enable Approval-Based Reviews

Add the following configuration to your risksheet.json file:
{
  "global": {
    "culture": "en"
  },
  "reviews": {
    "reviewManager": "ApprovalBased"
  }
}
This configuration enables the approval-based review manager, which filters and displays only comments marked as “Approval comment” from Polarion’s approval workflow.

How Approval-Based Reviews Work

Approval-based reviews integrate with Polarion’s document approval system: diagram
RISKSHEET can display approval status and comments, but approval actions (approve/reject decisions) must be performed in Polarion itself. Users cannot execute approvals directly from the RISKSHEET table view. This is a current limitation that requires users to navigate to Polarion for approval decisions.

Add a Review Display Column

To display approval reviews in your RISKSHEET, add a review column:
"columns": [
  {
    "id": "reviews",
    "title": "Approval Reviews",
    "binding": "reviewsRendered",
    "width": 300
  }
]
The reviewsRendered binding automatically retrieves and displays all approval comments for each work item.

Review Display Format

Approval-based reviews appear with:
  • Reviewer name: Full name (or user ID if name unavailable)
  • Timestamp: Date and time of approval comment (yyyy-MM-dd HH:mm format)
  • Comment text: The approval comment content
  • CSS styling: Wrapped in risk_reviews class for custom styling
Apply custom CSS to the .risk_reviews class in your styles configuration to match your organization’s visual standards for approval displays.

Filter Behavior

The approval-based review manager automatically:
  • ✅ Shows only comments titled “Approval comment”
  • ❌ Hides resolved comments
  • ❌ Excludes unresolvable comments
  • ❌ Filters out regular (non-approval) comments
This ensures only active approval workflow comments appear in RISKSHEET.

Comparison with Other Review Types

FeatureApproval-BasedComment-BasedWork Item-Based
StorageApproval commentsAll commentsSeparate work items
FilteringOnly “Approval comment”All commentsQuery-based
ConfigurationMinimalMinimalComplex (requires typeProperties)
Best ForDocument approval workflowsLightweight reviewsStructured review tracking

Verify Your Configuration

  1. Save your risksheet.json configuration
  2. Refresh your RISKSHEET page
  3. Navigate to a work item in Polarion and add an approval comment
  4. Return to RISKSHEET
You should now see approval comments displayed in the review column, showing the reviewer’s name, timestamp, and comment text. Only comments with the title “Approval comment” will appear.
Approval-based reviews are designed for organizations using Polarion’s document approval workflows. If your process doesn’t use formal approvals, consider comment-based reviews for simpler review tracking.

See Also

KB ArticlesSupport TicketsSource Code
  • AppConfig.ts
  • ApprovalBasedReview.java
  • IReview.java
  • risksheet.json
  • SystemConsts.java