Skip to main content

Step 1: Open the Configuration File

Open the risksheet.json file attached to your Risksheet document. You can edit it through the configuration editor or directly as an attachment.

Step 2: Define the Column Entry

Add a new object to the columns array in your configuration. Each column requires at minimum a binding and header:
{
  "columns": [
    {
      "id": "failureDescription",
      "binding": "description",
      "header": "Failure Description",
      "width": 200
    }
  ]
}

Step 3: Configure Column Properties

Set the properties that control column behavior:
PropertyDefaultDescription
idAuto-generated from header or bindingUnique identifier for the column
binding(required)Polarion work item field name
header(required)Display text in column header
typeAuto-detected from bindingData type: string, int, float, enum, date, boolean
widthAutoColumn width in pixels
readOnlyfalsePrevents editing when set to true
visibletrueControls column visibility
filterabletrueEnables filtering by column values
level1Hierarchical level (1 = top level)
headerGroup(none)Groups columns under a shared header
Use headerGroup to organize columns under a shared group header:
{
  "columns": [
    {
      "id": "sev",
      "binding": "severity",
      "header": "S",
      "headerGroup": "Initial Rating",
      "type": "rating:severity",
      "width": 60
    },
    {
      "id": "occ",
      "binding": "occurrence",
      "header": "O",
      "headerGroup": "Initial Rating",
      "type": "rating:occurrence",
      "width": 60
    },
    {
      "id": "det",
      "binding": "detection",
      "header": "D",
      "headerGroup": "Initial Rating",
      "type": "rating:detection",
      "width": 60
    }
  ]
}
The group header height is controlled by headers.columnGroupHeader.height (default: 32 pixels). If you omit the type property, Risksheet automatically detects the type from the Polarion field definition. For standard Polarion fields like description, title, or severity, auto-detection works reliably. Explicitly set type when binding to custom fields or when you want to override the default rendering.

Step 5: Control Read-Only Behavior

Certain columns become read-only automatically:
  • Columns with a formula property
  • Columns with a serverRender property
  • System fields: id, status, type, project, outlineNumber
  • Fields where Polarion permissions deny modification
To make a column explicitly non-editable:
{
  "id": "riskCategory",
  "binding": "riskCategory",
  "header": "Category",
  "readOnly": true
}

Verification

Reload your Risksheet page after saving the configuration. You should now see the new column in the grid with the specified header text. Click on a cell in the column to verify it is editable (unless marked readOnly).

See Also

KB ArticlesSupport TicketsSource Code
  • ConfigureColumnsCommand.ts
  • TextEditor.ts
  • ColumnsHelper.ts
  • AppConfig.ts
  • risksheet.json