Skip to main content

​
URL Patterns

Risksheet uses several distinct URL patterns for different views and operations. diagram

​
Main View Parameters

These parameters control the primary Risksheet grid view.
ParameterTypeRequiredDefaultDescription
projectstringYes---Polarion project identifier. Scopes the Risksheet to a specific project context. Must match a valid Polarion project ID (e.g., AutoSafety, MedDevice).
documentstringYes---Path to the risk document within the project, relative to the project’s document root (e.g., Risks/FMEA-BrakingSystem, Design/HARA-SteeringControl).
revisionstringNo"" (empty = current/head)Document revision identifier. When empty or absent, opens the current (head) revision with full editing capability. When set to a non-empty value, forces the sheet into read-only mode regardless of other permission settings.
comparingTostringNo---Baseline revision for comparison mode. When present, activates the comparison view showing differences between the current document state and the specified baseline revision. Removed from the URL when comparison is cancelled.

​
Example: Main View URLs

# Open current revision (editable)
https://polarion.example.com/polarion/risksheet/view?project=AutoSafety&document=Risks/FMEA-Braking

# Open specific revision (read-only)
https://polarion.example.com/polarion/risksheet/view?project=AutoSafety&document=Risks/FMEA-Braking&revision=156

# Open with comparison mode active
https://polarion.example.com/polarion/risksheet/view?project=AutoSafety&document=Risks/FMEA-Braking&comparingTo=42

# Open specific revision while comparing to baseline
https://polarion.example.com/polarion/risksheet/view?project=AutoSafety&document=Risks/FMEA-Braking&revision=200&comparingTo=42
Any non-empty revision parameter value forces the entire Risksheet into read-only mode. The readonly configuration property in risksheet.json is automatically overridden to true when viewing a historical revision. This prevents accidental edits to historical document snapshots.

​
Revision Parameters

​
revision

AttributeValue
Typestring
RequiredNo
Default"" (empty string = current/head revision)
Effect when setForces readonly = true on the entire Risksheet
The revision parameter accepts:
  • Empty string or absent: Opens the current (head) revision with normal editing permissions
  • Numeric revision ID: Opens the specific historical revision in read-only mode
  • "head" keyword: Opens the latest revision (used programmatically when navigating between revisions)
When a user opens a revision through the Risksheet UI (via the revision picker or baseline selector), the application constructs the URL with the appropriate revision value and optionally opens it in a new browser window.

​
comparingTo

AttributeValue
Typestring
RequiredNo
Default--- (not present = normal mode)
Effect when setActivates comparison mode with visual diff highlights
When comparison mode is active:
  • Added items appear highlighted with “added” indicators
  • Removed items appear as ghost rows (placeholder rows for items that existed in the baseline but not in the current revision)
  • Modified cells are individually highlighted with before/after tooltips
  • The Show Unchanged toggle controls whether unchanged items remain visible
  • Downstream task changes are tracked separately from master risk item changes
When comparison mode is cancelled:
  1. The comparingTo parameter is removed from the URL
  2. Ghost items (placeholder rows) are cleared from the grid
  3. The original sort order is restored
  4. Comparison-specific CSS classes are removed
  5. The grid refreshes to normal view
Comparison URL management works in both standalone browser windows and iframe contexts (when Risksheet is embedded in a LiveDoc page). In iframe mode, the parent page URL is not affected.

​
Configuration Editor Parameters

The configuration editor opens in a separate browser window and uses its own URL pattern.
ParameterTypeRequiredDefaultDescription
projectstringYes---Polarion project identifier providing project context for configuration lookup.
documentstringYes---Unique identifier of the Risksheet document whose configuration to edit.
typestringNo---Configuration editor panel to display. Determines which section of the configuration editor opens initially.

​
Configuration Editor URL Pattern

https://<server>/polarion/risksheet/configuration/?project=<projectId>&document=<documentId>&type=<editType>

​
Example: Configuration Editor URLs

# Open configuration editor (default panel)
https://polarion.example.com/polarion/risksheet/configuration/?project=AutoSafety&document=Risks/FMEA-Braking

# Open columns configuration panel
https://polarion.example.com/polarion/risksheet/configuration/?project=AutoSafety&document=Risks/FMEA-Braking&type=columns

# Open settings panel
https://polarion.example.com/polarion/risksheet/configuration/?project=AutoSafety&document=Risks/FMEA-Braking&type=settings

# Open levels configuration panel
https://polarion.example.com/polarion/risksheet/configuration/?project=AutoSafety&document=Risks/FMEA-Braking&type=levels
The exact set of valid type parameter values depends on the Risksheet version and the configuration editor’s available panels. Test specific type values in your environment.
Risksheet registers itself in Polarion’s project navigation sidebar. The sidebar link uses a simplified URL pattern without a document parameter: 
/polarion/risksheet/view?project=<projectId>
ParameterTypeRequiredDescription
projectstringYesPolarion project identifier. When no document is specified, Risksheet shows the project’s default document selection view.
The navigation label displayed in the sidebar is configurable via project properties and supports rebranding (e.g., displaying “Risksheet”, “POWERSHEET”, or a custom name).

​
Data Service URL

Risksheet constructs data service URLs internally to fetch grid data from the server. These URLs are not user-facing but are documented here for troubleshooting and integration purposes.
ComponentSourceDescription
baseUrlRuntime context (risksheet.baseUrl)Base URL for the Risksheet application
projectIdRuntime context (risksheet.projectId)Polarion project identifier
documentIdDocument metadataThe document being viewed
revisionURL parameter or runtime contextOptional revision for historical views
The data service URL is constructed from a template function that accepts these parameters and returns the fully qualified endpoint path.

​
Polarion Document URL

Risksheet provides a link back to the source Polarion wiki document. This URL is constructed from the baseUrl, projectId, and documentId: 
https://<server>/polarion/#/project/<projectId>/wiki/<documentPath>
This link opens the document in Polarion’s standard LiveDoc interface, outside of the Risksheet grid view.

​
Runtime Context Properties

These properties are available in the Risksheet runtime context and influence URL construction. They are set automatically and cannot be configured via URL parameters.
PropertyTypeSourceDescription
baseUrlstringServer configurationBase URL for the Risksheet application
projectIdstringURL project parameterPolarion project identifier
revisionstringURL revision parameterCurrent revision (empty = head)
currentRevisionstringServer responseLatest revision number of the document
versionstringApplication buildFull Risksheet version string including build metadata
shortVersionstringApplication buildShortened version without build metadata
canAdminbooleanServer-side permission checkWhether the current user has admin privileges

​
URL Encoding

Risksheet automatically URL-encodes parameter values when constructing URLs programmatically. This includes:
  • Document paths containing spaces or special characters
  • Baseline names with special characters (when creating baselines)
  • Revision identifiers
You do not need to manually encode parameter values when constructing URLs in browser address bars --- the browser handles standard encoding. However, when building Risksheet URLs programmatically (e.g., in Velocity templates or custom scripts), ensure all parameter values are properly URL-encoded.

​
Complete Example

Typical URL patterns for an automotive FMEA project across different workflows: 
# 1. Open RISKSHEET for a document (normal editing)
https://polarion.example.com/polarion/risksheet/view?project=AutoSafety&document=Risks/FMEA-Braking

# 2. View historical revision 156 (read-only)
https://polarion.example.com/polarion/risksheet/view?project=AutoSafety&document=Risks/FMEA-Braking&revision=156

# 3. Compare current state against baseline revision 42
https://polarion.example.com/polarion/risksheet/view?project=AutoSafety&document=Risks/FMEA-Braking&comparingTo=42

# 4. Compare revision 200 against baseline revision 42
https://polarion.example.com/polarion/risksheet/view?project=AutoSafety&document=Risks/FMEA-Braking&revision=200&comparingTo=42

# 5. Open configuration editor for column layout
https://polarion.example.com/polarion/risksheet/configuration/?project=AutoSafety&document=Risks/FMEA-Braking&type=columns

# 6. Navigate to source Polarion document
https://polarion.example.com/polarion/#/project/AutoSafety/wiki/Risks/FMEA-Braking

# 7. Project-level RISKSHEET navigation (sidebar link)
https://polarion.example.com/polarion/risksheet/view?project=AutoSafety

​
Parameter Interaction Summary

CombinationBehavior
project + document onlyOpens current revision, fully editable (subject to permissions)
project + document + revisionOpens historical revision, forced read-only
project + document + comparingToOpens current revision with comparison mode active
project + document + revision + comparingToOpens historical revision (read-only) with comparison to baseline
project only (no document)Opens project-level document selection view
Source Code
  • ShowConfigurationCommand.ts
  • AppConfig.ts
  • AppConfigParser.ts
  • SheetConstants.ts
  • NewBaselineCommand.ts