Configuration Properties Index - Nextedy Documentation

Configuration Property Map

Top-Level Properties

Name	Type	Default	Description
`columns`	`array`	`[]`	Defines the columns displayed in the grid including bindings, types, headers, and rendering properties
`dataTypes`	`object`	`{}`	Configures risk and task data types including query factories, work item types, roles, and menu visibility
`readonly`	`boolean`	`false`	Makes the entire Risksheet read-only, preventing any user edits to grid cells or structure
`levels`	`array`	`[]`	Defines hierarchical levels with control columns for expand/collapse and zoom navigation
`headers`	`object`	`{}`	Configures row header width/renderer and column header heights for grid layout customization
`formulas`	`object`	`{}`	Named formula definitions referenced by column `formula` properties for calculated columns
`styles`	`object`	`{}`	Named CSS style definitions for conditional cell formatting based on data values
`cellDecorators`	`object`	`{}`	Maps column IDs to conditional formatting logic that applies styles based on cell values
`enums`	`object`	`{}`	Defines enumeration options for `enum` and `multiEnum` column types with `id`, `name`, `description`, and `icon`
`ratings`	`object`	`{}`	Defines rating enumerations specifically for risk assessment scales (identical structure to `enums`)
`relations`	`array`	`[]`	Defines relationships between enumerations for dependent enum behavior and cascading selections
`views`	`array`	`[]`	Defines saved column visibility presets allowing users to switch between different column sets
`global`	`object`	`{}`	Global settings including culture/locale, help URL, refresh behavior, and menu organization
`reviews`	`object`	`{}`	Configures review workflow integration with `reviewManager` specification for approval processes
`sortBy`	`array`	`[]`	Defines default sort order by specifying column IDs in priority sequence; prefix with `~` for descending
`downstreamReadonly`	`boolean`	`false`	Makes downstream linked items read-only to prevent edits to items from other documents
`reviewer`	`boolean`	`false`	Enables reviewer mode which restricts editing and shows review-specific UI controls
`source`	`string`	`null`	Path to configuration source file (document or template). Read-only, set automatically
`templateName`	`string`	`null`	Name of template when configuration is loaded from a global template

Column Properties (`columns[]`)

Name	Type	Default	Description
`id`	`string`	Auto-generated from header or binding	Unique identifier for the column. Must be unique across the entire configuration
`type`	`string`	Auto-detected from binding	Data type: `string`, `int`, `float`, `enum`, `multiEnum`, `workflow`, `itemLink`, `taskLink`, `multiItemLink`, `boolean`, `date`, `datetime`, `time`, `currency`, `duration`, `rating`, `ref`, `text`
`binding`	`string`	Same as `id`	Polarion field name this column maps to
`header`	`string`	See application	Display text shown in the column header
`level`	`number`	`1`	Hierarchical level at which this column appears (1 = top level). Not set for task columns
`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`)
`filterable`	`boolean`	`true`	Controls whether users can filter the grid by values in this column
`canCreate`	`boolean`	`true`	For `itemLink` and `multiItemLink` 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
`collapseTo`	`string`	None	Column ID to collapse this column into when the 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 for column data (date format, number format)
`cellRenderer`	`string`	None	Name of a custom cell renderer function for this column
`cellCss`	`string`	None	CSS class name(s) to apply to cells in this column
`headerGroupCss`	`string`	None	CSS class name(s) to apply to the header group row

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

Data Type Properties (`dataTypes`)

Risk Item Configuration (`dataTypes.risk`)

Name	Type	Default	Description
`type`	`string`	None	Work item type for risk items. Supports dynamic values via expression evaluation
`role`	`string`	None	Link role used when creating relationships to risk items
`removeStrategy`	`string`	`delete`	Strategy for removing risk items: `delete` permanently removes the item
`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	Work item type for task/mitigation items. Supports dynamic values via expression evaluation
`role`	`string`	None	Link role used when creating relationships to task items
`showInMenu`	`boolean`	`true`	Controls whether task creation options appear in menus

Level Properties (`levels[]`)

Name	Type	Default	Description
`showInMenu`	`boolean`	`true`	Controls whether the level is displayed in the menu navigation
`controlColumn`	`string`	`systemItemId`	Specifies which column controls navigation and hierarchy for this level

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

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: `CommentBased`, `WorkItemBased`, or `ApprovalBased`

Polarion Administration Configuration Properties

These properties are set in Polarion 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.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.branchingSupport`	`boolean`	`false`	Enables support for Polarion branched documents and referenced work items
`nextedy.risksheet.upstreamChains`	`string`	None	Automatic upstream chain building. Format: `fromType-linkRole-toType` (e.g., `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+)

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.

Complete Example

{
  "columns": [
    {
      "id": "severity",
      "header": "Severity",
      "type": "rating:severity_scale",
      "level": 1,
      "filterable": true,
      "headerTooltip": "Rate the severity of the potential failure effect (1-10)"
    },
    {
      "id": "occurrence",
      "header": "Occurrence",
      "type": "rating:occurrence_scale",
      "level": 1
    },
    {
      "id": "rpn",
      "header": "RPN",
      "formula": "commonRpn",
      "level": 1
    }
  ],
  "dataTypes": {
    "risk": {
      "type": "failureMode",
      "role": "has_parent",
      "removeStrategy": "delete"
    },
    "task": {
      "type": "mitigationAction",
      "role": "mitigates",
      "showInMenu": true
    }
  },
  "levels": [
    { "showInMenu": true, "controlColumn": "systemItemId" }
  ],
  "formulas": {
    "commonRpn": "function(info){ var value = info.item['occ']*info.item['det']*info.item['sev']; return value?value:null;}"
  },
  "global": {
    "culture": "en"
  },
  "sortBy": ["severity"],
  "readonly": false
}

​Configuration Property Map

​Top-Level Properties

​Column Properties (columns[])

​Data Type Properties (dataTypes)

​Risk Item Configuration (dataTypes.risk)

​Task/Mitigation Configuration (dataTypes.task)

​Level Properties (levels[])

​Global Settings (global)

​Header Properties (headers)

​Review Properties (reviews)

​Polarion Administration Configuration Properties

​Complete Example

​See Also

Configuration Property Map

Top-Level Properties

Column Properties (`columns[]`)

Data Type Properties (`dataTypes`)

Risk Item Configuration (`dataTypes.risk`)

Task/Mitigation Configuration (`dataTypes.task`)

Level Properties (`levels[]`)

Global Settings (`global`)

Header Properties (`headers`)

Review Properties (`reviews`)

Polarion Administration Configuration Properties

Complete Example

See Also