Setup risk review process

Modified on Mon, 28 Jul at 2:48 PM

The review use-case in Risksheet allows users to review or comment on risk objects directly within the Risksheet interface. Depending on your organization’s needs, the system can support lightweight comment-based reviews, approval-style reviews, or fully structured work item-based reviews.

TABLE OF CONTENTS

Configuration
Supported Review Managers

Configuration

To enable review functionality, add the following to your risksheet.json configuration:

{
   "global":{
    "culture":"en"
   },
   "reviews":{
        "reviewManager":"CommentBased"
    },

The reviewManager key determines the type of review integration that will be used.

Supported Review Managers

CommentBased

Simple review approach where reviews are tracked as comments on the risk work items.
No additional configuration needed

ApprovalBased

Aligns review behavior with document approval workflows.
Displays only comments labeled with “Approval comment” in the title.
No additional configuration needed

WorkItemBased

Review items are separate work items (e.g. “Review” type) linked to the risks via a relationship.
You need to specify typeProperties

      "reviews":{
        "reviewManager":"WorkItemBased",
          "typeProperties":{
            "linkTypes": "review",
            "linkRole": "review",
            "query":"NOT status:assigned",
            "document":"ACC/Test",
            "itemTemplate":"<span class=\"risk_reviews\"><b>$item.render().withLinks().htmlFor().forFrame()</b> by $item.fields().author().render().htmlFor().forFrame() [$item.fields().status().render().withIcon(false).htmlFor().forFrame()]<br/>$item.fields().description().render().htmlFor().forFrame() </span>"

          }

The mandatory type properties are:
- "itemTypes":"review" - work item type id
- "linkRole":"review" - link role id
Other type properties for WorkItemBased review are:
- query - query for work items (e.g by status)
- document - where to load / created items from: SPACE/DOC id
- project - where to load / create items from: project id
- itemTemplate: velocity code that is used to render the review
All the properties can be processed by velocity
In the context you have: $doc (com.polarion.alm.shared.api.model.document.Document)
- example "project":"$doc.getReference().projectId()"

For any assistance, please don’t hesitate to reach out by submitting a ticket here.