Skip to main content
diagram

Column Properties

NameTypeDefaultDescription
idstringAuto-generated from header or bindingUnique column identifier. If not specified, generated from header or binding.
headerstringRequiredDisplay text shown in the column header row.
bindingstringSame as idPolarion field binding for the user reference. Common values: assignee for risk item owner, task.assignees for downstream task assignee.
typestringAuto-detected from bindingColumn type. Set to ref for user reference columns when auto-detection does not apply.
widthnumberSee applicationColumn width in pixels.
readOnlybooleanfalseControls editability. When true, displays user ID as a plain string. When false, provides a dropdown selector.
levelnumber1Hierarchical level at which this column appears (1 = top level, 2 = second level, etc.). Not set for task columns.
headerGroupstringNoneHeader group identifier for multi-level column grouping. Columns with the same headerGroup share a group header.
filterablebooleanSee applicationControls whether the column supports filtering.
visiblebooleantrueControls initial visibility of the column. Can be toggled via saved views.

User Role Configuration

The userRole property controls which users appear in the dropdown selector for editable user reference columns. This property specifies a Polarion role to filter the available user list.
PropertyTypeDefaultDescription
userRolestringSee applicationSpecifies the Polarion role to filter available users. The value project_assignable fetches users who have the assignable role in the current project context.
When mitigation tasks reside in a different project than the Risksheet document, the userRole: 'project_assignable' property fetches users from the Risksheet’s project context, not from the task’s project. This means the dropdown may not include users who are assignable only in the task’s project.Workaround: Use a global Polarion role where the needed persons are added, rather than relying on project-specific roles. Global roles are visible across all projects.
Dependent enum support (available in version 25.3.1 and later) may enable project-dependent user lists in the future, allowing the dropdown to respect the task’s project context.

Read-Only vs. Editable Behavior

User reference columns behave differently depending on the readOnly property:
ModereadOnly ValueDisplayEditing BehaviorData Handling
Read-onlytrueUser ID as plain string textNo editing allowed; cell is non-interactiveReturns user ID string from work item field
EditablefalseDropdown selector populated from userRoleUser selects from filtered dropdown listClears all existing assignees and adds selected user

How Editable User Columns Save Data

When a user selects a value from the dropdown in an editable user reference column, the following sequence occurs:
  1. All existing assignees on the work item are cleared
  2. The selected user is added as the sole assignee
  3. The change is saved to the Polarion work item
Editable user reference columns currently support single-user assignment only. Selecting a new user always replaces all existing assignees. If the work item previously had multiple assignees (set from Polarion’s native interface), all but the newly selected user are removed.

Read-Only Field Protection

The following system-level fields are always read-only regardless of column configuration:
FieldBindingReason
idWork item IDSystem-generated, immutable
statusWorkflow statusChanged only via workflow transitions
typeWork item typeImmutable after creation
projectProject identifierDetermined by document location
outlineNumberOutline numberManaged by document structure
authorItem creatorHistorical record, never changeable
Additionally, any column with readOnly: true in the configuration silently ignores save attempts.

PDF Export Behavior

User reference fields in PDF export display user IDs rather than display names. This is an inconsistency with regular enum fields, which export with human-readable titles.
Field TypePDF Export Display
Regular enumDisplay name / title
Rating enumNumeric ID
User reference / assigneeUser ID
Use Saved Views as an alternative export option when you need user names displayed consistently in PDF export sections. Saved views provide more control over which columns appear and how they are formatted in exports.

Excel Export Behavior

In Excel exports, user reference columns follow the same pattern as the grid display:
  • Read-only user columns export the user ID as a plain string
  • The exported file preserves cell background and text colors from the grid (when includeStyles is active)
  • Column headers are included in bold font at the top of the exported sheet

Type Conversion Details

Risksheet handles user reference fields through a dynamic type conversion system:
DirectionConversion
Polarion to Grid (read)Reads user ID from work item field. For read-only columns, returns the ID as a string. For editable columns, provides the ID to the dropdown selector.
Grid to Polarion (write)Clears the work item’s assignees collection, then adds the selected user. Only executes for non-read-only columns and non-system fields.
The type conversion system supports displaying any Polarion field as a user reference column, though the primary use case is the assignee field binding.

Configuration Examples

Risk Owner Column (Editable)

Assign a risk owner directly from the Risksheet grid:
{
  "columns": [
    {
      "id": "riskOwner",
      "header": "Risk Owner",
      "binding": "assignee",
      "width": 130,
      "level": 1,
      "headerGroup": "Responsibility",
      "readOnly": false
    }
  ]
}

Mitigation Task Assignee (Editable)

Assign users to downstream mitigation tasks:
{
  "columns": [
    {
      "id": "taskAssignee",
      "header": "Task Assignee",
      "binding": "task.assignees",
      "width": 130,
      "headerGroup": "Mitigation",
      "readOnly": false
    }
  ]
}

Audit Trail Column (Read-Only)

Display the work item creator for audit purposes:
{
  "columns": [
    {
      "id": "createdBy",
      "header": "Created By",
      "binding": "author",
      "width": 100,
      "level": 1,
      "readOnly": true
    }
  ]
}

Complete Example

An FMEA configuration with risk owner, task assignee, and audit trail columns:
{
  "columns": [
    {
      "id": "failureMode",
      "header": "Failure Mode",
      "binding": "title",
      "width": 200,
      "level": 1
    },
    {
      "id": "riskOwner",
      "header": "Risk Owner",
      "binding": "assignee",
      "width": 130,
      "level": 1,
      "headerGroup": "Responsibility",
      "readOnly": false
    },
    {
      "id": "sev",
      "header": "Severity",
      "binding": "sev",
      "type": "rating",
      "width": 70,
      "level": 1,
      "headerGroup": "Initial Assessment"
    },
    {
      "id": "occ",
      "header": "Occurrence",
      "binding": "occ",
      "type": "rating",
      "width": 70,
      "level": 1,
      "headerGroup": "Initial Assessment"
    },
    {
      "id": "taskAssignee",
      "header": "Assignee",
      "binding": "task.assignees",
      "width": 130,
      "headerGroup": "Mitigation Tasks",
      "readOnly": false
    },
    {
      "id": "author",
      "header": "Created By",
      "binding": "author",
      "width": 100,
      "level": 1,
      "readOnly": true
    }
  ]
}

Edge Cases and Limitations

ScenarioBehavior
Multiple assignees set from Polarion UIRisksheet displays only the first assignee; editing replaces all with the selected user
User not found in projectUser ID is displayed as-is; dropdown may not include the user for re-selection
Cross-project task assigneeDropdown shows users from the Risksheet’s project, not the task’s project
Historical revision viewUser columns become read-only automatically when viewing a non-current revision
Empty assignee fieldCell displays empty; no default user is assigned
System field binding (e.g., author)Always read-only regardless of readOnly configuration setting
  • Column Type Reference — overview of all available column types
  • Data Types — complete data type reference including task configuration
  • Saved Views — column visibility presets for consistent export formatting
  • Enum Columns — enum columns with similar dropdown behavior
  • System Fields — system field bindings and read-only protection
  • Field Mapping — how Polarion fields map to Risksheet columns
KB ArticlesSupport TicketsSource Code
  • GetSetUtil.java
  • RisksheetViewServlet.java
  • risksheet.json
  • SheetConstants.ts
  • AppConfig.ts