Skip to main content

​
Overview

The templateDoc custom field determines which template document provides the configuration for your Risksheet. This is useful for:
  • Reusing configuration across multiple documents
  • Centralizing configuration management
  • Setting up global templates across projects
  • Maintaining consistent column layouts and formulas

​
Configuration Hierarchy

Risksheet configuration is loaded in the following priority order: diagram When you configure the templateDoc field, you’re pointing to location #2 in this hierarchy.

​
Step 1: Configure the Custom Field

First, ensure the templateDoc custom field exists on your Risksheet document:
  1. Navigate to Administration > Work Items > Custom Fields
  2. Find or create a custom field named templateDoc
  3. For project-level templates: Set type to Enum (Document)
  4. For global/cross-project templates: Set type to String
The field type determines whether you can reference templates from other projects. Enum (Document) only works within a single project. String enables cross-project references using the PROJECTID:PATH format.

​
Step 2: Set the Template Path

​
For Project-Level Templates

  1. Open your Risksheet document in Edit mode
  2. Locate the templateDoc custom field
  3. Select the template document from the dropdown
  4. Save the document
The path is automatically set to the selected document within the current project.

​
For Global/Cross-Project Templates

  1. Open your Risksheet document in Edit mode
  2. Locate the templateDoc custom field (must be String type)
  3. Enter the path in the format: PROJECTID:Folder/DocumentName
    • Example: GlobalLibrary:Risks/Risk Specification
  4. Save the document
You can configure multiple global template paths in Administration > Configuration Properties using nextedy.risksheet.risksheetTemplatePath. Separate paths with commas: GlobalLibrary:Risks/Template1,SharedConfig:Templates/Template2

​
Step 3: Verify the Template Path

  1. Open your Risksheet document
  2. Navigate to Menu > Configuration > Edit Risksheet Configuration
  3. The Configuration Editor opens in a new tab
  4. Check the banner at the top of the editor
You should see:
  • “Configuration loaded from template” if using a template
  • The template name and path displayed
  • “Configuration attached to this document” if using document-specific config

​
Common Pitfalls

Users must have read access to both the consuming project and the template project. If users can’t see the template, check:
  • Project-level permissions for the template project
  • Document-level permissions for the template document
  • User roles include read access to both projects
In clustered Polarion installations, configuration changes may not propagate immediately to all nodes. If changes don’t appear after updating the template:
  1. Wait 2-3 minutes for cache invalidation
  2. Clear browser cache and refresh
  3. Restart Polarion nodes if necessary
If you attach a risksheet.json file directly to a document that uses templateDoc, the document attachment takes precedence and the template path is ignored. Use the Override Template feature in the Configuration Editor to intentionally detach from a template.

​
Tips

Global templates are ideal for:
  • Organizations with multiple projects using identical risk analysis structures
  • Centralized governance requiring consistent configuration across teams
  • Simplifying updates — change once, apply everywhere
Use document-specific configurations when:
  • Each project has unique column requirements
  • You’re prototyping new configurations before rolling out
  • Different teams follow different risk methodologies (FMEA vs HARA)
The nextedy.risksheet.risksheetTemplatePath configuration property controls which templates appear in the New Blank Document wizard. This is separate from templateDoc but works together:
  • risksheetTemplatePath (property) = where to find templates when creating new documents
  • templateDoc (custom field) = which template provides configuration for this specific document

​
Verification

You should now see:
  • ✅ The template path displayed in the Configuration Editor banner
  • ✅ Columns, formulas, and styling matching the template configuration
  • ✅ Changes to the template propagate to all documents using that template path
Test by modifying a column in the template’s risksheet.json and refreshing a consuming document — the change should appear automatically.

​
See Also

KB ArticlesSource Code
  • DocumentConfigProvider.java
  • AppConfig.ts
  • RisksheetProjectProperties.java
  • PdfExportConfigurationService.java
  • ShowConfigurationCommand.ts