Document Configuration Override - Nextedy Documentation

Configuration Loading Hierarchy

The configuration manager searches for the risksheet.json attachment in the following order:

Document attachment — the risksheet.json file attached directly to the current Polarion LiveDoc document
Template hierarchy — if not found on the document, the system searches the document’s template module for the attachment

When configuration is loaded from a template, the fromTemplate flag is set to true and the templateName property contains the display name of the source template (including a project name prefix if the template is from a different project).

Configuration Source Properties

These properties are set by the configuration loader and indicate where the active configuration originated:

Property	Type	Default	Description
`fromTemplate`	`boolean`	`false`	Set to `true` when the configuration was loaded from a template document rather than the target document itself.
`configPath`	`string`	`None`	URI path to the configuration attachment that was actually loaded, whether from the document or from a template. Useful for debugging configuration source.
`templateName`	`string`	`None`	Display name of the template document from which configuration was inherited. Includes project name prefix if the template is from a different project. Empty when configuration is loaded directly from the document.
`fileName`	`string`	`None`	Path and name of the document where configuration was requested (not necessarily where it was found). Formatted as `folder/documentTitle`.
`source`	`string`	`null`	Path to the configuration source file (document or template) used to load the Risksheet configuration. Displayed in the UI to indicate configuration origin.
`revision`	`string`	`None`	Data revision identifier of the cached configuration attachment. Used internally for cache invalidation when attachment content changes.

The configuration manager caches loaded configuration files keyed by the document path and the attachment revision. When the attachment is updated (new revision), the cache is automatically invalidated and the configuration is reloaded on the next page load.

Override Template Feature

How It Works

The Override Template feature copies the risksheet.json from the template and attaches it directly to the current document. After this operation:

The document has its own risksheet.json attachment
Changes to the template no longer affect this document
The fromTemplate flag changes from true to false
The templateName property becomes empty
The source property updates to reference the document itself

Accessing Override Template

The Override Template option is available in the Risksheet menu. It requires administrative privileges (canAdmin: true) to execute. The configuration editor can be opened via:

Property	Type	Default	Description
`configEditUrl`	`string`	`${baseUrl}/risksheet/configuration/`	Base URL for the Risksheet configuration editor interface. Opens in a new browser window with `project`, `document`, and `type` query parameters.
`canAdmin`	`boolean`	`false`	Indicates whether the current user has administrative privileges for configuration editing. Required to access Override Template.

The configuration update endpoint (POST /config/update) supports a scope parameter to indicate whether the update is copying from a template. The operation executes within a write transaction and redirects back to the document view upon completion.

Reverting to Template

The Override Template operation is reversible. To revert a document back to template-inherited configuration:

Remove the risksheet.json attachment from the document
The configuration manager will fall back to the template hierarchy on the next page load
The fromTemplate flag returns to true

When you revert from an overridden configuration back to the template, all document-specific configuration changes are lost. The document-level risksheet.json attachment is removed and the template’s configuration takes effect immediately. There is no merge — the template configuration replaces the document configuration entirely.

Template Inheritance Details

Template Resolution

When Risksheet searches the template hierarchy, it looks for the risksheet.json attachment in the document’s template module. The template module is determined by the Polarion document’s template assignment (configured at document creation time or through Polarion’s document management). If the template module is in a different project, the templateName includes the project name prefix for disambiguation. For example, a template named “FMEA Standard” in the “Templates” project would display as Templates/FMEA Standard.

Template Path Configuration

The location where Risksheet documents can be created is controlled by the template path configuration:

Property	Type	Default	Description
Template path	`string`	`Risks/Risk Specification`	Document template path(s) where new risk documents can be created. Multiple paths can be comma-separated. Configured in the Risksheet project properties.

See Template Path Configuration for the full reference on template path settings.

Configuration Sections Subject to Override

When a document overrides the template configuration, the entire risksheet.json file is copied and becomes independent. All configuration sections are included in the override:

Section	Property	Description
Column definitions	`columns`	Array of column definitions including bindings, types, headers, and rendering properties
Data types	`dataTypes`	Risk and task type configuration including work item types, roles, and menu visibility
Levels	`levels`	Hierarchical level definitions with control columns
Formulas	`formulas`	Named JavaScript formula definitions for calculated columns
Styles	`styles`	CSS style definitions for conditional formatting
Cell decorators	`cellDecorators`	Conditional formatting functions that apply styles based on cell values
Enumerations	`enums`	Enumeration option definitions for dropdown columns
Ratings	`ratings`	Rating scale definitions for risk assessment parameters
Relations	`relations`	Enumeration relationships for dependent enum behavior
Views	`views`	Saved column visibility presets
Global settings	`global`	Culture/locale, help URL, refresh behavior, menu organization
Reviews	`reviews`	Review workflow configuration
Sort order	`sortBy`	Default sort column sequence
Headers	`headers`	Row header and column header height/renderer settings
Read-only flag	`readonly`	Global read-only toggle
Downstream readonly	`downstreamReadonly`	Controls whether downstream linked items are editable

Use Cases for Document Override

Critical Project Phase Isolation

During critical project phases (certification review, safety case preparation), you may want to freeze the Risksheet configuration to prevent unintended changes from template updates. Override the template to create a stable, document-specific configuration:

{
  "columns": [
    {"id": "systemItemId", "header": "ID", "binding": "systemItemId", "level": 1},
    {"id": "title", "header": "Failure Mode", "binding": "title", "level": 1},
    {"id": "sev", "header": "Severity", "binding": "sev", "type": "rating", "level": 2},
    {"id": "occ", "header": "Occurrence", "binding": "occ", "type": "rating", "level": 2},
    {"id": "det", "header": "Detection", "binding": "det", "type": "rating", "level": 2}
  ],
  "dataTypes": {
    "risk": {"type": "fmea_risk", "role": "has_risk"},
    "task": {"type": "fmea_task", "role": "mitigates"}
  },
  "levels": [
    {"controlColumn": "systemItemId", "showInMenu": true}
  ],
  "formulas": {
    "rpn": "function(info){ var v = info.item['occ']*info.item['det']*info.item['sev']; return v?v:null; }"
  }
}

This configuration is now independent of the template and will not change when the template is updated.

Document-Specific Column Layout

Individual FMEA documents may require different column configurations than the standard template. For example, a cybersecurity TARA analysis may need STRIDE-specific columns while the standard template uses FMEA columns:

Override the template on the TARA document
Modify the columns array to include TARA-specific fields
The rest of the project’s FMEA documents continue using the template configuration

Testing Configuration Changes

Before modifying a template that affects multiple documents, override the template on a single test document, make changes, and validate. Once confirmed, apply the changes to the template.

PDF Export Configuration Override

The PDF export configuration follows the same override pattern as risksheet.json:

Property	Type	Default	Description
`risksheetPdfExport.vm`	`string`	`risksheetPdfExport.vm`	Velocity template file name for PDF export. Can be attached to the document or inherited from the template.
`pdfExportConfiguration`	`string`	`None`	Full content of the PDF export Velocity template. Loaded from either the document attachment or the template.
`fromTemplate` (PDF)	`boolean`	`false`	Whether the PDF export configuration was loaded from a template.

The same resolution order applies: document attachment first, then template hierarchy.

Configuration Editor

The configuration editor opens in a new browser window and provides a visual interface for modifying risksheet.json. The URL is constructed from:

configEditUrl — base URL for the editor (${baseUrl}/risksheet/configuration/)
projectId — Polarion project identifier
document.id — Risksheet document identifier
type — configuration section to edit (e.g., columns, settings, levels)

When changes are saved through the editor, the system executes the update within a write transaction. If the document is using a template configuration and you make changes through the editor, the system may prompt you to override the template first.

Interaction with Other Configuration Features

Feature	Interaction
Template path	Controls where new documents can be created and which templates are available. The template path does not affect the override mechanism.
Global help URL	The `global.help` property defaults to the Nextedy support portal (`https://go.nextedy.com/risksheet-support-portal`). This can be customized per document via override.
Historical revisions	Viewing a document at a specific revision loads the `risksheet.json` from that revision. The `readonly` flag is automatically set to `true` for historical views.
Auto-suspect	The auto-suspect setting (whether changes trigger suspect links) is a project-level property, not a document configuration property. It is not affected by document overrides.

Complete Example

A document-specific override configuration for an automotive FMEA with custom RPN thresholds:

{
  "columns": [
    {"id": "systemItemId", "header": "ID", "binding": "systemItemId", "level": 1, "width": 80},
    {"id": "title", "header": "Failure Mode", "binding": "title", "level": 1, "width": 200},
    {"id": "cause", "header": "Cause", "binding": "cause", "level": 2, "width": 180},
    {"id": "effect", "header": "Effect", "binding": "effect", "level": 2, "width": 180},
    {"id": "sev", "header": "S", "binding": "sev", "type": "rating", "level": 2, "width": 50},
    {"id": "occ", "header": "O", "binding": "occ", "type": "rating", "level": 2, "width": 50},
    {"id": "det", "header": "D", "binding": "det", "type": "rating", "level": 2, "width": 50},
    {"id": "rpn", "header": "RPN", "formula": "commonRpn", "level": 2, "width": 60}
  ],
  "dataTypes": {
    "risk": {"type": "fmea_risk", "role": "has_risk", "removeStrategy": "delete", "rejectedStatus": "rejected"},
    "task": {"type": "fmea_task", "role": "mitigates", "showInMenu": true}
  },
  "levels": [
    {"controlColumn": "systemItemId", "showInMenu": true}
  ],
  "formulas": {
    "commonRpn": "function(info){ var v = info.item['occ']*info.item['det']*info.item['sev']; return v?v:null; }"
  },
  "cellDecorators": {
    "rpn": "function(info){ var val=info.value; $(info.cell).toggleClass('rpn1',val>0&&val<=100); $(info.cell).toggleClass('rpn2',val>100&&val<=200); $(info.cell).toggleClass('rpn3',val>200); }"
  },
  "styles": {
    ".rpn1": "{background-color:#eaf5e9!important;color:#1d5f20!important;}",
    ".rpn2": "{background-color:#fff3d2!important;color:#735602!important;}",
    ".rpn3": "{background-color:#f8eae7!important;color:#ab1c00!important;}"
  },
  "global": {
    "culture": "en"
  },
  "reviews": {
    "reviewManager": "CommentBased"
  }
}

​Configuration Loading Hierarchy

​Configuration Source Properties

​Override Template Feature

​How It Works

​Accessing Override Template

​Reverting to Template

​Template Inheritance Details

​Template Resolution

​Template Path Configuration

​Configuration Sections Subject to Override

​Use Cases for Document Override

​Critical Project Phase Isolation

​Document-Specific Column Layout

​Testing Configuration Changes

​PDF Export Configuration Override

​Configuration Editor

​Interaction with Other Configuration Features

​Complete Example

​See Also

Configuration Loading Hierarchy

Configuration Source Properties

Override Template Feature

How It Works

Accessing Override Template

Reverting to Template

Template Inheritance Details

Template Resolution

Template Path Configuration

Configuration Sections Subject to Override

Use Cases for Document Override

Critical Project Phase Isolation

Document-Specific Column Layout

Testing Configuration Changes

PDF Export Configuration Override

Configuration Editor

Interaction with Other Configuration Features

Complete Example

See Also