Source file: .polarion/documents/fields/custom-fields.xml
Field Reference
| Field ID | Type | Display Name | Description |
|---|
subsystem | String | Subsystem | Associates the document with a specific system element subsystem |
templateDoc | Enum (@document) | Template Document | Links to a template document for document creation |
nextedySheetConfig | Enum (@NextedySheetConfigs) | Sheet Configuration | Binds the document to a risksheet or powersheet configuration |
version | Float | Version | Manual document version number |
Field Details
subsystem
The subsystem field associates a risk assessment document with a specific subsystem identifier from the System Element Type Hierarchy. This field is central to several solution features:
- DFMEA function scoping — The DFMEA risksheet top panel reads this field to set the
component JavaScript variable, which the functionQuery queryFactory uses to filter available functions to the current subsystem.
- DFMEA report breakdown — The DFMEA Summary Report reads this field to label each DFMEA module in the per-module breakdown table.
- Component RTM scoping — Used alongside
applyCurrentDocumentTo constraints in powersheet configurations.
The subsystem field is a free-text string, not a constrained enumeration. Values should match system element identifiers used elsewhere in the solution for consistent scoping behavior.
templateDoc
The templateDoc field uses the special @document dynamic enum type, which auto-discovers all documents in the project at runtime. When creating a new risk assessment document, users select an existing document as the template source.
The solution ships with four risk templates:
| Template Document | Path | Sheet Type |
|---|
| HARA Template | RiskTemplates/HARATemplate | HARA Risksheet |
| DFMEA Template | RiskTemplates/DFMEATemplate | DFMEA Risksheet |
| PFMEA Template | RiskTemplates/PFMEATemplate | PFMEA Risksheet |
| Risk Control Plan Template | RiskTemplates/RiskControlPlanTemplate | Risk Control Plan |
context.properties file under the nextedy.risksheet.risksheetTemplatePath property.
nextedySheetConfig
The nextedySheetConfig field uses the special @NextedySheetConfigs dynamic enum type, which auto-discovers available sheet configurations at runtime from the .polarion/nextedy/sheet-configurations/ directory. This field determines which risksheet or powersheet JSON configuration applies when the document is opened in the Nextedy sheet view.
Available configurations include all risksheet templates and powersheet configurations defined in the project.
Catalog documents (Hazards Catalog, Standard Harms) explicitly set this field to - No Sheet -, excluding them from risksheet editing. These catalogs are managed in the standard Polarion document view.
version
The version field is a float type (not integer), allowing minor version increments such as 1.0, 1.1, 1.2. This provides manual document version tracking independent of Polarion’s built-in revision system.
This field is displayed in the HARA risksheet top panel header alongside other document metadata (Item, Owner, Model, Core Team).
Document Type: riskSpecification
The riskSpecification document type has its own dedicated lifecycle:
| Status | Icon | Description |
|---|
draft | Blue | Initial editing state |
inReview | Yellow | Under review with approval signatures |
approved | Green | Review complete with at least one signature |
published | — | Released for use |
Document Types in the Solution
All seven document types available in the project:
| ID | Display Name | Default | Icon |
|---|
customerSpecification | Customer Specification | No | — |
systemRequirementsSpecification | System Requirements Specification | Yes | — |
designRequirementsSpecification | Design Requirements Specification | No | — |
testsSpecification | Tests Specification | No | — |
generic | Generic | No | — |
powersheet | Powersheet | No | document_risk |
riskSpecification | Risk Assessment | No | document_risk |
