Skip to main content

Prerequisites

  • Polarion administrator privileges
  • Access to the Risksheet administration interface

Step 1: Install Default Templates

Risksheet ships with predefined project templates that provide ready-to-use configurations. To install them:
  1. Navigate to Administration > Nextedy Risksheet.
  2. Select the Setup option.
  3. Click Install Templates.
The system installs two starter templates:
TemplatePurpose
Standard RisksheetGeneral-purpose FMEA risk analysis with severity, occurrence, and detection columns
HARA TemplateHazard Analysis and Risk Assessment template aligned with ISO 26262 workflows
Re-installing templates overwrites previous versions. The system removes old template data and performs a clean installation. This is safe for updating templates but will discard any manual customizations made directly to the template files. Installation is atomic — it either completes fully or rolls back on error.

Step 2: Create a New Project from a Template

  1. In Polarion, go to Administration > Projects > Create Project.
  2. Select either the standard Risksheet or HARA template from the template list.
  3. Provide a project name and identifier.
  4. Complete the project creation wizard.
The new project inherits the full Risksheet configuration including column layouts, formulas, cell decorators, enums, and risk rating scales.

Step 3: Configure Template Paths

Control where users can create new risk documents within a project by configuring template paths. In the project-level Risksheet properties, set:
nextedy.risksheet.templatePath=Risks/Risk Specification
To allow multiple document locations, separate paths with commas:
nextedy.risksheet.templatePath=Risks/Risk Specification,Risks/HARA Documents,Safety/Assessments
The default template path is Risks/Risk Specification. These paths control which folders appear in the Risksheet home view when creating new documents.

Configuration Inheritance

Risksheet uses a template-to-document inheritance model for configuration: diagram When Risksheet loads configuration for a document, it searches in this order:
  1. Document attachment — a risksheet.json attached directly to the LiveDoc
  2. Template inheritance — the risksheet.json from the document’s parent template
The source and templateName properties in the loaded configuration indicate where the config was found. The fromTemplate flag is true when configuration was inherited rather than directly attached.
Both Polarion template-based document creation and the Polarion “Reuse” function work with Risksheet. The template approach is recommended because configuration changes to the template propagate to all new documents automatically. The Reuse approach also works but does not propagate template changes.

Step 4: Customize the Tool Name

Organizations can rebrand the tool name displayed in the Risksheet UI:
PropertyDefaultExample
Tool nameRisksheetFMEA Tool, Risk Matrix
Document name (singular)Risk AnalysisRisk Assessment
Document name (plural)Risk AnalysesRisk Assessments
Configure these through Risksheet project properties in Administration > Nextedy Risksheet > Project Properties.

Step 5: Use Multiple Configurations per Project

Risksheet supports multiple distinct configurations within a single project. Each LiveDoc document can have its own risksheet.json attached, or inherit from different templates. To set up multiple configurations:
  1. Create separate LiveDoc templates for each risk analysis type (e.g., FMEA, HARA, TARA).
  2. Attach a unique risksheet.json to each template.
  3. When creating new documents, select the appropriate template.
Risksheet has no required specific fields or work item types. You can configure it to work with any custom work item type in your Polarion project. The default demo uses Risk item types, but the tool is fully configurable for any work item type. This makes integration with existing project templates straightforward.

Step 6: Scope Work Items to Documents

To restrict linked items to a specific LiveDoc rather than the entire project, use the document property in your dataTypes configuration:
{
  "dataTypes": {
    "task": {
      "type": "measure",
      "role": "has_measure",
      "document": "Risks/FMEA Measures"
    }
  }
}
This ensures that when users search for linked items, only work items from the specified document are shown. This is a common need for FMEA setups with multiple documents in the same project. To create new items directly within the current document, use the createInCurrentDocument parameter in the data type definition. This controls whether new upstream items are stored in the current document rather than at the project level.

Verification

After completing the template setup:
  1. Create a new project using your Risksheet template.
  2. Navigate to the Risksheet home page within the project.
  3. You should now see the configured document folders and the ability to create new risk documents.
  4. Open a document and verify that column layouts, enums, and formulas match your template configuration.
  5. Check the configuration editor to confirm the templateName field shows your template name.

See Also

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