Skip to main content

​
Configuration File Types

Risksheet uses three configuration files, each stored as a Polarion document attachment:
FilePurposeFormat
risksheet.jsonPrimary configuration: columns, levels, data types, formulas, styles, enums, ratings, views, global settingsJSON
risksheetTopPanel.vmCustom top panel template with buttons, filters, and UI elements above the gridVelocity (HTML)
risksheetPdfExport.vmPDF export script that controls how risk tables render in exported PDFsVelocity
All three files follow the same inheritance model: if a file is not found directly on the document, the system searches the document’s template hierarchy.

​
Step 1: Check Document Attachments

  1. Open the LiveDoc document in Polarion.
  2. Navigate to the document’s Attachments section.
  3. Look for risksheet.json in the attachment list.
If risksheet.json is present, the document has its own configuration. If it is absent, the document inherits its configuration from a template.

​
Step 2: Identify the Configuration Source

The configuration metadata exposes several properties that indicate where the active configuration was loaded from:
PropertyValueMeaning
sourcePath stringURI path to the configuration attachment that was actually loaded
templateNameTemplate name or emptyName of the template document; includes project prefix if from a different project
fromTemplatetrue / falseWhether configuration was inherited from a template
When templateName is populated (for example, SharedTemplates/FMEA Template), the configuration is inherited. When it is empty, the configuration is attached directly to the document. diagram
Modifying Risksheet configuration settings requires the Admin role for the project. Non-admin users must contact their project administrator to get the necessary permissions.

​
Step 3: Download and Edit Locally

To edit risksheet.json outside the built-in editor:
  1. Open the LiveDoc document in Polarion.
  2. Navigate to the document’s Attachments section.
  3. Download the risksheet.json file.
  4. Edit the JSON in your preferred text editor. Validate syntax with a JSON linter before uploading.
  5. Upload the modified file back as an attachment, replacing the existing one.
If the document inherits its configuration from a template, you must first create a document-specific copy using Menu > Override Template before you can download and edit. See Override Template Configuration.

​
Configuration Caching

Risksheet caches configuration files using the data revision identifier of the attachment. The cache is automatically invalidated when:
  • The risksheet.json attachment content changes (new revision)
  • The template document is updated
  • You manually refresh the Risksheet page
In clustered Polarion deployments, configuration changes may not immediately propagate to all server nodes. If you see inconsistent Risksheet structures, refresh the page to reload the configuration from the updated attachment.

​
Project Properties

In addition to document-level configuration files, Risksheet uses Polarion project properties for project-wide settings. These are managed through Polarion Administration, not through risksheet.json:
PropertyDefaultPurpose
Template pathRisks/Risk SpecificationFolder paths where new risk documents can be created
Tool nameRisksheetDisplay name shown in navigation and UI labels
Suggester result limit20Maximum autocomplete suggestions shown
Fuzzy searchEnabledWhether fuzzy matching is used in item search
Wildcard searchEnabledWhether wildcard characters are supported in search

​
Troubleshooting

  • “Error while reading configuration” — The risksheet.json file contains invalid JSON. Download it and validate with a JSON linter.
  • Different users see different configurations — Verify that all users have read access to the project where the template configuration is stored.
  • Configuration appears inconsistent across sessions — Clear your browser cache and confirm you are not viewing a cached historical revision.

​
Verification

After identifying your configuration source, you should now see either risksheet.json in the document’s attachments (document-specific config) or a templateName value in the Risksheet metadata (template-inherited config).

​
See Also

KB ArticlesSupport TicketsSource Code
  • DocumentConfigProvider.java
  • PdfExportConfigurationService.java
  • RisksheetViewServlet.java
  • AppConfigParser.ts
  • PolarionAppConfigManager.java