Overview
Nextedy RISKSHEET uses a hierarchical configuration system where document-specific settings override inherited configurations from templates. Understanding this override mechanism is essential for managing multi-project deployments where some documents need unique customization while others follow standardized templates.Configuration Attachment Properties
| Property | Type | Default | Description |
|---|---|---|---|
config | string | risksheet.json | Name of the configuration file attachment on the document. The system searches for this file first on the document itself, then on template documents in the hierarchy. |
fromTemplate | boolean | false | Read-only flag indicating whether the active configuration was loaded from a template document (true) or directly from the document (false). Helps administrators track configuration sources. |
configPath | string | — | URI path to the configuration file that was actually loaded. Includes full attachment path and is used for debugging to verify which configuration file is being used. |
templateName | string | — | Display name of the template document from which configuration was inherited. Includes project prefix (e.g., PROJECT:TemplateFolder/TemplateName) if template is in a different project. Empty if configuration is local to the document. |
fileName | string | — | Path and name of the document where configuration was requested, formatted as folder/documentTitle. Indicates the source document, regardless of where configuration was actually found. |
revision | string | — | Data revision identifier of the cached configuration attachment. Used internally to invalidate cache when configuration changes. Used for cache management only. |
Document-Specific Configuration Workflow
Creating Document-Specific Configuration
- Access Configuration Editor: Open the RISKSHEET and select Menu > Configure
- Create Local Copy: The configuration editor detects whether configuration is inherited from template
- Modify Settings: Edit columns, data types, workflows, or other properties as needed
- Save Local Configuration: The system creates/updates
risksheet.jsonas an attachment on the document
Switching Between Template-Driven and Local Mode
When a document uses template configuration:- All changes to the template automatically apply to the document
- Document-specific edits are impossible without creating local configuration
- Template inheritance shown as
fromTemplate = true
- Template updates do not override document settings
- Document configuration takes precedence over template
- Full independence for customization
Configuration Override Rules
Complete Override
If a document has arisksheet.json attachment:
- All document configuration comes from the local file
- Template configuration is completely bypassed
fromTemplateflag is set tofalse- Project-level properties still apply for system settings not in the document config
Template Inheritance (No Local Config)
If a document has norisksheet.json attachment:
- Configuration searches the template hierarchy
- First template in the chain with
risksheet.jsonis used fromTemplateflag is set totrue- If no template has configuration, system defaults apply
Detaching and Reattaching Configuration
Detach from Template
To switch a document from template-driven to independent configuration:- Open the RISKSHEET document
- Click Menu > Configure to open the configuration editor
- The system detects template inheritance and offers to Create Local Copy
- Confirm to create
risksheet.jsonattachment on the document - Document is now independent; future template changes do not apply
Reattach to Template
To return a document to template inheritance:- Open the RISKSHEET document
- Click Menu > Configure
- Select Switch to Template Configuration (if available)
- Confirm deletion of local
risksheet.jsonattachment - Document reverts to template inheritance;
fromTemplate = true
Detaching and reattaching configuration does not affect work item data. Risk items and their properties remain unchanged; only the configuration structure is affected.
Common Override Scenarios
Scenario 1: Exclude One Document from Template Updates
Situation: Global template defines standard columns for all risk sheets. One specific project needs custom columns without affecting others. Solution:- Verify the document inherits template configuration (
fromTemplate = true) - Open the document and click Menu > Configure
- Create a local copy of the configuration
- Modify columns, data types, and properties as needed
- Save the document
Scenario 2: Archive and Restore Configuration
Situation: You want to test new template settings without affecting documents that depend on the current template. Solution:- Export current template configuration as backup
- For documents that should NOT use new settings, create local copies
- Update the template configuration
- Documents with local configs retain old settings; others inherit the new template
Scenario 3: Multi-Project Configuration
Situation: Different projects use different risk assessment methods (FMEA vs. HARA). Solution:- Create separate template documents in each project with project-specific configuration
- Documents in Project A inherit from Project A template
- Documents in Project B inherit from Project B template
- Each project maintains independent configuration hierarchy
Properties Index Documentation
For complete reference of all configuration properties available for document override, see:- Configuration Properties Index — All available properties with defaults
- Risksheet.json Format — File format and structure
- Template Path Configuration — How templates are located and loaded
Debugging Configuration Sources
To determine which configuration your document is using:- Open the RISKSHEET document
- Click Menu > Help > Configuration Info
- View configuration source metadata:
fromTemplate: Whether configuration is inheritedtemplateName: Name of template (if applicable)configPath: Full path to the configuration filefileName: Document where configuration is attached
Best Practices
✅ Use templates for common structure — Define base columns, data types, and workflows in project templates ✅ Override sparingly — Create local configuration only when necessary for document-specific needs ✅ Document customization — Track which documents have local configuration and why ✅ Plan multi-project deployments — Use separate templates per project with clear inheritance paths ✅ Test template changes — Use staging environments or create local configs on test documents before updating production templates ❌ Avoid mixing approaches — Don’t frequently switch between template-driven and local configuration for the same document ❌ Don’t create orphaned configs — If a document has local configuration, ensure it’s intentional and documentedRelated Pages
- Configure Template Paths — How-to guide for managing template inheritance
- Override Template Configuration — How-to guide for switching between modes
- Set Up Global Templates — How-to guide for creating project templates
Sources
Sources
KB ArticlesSupport TicketsSource Code
DocumentConfigProvider.javaAppConfig.tsAppConfigParser.tsPolarionAppConfigManager.javaOpenHelpCommand.ts