Skip to main content

Prerequisites

Before setting up global templates, ensure you have:
  • Project administrator privileges in the template project
  • Access permissions to all projects where the template will be used
  • The Risksheet extension installed in Polarion
Users must have access to the project where global templates are stored. Without project-level permissions, templates will not appear in the template selection menu when creating new Risksheets.

Create the Global Template Project

  1. Create a dedicated Polarion project to hold your global templates (e.g., “GlobalLibrary” or “RisksheetTemplates”)
  2. Navigate to Administration > Documents & Pages > Document Custom Fields
  3. Locate the templateDoc custom field and change its type from Enum:Document to String:
    Field Name: templateDoc
    Field Type: String (not Enum:Document)
    
    !!! tip “Why String Type?” Using String type allows cross-project template references. The format PROJECTID:TEMPLATE_PATH enables referencing templates from other projects, while Enum:Document restricts selection to the current project only.
  4. Create a Risksheet document in this project with your desired configuration
  5. Set the templateDoc property of your template document using the format:
    PROJECTID:TEMPLATE_PATH
    
    Example: GlobalLibrary:Risks/Risk Specification

Configure Projects to Use Global Templates

For each project that should use the global template:
  1. Navigate to Administration > Documents & Pages > Document Custom Fields
  2. Change the templateDoc custom field type to String (same as template project)
  3. Open Administration > Configuration Properties
  4. Add or update the template path property:
    nextedy.risksheet.risksheetTemplatePath=GlobalLibrary:Risks/Risk Specification
    
    !!! tip “Multiple Templates” You can specify multiple global templates as a comma-separated list:
    nextedy.risksheet.risksheetTemplatePath=GlobalLibrary:FMEA Template,GlobalLibrary:HARA Template
    

Template Hierarchy

Global templates follow a three-tier configuration hierarchy: diagram Documents inherit configuration from the global template unless they have their own risksheet.json attachment.

Create a New Risksheet from Global Template

  1. Navigate to any project configured to use the global template
  2. Open the Risksheet topic in the sidebar
  3. Click ➕ New Blank Document
  4. Select your global template from the dropdown menu: Template Selection
  5. Enter document details and click Create
  6. Open the new document in Risksheet
  7. Verify the configuration by clicking Menu > Configuration > Edit Risksheet Configuration You should see an indicator showing the configuration is loaded from the global template project.

Override Global Configuration for Specific Documents

If a specific document needs different configuration:
  1. Open the document in Risksheet
  2. Click Menu > Configuration > Edit Risksheet Configuration
  3. In the configuration editor, enable Override Template
  4. Make your changes and save
This creates a document-specific risksheet.json attachment that takes precedence over the global template.
Once you override the template configuration, the document no longer receives updates when the global template changes. To re-sync with the global template, delete the document’s risksheet.json attachment.

Common Pitfalls

If users cannot see global templates, verify:
  • Users have read access to the template project
  • The templateDoc field is type String in both template and target projects
  • The nextedy.risksheet.risksheetTemplatePath property uses correct PROJECTID:PATH format
In multi-node Polarion deployments, configuration changes may not propagate immediately. After updating global templates:
  • Clear the application cache on all nodes
  • Restart Polarion services if configuration changes don’t appear
  • Wait up to 5 minutes for cache invalidation

Verification

After setup, verify the global template works correctly:
  1. Create a test Risksheet document in a configured project
  2. Open it in Risksheet
  3. Click Menu > Configuration > Edit Risksheet Configuration
  4. Check the configuration source indicator shows your global template project
  5. Verify columns, formulas, and styling match your template configuration
You should see the configuration loaded from GlobalLibrary:Risks/Risk Specification (or your configured path).

See Also

KB ArticlesSupport TicketsSource Code
  • AppConfig.ts
  • DocumentConfigProvider.java
  • OpenHelpCommand.ts
  • RisksheetViewServlet.java
  • PdfExportConfigurationService.java