Prerequisites
- You have administrator privileges for the Polarion project (
canAdminmust betrue) - The Risksheet document is open in your browser
- You are viewing the current revision (not a historical baseline), since configuration editing is disabled in read-only mode
Step 1: Open the Configuration Editor
- Open your Risksheet document in Polarion.
- Click the Menu button in the Risksheet toolbar.
- Select Configuration from the dropdown menu.
- The configuration editor opens in a new browser window with the project and document context automatically loaded.
type parameter determines which section of the configuration opens first. Valid values include columns, settings, and levels.
Step 2: Navigate Editor Sections
The configuration editor organizes yourrisksheet.json into the following sections:
| Section | What You Can Edit |
|---|---|
| Columns | Column definitions: binding, type, header, width, visibility, ordering |
| Levels | Hierarchical level definitions, control columns, and menu visibility |
| Data Types | Risk and task work item types, link roles, query factories |
| Global Settings | Culture/locale (global.culture), help URL, refresh behavior |
| Formulas | Named JavaScript formula definitions for calculated columns |
| Styles | CSS class definitions for conditional cell formatting |
| Cell Decorators | Conditional formatting logic that maps cell values to style classes |
| Enums | Enumeration options for dropdown columns |
| Ratings | Risk rating scales for severity, occurrence, and detection parameters |
| Views | Saved column visibility presets |
| Reviews | Review workflow configuration (reviews.reviewManager) |
Step 3: Edit and Save Configuration
- Navigate to the appropriate section in the editor.
- Locate the property you want to modify.
- Make your changes in the editor form fields.
- Click Save to apply the changes.
risksheet.json attachment on the document. After saving, the editor redirects you back to the document view where the Risksheet grid reloads with the new settings.
| Configuration Editor Workflow | ||||||
|---|---|---|---|---|---|---|
| Open Document Open Editor Edit & Save Grid Reloads | ||||||
| Risksheet | ---> | Menu > | ---> | Modify JSON | ---> | New settings |
| view loaded | Configuration | via forms | active | |||
| v | ||||||
| Updates risksheet.json | ||||||
| attachment on document |
Template vs. Document Configuration
When you open the editor, Risksheet determines whether the current configuration comes from a global template or a document-specific attachment:- Template-linked configuration — The editor shows the inherited template configuration. Changes update the template and affect all documents that inherit from it.
- Document-specific configuration — The editor shows the configuration attached directly to the current document. Changes affect only this document.
source and templateName properties in the configuration metadata. If templateName is populated, the configuration is inherited from a template.
Copy Configuration from a Template
To apply a different template’s configuration to the current document:- Open the configuration editor.
- Select the source template you want to copy from.
- Save the configuration with the scope set to indicate a template copy.
risksheet.json with a copy of the selected template’s configuration.
Common Configuration Tasks
| Task | Editor Section | Key Properties |
|---|---|---|
| Add a new column | Columns | binding, header, type, level |
| Change risk item type | Data Types | dataTypes.risk.type, dataTypes.risk.role |
| Set up severity scale | Ratings | ratings with id, name, description |
| Enable review workflow | Reviews | reviews.reviewManager |
| Define calculated field | Formulas | formulas.<name> with JavaScript function |
| Set default sort order | Global Settings | sortBy array with column IDs |
| Customize help URL | Global Settings | global.help |
Troubleshooting
- “Error while reading configuration” — The
risksheet.jsonfile may contain invalid JSON syntax. Download the attachment from Polarion and validate it with a JSON linter. - Editor opens but shows empty fields — Verify that you have read access to the project where the template configuration is stored.
- Browser console errors during editing — Check the browser console on non-Risksheet Polarion pages first. Some errors (such as “Uncaught Positive number expected”) may originate from Polarion itself rather than from the Risksheet configuration.
Verification
After saving your configuration changes and returning to the document view, you should now see the Risksheet grid displaying the updated settings. If the grid does not reflect your changes, try a hard refresh of the browser page.See Also
- Find Configuration Files — understand where your configuration is stored
- Set Up Global Templates — create shared configurations
- Override Template Configuration — create document-specific settings
- Configure Permissions — manage admin access for configuration editing
Sources
Sources
KB Articles
- Adjusting Risksheet configuration
- Risksheet Document Config File - risksheet - format reference
- Risksheet Configuration Properties
ShowConfigurationCommand.tsCellEditorFormatter.tsRisksheetViewServlet.javaAppConfigParser.tsAppConfig.ts