Skip to main content

Add Comment-Based Review Configuration

Open your risksheet.json file and add the following to the root object:
{
  "global": {
    "culture": "en"
  },
  "reviews": {
    "reviewManager": "CommentBased"
  }
}
That’s it. Comment-Based reviews require no additional configuration beyond setting the reviewManager property.
Comment-Based reviews are the quickest to deploy and require zero Polarion customization. They leverage existing comment functionality, making them ideal for teams who want immediate review capabilities without additional setup work.

How Comment-Based Reviews Work

diagram When users create reviews in RISKSHEET:
  1. System creates a standard Polarion comment on the risk work item
  2. Comment includes optional title and plain text content
  3. Author and timestamp are captured automatically
  4. RISKSHEET retrieves and displays comments in chronological order

Review Display Format

Comment-Based reviews appear in RISKSHEET with this structure:
  • Author name in bold (falls back to user ID if name unavailable)
  • Timestamp in yyyy-MM-dd HH:mm format
  • Title (optional) displayed in bold
  • Comment text rendered as HTML
All reviews are wrapped in a <span class="risk_reviews"> element, allowing custom CSS styling.
RISKSHEET attempts to display the reviewer’s full name from their Polarion user profile. If the name field is empty or the user account is unresolvable, the system falls back to showing the user ID instead.

Add Reviews Through RISKSHEET

Users can create reviews directly from the grid interface:
  1. Right-click the risk item row
  2. Select Add Review from the context menu
  3. Enter an optional title in the first field
  4. Enter review content (plain text) in the text area
  5. Click Save
The review appears immediately in the RISKSHEET review column and as a comment in Polarion.
Comment-Based reviews store content as plain text, not rich text. Formatting like bold, italics, or bullet points is not preserved. If you need formatted review content, consider using Work Item-Based reviews instead.

Review Filtering Behavior

Nextedy RISKSHEET automatically filters out:
  • Resolved comments — Comments marked as resolved in Polarion won’t appear in review lists
  • Unresolvable comments — Comments with data integrity issues are excluded
This ensures users see only active, relevant review feedback in the grid.

Customize Review Styling

Target the risk_reviews CSS class to customize review appearance:
"styles": {
  ".risk_reviews": {
    "background-color": "#f9f9f9",
    "padding": "8px",
    "border-left": "3px solid #4CAF50",
    "margin-bottom": "8px"
  },
  ".risk_reviews b": {
    "color": "#2E7D32"
  }
}
Add this to your risksheet.json configuration to apply custom visual styling to review entries.
Use background colors and borders to distinguish reviews from other cell content. Consider alternating background colors for multiple reviews on the same item to improve readability.

Permissions and Access Control

Comment-Based reviews inherit Polarion’s standard comment permissions:
  • Users need comment creation permissions on the work item to add reviews
  • Users with read access to the work item can view all non-resolved reviews
  • Comment editing and deletion follow Polarion’s permission model
No additional RISKSHEET-specific permissions are required.

Verification

After configuring Comment-Based reviews:
  1. Reload your RISKSHEET widget
  2. Right-click any risk item
  3. Verify “Add Review” appears in the context menu
  4. Create a test review with title “Test Review” and content “Verification test”
  5. Check that the review appears in the review column
  6. Navigate to the work item in Polarion and verify the comment exists
You should see the review displayed with your name, current timestamp, the title in bold, and your content text. The same content should appear as a standard comment when viewing the work item in Polarion.

See Also

KB ArticlesSource Code
  • IReview.java
  • CommentBasedReview.java
  • AppConfig.ts
  • WorkItemBasedReview.java
  • ApprovalBasedReview.java