Polarion document ID or location path to display (e.g., Safety/FMEA-2024, DOCID-12345). When omitted, shows the document where the widget is embedded. For remote documents, use projectId!documentLocation format.
projectId
string
No
Current project
Polarion project identifier containing the target document. Required only if displaying a document from a different project.
documentLocation
string
No
(from documentId)
Alternative way to specify document using folder path (e.g., Risks/Risk Specification). Use either documentId or documentLocation, not both.
Specific document revision identifier to display. When specified, the RISKSHEET automatically enters read-only mode. Example: v2.1, rev-2024-01-15. Leave empty for the latest version.
comparingTo
string
No
(none)
Revision ID to compare against the main revision. When specified, enables side-by-side baseline comparison showing which items changed between revisions.
Forces the RISKSHEET into read-only mode regardless of user permissions or revision. Useful for embedded views where editing should be prevented.
configPath
string
No
(auto-resolved)
Path to a custom risksheet.json configuration file. If omitted, the system searches: document attachment → document template → global configuration. Use this to override the default configuration resolution.
configScope
string
No
document
Scope for loading configuration: document (use document config), template (use template config), or global (use global configuration only). Controls which level of the configuration hierarchy to use.
Comma-separated list of column IDs to initially hide. Users can unhide these columns through the column visibility menu. Example: severity,occurrence,detection
visibleColumns
string
No
(all)
Comma-separated list of column IDs to show. When specified, all other columns are hidden by default. Opposite of hiddenColumns.
initialSort
string
No
(from config)
Column ID to sort by on initial load, with optional ~ prefix for descending order. Example: ~severity (descending), dueDate (ascending).
pageSize
number
No
25
Number of rows to display per page when pagination is enabled. Valid values: 10, 25, 50, 100.
Defers loading the RISKSHEET until the widget becomes visible. Improves initial page load performance on pages with multiple widgets.
enableCache
boolean
No
true
Caches RISKSHEET data in the browser. When false, all data is fetched fresh from the server on each load.
refreshInterval
number
No
0 (disabled)
Milliseconds between automatic data refresh from server. Use for live data views. Example: 30000 (refresh every 30 seconds). When 0, no automatic refresh occurs.
debugMode
boolean
No
false
Enables diagnostic logging and performance metrics in the browser console.
Column visibility settings (not shared across page refreshes unless persisted)
Sort order and filter state
Scroll position
Expanded/collapsed hierarchy levels
Current selection
Widget state is session-based and lost when the Polarion session ends or the page is closed. To persist view preferences, configure them as widget parameters rather than relying on user-selected settings.
When displaying documents from different projects, ensure the user has appropriate read (or edit) permissions in the source project. The projectId parameter identifies the project context; permissions are still validated by Polarion.
