Skip to main content
NameTypeDefaultDescription
linkRolestringNone (required when storage: linkedWorkItems)Polarion link role ID used to store the relationship. Must match a link role defined in the Polarion project configuration.
The linkRole value must exactly match a link role ID defined in Administration > Work Item Link Roles in your Polarion project. A mismatch causes relationship data to fail to load.
diagram The link role bridges the domain model and Polarion. When Powersheet loads data, it queries Polarion for work items linked via the specified link role. When users create or remove links in the sheet, the corresponding Polarion link role is used. The linkRole property appears in the relationships array of the domain model YAML: 
relationships:
  - from: UserNeed
    to: SystemRequirement
    cardinality: one-to-many
    storage: linkedWorkItems
    linkRole: refines
    direct:
      name: systemRequirements
    back:
      name: userNeeds

​
Relationship Properties That Work With linkRole

NameTypeDefaultDescription
fromstringNone (required)Source entity type name
tostringNone (required)Target entity type name
cardinalitystringNone (required)Relationship multiplicity. See Cardinality
storagestringNone (required)Must be linkedWorkItems when using linkRole. See Storage
linkRolestringNone (required)Polarion link role ID
directobjectNoneForward navigation property definition
backobjectNoneReverse navigation property definition
fromNavPropNamestringNoneAlternative to direct.name for forward navigation property
toNavPropNamestringNoneAlternative to back.name for reverse navigation property
Link Role IDTypical UsageFrom EntityTo Entity
refinesRequirements refinementUserNeedSystemRequirement
refinesDesign decompositionSystemRequirementDesignRequirement
verifiesVerification traceabilityVerificationTestCaseSystemRequirement
validatesValidation traceabilityValidationTestCaseUserNeed
mitigatesRisk control traceabilityRiskControlHazard
relatesToExternal referencesExternalReferenceDesignRequirement
Before using a linkRole value in the domain model, verify the link role exists in Polarion:
  1. Navigate to Administration > Work Item Link Roles
  2. Confirm the link role ID matches the value used in linkRole
  3. Verify the link role allows connections between the intended work item types
  4. Check if the link role is bidirectional (recommended for most traceability relationships)
Bidirectional link roles are recommended for traceability relationships. They allow Powersheet to traverse the relationship in both directions using direct and back navigation properties.

​
Complete YAML Example

domainModelTypes:
  UserNeed:
    polarionType: userNeed
    properties:
      description:
      severity:

  SystemRequirement:
    polarionType: systemRequirement
    properties:
      description:

  DesignRequirement:
    polarionType: designOutput
    properties:
      description:

  ExternalReference:
    properties:
      description:

  Hazard:
    polarionType: hazard
    properties:
      description:

  RiskControl:
    polarionType: riskControl
    properties:
      description:

relationships:
  - from: UserNeed
    to: SystemRequirement
    cardinality: one-to-many
    storage: linkedWorkItems
    linkRole: refines
    direct:
      name: systemRequirements
    back:
      name: userNeeds

  - from: SystemRequirement
    to: DesignRequirement
    cardinality: one-to-many
    storage: linkedWorkItems
    linkRole: refines
    direct:
      name: designRequirements
    back:
      name: systemRequirements

  - from: ExternalReference
    to: DesignRequirement
    cardinality: many-to-one
    storage: linkedWorkItems
    linkRole: relatesTo
    direct:
      name: designRequirement
    back:
      name: externalReferences

  - from: Hazard
    to: RiskControl
    cardinality: one-to-many
    storage: linkedWorkItems
    linkRole: mitigates
    direct:
      name: riskControls
    back:
      name: hazards
KB ArticlesSource Code
  • Relationship.java
  • todosBig_model.yaml
  • prod-powersheet-src/com.nextedy.powersheet.client/cypress/fixtures/models/constraints_create_only.yaml
  • todos_model.yaml
  • model.yaml