Skip to main content

​
Open the Configuration Editor

  1. Open your Risksheet document in Polarion
  2. Click Menu > Configuration > Edit Risksheet Configuration…
  3. The editor opens in a new browser tab
Starting with version 25.5.0, the editor opens in a separate tab so you can view your Risksheet and configuration side by side. Make changes in the editor, save, and refresh the Risksheet tab to see results.

​
Editor Interface Overview

diagram Key controls:
  • JSON/YAML toggle - Switch between format modes with syntax highlighting
  • Download - Export current configuration as a file
  • History - View previous configuration versions
  • Template dropdown - Switch between document-specific and template configuration
  • Validation panel - Shows real-time syntax errors and warnings

​
Make Configuration Changes

​
Edit in JSON Mode

JSON mode provides the traditional risksheet.json format:
  1. Click the JSON tab if not already selected
  2. Navigate to the section you want to modify (global, columns, formulas, etc.)
  3. Edit the property values directly
  4. Check the validation panel at the bottom for syntax errors
Example - Change culture setting: 
"global": {
  "culture": "de-DE",
  "refreshOnSave": true
}

​
Edit in YAML Mode

YAML mode (version 25.5.0+) offers cleaner syntax without braces and quotes:
  1. Click the YAML tab
  2. Edit using YAML syntax with proper indentation
  3. Validation detects both YAML syntax errors and configuration schema issues
Example - Same culture change in YAML: 
global:
  culture: de-DE
  refreshOnSave: true
YAML is whitespace-sensitive. Use consistent indentation (2 or 4 spaces, no tabs). The editor highlights indentation errors in red.

​
Save and Apply Changes

  1. Review the validation panel - it must show ✅ No issues found
  2. Click Save Configuration
  3. Return to your Risksheet browser tab
  4. Refresh the page to load the new configuration
The editor validates JSON/YAML syntax and basic structure, but does not catch all semantic errors. For example, invalid enum values like "nice_to_have" when a numeric rating is expected may pass validation but cause runtime errors. Always test configuration changes on a non-production document first.

​
Template vs Document Configuration

​
Understanding the Hierarchy

Risksheet searches for configuration in this order:
  1. Document attachment - risksheet.json attached directly to the LiveDoc
  2. Template attachment - risksheet.json attached to the template document referenced by the templateDoc custom field
  3. Built-in default - Hardcoded default configuration if no files found

​
Override Template Configuration

By default, document configuration inherits from the template. To create a document-specific configuration:
  1. In the configuration editor, click the Template dropdown
  2. Select Override Template
  3. Edit the configuration as needed
  4. Click Save Configuration
The document now has its own risksheet.json attachment and will not inherit future template changes.
Use template-level configuration for organization-wide standards (columns, formulas, styling). Use document-level overrides for project-specific customizations like queries, filters, or specialized columns.

​
Revert to Template

To discard document-specific configuration and return to template inheritance:
  1. Click the Template dropdown
  2. Select Use Template Configuration
  3. Confirm the action
Reverting to template discards all document-specific customization. Download your document configuration first if you might need it later.

​
Use Configuration History

The History feature (version 25.5.0+) tracks previous configuration versions:
  1. Click the History button
  2. Browse the list of saved configurations with timestamps
  3. Select a previous version to view its content
  4. Click Restore to revert to that configuration

​
Keyboard Shortcuts

The editor supports these shortcuts:
ShortcutAction
Ctrl+S (Windows) / Cmd+S (Mac)Save configuration
Ctrl+F (Windows) / Cmd+F (Mac)Find text in configuration
Ctrl+H (Windows) / Cmd+H (Mac)Find and replace
Ctrl+Z (Windows) / Cmd+Z (Mac)Undo changes
Ctrl+Shift+Z (Windows) / Cmd+Shift+Z (Mac)Redo changes

​
Verify Your Changes

After saving and refreshing your Risksheet:
  • Column changes - New columns appear, renamed headers display correctly
  • Formula changes - Calculated columns show updated values
  • Style changes - Cell colors and formatting reflect new rules
  • Global changes - Refresh behavior, culture settings, menu options work as configured
If changes don’t appear, check:
  1. Did you save in the editor? Look for a save confirmation message
  2. Did you refresh the Risksheet browser tab? Press Ctrl+R / Cmd+R
  3. Is the configuration attached at the right level (document vs template)?
  4. Are there JavaScript errors? Open browser DevTools Console (F12)

​
See Also

KB ArticlesSupport TicketsSource Code
  • ShowConfigurationCommand.ts
  • CellEditorFormatter.ts
  • RisksheetViewServlet.java
  • AppConfigParser.ts
  • AppConfig.ts