Skip to main content

Configuration Files and Locations

Where are RISKSHEET configuration files stored?

RISKSHEET configuration is stored in two locations: (1) risksheet.json files attached to document templates for document-specific settings, and (2) Configuration Properties in Polarion’s Administration panel for project/global settings. See Find Configuration Files and Configuration Hierarchy for details on the configuration layering system.

How do I edit RISKSHEET configuration?

Use the built-in Configuration Editor accessible from the RISKSHEET menu (Configure → Edit Configuration) for document-level settings. For project/global properties, navigate to Polarion Administration → Configuration Properties. The editor provides syntax validation and property documentation. See Use the Configuration Editor.

What’s the difference between global and document-level configuration?

Global/project-level configuration (set in Configuration Properties) defines defaults that apply across all RISKSHEETs in a project. Document-level configuration (risksheet.json) overrides these defaults for specific documents or templates. This hierarchy allows shared standards with document-specific customization. See Configuration Hierarchy.

Can I use configuration from one RISKSHEET in another document?

Yes, use global templates or copy risksheet.json from one document template to another. Global templates defined in Configuration Properties automatically apply to matching document types. For manual copying, use the Configuration Editor’s template selection feature. See Set Up Global Templates and Override Template Configuration.

Column Configuration

How do I create custom menu buttons like ’+ Hazard’ or ’+ Risk’?

Configure custom menu buttons in the levels section of your configuration. Each level requires a name, controlColumn, and zoomColumn property. Set showInMenu: true to display the level in the navigation menu. These buttons enable quick work item creation at specific hierarchical levels. See Levels Configuration for syntax and examples.

Why are some columns read-only even though I have edit permissions?

Columns become read-only automatically when they use formulas, server-side rendering, or reference system fields (like author, created, updated, type, or resolution). Additionally, upstream sub-columns are read-only by default unless you set nextedy.risksheet.upstreamSubColumnsReadonly=false. Check the column’s readOnly, formula, and serverRender properties. See Configuration Properties Index.

Can I control which columns appear in different contexts?

Yes, use the visible property for column visibility, or create saved views with different column sets for different user roles or tasks. You can also use the level property to show columns only at specific hierarchical levels. Column visibility can be controlled at configuration time or dynamically via saved views. See Control Column Visibility and Create Saved Views.

Advanced Configuration

How do I enable branching support for baseline comparisons?

Set nextedy.risksheet.branchingSupport=true in Configuration Properties. This enables RISKSHEET to work with Polarion branched documents and allows baseline comparison. Optionally, set nextedy.risksheet.includeProjectBaselines=true to load project-level baselines in the History menu. See Work with Branched Documents.

What is the difference between ratings and enumerations?

Ratings are specialized integer-based enumerations used for risk assessment (severity, occurrence, detection) where the numeric value matters for calculations. Standard enumerations are text-based dropdowns where values are symbolic. Ratings use integer IDs in formulas, while enums use string IDs. See Configure Enum Columns and Risk Matrices.

How do I improve loading times for large RISKSHEETs?

Set nextedy.risksheet.moduleOnlyPermissions=true if your permissions are defined at document level (not individual work item level). This skips item-level permission checks, significantly improving load times for large documents. Also consider limiting visible columns and using pagination. See Slow Page Loading.

Can I freeze downstream items at baseline revision time?

Yes, set nextedy.risksheet.downstreamFromRevision=true. By default, downstream items (linked tasks) always show their latest version even in historical baselines. This property locks downstream context to the state at revision creation time, making branched documents true snapshots. See Work with Branched Documents.

Configuration Decision Matrix

diagram
  • Use global templates for organization-wide standards (FMEA vs HARA layouts)
  • Use Configuration Properties for performance and permission settings
  • Use document-level risksheet.json for project-specific column sets
  • Document your configuration choices in template comments
The Configuration Editor validates JSON syntax but not all semantic rules. Test configuration changes in a non-production document first, especially for complex formulas or custom renderers.

Common Configuration Properties

PropertyPurposeDefaultReference
nextedy.risksheet.branchingSupportEnable baseline/branchingfalseBranched Documents
nextedy.risksheet.upstreamSubColumnsReadonlyLock upstream columnstrueEdit Upstream Columns
nextedy.risksheet.moduleOnlyPermissionsSkip item-level permission checksfalsePerformance
nextedy.risksheet.checkInstanceFieldPermissionsEnable field-level permissionsfalseConfigure Permissions
nextedy.risksheet.includeProjectBaselinesLoad project baselinesfalseBranched Documents
KB ArticlesSupport TicketsSource Code
  • RisksheetViewServlet.java
  • AppConfig.ts
  • ShowConfigurationCommand.ts
  • PolarionAppConfigManager.java
  • RisksheetProjectProperties.java