Skip to main content
Properties are organized by functional area. Use your browser’s search function (Ctrl+F / Cmd+F) to find specific properties. Many properties support PolarionExpressionEvaluator syntax for dynamic values—these are marked with 🔄.

Global Settings

PropertyTypeDefaultDescription
global.culturestringenLocalization culture code (e.g., en-US, de-DE) for interface language
global.helpstringnullURL or path to custom help documentation for this configuration
global.refreshOnSavebooleanfalseAutomatically refresh risksheet after saving changes
global.addAsSubmenubooleanfalseDisplay RISKSHEET as submenu item in Polarion navigation
global.suggestTextFieldsbooleantrueEnable autocomplete suggester for text field columns

Suggester Configuration

The suggester provides autocomplete suggestions for text fields based on previous values in other risk documents.
PropertyTypeDefaultDescription
global.isSuggesterFuzzySearchingbooleantrueEnable fuzzy/similarity search to find similar words
global.isSuggesterWildcardSearchingbooleantrueEnable wildcard searching for incomplete words (e.g., “risk*” finds “risksheet”)
global.isSuggesterKeywordsMandatorybooleanfalseRequire all keywords to match (true) or find best match even with missing keywords (false)
global.isSearchAllFieldsWhenSearchingLinkedItemsbooleanfalseSearch all work item fields (not just ID/title) when searching in itemLink columns

Suggester Example

With default settings, searching for “risk mitigation” will:
  • Find similar words: “risk” matches “risks”, “mitigating” matches “mitigation”
  • Allow partial words: “mit” finds “mitigation”
  • Use OR logic: finds results with “risk” OR “mitigation” (not both required)

Risk and Task Configuration

Define work item types and linking behavior for risks and mitigation tasks.

Risk Item Types 🔄

PropertyTypeDefaultDescription
dataTypes.risk.typestringriskWork item type ID for risk items (comma-separated for multiple types)
dataTypes.risk.rolestringrelates_toLink role when creating risk relationships
dataTypes.risk.namestringRiskDisplay name for risk items in UI
dataTypes.risk.zoomColumnstringnullColumn ID that identifies risks for zoom/focus operations
dataTypes.risk.showInMenubooleantrueShow risk creation option in navigation menu
dataTypes.risk.removeStrategystringdeleteStrategy for removing risks: delete (permanent) or other custom method
dataTypes.risk.rejectedActionstringrejectWorkflow action to execute when risk is rejected during review
dataTypes.risk.rejectedStatusstringrejectedStatus value to set for rejected risks
dataTypes.risk.rejectedResolutionstringinvalidResolution value to set for rejected risks

Task/Mitigation Item Types 🔄

PropertyTypeDefaultDescription
dataTypes.task.typestringtaskWork item type ID for task/mitigation items (comma-separated for multiple types)
dataTypes.task.rolestringrelates_toLink role when creating task relationships
dataTypes.task.namestringTaskDisplay name for task items in UI
dataTypes.task.zoomColumnstringnullColumn ID that identifies tasks for zoom/focus operations
dataTypes.task.showInMenubooleantrueShow task creation option in navigation menu

Example: Multiple Risk Types

{
  "dataTypes": {
    "risk": {
      "type": "hazard,failure",
      "name": "Risk Item"
    }
  }
}

Hierarchical Levels

Organize work items into collapsible hierarchies.
PropertyTypeDefaultDescription
levels[].namestringLevel {N}Display name for this hierarchical level
levels[].controlColumnstringsystemItemIdColumn ID that controls expand/collapse behavior
levels[].zoomColumnstringnullColumn ID for identifying items at this level
levels[].showInMenubooleantrueDisplay this level in navigation menu

Example: Risk Categories

{
  "levels": [
    {
      "name": "Risk Category",
      "controlColumn": "category",
      "showInMenu": true
    },
    {
      "name": "Individual Risks",
      "controlColumn": "systemItemId",
      "showInMenu": false
    }
  ]
}

Column Properties

Column Definition 🔄

PropertyTypeDefaultDescription
columns[].idstringauto-generatedUnique column identifier (auto-generated from header/binding if not specified)
columns[].headerstringrequiredDisplay text for column header
columns[].bindingstringcolumn.idData binding path for values
columns[].typestringauto-detectedColumn data type: string, int, float, enum:{enumId}, workflow, itemLink, taskLink, multiItemLink, multiEnum:{enumId}, date, datetime, time, boolean, currency, calculated
columns[].levelnumber1Hierarchical level (1=top level, 2=second, etc.)
columns[].widthnumber/stringnullColumn width in pixels or star notation (e.g., “2*“)
columns[].minWidthnumbernullMinimum column width in pixels
columns[].readOnlybooleanfalseMake column non-editable
columns[].canCreatebooleantrueAllow creating new items from itemLink/multiItemLink cells
columns[].filterablebooleantrueAllow filtering by this column’s values
columns[].formatstringnullFormat string for display (e.g., #,##0.00 for currency)
columns[].formulastringnullClient-side calculation formula (auto-sets readOnly=true)
columns[].serverRenderstringnullServer-side rendering script (auto-sets type=string, readOnly=true)
columns[].cellRendererstringnullCustom cell renderer identifier
columns[].cellCssstringnullCSS class for cell styling
columns[].headerGroupstringnullGroup header text for column grouping
columns[].collapseTostringnullCollapse this column into another column ID
columns[].multiLinebooleantrueUse textarea instead of single-line input for editing
columns[].wordWrapbooleantrueWrap text within cells
columns[].showEnumDescriptionbooleanfalseShow enum option descriptions in dropdown
columns[].headerTooltipstringnullTooltip text displayed on header hover

Column Type Examples

{
  "columns": [
    {
      "header": "Severity",
      "binding": "severity",
      "type": "enum:severityRating",
      "readOnly": false
    },
    {
      "header": "Risk Priority",
      "binding": "priority",
      "type": "calculated",
      "formula": "severity * occurrence"
    },
    {
      "header": "Related Requirement",
      "binding": "relatedReq",
      "type": "itemLink",
      "canCreate": true
    }
  ]
}

Header Configuration

PropertyTypeDefaultDescription
headers.rowHeader.widthnumber90Width of row header column in pixels
headers.rowHeader.rendererstringnullCustom renderer for row header cells
headers.columnHeader.heightnumbernullHeight of column header row in pixels
headers.columnGroupHeader.heightnumbernullHeight of column group header row in pixels

Review Management

PropertyTypeDefaultDescription
reviews.reviewManagerstringnullReview type: CommentBased, ApprovalBased, or WorkItemBased
reviews.typeProperties.linkTypesstringnullLink types for review items (WorkItemBased only)
reviews.typeProperties.linkRolestringnullLink role for review relationships (WorkItemBased only)
reviews.typeProperties.querystringnullQuery to filter review items (WorkItemBased only)
reviews.typeProperties.documentstringnullDocument path for creating/loading reviews (WorkItemBased only)
reviews.typeProperties.projectstringnullProject ID for reviews (WorkItemBased only, supports PolarionExpressionEvaluator)
reviews.typeProperties.itemTemplatestringnullVelocity template for rendering reviews (WorkItemBased only)

Project-Level Configuration Properties

These settings are configured via Project Administration > Configuration Properties and apply to all risksheets in the project.
PropertyTypeDefaultDescription
nextedy.risksheet.riskDocumentTypestringriskSpecificationDocument type(s) representing risk analysis
nextedy.risksheet.risksheetTemplatePathstringRisks/Risk SpecificationPath to template document for creating new risk analyses
nextedy.risksheet.upstreamSubColumnsReadonlybooleantrueMake upstream property columns read-only
nextedy.risksheet.checkPrototypePermissionsbooleantrueCheck work item permissions (disable for custom permissions)
nextedy.risksheet.branchingSupportbooleanfalseEnable support for Polarion branched documents
nextedy.risksheet.disable_admin_checkbooleanfalseRestrict Configure action to project administrators only
nextedy.risksheet.editableReferencedWorkItemsbooleanfalseAllow editing referenced items on branched risksheets
nextedy.risksheet.upstreamChainsstringnullEnable extra chains between upstream items (e.g., harm-relates_to-hazard)
nextedy.risksheet.checkInstanceFieldPermissionsbooleanfalseEnable field-level access control (beta)
nextedy.risksheet.checkLinkRoleCompliancebooleanfalseSupport multiple link roles for the same column (v24.2.2+)
nextedy.risksheet.downstreamFromRevisionbooleanfalseFreeze downstream items at baseline revision
nextedy.risksheet.moduleOnlyPermissionsbooleanfalseSkip item-level permission checks for large risksheets (v24.8.5+)
nextedy.risksheet.loadTasksFromDocumentbooleanfalseLoad tasks only from specific document (v23.8.3+)
nextedy.risksheet.includeProjectBaselinesbooleanfalseLoad project baselines for comparison (v24.2.0+)

Configuration Lookup Diagram

Config not taking effect?
  • Verify risksheet.json is attached to the correct document (check hierarchy diagram above)
  • Confirm JSON syntax is valid (use Configuration Editor to validate)
  • Check if document-specific config is overriding your template settings
  • Refresh the browser cache (Ctrl+Shift+R or Cmd+Shift+R)
Unexpected values?
  • Properties that support PolarionExpressionEvaluator (marked 🔄) use dynamic values—check the expression
  • Verify no document-level config override exists
  • Check if Polarion custom fields are affecting the value

See Also

KB ArticlesSupport TicketsSource Code
  • RisksheetViewServlet.java
  • AppConfigParser.ts
  • DocumentConfigProvider.java
  • ShowConfigurationCommand.ts
  • OpenHelpCommand.ts