Skip to main content

Prerequisites

  • A Risksheet document with a valid risksheet.json configuration
  • Access to the LiveDoc wiki page where you want to embed the table
  • Polarion wiki editing permissions

Step 1: Open the Target LiveDoc Page

Navigate to the Polarion wiki page where you want to display the Risksheet table. Open the page in edit mode.

Step 2: Add the Renderer Call

Insert the following Velocity script block into your wiki page content:
$risksheetDocRenderer.render($document)
Replace $document with a reference to the Risksheet document you want to render. You can obtain the document reference using standard Polarion Velocity APIs. diagram

Step 3: Understand Rendering Limitations

The $risksheetDocRenderer.render() API renders a basic HTML table in the LiveDoc page. It does not include the full Risksheet styling, conditional formatting, cell coloring, or interactive grid features. The rendered table shows risk data in a plain tabular format.
The following features are not available in the embedded rendering:
FeatureInteractive RisksheetEmbedded in LiveDoc
Cell conditional formattingYesNo
Color-coded RPN valuesYesNo
Interactive editingYesNo
Formula calculationsYesValues only
Column sorting/filteringYesNo
Row hierarchy mergingYesLimited

Step 4: Scope Linked Items to the Document

If your Risksheet configuration loads linked items (such as mitigation tasks or upstream requirements), use the document property in the dataTypes configuration to restrict the scope to a specific LiveDoc:
{
  "dataTypes": {
    "task": {
      "type": "mitigationAction",
      "role": "mitigates",
      "document": "Risks/FMEA Analysis"
    }
  }
}
The document property ensures that only items from the specified document path are loaded and displayed, rather than all matching items across the entire project.
The document property in dataTypes is critical for FMEA setups with multiple documents in a project. Without it, all matching work items from the entire project appear as selectable options, which can be confusing in projects with many risk documents.

Alternative: PDF Merge Workflow

If you need full Risksheet formatting (including cell colors, conditional formatting, and styled headers) in a LiveDoc context, consider this alternative approach:
  1. Export the Risksheet to PDF using the Export to PDF function
  2. Export the LiveDoc to PDF separately
  3. Merge both PDFs using an external tool
This preserves all visual formatting that the embedded renderer cannot reproduce.

Working with Templates

Risksheet supports both template-based and Reuse-based LiveDoc workflows:
  • Template approach: Attach risksheet.json to a LiveDoc template. Configuration changes propagate globally to all documents using that template.
  • Reuse approach: Use Polarion’s Reuse function to instantiate LiveDoc templates. Risksheet works without restrictions in reused documents.
For organizations with many risk documents, attach risksheet.json to a LiveDoc template rather than each individual document. This ensures all documents share the same configuration and updates propagate automatically.

Verification

After adding the renderer call to your LiveDoc page:
  1. Save the wiki page
  2. View the page in read mode
You should now see a basic HTML table displaying the risk items from your Risksheet document, rendered directly within the LiveDoc page content.

See Also

KB ArticlesSupport TicketsSource Code
  • OpenLiveDocCommand.ts
  • risksheet.json
  • AppConfigParser.ts
  • ColumnTypeManager.java
  • DefaultTraceProvider.java