Skip to main content

Overview

Enum columns map to Polarion enumeration fields and display their values using enum IDs. The system automatically loads enum options from the project configuration and renders them as dropdown editors when users edit cells.
Status fields are a special case — they display enum names instead of IDs and are controlled through Polarion’s workflow system.

Column Type Declaration

Enum columns are declared using the enum: prefix followed by the enumeration identifier:
{
  "header": "Severity Level",
  "id": "severity",
  "type": "enum:severity_scale",
  "width": 120,
  "filterable": true
}

Configuration Properties

Basic Properties

PropertyTypeDefaultDescription
headerstringRequiredColumn header text displayed in the grid
idstringRequiredUnique column identifier used for data binding
typestringRequiredMust be enum:<enumId> where enumId matches a Polarion enumeration
widthnumberAutoColumn width in pixels
minWidthnumber50Minimum column width in pixels
bindingstringvalue of idData binding path for the column

Display and Formatting

PropertyTypeDefaultDescription
headerGroupstringNoneHeader group text for column grouping
headerGroupCssstringNoneCSS class for styling the header group
headerCssstringNoneCSS class for styling the column header
cellCssstringNoneCSS class applied to all cells in the column
showEnumDescriptionbooleanfalseDisplay enum option descriptions in the dropdown editor
wordWrapbooleantrueWhether text wraps within cells

Behavior and Editing

PropertyTypeDefaultDescription
readOnlybooleanfalsePrevents editing when true; set to false to enable edits on upstream enum fields
filterablebooleantrueWhether the column appears in filter controls
sortablebooleantrueWhether users can sort by this column
editablebooleantrueControls whether cells can be edited

Styling and Appearance

PropertyTypeDefaultDescription
cssClassstringNoneAdditional CSS classes for custom styling
cellRendererstringNoneCustom renderer for specialized cell rendering
formatstringNoneFormat string for display (rarely used with enums)

Data Type Mapping

Enum columns support multiple Polarion field types for data storage:
Polarion Field TypeBehavior
EnumOptionNative enum field — recommended
StringStores comma-separated enum IDs
IntegerStores numeric enum codes
List<IEnumOption>Native Polarion multi-enum field
Status fields are read-only through Nextedy RISKSHEET. Status changes must be made through Polarion’s workflow system, not through enum column editing.

Example Configurations

Basic Risk Severity Enum

{
  "header": "Severity",
  "id": "riskSeverity",
  "type": "enum:severity_scale_5",
  "width": 100,
  "filterable": true,
  "sortable": true
}

Upstream Enum with Editing Enabled

Upstream (linked item) enum columns are read-only by default. Enable editing with readOnly: false:
{
  "header": "Requirement Severity",
  "id": "requirementSeverity",
  "bindings": "requirement.severity",
  "type": "enum:severity_scale",
  "width": 120,
  "readOnly": false,
  "level": 2
}

Enum with Header Group and Custom Styling

{
  "headerGroup": "Risk Assessment",
  "headerGroupCss": "riskAssessmentGroup",
  "headerCss": "severityHeader",
  "header": "Severity",
  "id": "severity",
  "type": "enum:severity_scale",
  "cellCss": "severityCell",
  "width": 110
}

Enum Value Loading

Enum values are automatically loaded from the Polarion project configuration during document initialization. The RISKSHEET configuration endpoint (/api/config) retrieves:
  • Enum definitions and their available options
  • Option display names and IDs
  • Enum descriptions and metadata
  • Project-specific enum filtering
Task-type enums and risk-type enums are automatically filtered to show only options relevant to configured task and risk types. Project enums show only projects allowed in the RISKSHEET configuration.

Filtering and Display

Enum Option Discovery

Enum options are determined by:
  1. Enumeration Type: Specified in the Polarion custom field definition
  2. Project Context: Options may be filtered by the RISKSHEET project
  3. Task/Risk Type Filtering: Task and risk enums filter by configured data types
  4. Dependent Enum Rules: Options may filter based on other column values (future feature)

Blank Option Handling

Blank/empty enum values are:
  • Displayed as empty cells in read mode
  • Removed from multi-enum selections automatically
  • Allowed in single-enum columns (null represents unset)

Read-Only Upstream Enums

Upstream enum columns (enums showing linked item properties) are read-only by default to prevent accidental modification of linked objects. This is controlled by the Polarion configuration property:
nextedy.risksheet.upstreamSubColumnsReadonly=false
To enable editing of a specific upstream enum column, set readOnly: false in the column definition:
{
  "bindings": "linkedItem.enumField",
  "type": "enum:enumId",
  "readOnly": false
}

Enum Availability Matrix

Column TypeRead-OnlyFilterableSortable
Direct enumNoYesYes
Upstream enum (default)YesYesYes
Upstream enum (editable)NoYesYes
Downstream enumVariesYesYes
Status enum (system)YesYesNo
KB ArticlesSupport TicketsSource Code
  • AppConfig.ts
  • RisksheetViewServlet.java
  • GetSetUtil.java
  • AppConfigHelper.ts
  • ExportToExcel.ts