Skip to main content

Understanding Configuration Storage

RISKSHEET configuration is stored in risksheet.json files attached to Polarion documents. The system searches for configuration in a specific hierarchy: diagram The first matching configuration file is loaded and used.

Locating Document-Level Configuration

Check Document Attachments

  1. Open your Risksheet document (LiveDoc) in Polarion
  2. Navigate to the Attachments section at the bottom of the page
  3. Look for a file named risksheet.json
  4. If present, this configuration takes precedence over template and built-in configurations
ℹ️ Tip: Document-level configuration allows you to customize individual Risksheets without affecting others using the same template.

View Configuration Source

  1. Open your Risksheet
  2. Go to Menu > Configuration > Edit Risksheet Configuration…
  3. The editor toolbar shows the configuration source:
    • From Template: Displays template document name if inherited
    • Document-Specific: Indicates configuration is attached directly to the document
    • Built-In: Shows when using default configuration
Using the Override Template feature in the Configuration Editor creates a document-level risksheet.json attachment that blocks future template updates. This makes the configuration independent but prevents automatic inheritance of template changes.

Locating Template-Level Configuration

Find the Template Document

  1. Open your Risksheet document in Polarion
  2. View the document’s Custom Fields section
  3. Find the templateDoc custom field
  4. The value shows the path to the template document (e.g., Risks/Risk Specification)
  5. Navigate to that document in Polarion’s document browser

Check Template Attachments

  1. Open the template document identified above
  2. Navigate to the Attachments section
  3. Look for risksheet.json
  4. This configuration is shared by all Risksheets using this template
Template Best Practice: Store common configuration settings in templates to ensure consistency across multiple Risksheets. Use document-level configuration only when specific customization is required.

Configuration File Paths Reference

Configuration LevelFile LocationScope
Document-specificDocument attachments: risksheet.jsonSingle Risksheet document
Template-basedTemplate document attachments: risksheet.jsonAll documents using this template
Built-inPlugin internal resourcesAll Risksheets without custom config

Identifying Active Configuration

Using the Configuration Editor

The Configuration Editor (version 25.5.0+) provides visual indicators:
  1. Open Menu > Configuration > Edit Risksheet Configuration…
  2. Check the tab title:
    • Shows template name if configuration is inherited
    • Shows document name if configuration is document-specific
  3. Review the config history panel to see when configuration was last modified
  4. The YAML mode displays the complete active configuration regardless of source

Checking Server Logs

For troubleshooting configuration loading issues in multi-node environments:
  1. Open the Risksheet
  2. Go to Menu > Configuration > Edit Risksheet Configuration…
  3. Check Polarion server logs (polarion/log/log.txt)
  4. Search for entries containing:
    • DocumentConfigProvider
    • risksheet.json
    • Configuration file path resolution messages
In clustered Polarion environments, configuration may appear differently across nodes due to caching. Clear the Polarion cache and restart all nodes after deploying configuration changes to ensure consistency.

Common Configuration Issues

Configuration Not Loading

Symptom: Changes to risksheet.json don’t appear in the Risksheet Resolution:
  1. Verify the file is named exactly risksheet.json (case-sensitive)
  2. Check that the file is attached to the correct document or template
  3. Clear browser cache and reload the Risksheet
  4. Verify the templateDoc custom field points to the correct template

Multiple Versions Causing Conflicts

Symptom: Unexpected configuration behavior or partial settings Resolution:
  1. Check if both document and template have risksheet.json attachments
  2. Remember document-level configuration overrides template configuration completely (no merging)
  3. Use Override Template only when full customization is needed

Template Changes Not Reflected

Symptom: Template risksheet.json updates don’t affect existing Risksheets Resolution:
  1. Verify the Risksheet document doesn’t have its own risksheet.json attachment
  2. If document-level configuration exists, remove it or use Revert to Template option
  3. Refresh the Risksheet after template changes

Verification

You should now be able to:
  • Locate the active risksheet.json file for any Risksheet
  • Determine whether configuration is document-level or template-level
  • Identify the template document path from custom fields
  • Use the Configuration Editor to view configuration source

See Also

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