Skip to main content

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. diagram

Configuration Attachment Properties

PropertyTypeDefaultDescription
configstringrisksheet.jsonName 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.
fromTemplatebooleanfalseRead-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.
configPathstringURI 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.
templateNamestringDisplay 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.
fileNamestringPath and name of the document where configuration was requested, formatted as folder/documentTitle. Indicates the source document, regardless of where configuration was actually found.
revisionstringData 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

  1. Access Configuration Editor: Open the RISKSHEET and select Menu > Configure
  2. Create Local Copy: The configuration editor detects whether configuration is inherited from template
  3. Modify Settings: Edit columns, data types, workflows, or other properties as needed
  4. Save Local Configuration: The system creates/updates risksheet.json as 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
When document has local configuration:
  • Template updates do not override document settings
  • Document configuration takes precedence over template
  • Full independence for customization
You can use template configuration for base structure (columns, data types, workflows) and override only specific properties in the document config. This provides flexibility while maintaining governance through templates.

Configuration Override Rules

Complete Override

If a document has a risksheet.json attachment:
  • All document configuration comes from the local file
  • Template configuration is completely bypassed
  • fromTemplate flag is set to false
  • Project-level properties still apply for system settings not in the document config

Template Inheritance (No Local Config)

If a document has no risksheet.json attachment:
  • Configuration searches the template hierarchy
  • First template in the chain with risksheet.json is used
  • fromTemplate flag is set to true
  • If no template has configuration, system defaults apply
Document-level configuration completely overrides template configuration. If you create a local config file, template updates will not apply to that document. This is intentional but requires careful planning in multi-project environments.

Detaching and Reattaching Configuration

Detach from Template

To switch a document from template-driven to independent configuration:
  1. Open the RISKSHEET document
  2. Click Menu > Configure to open the configuration editor
  3. The system detects template inheritance and offers to Create Local Copy
  4. Confirm to create risksheet.json attachment on the document
  5. Document is now independent; future template changes do not apply

Reattach to Template

To return a document to template inheritance:
  1. Open the RISKSHEET document
  2. Click Menu > Configure
  3. Select Switch to Template Configuration (if available)
  4. Confirm deletion of local risksheet.json attachment
  5. 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:
  1. Verify the document inherits template configuration (fromTemplate = true)
  2. Open the document and click Menu > Configure
  3. Create a local copy of the configuration
  4. Modify columns, data types, and properties as needed
  5. Save the document
Result: This document uses local configuration. Other documents continue to use the template.

Scenario 2: Archive and Restore Configuration

Situation: You want to test new template settings without affecting documents that depend on the current template. Solution:
  1. Export current template configuration as backup
  2. For documents that should NOT use new settings, create local copies
  3. Update the template configuration
  4. 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:
  1. Create separate template documents in each project with project-specific configuration
  2. Documents in Project A inherit from Project A template
  3. Documents in Project B inherit from Project B template
  4. Each project maintains independent configuration hierarchy

Properties Index Documentation

For complete reference of all configuration properties available for document override, see:

Debugging Configuration Sources

To determine which configuration your document is using:
  1. Open the RISKSHEET document
  2. Click Menu > Help > Configuration Info
  3. View configuration source metadata:
    • fromTemplate: Whether configuration is inherited
    • templateName: Name of template (if applicable)
    • configPath: Full path to the configuration file
    • fileName: 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 documented
KB ArticlesSupport TicketsSource Code
  • DocumentConfigProvider.java
  • AppConfig.ts
  • AppConfigParser.ts
  • PolarionAppConfigManager.java
  • OpenHelpCommand.ts