> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nextedy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Polarion Version Compatibility

> Nextedy RISKSHEET is a Siemens Polarion ALM server plugin that requires specific Polarion versions to function correctly.

export const LastReviewed = ({date}) => {
  if (!date) return null;
  const formatted = new Date(`${date}T00:00:00Z`).toLocaleDateString("en-US", {
    year: "numeric",
    month: "long",
    day: "numeric",
    timeZone: "UTC"
  });
  return <p className="mt-10 text-sm text-gray-400 dark:text-zinc-500 not-prose">
      Last reviewed on {formatted}
    </p>;
};

## Supported Polarion Versions

<Info title="Verify in application">
  Exact minimum and maximum Polarion version requirements may vary by Risksheet release. Always check the release notes for your specific Risksheet version before upgrading Polarion.
</Info>

| Risksheet Version | Minimum Polarion Version | Key Changes                                                                                                                              |
| ----------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| 24.7.0+           | Polarion 2310            | Suppresses harmless `UnsupportedOperationException` for `renderingLayouts` document field rendering                                      |
| 24.7.2            | Polarion 2310            | Additional bug fix release; recommended over 24.7.0                                                                                      |
| 24.11.0           | Polarion 2310+           | Fixes for `backLink` parameter, baseline comparison, and comparison features                                                             |
| 25.2.0            | Polarion 2310+           | `readOnly` exception for title columns: allows creating new items in otherwise read-only title columns                                   |
| 25.3.1            | Polarion 2310+           | Dependent enums introduced as a column-level feature                                                                                     |
| 25.4.0            | Polarion 2310+           | Dependent multi-enums extend dependent-enum behavior to multi-value enum columns                                                         |
| 25.5.0            | Polarion 2310+           | Sheet configuration editor with YAML editing, syntax highlighting, error detection, and edit history; `refreshOnSave` option in `global` |
| 25.11.0+          | Polarion 2310+           | License group change: `nextedy_powersheet_users` replaces `nextedy_risksheet_users` when Powersheet is also installed                    |
| 26.1.0            | Polarion 2310+           | License flow improvements, Powersheet license alignment                                                                                  |

## Version-Specific Behavior

Risksheet is a generic risk-analysis tool that supports any methodology (FMEA, HARA, TARA, STRIDE, CVSS, and others). The following behavior notes describe capabilities introduced in specific Risksheet releases. Use the version badges below to confirm the minimum Risksheet release required for each feature.

### **v25.2.0+** — `readOnly` exception for title columns

Before v25.2.0, columns marked `readOnly: true` blocked all user input, including creation of new linked work items in title columns. From v25.2.0 onward, title columns honor a `readOnly` exception that allows users to **create new items** inline even when the column is otherwise read-only. Existing values remain non-editable; only inline creation is enabled.

This behavior applies to columns that act as the primary title/identifier of a linked item (typically `itemLink` or `multiItemLink` columns bound to a `title` field).

### **v25.3.1+** — Dependent enums (column-level)

Dependent enums are a **column-level** feature. They are configured on individual columns, not as a top-level configuration section. When a column's value depends on another column's value (for example, an ASIL level that depends on a severity rating), Risksheet filters the available enum options based on the value selected in the source column.

Dependent enums are defined by referencing Polarion enumerations and configuring the dependency on the column. The underlying enumerations themselves are defined in Polarion Administration (Administration → Enumerations).

### **v25.4.0+** — Dependent multi-enums

Dependent multi-enums extend the v25.3.1 dependent-enum mechanism to columns of type `multiEnum:<enumId>`. Users can select multiple values from a filtered set that depends on another column's value.

This is also a column-level feature — there is no top-level `relations` section in the sheet configuration.

### **v25.5.0+** — Sheet configuration editor and `refreshOnSave`

From v25.5.0, Risksheet includes an integrated **sheet configuration editor** with YAML editing support. The editor provides:

* YAML syntax highlighting for the sheet configuration
* Error detection while editing
* Edit history with version comparison

The underlying configuration is still stored as a JSON attachment on the Polarion document; the editor surfaces YAML for readability.

v25.5.0 also introduces the `refreshOnSave` option in the `global` section of the sheet configuration. When enabled, the grid refreshes automatically after each save operation, ensuring downstream calculations and decorators reflect the latest data immediately.

```yaml theme={null}
global:
  refreshOnSave: true
```

## Version Compatibility Architecture

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/yWl5nA2D0IzEnZC1/risksheet/diagrams/reference/compatibility/polarion-versions/diagram-1.svg?fit=max&auto=format&n=yWl5nA2D0IzEnZC1&q=85&s=a91b527d689a8171850dea8142bc43ec" alt="diagram" style={{ maxWidth: "700px", width: "100%" }} width="700" height="310" data-path="risksheet/diagrams/reference/compatibility/polarion-versions/diagram-1.svg" />
</Frame>

## Known Compatibility Issues by Polarion Version

### Polarion 2310

<Warning title="Document field rendering exception (non-functional)">
  Upgrading to Polarion 2310 causes an `UnsupportedOperationException` in server logs when the system attempts to render document fields like `renderingLayouts`. This error has **no functional impact** on Risksheet operations. The system skips failed fields and continues normally.
</Warning>

**Symptoms:**

* `java.lang.UnsupportedOperationException` in Polarion server logs during Risksheet loading
* Error message references the `renderingLayouts` document field
* No visible impact on Risksheet functionality, grid rendering, or data operations
* Error appears each time a Risksheet document is opened

**Resolution:** Update Risksheet to version 24.7.0 or later, which suppresses the document field rendering error. Version 24.7.2 is recommended as it also includes an unrelated bug fix.

**Affected versions:** Risksheet versions prior to 24.7.0 running on Polarion 2310.

### Polarion 2410

<Warning title="Query parsing errors after upgrade">
  After upgrading Polarion to 2410 and updating Risksheet plugins, users may encounter unparseable query errors that prevent access to LiveDoc documents. These errors frequently originate from Polarion's Auto Assignment feature with invalid inputs, not from Risksheet itself.
</Warning>

**Symptoms:**

* Unparseable query errors preventing access to LiveDoc documents (particularly in demo projects)
* Stack traces referencing data service interceptors and Nextedy components
* Errors appearing in server logs that mention Risksheet hooks even though the root cause is Polarion configuration

**Root cause:** Polarion's Auto Assignment feature may contain invalid field references or user assignments that produce malformed Lucene queries. Risksheet data service hooks appear in the stack trace because they intercept data service calls, but they are not the source of the error.

**Resolution:**

1. Investigate Polarion configuration first, particularly **Administration > Work Items > Auto Assignment**
2. Verify that all Auto Assignment rules contain valid field references and user assignments
3. Check that custom queries in the sheet configuration use valid Lucene syntax compatible with Polarion 2410
4. Update Risksheet to the latest version compatible with Polarion 2410

<Tip title="Data service interceptor stack traces are misleading">
  Risksheet components such as data service hooks appear in error stack traces for **any** data service exception, even when Risksheet is not the cause. Always examine the actual error message and the originating query text to determine the true source of the problem.
</Tip>

## Runtime Configuration Properties

The following properties are loaded from the Polarion runtime context and reflect version and environment information. These values are available in the browser via the `window.risksheet` object:

| Property            | Type      | Default         | Description                                                                                                                             |
| ------------------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `version`           | `string`  | See application | Full version string of the Risksheet application including build metadata                                                               |
| `shortVersion`      | `string`  | See application | Shortened version identifier without build metadata for display purposes                                                                |
| `baseUrl`           | `string`  | See application | Base URL for the Risksheet application, used to construct data service endpoints and navigation URLs                                    |
| `projectId`         | `string`  | See application | Polarion project identifier used in API endpoints and URL construction                                                                  |
| `revision`          | `string`  | `""` (empty)    | Document revision identifier. Empty string indicates current/head revision; non-empty value forces read-only mode automatically         |
| `currentRevision`   | `string`  | See application | The latest revision number of the document, used to determine if viewing current or historical version                                  |
| `canAdmin`          | `boolean` | `false`         | Permission flag indicating whether the current user has administrative privileges to modify configuration                               |
| `settings.readonly` | `boolean` | `false`         | Controls whether the grid allows editing. Automatically set to `true` when viewing historical revisions (when `revision` is non-empty). |

## Configuration Source Tracking

The configuration loading system tracks where each sheet configuration was loaded from, which is essential for debugging after version upgrades:

| Property        | Type     | Default                               | Description                                                            |
| --------------- | -------- | ------------------------------------- | ---------------------------------------------------------------------- |
| `configPath`    | `string` | None                                  | URI path to the configuration attachment that was actually loaded      |
| `configEditUrl` | `string` | `${baseUrl}/risksheet/configuration/` | URL to the sheet configuration editor interface                        |
| `documentUrl`   | `string` | Constructed                           | Direct URL to the source Polarion document in the standard Polarion UI |

## Project-Level Properties

These project-level settings are managed through Polarion administration and interact with version compatibility:

| Property                  | Default                    | Description                                                                                |
| ------------------------- | -------------------------- | ------------------------------------------------------------------------------------------ |
| Template path             | `Risks/Risk Specification` | Default document template path. Multiple paths can be comma-separated.                     |
| Tool name                 | `Risksheet`                | Display name for the tool in the Polarion navigation UI                                    |
| Document name (singular)  | `Risk Analysis`            | Singular form of the document type label                                                   |
| Document names (plural)   | `Risk Analyses`            | Plural form of the document type label                                                     |
| Auto-suspect disabled     | `false`                    | When `true`, changes made through Risksheet do not trigger suspect link marking            |
| Suggester fuzzy search    | `true`                     | Enables approximate matching in the item suggester                                         |
| Suggester wildcard search | `true`                     | Enables wildcard characters (`*` and `?`) in item search                                   |
| Suggester result limit    | `20`                       | Maximum number of suggestions shown when searching for items to link                       |
| Admin check bypass        | `false`                    | Setting `nextedy.risksheet.disable_admin_check=true` bypasses admin permission requirement |

## Upgrade Procedure

### Pre-Upgrade Checklist

| Step | Action                 | Details                                                                                                                                                           |
| ---- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1    | Check release notes    | Review both Polarion and Risksheet release notes for version compatibility                                                                                        |
| 2    | Back up configurations | Save all sheet configurations, top panel configurations (`risksheetTopPanel.vm`), PDF export configurations (`risksheetPdfExport.vm`), and project-level settings |
| 3    | Test in staging        | Deploy the upgrade to a non-production environment first                                                                                                          |
| 4    | Verify custom queries  | Test that custom Lucene queries in the sheet configuration parse correctly on the new Polarion version                                                            |
| 5    | Check license groups   | For upgrades to **v25.11.0+**, verify user group assignments (see License Group Changes below)                                                                    |

### Upgrade Steps

1. **Download the new Risksheet version** from the Nextedy website
2. **Stop the Polarion server**
3. **Delete the previous plugin version** from the `Extensions` folder -- do not copy the new version over the old one
4. **Copy the new plugin version** into the `Extensions` folder (only one version folder per product should exist)
5. **Delete the cache directory** at `[POLARION_INSTALL]/data/workspace/.config` to clear plugin caches
6. **Start the Polarion server**
7. **Verify installation** by checking the Risksheet Setup and License pages in Polarion Administration

<Warning title="Delete the old plugin version first">
  A common update mistake is copying the new plugin folder over the old one, resulting in two plugin versions in the `Extensions` directory. This causes the Risksheet menu to disappear from the Polarion navigation. Always delete the old version folder before copying the new one.
</Warning>

<Warning title="Clear the .config cache directory">
  After installing or updating Risksheet, you **must** delete `[POLARION_INSTALL]/data/workspace/.config` to clear plugin caches. Failure to do so causes empty Setup and License pages in the Polarion administration interface.
</Warning>

### Post-Upgrade Verification

After upgrading, verify the following:

1. Risksheet menu appears in the Polarion navigation panel for all projects
2. Existing Risksheet documents open without errors
3. The Setup page in Administration shows the correct version number
4. The License page shows valid license status with the expected number of named users
5. Server logs are free of unexpected exceptions (the `renderingLayouts` exception is harmless on versions prior to 24.7.0)
6. Custom Velocity templates (top panel configuration, PDF export configuration) render correctly
7. On **v25.5.0+**, open the sheet configuration editor and confirm YAML editing, syntax highlighting, and history work as expected

<Tip title="Always test updates in a non-production environment">
  Risksheet releases can occasionally be pulled back due to discovered regressions. Always deploy updates to a staging or test environment before production to verify compatibility with your specific configuration and workflows.
</Tip>

## License Group Changes in Major Upgrades

### **v25.11.0+** with Powersheet Installed

When both Risksheet and Nextedy POWERSHEET are installed with production licenses, Risksheet v25.11.0 and later reads user assignments from the `nextedy_powersheet_users` group instead of `nextedy_risksheet_users`. This license unification change can cause all Risksheet licenses to appear inactive after upgrading.

**Symptoms after upgrading to v25.11.0+ or v26.1.0:**

* License page shows 0 named users configured
* All Risksheet licenses appear inactive
* Users cannot access Risksheet despite being in the `nextedy_risksheet_users` group

**Resolution:**

1. Create a `nextedy_powersheet_users` group in Polarion
2. Add all users from the `nextedy_risksheet_users` group to `nextedy_powersheet_users`
3. Verify the License page shows the correct number of named users

| Risksheet Version | License Group (Risksheet only) | License Group (with Powersheet) |
| ----------------- | ------------------------------ | ------------------------------- |
| Pre-25.11.0       | `nextedy_risksheet_users`      | `nextedy_risksheet_users`       |
| 25.11.0+          | `nextedy_risksheet_users`      | `nextedy_powersheet_users`      |

## Template Installation After Upgrade

After upgrading Risksheet, you may need to reinstall project templates to get updated defaults. Nextedy provides solution templates for typical methodologies across industries; pick the closest one to your process and modify it rather than starting from a blank configuration.

| Template                 | Description                                                                                |
| ------------------------ | ------------------------------------------------------------------------------------------ |
| `risksheet_template`     | Standard Risksheet project template for FMEA (Failure Mode and Effects Analysis) workflows |
| `risksheet_templateHara` | HARA (Hazard Analysis and Risk Assessment) project template for ISO 26262 hazard analysis  |

Template installation is available via `POST /admin/setup` or through the Administration interface. The system detects existing templates and removes them before installing fresh versions.

## URL Patterns

Risksheet URLs include version and project context:

```
# Document view
https://polarion.example.com/polarion/risksheet/view?project=MyProject&document=Risks/FMEA

# Historical revision (read-only)
https://polarion.example.com/polarion/risksheet/view?project=MyProject&document=Risks/FMEA&revision=123

# Configuration editor
https://polarion.example.com/polarion/risksheet/configuration/?project=MyProject&document=Risks/FMEA&type=sheet
```

## See Also

* [Browser Compatibility](/risksheet/reference/compatibility/browser-compatibility) -- supported browsers and known issues
* [Polarion License Types](/risksheet/reference/compatibility/license-types) -- supported Polarion license types
* [Configuration Properties Index](/risksheet/reference/configuration/properties-index) -- complete configuration reference

<LastReviewed date="2026-06-29" />