Skip to main content
diagram

Top-Level Properties

PropertyTypeDefaultDescription
columnsarray[]Column definitions for the grid. An empty array results in no visible data columns.
dataTypesobject{}Risk and task data type configuration including work item types, link roles, and menu visibility.
readonlybooleanfalseMakes the entire grid read-only. Automatically forced to true when viewing a historical revision.
levelsarray[]Hierarchical level definitions with control columns for zoom navigation.
headersobject{}Row header and column header sizing and rendering configuration.
formulasobject{}Named JavaScript formula definitions referenced by column formula properties.
stylesobject{}Named CSS class definitions for conditional cell formatting.
cellDecoratorsobject{}Named JavaScript functions that apply conditional CSS classes to cells.
enumsobject{}Enumeration option definitions for enum and multiEnum column types.
ratingsobject{}Rating scale definitions for rating column types. Structurally identical to enums.
relationsarray[]Dependent enum relationships for cascading selections between columns.
viewsarray[]Saved column visibility presets.
globalobject{}Global settings including culture/locale, help URL, and menu organization.
reviewsobject{}Review workflow configuration.
sortByarray[]Default sort order. Column IDs with optional tilde prefix for descending.
canAdminbooleanfalseWhether the current user has admin privileges. Set at runtime, not in configuration.
reviewerbooleanfalseEnables reviewer mode with restricted editing and review-specific UI.
downstreamReadonlybooleanfalseMakes downstream linked items read-only.
sourcestringnullPath to configuration source file. Set at runtime.
templateNamestringnullName of the template when config is loaded from a global template.

Column Property Defaults

When a column entry in the columns array omits optional properties, these defaults apply:
PropertyTypeDefaultDescription
idstringAuto-generated from header or bindingUnique column identifier. If omitted, generated from the header text or binding name.
typestringAuto-detected from Polarion field typeColumn data type. Inferred from the bound Polarion field when not specified.
levelnumber1Hierarchical level. Defaults to top level. Not set for task-level columns.
readOnlybooleanfalseEditability. Automatically set to true for formula columns, server-rendered columns, reference columns, and protected system fields.
filterablebooleantrueWhether column values can be filtered.
canCreatebooleantrueFor itemLink and multiItemLink columns, allows creation of new linked items.
formulastringNoneNo formula. When set, column becomes read-only.
serverRenderstringNoneNo server render script. When set, column becomes text type and read-only.
multiLinebooleantrueMulti-line editing enabled by default.
wordWrapbooleantrueWord wrap enabled by default.
When you omit the type property, Risksheet queries the Polarion field definition and maps it to the corresponding column type. For example, a Polarion Integer field becomes int, a Date field becomes date, and a native Enum field becomes enum. See Data Types for the complete mapping.

Levels Property Defaults

Each entry in the levels array receives these defaults when properties are omitted:
PropertyTypeDefaultDescription
showInMenubooleantrueLevel appears in the row creation menu.
controlColumnstringsystemItemIdColumn that controls hierarchy navigation and zoom for this level.
{
  "levels": [
    {
      "showInMenu": true,
      "controlColumn": "systemItemId"
    },
    {
      "showInMenu": true,
      "controlColumn": "systemItemId"
    }
  ]
}
See Levels Configuration for detailed level hierarchy setup.

DataTypes Property Defaults

The dataTypes object configures risk and task work item types. Each data type entry has its own defaults:

Risk Data Type Defaults

PropertyTypeDefaultDescription
dataTypes.risk.typestringNone (required)Polarion work item type ID for risk items. Evaluated through expression evaluator for dynamic values.
dataTypes.risk.rolestringNoneLink role for relationships to risk items. Evaluated through expression evaluator.
dataTypes.risk.removeStrategystringdeleteStrategy when removing risk items: delete removes permanently.
dataTypes.risk.rejectedActionstringrejectWorkflow action executed when a risk item is rejected during review.
dataTypes.risk.rejectedStatusstringrejectedStatus value set when a risk item is rejected.
dataTypes.risk.rejectedResolutionstringinvalidResolution value set when a risk item is rejected.
The dataTypes.risk.type property has no usable default — you must define the Polarion work item type for risk items. Without it, Risksheet cannot query or create risk items, producing the error: "No type attribute is defined for dataType".

Task Data Type Defaults

PropertyTypeDefaultDescription
dataTypes.task.typestringNonePolarion work item type ID for task/mitigation items. Evaluated through expression evaluator.
dataTypes.task.rolestringNoneLink role for relationships to task items. Evaluated through expression evaluator.
dataTypes.task.showInMenubooleantrueTask creation options appear in context menus.

Header Property Defaults

PropertyTypeDefaultDescription
headers.columnHeader.heightnumber32Column header row height in pixels.
headers.columnGroupHeader.heightnumber32Column group header row height in pixels.
headers.rowHeader.rendererstringNoneCustom renderer function for row headers. When set, applies conditional styling (e.g., RPN-based color coding).
{
  "headers": {
    "rowHeader": {
      "renderer": "rowHeaderRpnNew"
    },
    "columnHeader": {
      "height": 32
    },
    "columnGroupHeader": {
      "height": 32
    }
  }
}

Global Settings Defaults

PropertyTypeDefaultDescription
global.culturestringenCulture/locale code affecting date formats, number formats, and localization. See Culture and Localization Codes.
Additional global properties (help URL, refresh behavior, menu organization) have defaults that may vary by Risksheet version. Consult the Configuration Properties Index for the complete list.

Review Configuration Defaults

PropertyTypeDefaultDescription
reviews.reviewManagerstringCommentBasedReview workflow mechanism. Determines how reviews and approvals are handled.

Auto-Read-Only Rules

Risksheet automatically overrides the readOnly default (false) to true for columns matching these conditions, regardless of your explicit configuration:
ConditionApplied ToReason
formula is setColumnCalculated values cannot be manually edited
serverRender is setColumnServer-rendered content is display-only
Reference columnColumnCross-project referenced items are read-only
System field bindingColumnFields author, resolution, created, updated, type
Permission deniedColumnUser lacks write access to the bound field
Historical revisionEntire gridViewing a past revision forces readonly: true on the entire config

Configuration File Location

The configuration file is always named risksheet.json (constant: CONFIG_FILENAME) and is stored as an attachment on the Polarion LiveDoc document. The configuration resolution order is:
  1. Document-specific risksheet.json — attached directly to the LiveDoc
  2. Template-based — loaded from a global template if templateName is set
  3. Defaults applied — factory defaults fill in any missing properties
See Document Configuration Override and Template Path Configuration for inheritance details.

Complete Minimal Example

The smallest valid risksheet.json that produces a working FMEA risksheet. All other properties use their documented defaults:
{
  "dataTypes": {
    "risk": {
      "type": "risk"
    }
  },
  "levels": [
    {},
    {}
  ],
  "columns": [
    {
      "binding": "title",
      "header": "Failure Mode"
    },
    {
      "binding": "sev",
      "header": "Severity",
      "type": "rating:severity"
    },
    {
      "binding": "occ",
      "header": "Occurrence",
      "type": "rating:occurrence"
    }
  ],
  "ratings": {
    "severity": [
      { "id": "1", "name": "Negligible" },
      { "id": "2", "name": "Minor" },
      { "id": "3", "name": "Moderate" },
      { "id": "4", "name": "Significant" },
      { "id": "5", "name": "Catastrophic" }
    ],
    "occurrence": [
      { "id": "1", "name": "Remote" },
      { "id": "2", "name": "Low" },
      { "id": "3", "name": "Moderate" },
      { "id": "4", "name": "High" },
      { "id": "5", "name": "Very High" }
    ]
  }
}
In this example:
  • columns[].id is auto-generated from binding (e.g., title, sev, occ)
  • columns[].type is auto-detected for the title column (becomes text) and explicitly set for rating columns
  • columns[].level defaults to 1 for all columns
  • columns[].readOnly defaults to false
  • columns[].filterable defaults to true
  • levels[].showInMenu defaults to true for both levels
  • levels[].controlColumn defaults to systemItemId
  • dataTypes.risk.removeStrategy defaults to delete
  • dataTypes.risk.rejectedAction defaults to reject
  • global.culture defaults to en
  • reviews.reviewManager defaults to CommentBased
KB ArticlesSource Code
  • PolarionAppConfigManager.java
  • RisksheetViewServlet.java
  • ShowConfigurationCommand.ts
  • AppConfigParser.ts
  • SystemConsts.java