Skip to main content

​
What you will achieve

By the end of this tutorial, you will have:
  • Installed the RISKSHEET demo project template
  • Created a demo project with sample risk analysis data
  • Accessed RISKSHEET through the Polarion sidebar
  • Explored a working FMEA risk analysis example
  • Understood the evaluation workflow and next steps

​
Prerequisites

  • Nextedy RISKSHEET installed on Polarion (see Installation)
  • Administrative access to Polarion
  • Polarion version 19.1 or newer
The demo project provides the fastest way to see RISKSHEET in action. It includes pre-configured work item types, document templates, and sample data.

​
Evaluation Setup Steps

​
Step 1: Access RISKSHEET Setup

After installing RISKSHEET, navigate to the setup page: 
Administration > Risksheet > Setup
What you should see: The RISKSHEET Setup page with two main options:

​
Step 2: Install Demo Project Template

Click “Install Demo Project Template” on the Setup page. What happens: Polarion installs a project template containing:
  • Pre-configured work item types (Risk, Task, Failure Mode, etc.)
  • Document templates for risk specifications
  • Sample RISKSHEET configurations
  • Example FMEA workflows
What you should see: A confirmation message indicating the template was successfully installed.
You must install the demo template before creating the demo project. The Risksheet topic will not appear in the sidebar until the demo project exists.

​
Step 3: Create Demo Project

After the template installation completes, click “Create Demo Project” on the Setup page. What happens: Polarion creates a new project based on the template, pre-populated with sample risk analysis data. What you should see: A new project appears in your project list, typically named “RISKSHEET Demo” or similar.

​
Step 4: Access the Demo Project

Navigate to the newly created demo project:
  1. Go to the Polarion home page
  2. Select the demo project from your project list
  3. Look for “Risksheet” in the left sidebar navigation
What you should see: The Risksheet entry in the sidebar:
The Risksheet sidebar entry is configured via Administration > Portal > Topic by adding <topic id="risksheet"/>. The demo project includes this configuration automatically.

​
Step 5: Open a Sample Risksheet

Click on “Risksheet” in the sidebar, then select one of the sample risk analysis documents. What you should see: An interactive spreadsheet-style interface displaying:
  • Risk items organized in a hierarchical structure
  • Columns for failure modes, causes, effects, and controls
  • Severity, Occurrence, and Detection ratings
  • Calculated RPN (Risk Priority Number) values
  • Linked mitigation tasks
Failure ModeCauseEffectSevOccDetRPN
Sensor FailureConnector CorrosionLoss of Function934108
Water IngressDegraded Accuracy74384

​
Evaluation Workflow

diagram

​
Exploring Demo Features

​
Risk Analysis Structure

The demo project demonstrates a typical FMEA (Failure Mode and Effects Analysis) structure:
LevelDescriptionPurpose
Level 1Failure ModeTop-level failure scenarios
Level 2CauseRoot causes of failure modes
Level 3TasksMitigation actions
Notice how cells merge vertically when multiple causes share the same failure mode. This visual grouping is controlled by the levels configuration.

​
Interactive Features to Test

Editing Cells:
  • Click any cell to edit severity, occurrence, or detection ratings
  • Notice how RPN values recalculate automatically
  • Observe cell color changes based on risk thresholds
Adding Risks:
  • Click ”+ Failure Mode” or ”+ Cause” in the toolbar
  • Fill in the new row
  • See how the hierarchy updates
Configuration Inspection:
  • Go to Menu > Configuration > Edit Risksheet Configuration
  • Review the risksheet.json structure
  • Note the columns, levels, and dataTypes sections
Export Functionality:
  • Click Menu > Export > PDF
  • Generate a formatted risk analysis report
  • Review export options and formatting

​
Understanding the Demo Configuration

The demo project illustrates key RISKSHEET concepts:

​
Work Item Type Mapping

The demo uses a “risk” work item type for failure modes and causes: 
"dataTypes": {
  "risk": {
    "type": "risk"
  },
  "task": {
    "type": "task",
    "role": "mitigates",
    "name": "Task"
  }
}

​
Document Template Path

Risksheets are created from a template document: 
nextedy.risksheet.risksheetTemplatePath=Risks/Risk Analysis
This property (found in Administration > Configuration Properties) defines which LiveDoc serves as the template.

​
Topic Configuration

The Risksheet sidebar entry is defined in Administration > Portal > Topic: 
<topic id="risksheet"/>
The demo project template includes all these configurations. When adding RISKSHEET to an existing project, you must configure these elements manually. See Add RISKSHEET to Existing Project for details.

​
Comparison: Template-Based vs. Manual Setup

AspectDemo TemplateManual Setup
Work Item TypesPre-configuredMust create “risk” type
Document TypesPre-configuredMust create “riskSpecification”
Sidebar TopicAuto-includedMust add manually
Sample DataIncludedStart from scratch
ConfigurationReady to useMust customize risksheet.json
Time to Start5 minutes30-60 minutes

​
Next Steps

After exploring the demo project: Learn the Interface: Create Your Own: Production Setup: Advanced Topics:
Related Topics:
KB ArticlesSupport TicketsSource Code
  • risksheet.json
  • DefaultTraceProvider.java
  • RisksheetProduct.java
  • AddTaskCommand.ts
  • CommandFactory.ts