Skip to main content

Choose a Review Strategy

Nextedy RISKSHEET supports three review approaches, each suited to different workflow requirements:
Review TypeBest ForStorage MethodConfiguration Complexity
Comment-BasedLightweight reviews and informal feedbackPolarion comments on work itemsLow
Approval-BasedFormal approval workflows with audit trailsPolarion approval commentsLow
Work Item-BasedStructured reviews with status trackingSeparate linked work itemsMedium

Configure Your Review Manager

Open your risksheet.json configuration file and add a reviews section within the root object:
{
  "global": {
    "culture": "en"
  },
  "reviews": {
    "reviewManager": "CommentBased"
  }
}
Replace "CommentBased" with one of these values:
  • "CommentBased" — Reviews stored as work item comments
  • "ApprovalBased" — Reviews use Polarion approval workflow
  • "WorkItemBased" — Reviews created as separate work items
Begin with CommentBased reviews for immediate use with zero additional configuration. Upgrade to WorkItemBased later if you need status tracking and advanced queries.

Review Workflow Diagram

diagram

Additional Configuration for Work Item-Based Reviews

If you selected "WorkItemBased", add typeProperties to specify where and how review work items are created:
{
  "reviews": {
    "reviewManager": "WorkItemBased",
    "typeProperties": {
      "linkTypes": "review",
      "linkRole": "review",
      "query": "NOT status:closed",
      "document": "SAFETY/Reviews",
      "itemTemplate": "<span class=\"risk_reviews\"><b>$item.id</b> by $item.fields().author().render().htmlFor().forFrame() [$item.fields().status().render().withIcon(false).htmlFor().forFrame()]</span>"
    }
  }
}

Required Properties

  • linkTypes — Work item type ID for review items (e.g., "review")
  • linkRole — Link role connecting reviews to risk items (e.g., "review")

Optional Properties

  • query — Filter which reviews appear (e.g., "NOT status:closed")
  • document — Target document for review creation (format: "SPACE/DocumentName")
  • project — Target project ID (alternative to document)
  • itemTemplate — Custom HTML template for review rendering
Work Item-Based reviews will fail at runtime if linkTypes or linkRole are not defined. Verify these properties match your Polarion work item type and link role IDs exactly.

Enable Review Columns

Reviews appear automatically in RISKSHEET once configured, but you can add dedicated columns to control visibility:
"columns": [
  {
    "id": "reviews",
    "title": "Reviews",
    "binding": "systemReviewsRendered",
    "width": 300
  }
]
This column displays all reviews for each risk item with author attribution and timestamps.

Verification

After saving your configuration:
  1. Reload the RISKSHEET widget in Polarion
  2. Right-click any risk item row
  3. Select “Add Review” from the context menu
  4. Enter review title and content, then save
You should now see the review displayed in the review column (or as a comment/linked work item in Polarion, depending on your chosen strategy). Reviews display with author names, timestamps in yyyy-MM-dd HH:mm format, and your entered content.
Comment-Based and Approval-Based reviews filter out resolved comments automatically. Work Item-Based reviews respect your query configuration to show only relevant review items.

See Also

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