How to setup risk review process

Modified on Fri, 08 Apr 2022 at 10:07 PM

We enable "review use-case" - so you can easily review (in most cases comment), risk objects, see here:


In the current moment, it is still an "Early Access" feature by default disabled. You need to enable the review proces:


Add following lines to the configuration:

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

What review managers we support in current moment?

  • CommentBased
    • The reviews are tracked as Work Item Comments
    • No additional configuration needed
  • ApprovalBased
    • The reviews are aligned with Document Approvals, i.e. it shows only comments with "Approval comment" in a title
    • No additional configuration needed
  • WorkItemBased
    • The reviews are based on Work Items.
    • 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()"

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article