Skip to main content

​
Prerequisites

  • Polarion administrator access to set project administration properties
  • An existing Risksheet document to branch from
  • Familiarity with Polarion document branching
1

Enable Branching Support

Branching support is controlled at the project administration level, not in the sheet configuration. Navigate to Administration > Nextedy Risksheet > Setup and add the following project administration property:
The property name uses lowercase n in nextedy.risksheet.branchingSupport. The value is case-sensitive — using an uppercase N or incorrect casing will silently fail to enable branching support.
2

Branch a Document

  1. Open the source LiveDoc containing your risk analysis in Polarion.
  2. Use Polarion’s standard branching mechanism to create a branch of the document.
  3. Open the branched document in Risksheet.
After branching, risk items from the source document appear as referenced work items in the branched document. These items display in read-only mode by default.
diagram
3

Enable Editing of Referenced Work Items (Optional)

If you need users to edit referenced items in branched documents without overwriting them, set the following project administration property (available since v23.3.3):
editableReferencedWorkItems is a project administration property configured under Administration > Nextedy Risksheet > Setup (v23.3.3+). It is NOT a property of the sheet configuration. Setting it inside the sheet configuration has no effect — the engine reads it only from project administration.
When this property is enabled, referenced work items in branched documents become directly editable in the grid without requiring an overwrite operation. Verify the behavior in your Risksheet version before relying on it for production workflows, as changes may propagate to the source document depending on configuration.
4

Overwrite Referenced Items

To create a local copy of a referenced risk item in your branched document:
  1. Right-click the referenced row in the Risksheet grid.
  2. Select Overwrite Row Item from the context menu.
  3. The item changes from reference mode to overwrite mode, becoming fully editable.
When you overwrite an upstream work item in a branched document, all existing links are removed except the “is branched from” relationship. If your workflow requires preserving traceability links, you may need a custom script to restore backlinks after overwriting.
5

Handle Document Queries

When branching support is enabled, Risksheet automatically adjusts its data queries to use the document.id parameter. This ensures that only work items belonging to the current branched document are displayed.
If the Risksheet view does not display expected items after a branching operation, clear the Polarion cache. Branching operations may require a cache refresh for the updated document structure to be recognized.
If your Risksheet shows no data after branching, verify that nextedy.risksheet.branchingSupport is set to true in the project administration. This property is required for document.id-based queries to populate data correctly. Without it, the grid may appear empty in branched documents.

​
Variant Management with Branches

For projects that need release-based filtering across branches, Risksheet supports the assignedReleases document custom field to filter downstream items by release version. This is useful in variant projects where you maintain separate branches per product release.
The release filtering is currently hardcoded for the multiEnum release field. Assign only one release per document for reliable filtering. Multi-release filtering within a single document view is not yet available.
For detailed variant management configuration, see Configure Variant Management.

​
refreshOnSave Interaction

When using branched documents with the sheet configuration property refreshOnSave set to false, be aware of two behaviors:
  • A “Discard changes” popup may appear when navigating away, even though changes were saved successfully. This is a known side effect of the non-refresh mode.
  • The overwrite context menu option requires refreshOnSave to be enabled (the default). If you have disabled it, the overwrite option will not appear.

​
Known Limitations

​
Verification

You should now see referenced items from the source document displayed in read-only mode when you open a branched Risksheet document. Verify that:
  • Referenced items appear with read-only styling in the grid
  • Right-clicking a referenced item shows the Overwrite Row Item option
  • Overwriting an item converts it to an editable local copy
  • The “is branched from” link is preserved after overwriting

​
See Also

Last modified on July 10, 2026