Risksheet.json Format

ℹ️ Tip: The easiest way to manage configuration is through Menu > Configuration > Edit Risksheet Configuration, which provides visual editing with syntax highlighting and validation. Starting with version 25.5.0, the editor opens in a new tab, allowing you to view your Risksheet and its configuration side by side.

Configuration File Location

Nextedy RISKSHEET searches for risksheet.json in this order:

Priority	Configuration Source
1 (highest)	Document attachment — `risksheet.json` attached to the Risksheet document
2	Template attachment — `risksheet.json` attached to the template document
3 (fallback)	Built-in default — Fallback configuration if no file found

Load Order	Source	Precedence	Use Case
1st	Document attachment	Highest	Document-specific customization
2nd	Template attachment	Medium	Template-wide defaults
3rd	Built-in default	Lowest	No customization applied

File Structure Overview

{
  "global": { },
  "headers": { },
  "formulas": { },
  "cellDecorators": { },
  "styles": { },
  "levels": [ ],
  "dataTypes": { },
  "columns": [ ],
  "views": [ ],
  "reviews": { }
}

Global Settings

Global settings control culture, refresh behavior, and UI appearance.

Property	Type	Default	Description
`global.culture`	string	`en`	Localization culture code (e.g., `en`, `de`, `fr`, `es`). Controls date formats, number separators, and translated UI elements. See Culture Codes for full list.
`global.refreshOnSave`	boolean	`true`	Automatically refresh the Risksheet after saving changes. When `true`, cursor and scroll position are preserved on the last edited cell.
`global.addAsSubmenu`	boolean	`false`	Display “Add New” actions in a submenu instead of directly in the toolbar.
`global.suggestTextFields`	boolean	`false`	Enable autocomplete suggestions for text field columns when users are typing values.
`global.help`	string	`null`	URL to custom help documentation displayed when users request help.
`global.readonly`	boolean	`false`	Force the entire Risksheet into read-only mode. Overridden to `true` when viewing historical revisions.

Example:

{
  "global": {
    "culture": "en",
    "refreshOnSave": true,
    "addAsSubmenu": false,
    "suggestTextFields": true
  }
}

Headers Configuration

Control the appearance and behavior of column headers and row headers.

Column Headers

Property	Type	Default	Description
`headers.columnHeader.height`	number	`32`	Height in pixels for the main column header row. Increase for multi-line headers.
`headers.columnGroupHeader.height`	number	`32`	Height in pixels for grouped column headers (when columns are organized into `headerGroup`).

Row Headers

Property	Type	Default	Description
`headers.rowHeader.width`	number	`90`	Width in pixels of the row header column on the left side.
`headers.rowHeader.renderer`	string	`null`	Name of a custom renderer function (defined in `cellDecorators`) to style row headers. Applied to the row number column. Common examples: `rowHeaderRpnNew`, `rowHeaderRisk`.

Example:

{
  "headers": {
    "columnHeader": {
      "height": 52
    },
    "columnGroupHeader": {
      "height": 42
    },
    "rowHeader": {
      "width": 120,
      "renderer": "rowHeaderRpnNew"
    }
  }
}

Formulas

Define JavaScript functions for calculated columns and dynamic values.

Property	Type	Default	Description
`formulas.<name>`	string	`null`	Named JavaScript function that calculates a derived value. Function receives an `info` object with `info.item` (row data) and `info.cell` (DOM element). Return `null` for empty cells.

Available Context in Formulas:

Variable	Type	Description
`info.item`	object	Row data object. Access column values via `info.item['columnId']`.
`info.cell`	DOM element	HTML cell element (rarely used, mainly for decorators).

Example: RPN Calculation

{
  "formulas": {
    "commonRpn": "function(info) { var value = info.item['occ'] * info.item['det'] * info.item['sev']; return value ? value : null; }",
    "commonRpnNew": "function(info) { var value = info.item['occNew'] * info.item['detNew'] * info.item['sevNew']; return value ? value : null; }"
  }
}

Cell Decorators

Define JavaScript functions that apply conditional CSS classes to cells based on their content or context.

Property	Type	Default	Description
`cellDecorators.<name>`	string	`null`	Named JavaScript function that conditionally applies CSS classes to cells. Function receives `info` object with `info.item`, `info.cell`, and `info.value`. Use `$(info.cell).toggleClass()` to set classes.

⚠️ Important: Do not set inline styles directly. Cells are reused as the user scrolls, so use toggleClass() to apply CSS classes defined in the styles section. Example: RPN Risk Thresholds

{
  "cellDecorators": {
    "rpn": "function(info) { var val = info.value; $(info.cell).toggleClass('rpn1', val > 0 && val <= 150); $(info.cell).toggleClass('rpn2', val > 150 && val <= 350); $(info.cell).toggleClass('rpn3', val > 350); }",
    "rowHeaderRpnNew": "function(info) { var val = info.item['rpnNew']; $(info.cell).toggleClass('rpn1', val > 0 && val <= 150); $(info.cell).toggleClass('rpn2', val > 150 && val <= 350); $(info.cell).toggleClass('rpn3', val > 350); }"
  }
}

Styles

Define CSS classes for visual styling applied by cell decorators and columns.

Property	Type	Default	Description
`styles.<className>`	string	`null`	CSS rule applied when the class name is active on a cell. Use `!important` to override default styles.

Example: Risk Level Styling

{
  "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;",
    ".boldCol": "font-weight: 600;",
    ".rowHeadRpn1": "background-color: #eaf5e9 !important; border-left: 4px solid #1d5f20 !important;"
  }
}

Levels Configuration

Define the hierarchical structure of the Risksheet (e.g., system requirements → risks → mitigation tasks).

Property	Type	Default	Description
`levels[].name`	string	`null`	Display name for this level in navigation menus and UI.
`levels[].controlColumn`	string	`null`	Column ID that determines which column controls expand/collapse for this level.
`levels[].zoomColumn`	string	`null`	Column ID used to identify and zoom focus on items at this level.
`levels[].showInMenu`	boolean	`true`	Whether this level appears in the navigation menu for quick access.

Example: Three-Level Hierarchy

{
  "levels": [
    {
      "name": "Requirement",
      "controlColumn": "requirementId",
      "showInMenu": true
    },
    {
      "name": "Risk",
      "controlColumn": "riskId",
      "showInMenu": true
    },
    {
      "name": "Mitigation",
      "controlColumn": "taskId",
      "showInMenu": false
    }
  ]
}

Data Types Configuration

Define the work item types for risks and mitigation tasks, including how they are created and linked.

Risk Items

Property	Type	Default	Description
`dataTypes.risk.type`	string	`null`	Work item type(s) for risk items (e.g., `risk`, `fmea`). Can be comma-separated for multiple types. Evaluated through PolarionExpressionEvaluator for dynamic values.
`dataTypes.risk.role`	string	`null`	Link role name used to connect upstream items to risk items (e.g., `causes`, `depends_on`). Evaluated through PolarionExpressionEvaluator.
`dataTypes.risk.name`	string	`Risk`	Display name for risk items in menus and dialogs.
`dataTypes.risk.showInMenu`	boolean	`true`	Whether risk creation options appear in the “Add New” menu.
`dataTypes.risk.removeStrategy`	string	`delete`	Strategy when removing risk items: `delete` (permanent) or other custom strategy.
`dataTypes.risk.rejectedAction`	string	`reject`	Workflow action to execute when a risk is rejected during review.
`dataTypes.risk.rejectedStatus`	string	`rejected`	Status value to set when a risk is rejected.
`dataTypes.risk.rejectedResolution`	string	`invalid`	Resolution value to set when a risk is rejected.

Task Items (Mitigations)

Property	Type	Default	Description
`dataTypes.task.type`	string	`null`	Work item type(s) for mitigation task items (e.g., `task`, `action`). Can be comma-separated for multiple types. Evaluated through PolarionExpressionEvaluator.
`dataTypes.task.role`	string	`null`	Link role name used to connect risk items to task items (e.g., `mitigation`, `implementation`). Evaluated through PolarionExpressionEvaluator.
`dataTypes.task.name`	string	`Task`	Display name for task items in menus and dialogs.
`dataTypes.task.showInMenu`	boolean	`true`	Whether task creation options appear in the “Add New” menu.
`dataTypes.task.zoomColumn`	string	`null`	Column ID for identifying task items during zoom operations.

Example:

{
  "dataTypes": {
    "risk": {
      "type": "risk",
      "role": "causes",
      "name": "Risk",
      "showInMenu": true,
      "removeStrategy": "delete",
      "rejectedAction": "reject",
      "rejectedStatus": "rejected"
    },
    "task": {
      "type": "task",
      "role": "mitigation",
      "name": "Mitigation",
      "showInMenu": true
    }
  }
}

Columns Configuration

Define which columns appear in the Risksheet and how they behave.

Property	Type	Default	Description
`columns[].id`	string	auto-generated	Unique identifier for the column. Auto-generated from `header` or `bindings` if not specified.
`columns[].header`	string	`null`	Display name shown in the column header.
`columns[].headerGroup`	string	`null`	Group name for organizing related columns under a header section.
`columns[].bindings`	string	`null`	Work item field ID or custom field name to bind this column to.
`columns[].type`	string	auto-detected	Data type: `string`, `int`, `float`, `enum`, `workflow`, `itemLink`, `taskLink`, `date`, `richText`, etc. Auto-detected from Polarion field type if not specified.
`columns[].level`	number	`1`	Hierarchical level (1 = top, 2 = second, etc.). Controls cell merging.
`columns[].width`	number	`200`	Width in pixels.
`columns[].filterable`	boolean	`true`	Allow users to filter the Risksheet by this column.
`columns[].readOnly`	boolean	`false`	Make column read-only. Automatically set to `true` for formula columns, server-rendered columns, and system fields (author, created, updated, type).
`columns[].formula`	string	`null`	Name of formula function from `formulas` section. Column becomes read-only when set.
`columns[].serverRender`	string	`null`	Server-side rendering script. When set, column becomes text type and read-only.
`columns[].cellDecorator`	string	`null`	Name of decorator function from `cellDecorators` section to apply conditional styling.
`columns[].canCreate`	boolean	`true`	For `itemLink` and `multiItemLink` columns, allow creating new linked items directly from the cell.
`columns[].allowMultiple`	boolean	`false`	For enum columns, allow selecting multiple values.

Example: Risk Item Columns

{
  "columns": [
    {
      "headerGroup": "Identification",
      "header": "Risk ID",
      "bindings": "id",
      "id": "riskId",
      "level": 2,
      "width": 120,
      "readOnly": true
    },
    {
      "headerGroup": "Identification",
      "header": "Causes",
      "bindings": "causes",
      "id": "causes",
      "type": "string",
      "level": 2,
      "width": 250
    },
    {
      "headerGroup": "Assessment",
      "header": "Severity",
      "bindings": "severity",
      "id": "severity",
      "type": "enum",
      "level": 2,
      "width": 100
    },
    {
      "headerGroup": "Assessment",
      "header": "RPN",
      "id": "rpn",
      "formula": "commonRpn",
      "width": 100,
      "cellDecorator": "rpn"
    }
  ]
}

Views Configuration

Define saved views that users can quickly switch between.

Property	Type	Default	Description
`views[].name`	string	`null`	Display name for the saved view.
`views[].description`	string	`null`	Tooltip description shown when hovering over the view name.
`views[].columns`	array	`[]`	Array of column IDs to display in this view. Columns appear in the order specified.
`views[].expandLevels`	number	`2`	How many hierarchy levels are expanded by default in this view.
`views[].sortBy`	string	`null`	Column ID to sort by when this view is selected.

Example:

{
  "views": [
    {
      "name": "Assessment",
      "description": "Risk identification and severity assessment",
      "columns": ["riskId", "description", "severity", "occurrence", "detection", "rpn"],
      "expandLevels": 2
    },
    {
      "name": "Mitigation",
      "description": "Mitigation tasks and effectiveness",
      "columns": ["riskId", "description", "mitigation", "effectiveness", "status"],
      "expandLevels": 3
    }
  ]
}

Reviews Configuration

Configure how reviews and approvals are handled in your Risksheet.

Property	Type	Default	Description
`reviews.reviewManager`	string	`null`	Review workflow mechanism: `CommentBased`, `WorkitemBased`, or `ApprovalBased`. See Review Workflows for details.
`reviews.typeProperties`	object	`{}`	Custom type properties for review-specific configurations (e.g., approval status fields, review queues).

Example:

{
  "reviews": {
    "reviewManager": "CommentBased",
    "typeProperties": {
      "risk": {
        "reviewField": "reviewStatus",
        "reviewerField": "reviewer"
      }
    }
  }
}

Configuration Flow Diagram

Common Configuration Patterns

FMEA Risk Assessment

{
  "formulas": {
    "rpn": "function(info) { return (info.item['occurrence'] || 0) * (info.item['severity'] || 0) * (info.item['detection'] || 0); }"
  },
  "cellDecorators": {
    "rpnColor": "function(info) { var val = info.value; $(info.cell).toggleClass('low', val <= 100); $(info.cell).toggleClass('medium', val > 100 && val <= 300); $(info.cell).toggleClass('high', val > 300); }"
  },
  "styles": {
    ".low": "background-color: #d4edda !important;",
    ".medium": "background-color: #fff3cd !important;",
    ".high": "background-color: #f8d7da !important;"
  }
}

Header Tooltips

{
  "columns": [
    {
      "header": "Severity",
      "bindings": "severity",
      "headerTooltip": "Risk severity on scale 1-10"
    }
  ]
}

Validation and Troubleshooting

Issue	Cause	Solution
Configuration not applied	File not in correct location	Check Menu > Configuration > File Location. Verify attachment name is exactly `risksheet.json`.
”No issues found” but configuration fails	Validation gaps	Check browser console for JavaScript errors in formulas or decorators.
Enum parsing error	Invalid enum value in binding	Ensure enum ID in column `bindings` matches Polarion custom field name exactly.
Column not visible	Column ID missing or not listed in `columns`	Add column object to `columns` array with correct `bindings` and `id`.
Styling not applied	Missing CSS class definition	Ensure style class name matches decorator class name. Include `!important` in CSS rules.

See Configuration Properties Index for a searchable reference of all available properties.

Sources

KB Articles

Support Tickets

Source Code

PolarionAppConfigManager.java
risksheet.json
AppConfigParser.ts
AppConfig.ts
OpenHelpCommand.ts

Getting Started

Concepts

Reference

Guides

Troubleshooting

FAQ

Configuration File Location

File Structure Overview

Global Settings

Headers Configuration

Column Headers

Row Headers

Formulas

Cell Decorators

Styles

Levels Configuration

Data Types Configuration

Risk Items

Task Items (Mitigations)

Columns Configuration

Views Configuration

Reviews Configuration

Configuration Flow Diagram

Common Configuration Patterns

FMEA Risk Assessment

Header Tooltips

Validation and Troubleshooting

Getting Started

Concepts

Reference

Guides

Troubleshooting

FAQ

​Configuration File Location

​File Structure Overview

​Global Settings

​Headers Configuration

​Column Headers

​Row Headers

​Formulas

​Cell Decorators

​Styles

​Levels Configuration

​Data Types Configuration

​Risk Items

​Task Items (Mitigations)

​Columns Configuration

​Views Configuration

​Reviews Configuration

​Configuration Flow Diagram

​Common Configuration Patterns

​FMEA Risk Assessment

​Header Tooltips

​Validation and Troubleshooting

Configuration File Location

File Structure Overview

Global Settings

Headers Configuration

Column Headers

Row Headers

Formulas

Cell Decorators

Styles

Levels Configuration

Data Types Configuration

Risk Items

Task Items (Mitigations)

Columns Configuration

Views Configuration

Reviews Configuration

Configuration Flow Diagram

Common Configuration Patterns

FMEA Risk Assessment

Header Tooltips

Validation and Troubleshooting