When working with the RiskSheet in Polarion, it’s important to understand how configuration settings can be applied — either to a single document or to all documents based on a shared template. Depending on your use case, you may want to apply changes locally (to the currently opened document) or globally (through the template it was derived from).
This article explains both approaches in detail, using either the built-in editor or document attachments.
TABLE OF CONTENTS
- Where to apply the changes
Where to apply the changes
There are 3 main Risksheet configuration files:
- risksheet.json
- risksheetTopPanel.vm
- risksheetPdfExport.vm
When applying any changes to any of these files, it is possible to decide how you'd like to configure them:
a) Configure the settings specifically for the opened document;
b) Configure the default settings per document template.
This article describes both options using built-in editor and documents attachments.
The following sample contains information for risksheetTopPanel, however, everything described below can be applied to all 3 files equally.
A) Configure the settings for the Opened Document
A1) Using the built-in editor
A1.1) If the document already has a specific configuration
If a document has its specific configuration, then, when opening the built-in editor, you'd be by default modifying a document-specific configuration.
The following lines help you identify what configuration you are currently editing.
All that needs to be done is to implement the desired configurations, save the changes, and check that the configuration of the specific document is updated.
A1.2) If the document's configuration is derived from the template
By default, if a document is created from the template and the config file is attached to the template, when opening the configuration from the built-in editor, you'll be modifying the template configuration.
However, you may need to override the template and edit the currently opened document configuration.
This is possible to achieve by choosing the 'Override Template' action from the built-in editor menu:
When doing so, you'd be prompted to confirm that you want to create a document-specific configuration.
Once confirmed, you'll be able to edit the document-specific configuration, which will no longer affect the template.
A2) Using the document attachments
- Open the live document
- Open the attachments panel
- Attach the configuration file to the document
- If it is already attached there, click the Overwrite button
- Save the document
B) Configure the settings for all the documents based on the same Template
B1) Using the built-in editor
B1.1) If the document's configuration is already derived from the template
By default, if a document is created from the template and the config file is attached to the template, then, when opening the configuration from the built-in editor, you'll be modifying the template configuration.
The following lines help you identify what configuration you are currently editing.
All that needs to be done is to implement the desired configurations, save the changes, and check that the configuration is now updated for all documents based on that template.
B1.2) If the document has a specific configuration
It might happen that the document has a specific configuration attached to it, but you no longer need this configuration. In this case, you want to revert it back to the template and modify the template configuration.
This is possible to achieve by choosing the 'Discard Override' action from the built-in editor menu.
When doing so, you'd be prompted to confirm that you want to discard the document-specific configuration.
Once confirmed, you'll be able to modify the template configuration, which will now also affect the opened document.
B2) Using the document attachments
- Open the live document
- Check that it is connected to a template:
- Open document properties
- The custom field (id:templateDoc) must point to the document template. Open the document template by clicking on the document icon (see picture)
iii. If such a document custom field does not exist, create one in Polarion administration
- Open document properties
- Attach the configuration document to the template document, by following chapter points 2-4 from chapter A) Configure Header for Opened Document
For any assistance, please don’t hesitate to reach out by submitting a ticket here.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article