Skip to main content

​
When to Embed Risksheet

Use embedded Risksheets when you need to:
  • Show FMEA analysis alongside explanatory text in a requirement or design document
  • Display risk assessment results in context with system architecture descriptions
  • Create integrated safety case documents combining narrative and live risk data
  • Build training materials that demonstrate Risksheet features inline
Each Risksheet configuration is attached to exactly one Polarion LiveDoc module as document.risksheet. The embedded view and standalone Risksheet page both display the same underlying work items with bidirectional sync—changes in either interface update the source LiveDoc immediately.

​
Steps to Embed Risksheet

​
1. Create or Identify the Target LiveDoc Module

Navigate to the space where you want the embedded Risksheet (e.g., Risks space) and create a new LiveDoc module or open an existing one. The module must have document.type set to riskSpecification to support Risksheet attachment. 
Document: Risks/HAZID
Type: riskSpecification
Space: Risks

​
2. Configure the Risksheet Attachment

Ensure the LiveDoc module has a document.risksheet attachment containing valid Risksheet JSON configuration. If missing, upload a .json file with column definitions, views, levels, and formulas. Example minimal configuration: 
{
  "columns": [
    {"field": "id", "title": "ID", "width": 100},
    {"field": "title", "title": "Hazard", "width": 250}
  ],
  "views": [
    {"id": "default", "title": "All Columns", "columns": ["id", "title"]}
  ],
  "levels": []
}
See HARA Risksheet Configuration for complete examples.

​
3. Insert the Risksheet Widget in LiveDoc Content

Edit the LiveDoc module in Edit Mode (click Edit button in LiveDoc toolbar). Insert the Risksheet widget using this Velocity macro call: 
#nextedyRisksheet()
Place this macro where you want the Risksheet grid to appear. You can surround it with headers, explanatory text, or other LiveDoc content: 
## HAZID Analysis

The following table shows identified hazards for the AEB System:

#nextedyRisksheet()

## Analysis Summary

18 hazards identified across 4 operational phases...

​
4. Save and View the Embedded Risksheet

Click Save in the LiveDoc editor. The embedded Risksheet will render as a full interactive spreadsheet grid within the LiveDoc page: diagram Users can:
  • Edit cells inline (double-click or press F2)
  • Add new rows using toolbar +Add buttons
  • Filter columns using header dropdown icons
  • Switch views to show/hide column groups
  • Sort by clicking column headers
All changes save automatically to the underlying work items.

​
Embedded vs Standalone Risksheet

FeatureEmbedded (LiveDoc)Standalone (Risksheet Page)
URL pattern/polarion/#/project/.../wiki/Risks/HAZID/polarion/risksheet?module=Risks/HAZID
ContextSurrounded by LiveDoc text and headersFullscreen grid with toolbar
ToolbarCompact inline toolbarFull feature toolbar with export/print
Use caseDocumentation with inline risk tablesInteractive FMEA editing sessions
Traffic lightsNot displayedShows completion status overlay
Footer tour buttonNot displayedShows ”▶ Intro Tour” button
Both interfaces edit the same work items—use whichever fits your workflow.
If document.risksheet contains syntax errors (missing commas, unmatched braces), the embedded widget will fail to render and display an error message. Validate JSON syntax before uploading. Use the standalone Risksheet page to test configuration changes before embedding.
Define multiple views in risksheet.json to support phased FMEA workflows:
  • Pre-Mitigation View: Shows Severity, Occurrence, Detection, Initial AP only
  • Controls View: Shows Risk Controls, Mitigation Actions, Owner
  • Post-Mitigation View: Shows Residual Severity, Occurrence, Detection, Residual AP
Users switch views using the Columns button to focus on current workflow phase without overwhelming the screen.

​
Advanced: Multiple Embedded Risksheets

You can embed multiple Risksheet widgets in a single LiveDoc by referencing different modules: 
## System-Level FMEA
#nextedyRisksheet("Risks/System-SFMEA")

## ECU Subsystem FMEA
#nextedyRisksheet("Risks/ECU-SFMEA")
Each widget renders its own grid with independent configuration from the respective document.risksheet attachments.

​
Verification

After embedding, you should see:
  • An interactive spreadsheet grid rendered inline within the LiveDoc page
  • Column headers matching your columns[] configuration
  • Toolbar buttons for adding work items, switching views, and filtering
  • Editable cells that save changes when you click outside or press Enter
  • The same data visible in both the embedded view and standalone Risksheet page (open /polarion/risksheet?module=<YourModule> to verify sync)

​
See Also