Configuration Properties Index - Nextedy Documentation

Risksheet is a generic risk analysis tool supporting any methodology, including FMEA, HARA, TARA, STRIDE, and CVSS. The sheet configuration is editable via a YAML editor (v25.5.0+) with syntax highlighting and error detection.

Configuration Property Map

Top-Level Sections

The sheet configuration has the following verified top-level sections:

Name	Type	Default	Description
`global`	`object`	`{}`	Global settings including culture/locale, help URL, refresh behavior, and menu organization
`columns`	`array`	`[]`	Column definitions including bindings, types, headers, formulas, and rendering properties
`levels`	`array`	`[]`	Visual hierarchy level definitions used for cell merging based on control columns
`dataTypes`	`object`	`{}`	Risk and task work item type configuration including link roles and document scoping
`formulas`	`object`	`{}`	Named JavaScript formula functions referenced by column `formula` properties
`styles`	`object`	`{}`	Named CSS class definitions referenced by `cellDecorators`
`cellDecorators`	`object`	`{}`	Maps column IDs to conditional formatting logic that applies styles based on cell values
`headers`	`object`	`{}`	Row header width/renderer and column header heights for grid layout customization
`reviews`	`object`	`{}`	Configures review workflow integration with `reviewManager` specification
`sortBy`	`array`	`[]`	Default sort order by column IDs in priority sequence; prefix with `~` for descending
`views`	`array`	`[]`	Saved column visibility presets allowing users to switch between different column sets
`queryFactories`	`object`	`{}`	Named Lucene query functions for itemLink autocomplete filtering (advanced)

Risksheet does not define rating scales or enumerations in the sheet configuration. They are defined as Polarion enumerations under Administration > Enumerations and referenced from columns via type: rating:<enumId>, type: enum:<enumId>, or type: multiEnum:<enumId>. The server loads enum values automatically. Dependent enumerations are a column-level feature (v25.3.1+), not a top-level section.

Global Settings (`global`)

Name	Type	Default	Description
`culture`	`string`	`en`	Culture/locale for the interface, affecting date formats, number formats, and localization. See Culture and Localization Codes
`help`	`string`	Nextedy support portal URL	Custom help documentation URL opened via the Help button
`addAsSubmenu`	`boolean`	`false`	When `true`, Risksheet menu items are added as a submenu under the document menu instead of inline
`refreshOnSave`	`boolean`	`false`	When `true`, automatically refreshes the sheet after each save to reflect server-side changes

Column Properties (`columns[]`)

Name	Type	Default	Description
`id`	`string`	Auto-generated from header or bindings	Unique identifier for the column. Must be unique across the entire configuration
`type`	`string`	Auto-detected from bindings	Data type: `string`, `int`, `float`, `enum:<enumId>`, `multiEnum:<enumId>`, `itemLink`, `taskLink`, `multiItemLink`, `boolean`, `date`, `datetime`, `time`, `currency`, `duration`, `rating:<enumId>`, `ref:user`, `text`. Rating and enum types must be parameterized with the Polarion enumeration ID (e.g. `rating:severity`); a bare `rating` or `enum` is invalid. User-reference columns use `ref:user` — a bare `ref` breaks grid loading
`bindings`	`string`	Same as `id`	Polarion field ID this column maps to. Supports patterns: `fieldId` (direct field), `linkedItem.fieldId` (linked item field, read-only display), `linkedItem.$item` (entire linked item for Velocity access)
`header`	`string`	See application	Display text shown in the column header
`level`	`number`	`1`	Visual hierarchy level for cell merging. 1-indexed: `level: 1` maps to `levels[0]`. An unleveled risk-item column defaults to level 1 and merges into the first level. Downstream/task columns are a separate axis and are not leveled
`readOnly`	`boolean`	`false`	Controls whether the column is editable. Auto-set to `true` for formula columns, server-rendered columns, reference columns, and certain system fields (`author`, `resolution`, `created`, `updated`, `type`). Upstream columns default to `true`
`filterable`	`boolean`	`true`	Controls whether users can filter the grid by values in this column
`canCreate`	`boolean`	`true`	For `itemLink`, `multiItemLink`, and `taskLink` columns, controls whether users can create new linked items directly from the cell
`formula`	`string`	None	Client-side JavaScript formula for calculated columns. When set, column becomes read-only by default
`serverRender`	`string`	None	Server-side Velocity rendering script. When set, column becomes `text` type and read-only automatically
`headerTooltip`	`string`	None	Tooltip text displayed when hovering over the column header
`headerGroup`	`string`	None	Name of the header group this column belongs to for multi-level headers
`headerGroupTooltip`	`string`	None	Tooltip text displayed when hovering over the header group label
`collapseTo`	`boolean`	`false`	When `true`, this column remains visible when its header group is collapsed
`width`	`number`	See application	Column width in pixels
`minWidth`	`number`	See application	Minimum width in pixels that the column can be resized to
`format`	`string`	See application	Display format string. Numeric patterns: `n` (number), `f` (fixed), `g` (general), `d` (decimal), `x` (hex), `c` (currency), `p*` (percentage). Date patterns: `d`, `D`, `f`, `F`, `t`, `T`
`cellRenderer`	`string`	None	Name of a cell decorator function (defined in the `cellDecorators` section) that conditionally toggles CSS classes per cell
`cellCss`	`string`	None	Static CSS class applied to every cell in the column (defined in the `styles` block). Distinct from `cellRenderer`: `cellCss` is unconditional, while `cellRenderer` names a `cellDecorators` function that toggles classes per cell
`headerCss`	`string`	None	CSS class name(s) to apply to the column header
`headerGroupCss`	`string`	None	CSS class name(s) to apply to the header group row
`showEnumDescription`	`boolean`	`false`	For enum/multiEnum columns, when `true` displays the enumeration option’s description text alongside the name
`typeProperties`	`object`	None	Sub-properties for `itemLink`, `multiItemLink`, and `taskLink` columns. See below

Column id values must be unique across the entire sheet configuration. Duplicate IDs will break the sheet structure silently without an error message.

Type Properties for Link Columns (`columns[].typeProperties`)

Sub-properties available on itemLink, multiItemLink, and taskLink columns:

Name	Type	Default	Description
`linkRole`	`string`	None	Link role name connecting items
`linkTypes`	`string`	None	Comma-separated work item type IDs (string, not array)
`linkDirection`	`string`	None	Set to `back` for reverse link traversal
`backLink`	`boolean`	`false`	Enables back-link rendering for reverse-direction linking
`itemTemplate`	`string`	None	Velocity template for custom item display in autocomplete and cells
`queryFactory`	`string`	None	Reference to a named function in the top-level `queryFactories` section
`createInCurrentDocument`	`boolean`	`false`	When `true`, new items are created in the current document
`createInDocument`	`string`	None	Document path where new items are created (v24.8.1+)
`document`	`string`	None	Document path scoping autocomplete to items from a specific document (library pattern)
`project`	`string`	None	Project ID(s) for cross-project autocomplete. Supports `$projectId` runtime variable and space-separated multiple project IDs

Level Properties (`levels[]`)

Every level entry has three required properties:

Name	Type	Default	Description
`name`	`string`	None	Display name shown in the navigation and zoom menu (for example, “Item”, “Failure mode”)
`controlColumn`	`string`	None	Column ID used as the grouping key for cell merging. Consecutive rows sharing the same value in this column have their level cells merged
`zoomColumn`	`string`	None	Column ID used as the target for zoom and drill-down navigation

Data Type Properties (`dataTypes`)

Risk Item Configuration (`dataTypes.risk`)

Name	Type	Default	Description
`type`	`string`	None	Polarion work item type ID for risk items
`role`	`string`	None	Link role used when creating relationships to risk items
`removeStrategy`	`string`	`delete`	Strategy for removing risk items. Values: `delete` (permanently delete), `rejected` (move to rejected status, filterable), `recycle_bin` (move to hidden recycle bin), `hide` (item remains but filtered out; v23.7.7+)
`rejectedAction`	`string`	`reject`	Workflow action to execute when a risk item is rejected during review
`rejectedStatus`	`string`	`rejected`	Status value to set when a risk item is rejected
`rejectedResolution`	`string`	`invalid`	Resolution value to set when a risk item is rejected

Task/Mitigation Configuration (`dataTypes.task`)

Name	Type	Default	Description
`type`	`string`	None	Polarion work item type ID for task items. Since v25.3.1: comma-separated for multiple types
`role`	`string`	None	Link role connecting risk to task (for example, `mitigates`)
`name`	`string`	None	Display name shown in toolbar and menus (for example, “Task”, “Safety Requirement”)
`zoomColumn`	`string`	None	Column ID used for zoom navigation after task creation
`document`	`string`	None	Restricts tasks to a specific LiveDoc path (for example, `Risks/FHA-SYS-001`)
`project`	`string`	None	Single project ID for task items
`projects`	`array`	None	Array of project IDs for multi-project task scoping (v23.7.0+)
`query`	`string`	None	Lucene query for additional task filtering
`createInCurrentDocument`	`boolean`	`false`	When `true`, new tasks are created in the current document
`createInDocument`	`string`	None	Target document path for new task creation (v24.8.1+)
`canCreate`	`boolean`	`true`	When `false`, globally disables task creation across all task link columns. Users can only link to existing items
`linkToRisksheet`	`boolean`	`false`	When `true`, the task link column becomes a clickable hyperlink to a downstream risksheet document specified by `document`, enabling subsheet navigation

Header Properties (`headers`)

Name	Type	Default	Description
`rowHeader.renderer`	`string`	See application	Custom renderer function for row headers
`columnHeader.height`	`number`	`32`	Height in pixels for column headers
`columnGroupHeader.height`	`number`	`32`	Height in pixels for column group headers

Review Properties (`reviews`)

Name	Type	Default	Description
`reviewManager`	`string`	See application	Review workflow type. Values: `CommentBased`, `WorkItemBased`, or `ApprovalBased`

Risksheet approval review creates approval-tagged comments but does not trigger Polarion’s formal approval workflow (draft -> reviewed -> approved). For full ALM state transitions, use Polarion’s native document workflow.

Views Properties (`views[]`)

Saved column visibility presets that support staged risk assessment workflows. Each view entry has:

Name	Type	Default	Description
`name`	`string`	None	Display name in the view switcher
`columnIds`	`array`	`[]`	Array of column IDs to show. Supports the `@all` shorthand (include all columns) and the `-columnId` prefix (exclude a specific column from `@all`)
`defaultView`	`boolean`	`false`	When `true`, marks this view as the default loaded view (v24.1.0+)

Example:

views:
  - name: Full Analysis
    defaultView: true
    columnIds:
      - "@all"
  - name: Classification Summary
    columnIds:
      - function
      - failureCondTitle
      - classification
  - name: No Up/Down Risks
    columnIds:
      - "@all"
      - "-upstreamRisks"

Polarion Administration Configuration Properties

These properties are set in Administration > Configuration Properties at the project level using the nextedy.risksheet.* prefix.

Name	Type	Default	Description
`nextedy.risksheet.riskDocumentType`	`string`	See application	Document type(s) for risk documents. Multiple types use parentheses: `(type1 type2)`
`nextedy.risksheet.includeProjectBaselines`	`boolean`	`false`	Enables project baselines in baseline comparison (v24.2.0+)
`nextedy.risksheet.upstreamSubColumnsReadonly`	`boolean`	`true`	Makes sub-columns of upstream linked items read-only
`nextedy.risksheet.checkPrototypePermissions`	`boolean`	`true`	Enforces Polarion prototype-level permissions when reading and writing work items
`nextedy.risksheet.editableReferencedWorkItems`	`boolean`	`false`	Allows editing of referenced work items from other documents (v23.3.3+). Set at the project administration level
`nextedy.risksheet.checkInstanceFieldPermissions`	`boolean`	`false`	Enforces instance-level field permissions during sheet operations
`nextedy.risksheet.downstreamFromRevision`	`boolean`	`false`	Loads downstream items based on the document’s pinned revision
`nextedy.risksheet.branchingSupport`	`boolean`	`false`	Enables support for Polarion branched documents and referenced work items
`nextedy.risksheet.checkLinkRoleCompliance`	`boolean`	`false`	Enables multiple link roles from risk for item link columns (v24.2.2+). Backward-incompatible change
`nextedy.risksheet.isSearchAllFieldsWhenSearchingLinkedItems`	`boolean`	`false`	Enables searching through all fields when searching linked items (v24.3.0+)
`nextedy.risksheet.upstreamChains`	`string`	None	Automatic upstream chain building. Format: `fromType-linkRole-toType` (for example, `harm-relatesTo-situation`). Only builds chains, never deletes links
`nextedy.risksheet.disable_admin_check`	`boolean`	`false`	Bypasses admin permission requirement for configuration access
`nextedy.risksheet.moduleOnlyPermissions`	`boolean`	`false`	Speeds up loading for large sheets by using module-only permissions (v24.8.5+)
`nextedy.risksheet.loadTasksFromDocument`	`boolean`	`false`	Restricts task loading to the current document only (v23.8.3+)
`nextedy.risksheet.risksheetTemplatePath`	`string`	`Risks/Risk Specification`	Path to the global risksheet template. Supports `PROJECTID:TEMPLATE_PATH` format (for example, `GlobalLibrary:Risks/Risk Specification`)
`nextedy.risksheet.isSuggesterFuzzySearching`	`boolean`	`true`	Enables fuzzy matching in autocomplete suggesters
`nextedy.risksheet.isSuggesterWildcardSearching`	`boolean`	`true`	Enables wildcard matching in autocomplete suggesters
`nextedy.risksheet.isSuggesterKeywordsMandatory`	`boolean`	`false`	When `true`, requires all keywords to match in suggester results

When specifying multiple document types, enclose them in parentheses with space separation: nextedy.risksheet.riskDocumentType=(riskAnalysis URRA). Omitting parentheses causes only the first type to be recognized.

Runtime Properties (Server-Managed)

The following properties may appear in a loaded sheet configuration but are set by the server at runtime and are not user-configurable. They are listed here for reference only.

Name	Type	Description
`canAdmin`	`boolean`	Set by the server based on the current user’s administrative permissions
`reviewer`	`boolean`	Set by the server to indicate whether the current user is acting as a reviewer
`source`	`string`	Path to the configuration source (document or template). Populated automatically by the server
`templateName`	`string`	Name of the template when configuration is loaded from a global template. Populated automatically by the server

Do not set these properties manually in the sheet configuration — they will be overwritten on load.

Complete Example

global:
  culture: en
columns:
  - id: severity
    header: Severity
    type: rating:severity_scale
    bindings: severityRating
    level: 1
    filterable: true
    headerTooltip: Rate the severity of the potential failure effect (1-10)
  - id: occurrence
    header: Occurrence
    type: rating:occurrence_scale
    bindings: occurrenceRating
    level: 1
  - id: rpn
    header: RPN
    formula: commonRpn
    level: 1
dataTypes:
  risk:
    type: failureMode
    role: has_parent
    removeStrategy: delete
  task:
    type: mitigationAction
    role: mitigates
    name: Mitigation
    zoomColumn: taskTitle
levels:
  - name: Item
    controlColumn: item
    zoomColumn: item
formulas:
  commonRpn: "function(info){ var value = info.item['occ']*info.item['det']*info.item['sev']; return value?value:null;}"
sortBy:
  - severity
views:
  - name: Full Analysis
    defaultView: true
    columnIds:
      - "@all"

​Configuration Property Map

​Top-Level Sections

​Global Settings (global)

​Column Properties (columns[])

​Type Properties for Link Columns (columns[].typeProperties)

​Level Properties (levels[])

​Data Type Properties (dataTypes)

​Risk Item Configuration (dataTypes.risk)

​Task/Mitigation Configuration (dataTypes.task)

​Header Properties (headers)

​Review Properties (reviews)

​Views Properties (views[])

​Polarion Administration Configuration Properties

​Runtime Properties (Server-Managed)

​Complete Example

​See Also

Configuration Property Map

Top-Level Sections

Global Settings (`global`)

Column Properties (`columns[]`)

Type Properties for Link Columns (`columns[].typeProperties`)

Level Properties (`levels[]`)

Data Type Properties (`dataTypes`)

Risk Item Configuration (`dataTypes.risk`)

Task/Mitigation Configuration (`dataTypes.task`)

Header Properties (`headers`)

Review Properties (`reviews`)

Views Properties (`views[]`)

Polarion Administration Configuration Properties

Runtime Properties (Server-Managed)

Complete Example

See Also