Skip to main content

​
Configuration Overview

The template path system allows administrators to specify one or more locations where RISKSHEET documents can be created. This is configured through Polarion project administration settings and controls the document creation workflow.
A template is a Polarion wiki document that serves as a starting point for new risk documents. A configuration is the risksheet.json file that defines columns, styling, and behavior. Templates may contain configuration files as attachments.

​
Configuration Location

Template paths are configured in Polarion at: 
Project Administration > Configuration Properties > nextedy.risksheet.risksheetTemplatePath

​
Template Path Property

Property NameTypeDefaultDescription
nextedy.risksheet.risksheetTemplatePathstring"Risks/Risk Specification"Comma-separated list of template document paths where users can create new RISKSHEET documents. Each path follows the format Folder/DocumentName.

​
Single Template Path Example

For a simple setup with one template: 
nextedy.risksheet.risksheetTemplatePath=Risks/Risk Specification
This configuration allows users to create RISKSHEET documents in the Risks folder using the Risk Specification template.

​
Multiple Template Paths Example

For projects that need different templates for different purposes: 
nextedy.risksheet.risksheetTemplatePath=Risks/Risk Specification,Assessments/FMEA Template,Assessments/HARA Template
Users will see all three templates available when creating new documents:
  • Risks/Risk Specification in the Risks folder
  • FMEA Template in the Assessments folder
  • HARA Template in the Assessments folder

​
Global Template Path Configuration

For multi-project setups where you want to share a common template across projects, use the global template path format: 
nextedy.risksheet.risksheetTemplatePath=GlobalLibrary:Risks/Risk Specification
The format is: 
<ProjectId>:<Folder>/<DocumentName>

​
Global Template Setup Steps

  1. Create Template Project
    • Create a dedicated Polarion project (e.g., GlobalLibrary)
    • Configure RISKSHEET in this project
    • Create and configure template documents
  2. Modify Custom Field
    • In your template documents, set the custom field templateDoc to type STRING
    • This field stores the cross-project template reference
  3. Reference Templates Across Projects
    • In consuming projects, reference the global templates using the format above
    • Example: GlobalLibrary:Risks/Risk Specification
  4. Access Configuration
    • RISKSHEET automatically loads configuration from the global template when a document is created
    • Configuration is inherited through the templateDoc field reference

​
Global Template Example: Multi-Project Setup

diagram

​
Template Path Resolution Flow

When a user creates a new RISKSHEET document, the system resolves templates in this order:
  1. Parse risksheetTemplatePath property
  2. For each template path in the list:
    • If format includes ProjectId (contains :) — load from specified project
    • If format is local path only — load from current project
  3. Create document in target folder
  4. Apply template (copies structure and attachments)
  5. Load configuration:
    • Check document for risksheet.json attachment
    • Check templateDoc reference for risksheet.json
    • Use built-in default if not found

​
Template Document Requirements

For a valid RISKSHEET template document:
RequirementDescriptionRequired
Document TypeMust be a Polarion LiveDoc documentYes
Folder LocationAccessible path in Polarion folder structureYes
Configuration Filerisksheet.json attachment (optional)No
Initial StructureCan be empty or pre-configured with sample rowsNo
PermissionsUser must have read access to template documentYes
If your template document has risksheet.json attached, new documents created from this template will automatically inherit that configuration. This is the recommended way to distribute standard configurations across your organization.

​
Path Format Specifications

​
Local Template Path (Single Project)

Folder/DocumentName
Example: 
Risks/Risk Specification
Assessments/FMEA Analysis
Compliance/Safety Review
Folder names and document names are case-sensitive and must match exactly in Polarion.

​
Cross-Project Template Path (Global)

ProjectId:Folder/DocumentName
Example: 
GlobalLibrary:Risks/Risk Specification
TemplateRepo:FMEA/Standard FMEA
SharedAssets:Compliance/Risk Framework
The ProjectId must be a valid Polarion project ID. Folder and document names within that project must be exact matches.
PropertyPurposeExamples
nextedy.risksheet.templateDocCustom field for linking documents to templatesUsed internally by RISKSHEET
nextedy.risksheet.suggestTextFieldsEnable autocomplete in text fieldstrue or false
nextedy.risksheet.autoCreateDocumentAuto-create documents on page loadtrue or false
nextedy.risksheet.defaultTemplatePathDefault template if none specifiedRisks/Default Template

​
Common Configuration Scenarios

​
Scenario 1: Single Standard Template

All users create risk documents from one standard template: 
nextedy.risksheet.risksheetTemplatePath=Standards/Risk Assessment

​
Scenario 2: Multiple Local Templates

Users can choose between different templates in the same project: 
nextedy.risksheet.risksheetTemplatePath=Templates/Basic FMEA,Templates/Detailed FMEA,Templates/HARA

​
Scenario 3: Global Corporate Standard

All projects use templates from a centralized template library: 
nextedy.risksheet.risksheetTemplatePath=RiskTemplateLibrary:Assets/FMEA,RiskTemplateLibrary:Assets/HARA,RiskTemplateLibrary:Assets/Basic Risk

​
Scenario 4: Project-Specific with Global Fallback

Use project-specific templates when available, fall back to global: 
nextedy.risksheet.risksheetTemplatePath=LocalTemplates/FMEA,GlobalLibrary:Standards/FMEA,GlobalLibrary:Standards/Default

​
Document Creation User Experience

When accessing the RISKSHEET home page and creating a new document: diagram

​
Troubleshooting Template Path Issues

IssueCauseSolution
”No templates available”Path not configured or invalidVerify nextedy.risksheet.risksheetTemplatePath in project properties
”Template not found”Folder or document name doesn’t existCheck exact spelling and case in Polarion
”Access denied”No read permission to templateGrant read access to the template document
”Cross-project template fails”ProjectId incorrect or doesn’t existVerify ProjectId format: ProjectId:Folder/Document
”Configuration not loaded”risksheet.json not attached to templateAttach configuration file to template document

​
Validation Rules

  • Template paths are validated when set. Invalid paths show an error in project administration
  • Empty or null paths default to "Risks/Risk Specification"
  • Folder and document names are case-sensitive
  • Special characters in folder or document names should be URL-encoded
Users creating documents must have:
  • Read access to the template document
  • Write access to the target folder
  • RISKSHEET usage permission (if configured)
KB ArticlesSource Code
  • AppConfig.ts
  • DocumentConfigProvider.java
  • ShowConfigurationCommand.ts
  • PdfExportConfigurationService.java
  • AppConfigParser.ts