When Risksheet opens a document, it resolves the configuration by searching for risksheet.json in this order:The resolution result includes metadata about where the configuration was found. This metadata is exposed through the configuration API and shown in the Risksheet UI to help administrators understand which configuration is active.
These properties track where the current configuration was loaded from. They are set automatically by the configuration loader and are read-only.
Property
Type
Default
Description
source
string
null
Path to the configuration source file (document or template) used to load the current Risksheet configuration.
templateName
string
null
Display name of the template document from which configuration was inherited. Includes the project name prefix if the template is from a different project. Empty when configuration is directly attached to the document.
fromTemplate
boolean
false
Flag indicating whether the configuration was loaded from a template document rather than the target document itself. Set to true when configuration is inherited from a template module.
configPath
string
None
URI path to the configuration attachment that was actually loaded, whether from the document itself or from a template. Useful for debugging configuration source tracking.
fileName
string
None
Path and name of the document where configuration was requested (not necessarily where it was found). Formatted as folder/documentTitle.
revision
string
None
Data revision identifier of the cached configuration attachment. Used internally for cache invalidation when attachment content changes.
When multiple paths are specified (comma-separated), the document creation wizard presents all available templates to the user. Each path points to a folder and template name combination.
Each path follows the format FolderName/TemplateName. The folder name determines where in the Polarion project structure new documents are created. The template name identifies which Polarion template module provides the initial document structure and default risksheet.json configuration.
The template path setting feeds into the document creation wizard accessible from the Risksheet home view. The wizard allows users to:
Browse available folders defined in the template path setting
Select a template from the configured options
Enter a document name
Create the document with the selected template’s default configuration
Validation Rule
Description
Folder required
The folder field cannot be empty. Validation rejects empty folder selections.
Template selection
When multiple template paths are configured, the user must select one.
Document name
A non-empty document name is required.
The document creation endpoint is POST /document/create. On success, the user is redirected to the new Risksheet document. On failure, an error message is displayed.
Risksheet provides a mechanism to detach a document’s configuration from its inherited template, creating a document-specific configuration:
Override Template: Creates local copies of configuration files (risksheet.json, risksheetPdfExport.vm, and other template attachments) directly on the document, detaching it from the global template.
Revert to Template: Removes the document-level configuration attachments and restores template inheritance. This discards all document-specific customizations.
Reverting a document back to template inheritance permanently discards any document-specific configuration changes. There is no undo for this operation. Consider backing up the document’s risksheet.json attachment before reverting.
Project-level settings control the behavior of the autocomplete suggester used in item link and task link columns. These settings apply globally to all Risksheet documents in the project.
Property
Type
Default
Description
nextedy.risksheet.suggester.keywordRequired
boolean
false
Controls whether keywords are mandatory when using the suggester feature for finding and linking work items. When true, users must provide keywords to search.
nextedy.risksheet.suggester.fuzzySearch
boolean
true
Enables or disables fuzzy searching in the item suggester. Fuzzy search allows approximate matches, helping users find items despite slight spelling variations or typos.
nextedy.risksheet.suggester.resultLimit
number
20
Maximum number of suggestions shown when searching for items to link. Higher values provide more options but may impact performance.
nextedy.risksheet.suggester.wildcardSearch
boolean
true
Enables or disables wildcard searching. When true, users can use wildcard characters (* and ?) when searching for items.
nextedy.risksheet.suggester.allFieldSearch
boolean
false
When enabled, searches all fields of linked items instead of just primary fields. Provides more comprehensive search results but may impact performance.
For large projects with thousands of work items, consider reducing resultLimit to 10 and disabling allFieldSearch to improve autocomplete responsiveness. Enable keywordRequired to force more targeted searches.
Disables automatic suspect link marking when changes are made through Risksheet. When true, edits in Risksheet do not trigger suspect links on linked work items. Useful for workflows where Risksheet edits should not invalidate existing links.
settings.global.help
string
https://go.nextedy.com/risksheet-support-portal
URL opened when users click the Help button. Override this to point to your organization’s internal documentation.
Risksheet caches configuration files for performance. The cache uses the attachment revision identifier to detect changes:
Behavior
Description
Cache key
Document path + configuration file name
Cache invalidation
Triggered when the attachment revision changes
Configuration update
Use Menu > Override Template or the configuration editor; changes take effect on page reload
If the configuration file cannot be read or parsed, Risksheet logs an error: "Error while reading configuration". Check the Polarion server logs for details. Common causes include malformed JSON syntax in risksheet.json or missing template attachments.
