Work Items Widget Parameters - Nextedy Documentation

Data Type Parameters

The dataTypes object configures the work item types used in the Risksheet grid. Each entry defines the Polarion work item type, link role, and behavior settings for a category of items.

`dataTypes` Property

Name	Type	Default	Description
`dataTypes`	`object`	`{}`	Configures risk and task data types including work item types, link roles, and menu visibility. Each key identifies a data type category (e.g., `risk`, `task`).

Risk Item Data Type

Name	Type	Default	Description
`dataTypes.risk.type`	`string`	None	Work item type identifier for risk items (e.g., `failureMode`, `hazard`, `riskItem`). Must match a work item type defined in the Polarion project. Supports dynamic expression evaluation from project properties.
`dataTypes.risk.role`	`string`	None	Link role used when creating relationships between risk items and parent structures. Defines the traceability relationship in Polarion’s link model.
`dataTypes.risk.removeStrategy`	`string`	`delete`	Strategy for removing risk items from the grid. Supported values: `delete` (permanently deletes the work item), `rejected` (moves to rejected status, filterable), `recycle_bin` (moves to hidden recycle bin), `hide` (item remains but is filtered out by rejectedStatus, v23.7.7+).
`dataTypes.risk.rejectedAction`	`string`	`reject`	Workflow action executed when a risk item is rejected during a review process. Must match a valid workflow action defined for the risk work item type.
`dataTypes.risk.rejectedStatus`	`string`	`rejected`	Status value applied to rejected risk items after the rejected workflow action executes.
`dataTypes.risk.rejectedResolution`	`string`	`invalid`	Resolution value applied to rejected risk items. Set alongside the rejected status during the rejection workflow.
`dataTypes.risk.showInMenu`	`boolean`	`true`	Controls whether the risk item creation option appears in the toolbar menu and context menu. Set to `false` to prevent users from creating new risk items directly in the grid.

Task/Mitigation Data Type

Name	Type	Default	Description
`dataTypes.task.type`	`string`	None	Work item type identifier for mitigation tasks (e.g., `mitigationAction`, `corrective_action`, `task`). Must match a work item type defined in the Polarion project. Since v25.3.1, supports a comma-separated list for multiple types.
`dataTypes.task.role`	`string`	None	Link role for connecting tasks to their parent risk items. Defines the mitigation relationship in Polarion’s link model.
`dataTypes.task.name`	`string`	`Task`	Display name for the task type shown in context menu labels (e.g., Open Task Item becomes Open Mitigation Action when set to `"Mitigation Action"`).
`dataTypes.task.zoomColumn`	`string`	None	Column ID that receives focus after a new task is created. Determines which column the cursor moves to when you add a task from the context menu.
`dataTypes.task.document`	`string`	None	Restricts tasks to a specific LiveDoc path (e.g., `Risks/FHA-SYS-001`).
`dataTypes.task.project`	`string`	None	Single project ID used to load task items.
`dataTypes.task.projects`	`array`	None	Array of project IDs for multi-project task loading (v23.7.0+).
`dataTypes.task.query`	`string`	None	Lucene query for additional task filtering.
`dataTypes.task.createInCurrentDocument`	`boolean`	`false`	When `true`, new tasks are created in the current document.
`dataTypes.task.createInDocument`	`string`	None	Target document path for new task creation (v24.8.1+).
`dataTypes.task.canCreate`	`boolean`	`true`	Global switch for task creation. When `false`, users cannot create new task items at all, only link to existing ones.
`dataTypes.task.linkToRisksheet`	`boolean`	`false`	When `true`, the task link column (RC ID) becomes a clickable hyperlink to the downstream risksheet document defined by `dataTypes.task.document`. Enables subsheet navigation.
`dataTypes.task.showInMenu`	`boolean`	`true`	Controls whether the task creation button appears in the toolbar menu and context menu. Set to `false` to hide the task creation option.

Set showInMenu: false on dataTypes.task or dataTypes.risk to remove the creation button from the toolbar and context menu. For item link columns, use canCreate: false to allow linking existing items only without creating new ones. The canCreate switch operates at two independent levels: globally via dataTypes.task.canCreate and per-column via the column-level canCreate property.

Task Column Identification

The task identifier column is the column whose type is taskLink (or, since v25.3.1, multiTaskLink). The grid uses this column to determine task presence, generate new task IDs, and group task rows under their parent risk items. It is central to task management features including context menu actions and multi-task insertion.

There is no top-level taskColumn key in risksheet.json. Adding taskColumn at the root of the sheet configuration has no effect — the engine silently ignores the unrecognized key. Identify the task column by giving it a taskLink column type instead, and connect the task work item type and link role through dataTypes.task.

When you create a new task, Risksheet automatically generates a unique task identifier. The ID is stored in both the task-link column’s binding and the companion _link field, which holds the reference to the linked Polarion work item.

Multi-Task Behavior

When adding tasks to risk items that already have tasks, Risksheet:

Clones the current record as a template for the new task
Clears task-level fields (task ID, link fields, readonly flags, and all columns marked as task attributes)
Initializes multi-enum columns to empty arrays (not null)
Generates a new unique task ID
Inserts the new row immediately after all sibling tasks with the same systemItemId

Sorting Parameters

`sortBy` Property

Name	Type	Default	Description
`sortBy`	`array`	`[]`	Array of column IDs defining the default sort order when the grid loads. Column IDs are listed in priority sequence — the first entry is the primary sort, the second is the secondary sort, and so on. Prefix a column ID with `~` (tilde) for descending sort.

Sort Order Examples

Ascending sort by severity:

sortBy:
  - severity

Descending sort by due date, then ascending by priority:

sortBy:
  - ~dueDate
  - priority

Sort by outline number to match LiveDoc order:

sortBy:
  - outlineNumberColumn

To sort Risksheet items by document outline number (matching the LiveDoc order), create a serverRender column that uses Velocity to extract and zero-pad outline number segments, then set that column’s ID as the sortBy parameter. Zero-padding ensures that 1.10 sorts after 1.2.

Sort Behavior by Column Type

Risksheet applies specialized sorting logic automatically based on the column type:

Column Type	Sort Logic	Details
`string`, text fields	Alphabetical	Standard string comparison
`int`, `float`, `rating`, `currency`	Numeric	Numeric comparison with proper handling of negative values and decimals
`enum`, `multiEnum`	By display name	Sorted by the enum option’s `name` property, not the `id`
`date`, `datetime`, `time`	Chronological	Date-aware comparison ensuring proper temporal ordering
`itemLink`, `taskLink`	Alphanumeric ID	Work item ID sort that handles the `PROJECT-NNN` format correctly (e.g., `PROJECT-2` sorts before `PROJECT-10`)
`multiItemLink`	Concatenated labels	Parses the array of linked items, concatenates all item labels, and sorts by the combined string. Unsaved items (prefixed with `*`) are sorted with their asterisk intact.
`outlineNumber` binding	Hierarchical	Hierarchical sort where `1.2` comes before `1.10`, maintaining document structure

All sorting, filtering, and pagination are performed client-side in the browser for immediate visual feedback without server round-trips. Data is loaded once from the server and manipulated entirely in the client.

Baseline Comparison Sorting

When comparing to a baseline, the sort system switches context to compare-to-link item values for all columns except systemItemId and systemItemRevision. This means sorting during baseline comparison operates on the baseline snapshot values rather than current values, except for system identity fields which always refer to the current item.

Read-Only Parameters

Grid-Level Read-Only

Name	Type	Default	Description
`readonly`	`boolean`	`false`	Makes the entire Risksheet grid read-only, preventing any user edits to grid cells or structure. Automatically set to `true` when viewing historical revisions (non-empty `revision` URL parameter).
`downstreamReadonly`	`boolean`	`false`	Makes downstream linked items (items from other documents) read-only. When `true`, prevents edits to downstream items and blocks task creation for items with downstream readonly state.

Auto-Applied Read-Only Rules

The system automatically sets read-only state for certain columns and conditions, independent of the readonly configuration:

Condition	Effect
System fields (`id`, `status`, `type`, `outlineNumber`)	Always read-only
Formula columns (column has `formula` property)	Automatically read-only — values are calculated, not entered
Server-rendered columns (column has `serverRender` property)	Read-only — content is generated server-side
Historical revisions (non-empty `revision` parameter)	Entire grid forced read-only
Permission-denied fields (`systemReadOnlyFields` array)	Listed fields locked per item
Task attributes on items without tasks	Read-only until a task is created

Column Parameters

Column Definition Properties

Name	Type	Default	Description
`columns`	`array`	`[]`	Array of column definitions that configure the Risksheet grid structure. Each entry defines a column’s binding, type, header, width, and behavior.

Key column properties relevant to widget behavior:

Name	Type	Default	Description
`id`	`string`	Required	Unique column identifier.
`header`	`string`	Required	Display text shown in the column header.
`bindings`	`string`	None	Polarion work item field ID the column reads and writes (e.g., `bindings: severityRating`). Supports the patterns `fieldId`, `linkedItem.fieldId`, and `linkedItem.$item`.
`width`	`number`	`undefined`	Column width in pixels.
`minWidth`	`number`	`undefined`	Minimum width in pixels during column resize.
`readOnly`	`boolean`	`undefined`	Whether the column cells can be edited by users.
`type`	`string`	`undefined`	Column type determining editor and display behavior. Values include `enum:id`, `rating:id`, `multiEnum:id`, `int`, `float`, `currency`, `boolean`, `datetime`, `date`, `time`, `itemLink`, `multiItemLink`, `taskLink`.
`formula`	`string`	`undefined`	Name of a formula function from the `formulas` object. Makes the column automatically read-only.
`cellRenderer`	`string`	`undefined`	Name of a function defined in the `cellDecorators` section used for custom cell rendering.
`cellCss`	`string`	`undefined`	Static CSS class applied to all cells in the column.
`headerCss`	`string`	`undefined`	CSS class applied to the column header.
`headerGroup`	`string`	`undefined`	Column group name for multi-level headers.
`collapseTo`	`boolean`	`false`	When `true`, this column remains visible when its header group is collapsed.

Text wrapping inside a cell is not a column-level boolean — control it via CSS classes referenced from cellCss and the styles section.

`typeProperties` for Link Columns

When a column uses an itemLink, multiItemLink, or taskLink type, the typeProperties object configures how the autocomplete picker resolves and creates linked items.

Property	Type	Description
`linkRole`	`string`	Link role name connecting the current work item to the linked item.
`linkTypes`	`string`	Comma-separated list of work item type IDs that the picker may suggest.
`linkDirection`	`string`	Use `back` to traverse links in the reverse direction.
`backLink`	`boolean`	Enables back-link rendering for the column.
`itemTemplate`	`string`	Velocity template for custom item display in the picker.
`queryFactory`	`string`	Reference to a named function in the `queryFactories` section for dynamic autocomplete filtering.

View Parameters

Name	Type	Default	Description
`views`	`array`	`[]`	Array of saved view presets defining column visibility configurations. Each view specifies which columns are visible, allowing users to switch between different analysis perspectives (e.g., “FMEA View”, “Mitigation View”, “Review View”).

See Saved Views for detailed view configuration reference.

Review Parameters

Name	Type	Default	Description
`reviews`	`object`	`{}`	Configures review workflow integration with review manager specification.
`reviews.reviewManager`	`string`	None	Review workflow mode. Determines how reviews are created and stored.

Review Manager Options

Value	Description
`CommentBased`	Reviews are created as Polarion comments attached to the work item. The first review mode checked — takes precedence if multiple modes are configured.
`ApprovalBased`	Reviews use Polarion’s native approval comment system. Comments are created with the fixed title `Approval comment`. Displays reviewer name, timestamp, and comment text.
`WorkItemBased`	Reviews are created as separate Polarion work items linked to the reviewed item. Requires additional configuration: `typeProperties.itemTypes` (work item type ID) and `typeProperties.linkRole` (link role ID). Optional `typeProperties` include `query`, `document`, `project`, and `itemTemplate`. Supports cross-project review creation.

Risksheet approval review creates approval-tagged comments but does not trigger Polarion’s formal approval state transitions (draft -> reviewed -> approved). It is a comment-based approval signal, not a workflow state change.

The review system adds two special column bindings to the grid:

Binding	Description
`reviewsRendered`	Displays review status and approval information formatted as HTML with the `risk_reviews` CSS class
`reviewsAdd`	Provides UI controls to create new reviews or approvals

Header Parameters

Name	Type	Default	Description
`headers`	`object`	`{}`	Configures row header width/renderer and column header heights for grid layout customization.
`headers.rowHeader.renderer`	`string`	None	Name of a cell decorator function applied to row headers (e.g., `rowHeaderRpnNew` for RPN-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).

Global Parameters

Name	Type	Default	Description
`global`	`object`	`{}`	Global Risksheet settings including culture/locale, help URL, refresh behavior, and menu organization.
`global.culture`	`string`	`en`	Culture/locale code for the Risksheet interface. Affects date formats, number formats, and localization. See Culture and Localization Codes.
`global.suggestTextFields`	`boolean`	`true`	Enables autocomplete suggestions for text fields, drawing on the server data access layer, local changes, and configured suggestion sources.

Session and Runtime Parameters

The following values are session and runtime context, set by the server when the grid loads. They are not user-configurable in the sheet configuration.

Parameter	Type	Description
`baseUrl`	`string`	Base URL for the Risksheet application, used to construct data service endpoints and navigation URLs. Resolved from the runtime context.
`projectId`	`string`	Polarion project identifier used in API endpoints and URL construction.
`revision`	`string`	Document revision identifier. Empty string indicates current/head revision. Non-empty value forces `readonly: true`.
`currentRevision`	`string`	Latest revision number of the document. Used to determine if viewing current or historical version.
`version`	`string`	Full version string of the Risksheet application including build metadata.
`shortVersion`	`string`	Shortened version identifier without build metadata for display purposes.
`configEditUrl`	`string`	URL to the Risksheet configuration editor interface (`{baseUrl}/risksheet/configuration/`).

Polarion Administration Parameters

These project-level properties in Polarion Administration affect Risksheet work item behavior. Configure them in the Polarion project settings, not in the sheet configuration.

Name	Type	Default	Description
`nextedy.risksheet.risksheetTemplatePath`	`string`	`Risks/Risk Specification`	Document template path(s) where risk documents can be created. Format `PROJECTID:TEMPLATE_PATH` (e.g., `GlobalLibrary:Risks/Risk Specification`). Supports multiple paths separated by commas.
`nextedy.risksheet.toolName`	`string`	`Risksheet`	Custom display name for the tool in the Polarion UI. Organizations can rebrand (e.g., `FMEA Tool`, `Risk Matrix`).
`nextedy.risksheet.documentNames`	`string`	`Risk Analyses`	Plural form of the document name shown in UI navigation.
`nextedy.risksheet.documentName`	`string`	`Risk Analysis`	Singular form of the document name shown in UI.
`nextedy.risksheet.branchingSupport`	`boolean`	`false`	Enables referenced work items from branched documents. Required for `document.id` queries.
`nextedy.risksheet.disableAutoSuspect`	`boolean`	`false`	Disables automatic suspect link marking when changes are made through Risksheet. When `true`, edits in Risksheet will not trigger suspect links.
`nextedy.risksheet.isSuggesterKeywordsMandatory`	`boolean`	`false`	Controls whether keywords are mandatory when using the suggester for finding and linking work items.
`nextedy.risksheet.isSuggesterFuzzySearching`	`boolean`	`true`	Enables fuzzy searching in the item suggester, allowing approximate matches for spelling variations.
`nextedy.risksheet.isSuggesterWildcardSearching`	`boolean`	`true`	Enables wildcard characters (`*` and `?`) when searching for items.
`nextedy.risksheet.checkLinkRoleCompliance`	`boolean`	`false`	Enables multiple link roles from risk items (v24.2.2+).

Deferred Commit Mode

Risksheet uses deferred commit mode for data persistence. Changes are batched in memory and sent to the server together when you click Save, rather than saving each edit immediately.

Behavior	Description
Batch editing	Multiple edits accumulate in the browser before persistence
Save operation	All pending changes are submitted to the server in a single transaction
New item handling	New items receive temporary `*`-prefixed IDs until saved. After save, IDs are replaced with permanent Polarion work item IDs.
Entity updates	After save, the grid replaces entity content in-place for both new items (by temporary ID) and existing items (by permanent ID)

All data is stored in Polarion work items — Risksheet does not maintain a separate data store. Edits flow through Polarion’s standard authorization and audit infrastructure.

Complete Example

dataTypes:
  risk:
    type: failureMode
    role: has_parent
    removeStrategy: delete
    rejectedAction: reject
    rejectedStatus: rejected
    rejectedResolution: invalid
    showInMenu: true
  task:
    type: mitigationAction
    role: mitigates
    name: Mitigation Action
    showInMenu: true
    zoomColumn: taskTitle
sortBy:
  - ~severity
  - title
readonly: false
downstreamReadonly: true
reviews:
  reviewManager: CommentBased
headers:
  rowHeader:
    renderer: rowHeaderRpnNew
  columnHeader:
    height: 32
  columnGroupHeader:
    height: 32
global:
  culture: en
  suggestTextFields: true
views: []
columns:
  - id: id
    header: ID
    width: 80
    readOnly: true
  - id: title
    header: Failure Mode
    bindings: title
    width: 200
  - id: sev
    header: S
    width: 60
    type: rating:severity
    bindings: severityRating
  - id: occ
    header: O
    width: 60
    type: rating:occurrence
    bindings: occurrenceRating
  - id: det
    header: D
    width: 60
    type: rating:detection
    bindings: detectionRating
  - id: rpn
    header: RPN
    width: 80
    formula: commonRpn
  - id: taskId
    header: Task
    width: 100
    type: taskLink
  - id: taskTitle
    header: Task Title
    bindings: task.title
    width: 200

Configuration Properties Index — complete property reference
Sheet Configuration Format — configuration file structure and syntax
Default Configuration Values — default values for all properties
Levels Configuration — hierarchy level setup for multi-level risk structures
Saved Views — column visibility presets
Query Syntax — query syntax for data filtering and query factories
Template Path Configuration — document template inheritance
System Fields — system-managed field reference

​Widget Parameter Overview

​Data Type Parameters

​dataTypes Property

​Risk Item Data Type

​Task/Mitigation Data Type

​Task Column Identification

​Multi-Task Behavior

​Sorting Parameters

​sortBy Property

​Sort Order Examples

​Sort Behavior by Column Type

​Baseline Comparison Sorting

​Read-Only Parameters

​Grid-Level Read-Only

​Auto-Applied Read-Only Rules

​Column Parameters

​Column Definition Properties

​typeProperties for Link Columns

​View Parameters

​Review Parameters

​Review Manager Options

​Header Parameters

​Global Parameters

​Session and Runtime Parameters

​Polarion Administration Parameters

​Deferred Commit Mode

​Complete Example

​Related Pages

Widget Parameter Overview

Data Type Parameters

`dataTypes` Property

Risk Item Data Type

Task/Mitigation Data Type

Task Column Identification

Multi-Task Behavior

Sorting Parameters

`sortBy` Property

Sort Order Examples

Sort Behavior by Column Type

Baseline Comparison Sorting

Read-Only Parameters

Grid-Level Read-Only

Auto-Applied Read-Only Rules

Column Parameters

Column Definition Properties

`typeProperties` for Link Columns

View Parameters

Review Parameters

Review Manager Options

Header Parameters

Global Parameters

Session and Runtime Parameters

Polarion Administration Parameters

Deferred Commit Mode

Complete Example

Related Pages