Skip to main content

​
Overview

System fields enable RISKSHEET to maintain item identity across document revisions, manage permissions at the field level, track review states, and support comparison workflows. Users interact with these fields indirectly through features like historical revision viewing, baseline comparison, and permission management. diagram

​
Item Identity System

These system fields preserve work item identity when viewing historical revisions, comparing baselines, or navigating between document versions.
Field NameTypePurposeUser Interaction
systemOriginalItemIdstringOriginal item identifier before any revision changesRead-only; used internally for cross-revision tracking
systemItemIdstringCurrent item identifier in the viewed revisionRead-only; displayed as the working ID
systemItemProjectIdstringPolarion project identifier where item residesRead-only; enables cross-project linking validation
systemItemRevisionstringSpecific revision number of this item versionRead-only; populated when viewing historical revisions
systemItemFrozenRevisionstringMarks item as frozen at a specific baseline revisionRead-only; prevents changes to frozen items

​
Use Cases

When comparing two document revisions, the identity system allows RISKSHEET to:
  • Track which items existed in both revisions
  • Identify newly created items (present only in newer revision)
  • Identify deleted items (present only in older revision)
  • Map item properties between revisions for change highlighting
  • Navigate between revisions while maintaining context

​
Read-Only State Management

Read-only controls are applied at two levels: the entire item and individual fields within an item. This enables fine-grained permission management.
Field NameTypeScopePurpose
systemReadOnlybooleanItem-levelPrevents all editing when true; applies to risk items or work items
systemReadOnlyFieldsarrayField-levelJSON array of field binding names that cannot be edited; overrides column readOnly setting
systemTaskReadOnlybooleanTask-levelPrevents editing of linked mitigation/downstream tasks when true
systemTaskReadOnlyFieldsarrayTask fieldsJSON array of field names within task items that are protected from editing

​
How Read-Only is Applied

// Example: Risk item with mixed permissions
{
  "id": "PROJ-1234",
  "title": "Safety critical function",
  "severity": "High",
  "systemReadOnly": false,           // Item is editable
  "systemReadOnlyFields": [          // But these fields are locked
    "id",
    "created",
    "author",
    "type"
  ]
}
Read-only cells appear with gray background styling in the RISKSHEET grid. Users cannot:
  • Edit the cell content
  • Copy formatted content (only plain text)
  • Use cell editors (dropdowns, date pickers, etc.)
  • Navigate into the cell with keyboard
Read-only status comes from three sources:
  1. Polarion permissions — User lacks modify permission for the field
  2. Configuration — Column has readOnly: true set in risksheet.json
  3. System fields — Field is in systemReadOnlyFields array

​
Review Workflow System

These system fields manage the display and state of review workflows within the RISKSHEET grid.
Field NameTypePurposeNotes
reviewsRenderedboolean or arrayIndicates which items have been rendered in review modeWhen true, shows review indicators in grid; used by review columns
reviewsAddbooleanControls whether new review entries can be added for this itemAllows users to add approvals/comments directly from grid

​
Review Integration

When review workflows are enabled in the configuration:
  • RISKSHEET displays special reviewsRendered and reviewsAdd columns
  • These columns are automatically generated system columns
  • Users see approval status and can add review entries without leaving the grid
  • System fields track which items have been reviewed
Example review workflow in configuration: 
{
  "reviews": {
    "reviewManager": "CommentBased"
  },
  "columns": [
    {
      "header": "Reviews",
      "binding": "reviewsRendered",
      "type": "reviews",
      "readOnly": false
    }
  ]
}

​
Reference Item System

These system fields identify items that are external references from other projects or spaces in cross-project configurations.
Field NameTypePurposeBehavior
systemReferenceTypestringIdentifies items pulled from external projects or spacesWhen populated, marks item as reference (not local copy)

​
Reference Item Behavior

Reference items in cross-project RISKSHEET configurations:
  • Display: Shown with special visual indicators in the grid
  • Editing: May be read-only or support limited editing depending on configuration
  • Actions: Context menu offers option to convert reference into local copy
  • Linking: Can be linked to local items through normal traceability columns
Reference items are pulled from other projects and:
  • May not support all field types (depends on source project configuration)
  • Cannot be deleted directly (deletion removes only local reference)
  • Changes may not sync back to source project depending on permissions

​
Standard Item Data Bindings

In addition to system fields, these standard bindings are reserved for core item identification:
BindingTypePurposeRead-Only
idstringUnique work item identifier in PolarionTrue
tempIdstringTemporary ID assigned to newly created items before server persistenceTrue
linkstringHTML hyperlink to the Polarion work item (internal use)True
titlestringDisplay title or name of the work itemFalse (usually)
revisionstringDocument revision identifier when viewing historical versionsTrue
idNewbooleanFlag indicating item exists only in current document, not yet saved to PolarionTrue
labelstringDisplay label or short name for the itemFalse

​
Binding Naming Conventions

When you create item link columns, RISKSHEET automatically generates companion fields:
Source BindingGenerated FieldDescription
linkedItemlinkedItemJSON object with {id, title, label}
linkedItemlinkedItem_linkHTML link to Polarion
linkedItemlinkedItem_titleDisplay title string
linkedItemlinkedItem_idItem ID string
Do not use these postfix patterns in custom column bindings:
  • _link (reserved for HTML rendering)
  • _title (reserved for display text)
  • _id (reserved for identifier extraction)

​
CSS Classes for System Fields

System fields automatically receive CSS classes for visual styling:
CSS ClassApplied WhenVisual Effect
readonlyCell has read-only statusGray background, disabled appearance
updatedCell value changed during edit sessionHighlighted border
invalidCell value fails validationRed border, error indicator
new-itemRow created but not yet savedGreen highlight, new item indicator

​
Configuration Best Practices

Do not create columns with these bindings:
  • systemReadOnly, systemReadOnlyFields
  • systemTaskReadOnly, systemTaskReadOnlyFields
  • systemOriginalItemId, systemItemId
  • reviewsRendered, reviewsAdd
These are reserved for RISKSHEET internal use and will not work as expected in custom columns.
When configuring columns:
  1. Use Polarion field bindings for user-visible data
  2. Use item link bindings for traceability
  3. Let RISKSHEET manage system field columns automatically
  4. Configure permissions at the Polarion level for access control

​
Troubleshooting System Field Issues

ProblemCauseSolution
All cells appear read-onlysystemReadOnly: true for item or no edit permissionsCheck Polarion permissions or remove read-only flag
Some fields locked but not otherssystemReadOnlyFields array configuredReview configuration to see which fields are protected
Can’t edit items in comparison modeViewing historical revisionSwitch to current revision to enable editing
Reference items won’t updatesystemReferenceType set on itemConvert reference to local copy in context menu
Reviews not appearingreviewsRendered column not configuredEnable review configuration in risksheet.json
For detailed information about field binding syntax, see Field Mapping. For supported field types, see Supported Field Types.
Source Code
  • SystemConsts.java
  • SheetConstants.ts
  • AddTaskCommand.ts
  • RiskSheetContextMenu.ts
  • InsertRowsBelowCommand.ts