How to install Risksheet into existing project (Drive pilot)

This article describes how to set up your own Risksheet template based on the Drive Pilot Demo Project.

You can create a project based on the "Drive Pilot" template to reproduce exactly these steps, or you can use the information from this article for your own project needs.

Before you start, make sure you have Risksheet installed in Polarion. Follow this guide to learn how to install it.

TABLE OF CONTENTS

• Initial Setup
  • Set up work item type "risk"
  • Set up document type "riskSpecification"
  • Add the Risksheet tool to the sidebar
• LiveDoc Setup
• New Risksheet from template
• Risksheet data model
• Configuration Error

Initial Setup

Set up work item type "risk"

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

Set up document type "riskSpecification"

• Each risk sheet is associated with a single live document (some data - upstream/downstream objects can be stored outside)
• It does not need to be called like this; you can adjust the id of the document type in the Configuration Properties nextedy.risksheet.riskDocumentType=riskSpecification

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

1. The Risksheet product is imported into Polarion UI as a so-called "Topic"
2. Open the Topics configuration: Administration > Portal > Topic
3. Add <topic id="risksheet"/>

After that, you will see the Risksheet topic in the Polarion sidebar.

LiveDoc Setup

1. Open the space where you plan to store your Risksheets and create a LiveDoc that we will use as a template
2. For this tutorial, we will name it "Risk Analysis"
3. 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 

"+ New Blank Document" from a Risksheet topic.

Specify the path to the LiveDoc in the Configuration Properties, where "Risks" is the name of your space and "Risk Analysis" is the name of your LiveDoc.

nextedy.risksheet.risksheetTemplatePath=Risks/Risk Analysis

You can even have multiple Risksheet templates, enter a comma-separated list of document paths into the property: nextedy.risksheet.risksheetTemplatePath=Risks/Risk Analysis,Risks/Risk Specification

New Risksheet from template

Click on "+ New Blank Document" in the Risksheet topic, and you will see the previously added template.

Now it is time to use this template. Click on "+ New Blank Document", 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. 

Another important point to mention is that the LiveDoc template can also be reused in a different way. This can be done using the “Reuse” function directly within your LiveDoc. While it’s helpful to be aware of this option, we do not recommend using it.

Each time you reuse the template this way, it creates a full copy of the original document and adds new configuration documents to the attachments, which can lead to unnecessary duplication.

To keep in order all your Risksheets, we highly recommend creating them from a Risksheet topic as mentioned above. 

Risksheet data model

Now we need to configure how the Risksheet aligns with your data model.

• We recommend starting with a predefined configuration from our Nextedy demo templates. Please pick the FMEA or HARA template and create a project
• Take as a base a risksheet.json from one of these templates
• Risksheet Document Config File - risksheet.json - format reference
• Configure what work Items are visible on the Risksheet
• Configure the columns

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.

Configuration Error

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 open the configuration and change it depending on your needs. 

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