Plans Widget Parameters

This page has thin source coverage. The plans widget parameters documented below are derived from configuration management and servlet code. Additional widget-specific parameters may be available in your Risksheet version. Consult your Polarion administrator or the configuration editor for the complete parameter list.

The plans widget renders Risksheet within a Polarion plans page context. It uses the same underlying sheet configuration as the standard Risksheet view but accepts additional URL and widget parameters to control the rendering context. The sheet configuration file (risksheet.json) defines the columns, levels, formulas, and styles applied to the grid; the configuration editor supports YAML editing of this file since v25.5.0.

Context Parameters

These parameters establish the project and document context for the Risksheet instance within the plans widget.

Parameter	Type	Default	Description
`projectId`	`string`	See application	The Polarion project identifier that contains the Risksheet document. Passed as a query parameter to establish project context for data loading and API calls.
`document.id`	`string`	See application	The unique identifier of the Risksheet document within the Polarion project. Specifies which document’s sheet configuration and data should be rendered in the widget.
`revision`	`string`	`""` (empty = current)	Document revision identifier. An empty string indicates the current/head revision. When a non-empty revision is provided, the grid automatically enters read-only mode to prevent edits to historical document states.

When revision is set to a non-empty value, the Risksheet grid is forced into read-only mode regardless of the readonly configuration property. This is a safety mechanism to prevent modifications to historical document states.

Configuration Editor Parameters

When the configuration editor is opened from the plans widget context, the following parameters are passed to the editor URL.

Parameter	Type	Default	Description
`configEditUrl`	`string`	`${baseUrl}/risksheet/configuration/`	Base URL for the Risksheet configuration editor interface. The system appends `projectId`, `document.id`, and `type` as query parameters when opening the editor window.
`type`	`string`	See application	The type of configuration to edit (e.g., `columns`, `settings`, `levels`). Determines which configuration editor panel or section is displayed when the editor window opens.

Opening the Configuration Editor

The configuration editor opens in a new browser window. The final URL combines the base URL with context parameters:

${configEditUrl}?project=${projectId}&document=${document.id}&type=${type}

Ensure your browser allows pop-up windows from your Polarion server domain. The configuration editor opens as a new browser window and will be blocked if pop-ups are disabled. See Browser Compatibility for browser configuration guidance.

Sheet Configuration Properties

The following sheet configuration sections affect how the plans widget renders the Risksheet grid. These are set in the sheet configuration and are loaded when the widget initializes.

Display Properties

Property	Type	Default	Description
`columns`	`array`	`[]`	Defines the columns displayed in the Risksheet grid including their `bindings`, types, headers, and rendering properties. The plans widget renders the same column set as the standard view.
`headers`	`object`	`{}`	Configures row header width/renderer and column header heights for grid layout customization.
`headers.rowHeader.renderer`	`string`	See application	Custom renderer function for row headers (e.g., `rowHeaderRpnNew` for risk-priority-based coloring).
`headers.columnHeader.height`	`number`	`32`	Height in pixels for column headers.
`headers.columnGroupHeader.height`	`number`	`32`	Height in pixels for column group headers when columns are organized into groups.
`levels`	`array`	`[]`	Defines hierarchical levels in the Risksheet with control columns for expand/collapse and zoom navigation.
`views`	`array`	`[]`	Defines saved views — named column visibility presets allowing users to switch between different column sets within the plans widget.
`sortBy`	`array`	`[]`	Defines default sort order by specifying column IDs in priority sequence.

Permission Properties

Property	Type	Default	Description
`readonly`	`boolean`	`false`	Makes the entire Risksheet read-only. When set to `true`, the grid prevents all user edits. Automatically forced to `true` when viewing historical revisions.
`downstreamReadonly`	`boolean`	`false`	Makes downstream linked items read-only, preventing edits to items from other documents while allowing edits to primary risk items.

Data Source Properties

Property	Type	Default	Description
`dataTypes`	`object`	`{}`	Configures risk and task data types including work item types, link roles, document scoping, and menu visibility. The plans widget uses the same data type configuration as the standard view.
`formulas`	`object`	`{}`	Named JavaScript formula functions referenced by column `formula` properties for calculated columns.

Rating scales (severity, occurrence, detection) and enumerations are not defined inside the sheet configuration. They live in Polarion Administration → Enumerations. A column references them by setting its type to rating:<enumId>, enum:<enumId>, or multiEnum:<enumId> and pointing bindings at the corresponding custom field on the risk work item type. Dependent enumerations are a column-level feature (v25.3.1+), configured on the individual column rather than as a top-level configuration section.

Styling Properties

Property	Type	Default	Description
`styles`	`object`	`{}`	Named CSS class definitions for conditional cell formatting. Styles defined here apply to cells rendered within the plans widget.
`cellDecorators`	`object`	`{}`	Maps column IDs to JavaScript functions (cell decorators) that toggle style classes on cells based on cell values.

Runtime Properties (Server-Managed)

The following properties appear on the runtime configuration object delivered to the browser, but they are set by the server at runtime based on the current user, license, and document context. Do not include them in your sheet configuration — values supplied by the configuration file are ignored or overwritten.

Property	Type	Description
`canAdmin`	`boolean`	Server-injected. Indicates whether the current user has administrative privileges for editing the sheet configuration. Controls access to the configuration editor from within the plans widget.
`reviewer`	`boolean`	Server-injected. Indicates that the current user is acting in a reviewer role, restricting editing to review-specific UI controls while blocking data modifications.
`source`	`string`	Server-injected. Path indicating which configuration source (document attachment or template) the runtime configuration was loaded from. Used for trace/diagnostic purposes.
`templateName`	`string`	Server-injected. Name of the template the configuration was inherited from, when the configuration is loaded from a global template rather than a document-specific attachment.

URL Construction

The plans widget constructs several URLs from the context parameters to access Risksheet services:

Data Service URL

${baseUrl}/risksheet/data/${projectId}/${documentId}?revision=${revision}

Fetches the work item data for the grid. When revision is empty, returns current data. When set, returns data from the specified historical revision.

Document URL

${baseUrl}/wiki/${projectId}/${documentId}

Direct URL to the source Polarion LiveDoc document. Used for the “Open in Polarion” navigation action.

${baseUrl}/risksheet/view/${projectId}/${documentId}?revision=${revision}&comparingTo=${comparingTo}

Constructs the URL for navigating to the full Risksheet view from within the plans widget. The comparingTo parameter is added when baseline comparison is active.

The exact URL patterns may vary based on your Polarion server configuration and Risksheet version. The patterns above are derived from the URL template functions in the configuration parser.

The plans widget communicates with the following server endpoints:

Endpoint	Method	Description
`/api/config`	GET	Loads the full runtime configuration object including formulas, styles, cell decorators, and query factories
`/api/document`	GET	Returns document metadata including version, revision, license status, permissions, and configuration
`/api/panel`	GET	Renders the customizable top panel HTML via Velocity template
`/api/keepalive`	GET	Session heartbeat to prevent Polarion session timeout during long editing sessions
`/api/pdfscript`	GET	Generates PDF export scripts when export is triggered from within the plans widget
`/config/update`	POST	Saves sheet configuration changes when editing from the configuration editor

Session Keep-Alive

The keep-alive endpoint sends periodic HTTP 200 responses to maintain the Polarion session during extended risk analysis sessions within the plans widget. This prevents automatic logout when users spend significant time reviewing or editing risk data.

Version and License Information

The plans widget displays version and license information from the document metadata API:

Property	Type	Description
`version`	`string`	Full Risksheet version string including build metadata
`shortVersion`	`string`	Shortened version identifier for display purposes
`currentRevision`	`string`	Latest revision number of the document, used to determine if viewing current or historical version

Complete Example

Risksheet is a generic tool supporting any risk management methodology (FMEA, HARA, TARA, STRIDE, CVSS); the minimal sheet configuration below uses a Risk Priority Number (RPN) calculation typical of Failure Mode and Effects Analysis (FMEA), but the same structure applies to other methodologies. Start from the closest solution template for your industry rather than from a blank configuration.

readonly: false
columns:
  - id: systemItemId
    header: ID
    width: 80
    readOnly: true
  - id: title
    header: Title
    bindings: title
    width: 250
  - id: sev
    header: Severity
    bindings: severityRating
    type: rating:severity
    width: 100
  - id: occ
    header: Occurrence
    bindings: occurrenceRating
    type: rating:occurrence
    width: 100
  - id: rpn
    header: RPN
    formula: commonRpn
    width: 80
formulas:
  commonRpn: "function(info){ var value = info.item['occ']*info.item['sev']; return value?value:null; }"
styles:
  .rpn1: "{background-color: #eaf5e9 !important; color: #1d5f20 !important;}"
  .rpn2: "{background-color: #fff3d2 !important; color: #735602 !important;}"
  .rpn3: "{background-color: #f8eae7 !important; color: #ab1c00 !important;}"
cellDecorators:
  rpn: "function(info){ var val = info.value; $(info.cell).toggleClass('rpn1', val>0 && val<=150); $(info.cell).toggleClass('rpn2', val>150 && val<=250); $(info.cell).toggleClass('rpn3', val>250); }"
headers:
  columnHeader:
    height: 32
global:
  culture: en

The RPN thresholds used in cellDecorators (150, 250) are deployment-specific — adjust them to match your organization’s risk acceptance criteria.

Work Items Widget Parameters — parameters for the work items widget embedding
Sheet Configuration Format — complete sheet configuration format reference
Configuration Properties Index — alphabetical listing of all configuration properties
Default Configuration Values — default values for all properties
Template Path Configuration — how templates provide widget configuration
Browser Compatibility — browser requirements for the configuration editor pop-up

Widget Overview

Context Parameters

Configuration Editor Parameters

Opening the Configuration Editor

Sheet Configuration Properties

Display Properties

Permission Properties

Data Source Properties

Styling Properties

Runtime Properties (Server-Managed)

URL Construction

Data Service URL

Document URL

Risksheet Navigation URL

API Endpoints Used by the Plans Widget

Session Keep-Alive

Version and License Information

Complete Example

​Widget Overview

​Context Parameters

​Configuration Editor Parameters

​Opening the Configuration Editor

​Sheet Configuration Properties

​Display Properties

​Permission Properties

​Data Source Properties

​Styling Properties

​Runtime Properties (Server-Managed)

​URL Construction

​Data Service URL

​Document URL

​Risksheet Navigation URL

​API Endpoints Used by the Plans Widget

​Session Keep-Alive

​Version and License Information

​Complete Example

​Related Pages

Widget Overview

Context Parameters

Configuration Editor Parameters

Opening the Configuration Editor

Sheet Configuration Properties

Display Properties

Permission Properties

Data Source Properties

Styling Properties

Runtime Properties (Server-Managed)

URL Construction

Data Service URL

Document URL

Risksheet Navigation URL

API Endpoints Used by the Plans Widget

Session Keep-Alive

Version and License Information

Complete Example

Related Pages