Skip to main content

​
Prerequisites

Before adding RISKSHEET to your project, ensure you have:
  • Administrative access to your Polarion project
  • RISKSHEET installed in your Polarion instance
  • A demo project installed via Administration > Setup > Install Demo Project
The RISKSHEET topic will not appear in Polarion’s sidebar until you install at least one demo project via Administration > Setup > Install Demo Project. Many users encounter this as their first blocker when adding RISKSHEET to existing projects.

​
Step 1: Configure Work Item Type

Create or configure a work item type for risk items:
  1. Navigate to Administration > Work Items > Types
  2. Create a new type called risk (or use an existing type)
  3. Add custom fields for risk parameters: severity, occurrence, detection
The work item type doesn’t need to be called “risk” - you can use any name and reference it later in the dataTypes section of your risksheet.json configuration.

​
Step 2: Configure Document Type

Set up a document type for RISKSHEET documents:
  1. Navigate to Administration > Documents & Pages > Document Types
  2. Create a new document type called riskSpecification
  3. Add a custom field named templateDoc of type Enum:Document
If you plan to use multiple document types for RISKSHEET, configure the configuration property: 
nextedy.risksheet.riskDocumentType=(softwareReqSpecification riskSpecification)

​
Step 3: Add RISKSHEET Topic to Sidebar

Make RISKSHEET accessible from the Polarion sidebar:
  1. Navigate to Administration > Portal > Topics
  2. Add the following line to the topics configuration:
<topic id="risksheet"/>
  1. Save the configuration
You should now see the RISKSHEET topic in your Polarion sidebar.

​
Step 4: Create Template Document

Set up a template document that defines the RISKSHEET structure:
  1. Navigate to your desired space (e.g., “Risks”)
  2. Create a new LiveDoc named “Risk Analysis”
  3. Select the riskSpecification document type
  4. In the document properties panel, set the templateDoc field to Risk/Risk Analysis

​
Step 5: Configure Template Path

Tell RISKSHEET where to find your template:
  1. Navigate to Administration > Configuration Properties
  2. Add or update this property:
nextedy.risksheet.risksheetTemplatePath=Risks/Risk Analysis
For multiple templates, use a comma-separated list: 
nextedy.risksheet.risksheetTemplatePath=Risks/Risk Analysis,Risks/HARA Template

​
Step 6: Configure Data Model

Attach a risksheet.json configuration file to your template document:
  1. Open your template document in edit mode
  2. Attach a file named risksheet.json
  3. Define your data model, columns, and levels
Copy the risksheet.json from the FMEA or HARA demo project as a starting point. This saves significant configuration time and provides working examples.
Key configuration sections: 
{
  "dataTypes": {
    "risk": {
      "type": "risk",
      "role": "relates_to"
    },
    "task": {
      "type": "task",
      "role": "mitigates"
    }
  },
  "columns": [
    {"header": "ID", "binding": "id"},
    {"header": "Title", "binding": "title"}
  ]
}

​
Step 7: Create New RISKSHEET Documents

Create RISKSHEET documents from your template:
  1. Click the RISKSHEET topic in the sidebar
  2. Click + New Blank Document
  3. Select your template from the dropdown
  4. Enter a document name and location
  5. Click Create
Do not use the LiveDoc “Reuse” function to duplicate templates. This creates redundant configuration attachments and can cause conflicts. Always create new documents via the RISKSHEET topic’s ”+ New Blank Document” button.

​
Troubleshooting Common Issues

SymptomCauseSolution
RISKSHEET topic missingDemo project not installedInstall demo project via Administration
Configuration errors on first loadData model mismatchReview risksheet.json and ensure work item types match
Template not appearing in dropdownTemplate path incorrectVerify nextedy.risksheet.risksheetTemplatePath matches actual document location
Cannot edit cellsPermission restrictionsCheck user permissions for the work item type

​
Verification

You should now see:
  • RISKSHEET topic in the Polarion sidebar
  • Your template listed when clicking ”+ New Blank Document”
  • A functional RISKSHEET grid with your configured columns
  • Ability to create and edit risk items directly in the grid

​
See Also

KB ArticlesSupport TicketsSource Code
  • RisksheetProjectProperties.java
  • RisksheetViewServlet.java
  • AppConfig.ts
  • RisksheetSetupService.java
  • RisksheetProduct.java