How to install Risksheet into existing project (Drive pilot)

Modified on Fri, 02 Feb 2024 at 05:29 PM

This page describes how to setup your own Risksheet template based on the Pilot drive demo project.
You can create a project based on the “Drive Pilot” template to reproduce exactly these steps or just use information from this article for your own project needs.

  • Setup work item type "risk"

It does not need to be called "risk", you refer to the risk item type in "risksheet.json" dataTypes section;

  • Setup document type "riskSpecification"
  • each risk sheet is associated with a single live document (some data - upstream/downstream objects can be stored outside);
  • at the current moment, a single document type is supported;
  • it does not need to be called like this, you can adjust the id of the document type in Administration > Configuration properties:  


Note: In case multiple document types will be used for the Risksheet, you can specify them as mentioned below:

 nextedy.risksheet.riskDocumentType=(softwareReqSpecification riskSpecification)

  • Add the Risksheet tool to the sidebar
  • the risksheet product is imported into Polarion UI as a so called "Topic";
  • Open the Topics configuration: Administration> Portal > Topic;
  • add there:  <topic id="risksheet"/>

  • Go to the Risk topic and create a LiveDoc document, that we will use as a template for the Risksheet. 

For this tutorial, we will call it "Risk Analysis".  Select the “Risk Specification” type for it and fill in the rest of the fields. 

  • Configure the "templateDoc" (of type Enum:Document) custom field for a document. This custom field holds the connection between a document and its template. 

Open Administration -> Documents & Pages -> Document Custom fields -> Risk Specification 


After that, you will see this template field on the right side of your LiveDoc under the Document properties.

  • From a list of different templates, you should make sure that you select the "Risk/Risk Analysis" template. That's how this LiveDoc will become a template for other risksheets.

  • The Risksheet configuration is stored in a Risksheet document that is used as a template, and duplicated when you click "Create new Blank Risk analysis" from a Risksheet topic ;
  • Specify the path to the LiveDoc in the Configuration properties:

         nextedy.risksheet.risksheetTemplatePath=Risks/Risk Analysis

So now if you click on "Create new Blank Risk analysis" it shows the added template.

  • BTW, you can have multiple risksheet templates and configurations, just enter a comma-separated list of document paths into the property nextedy.risksheet.risksheetTemplatePath

It will look somehow like below:

 nextedy.risksheet.risksheetTemplatePath=Risks/Risk Analysis,Risks/Risk Specification

  • Now it is time to use this template. Click on "Create new Blank Risk analysis", give it a name and select the desired template. 
  • This way you will have as many risksheets as you need coming from one template only. 
  • As you see it loads a nice and empty document, ready for any additional changes.

  • One more important thing to mention is that you can also reuse the template LiveDoc in a different way. For doing this you use the "Reuse" function directly in your LiveDoc. It is good to know about this function, but we do not advise using it, as it copies totally the template doc, and adds new configuration documents to attachments every time you use it.
  • So as to keep in order all your Risksheets, we highly recommend creating them from a Risksheet topic as mentioned above. 

  • Note: sometimes the configuration of your project may vary from the one, used for this risksheet sample, so you may get an error. But nothing to be worried about, you can always check the configuration and change it depending on your needs. 

  • Now we need to configure how the risksheet aligns with your data model

Note: you may see some differences in the configuration of the Risksheet for the Drive Pilot project that you created right now and the FMEA template project which is also based on Drive Pilot. We slightly simplified some moments on purpose in order to not make this article too complex. The functionality is the same, but you can check the differences whenever you wish. 

In case of issues, please send a message to: 

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