Skip to main content

​
Prerequisites

  • Access to your project’s domain model YAML file via Administration > Nextedy POWERSHEET > Domain Models or through Menu > Configuration > Edit Model within a powersheet document
  • The Polarion work item type you want to map to must already exist in your project configuration

​
Step 1: Open the Domain Model

  1. Open your powersheet document
  2. Go to Menu > Configuration > Edit Model
  3. Locate the domainModelTypes section in the YAML editor

​
Step 2: Add the Entity Type

Add a new key under domainModelTypes with a PascalCase name. The key becomes the entity type name used throughout Powersheet. 
domainModelTypes:
  UserNeed:
    polarionType: userNeed
    properties:
      description:
      severity:
      component:
      type:

​
Entity Type Properties

PropertyRequiredDescription
polarionTypeRecommendedMaps to a Polarion work item type ID. If omitted, the entity type name is used.
propertiesYesMap of property names to expose. Use null values for default configuration.
Domain model type names must be single words without spaces or special characters. Use PascalCase: SystemRequirement is valid, System Requirement is not. Invalid names cause silent errors during model loading.

​
Step 3: Define Properties

List the Polarion work item fields you want to expose. Each key in properties must match a built-in field name or custom field name in Polarion. 
SystemRequirement:
  polarionType: systemRequirement
  properties:
    description:
    severity:
    component:
    type:
    status:
Common built-in properties:
Property NameDescription
descriptionWork item description (rich text)
severitySeverity enum field
componentComponent assignment
typeWork item sub-type
statusWorkflow status
titleWork item title (automatically included)
Begin with only the properties you need to display in your sheet. You can add more properties later without breaking existing configurations. Starting with a simple single-entity setup makes it easier to diagnose errors.

​
Step 4: Add Built-in Types (If Needed)

The domain model supports two special built-in entity types that do not require polarionType: 
domainModelTypes:
  Document:
  Chapter:
  UserNeed:
    polarionType: userNeed
    properties:
      description:
  • Document — represents Polarion LiveDoc modules. Automatically includes module-level properties.
  • Chapter — represents document headings (structure elements).

​
Step 5: Save and Verify

  1. Save the domain model YAML
  2. Reload the powersheet document
  3. You should now see the new entity type available in source queries and relationship configurations
To verify the entity type is loaded correctly, use the Model Helper widget:
  • Set model to your model name
  • Set startEntity to your new entity type name
  • Set depth to 1
The Model Helper will display the entity type with its properties and any configured relationships.
After adding a new entity type, any relationships that reference it by name in from or to fields must use the exact type name (case-sensitive). A mismatch causes a “left error” (invalid from entity) or “right error” (invalid to entity).

​
Example: Adding Multiple Entity Types

domainModelTypes:
  Document:
  Chapter:

  UserNeed:
    polarionType: userNeed
    properties:
      description:
      severity:
      component:

  SystemRequirement:
    polarionType: systemRequirement
    properties:
      description:
      severity:
      component:

  DesignRequirement:
    polarionType: designOutput
    properties:
      description:
      severity:
      component:
The entity type name (DesignRequirement) is used within Powersheet for relationships, queries, and binding paths. The polarionType value (designOutput) is the Polarion work item type ID used for server queries. These can differ.

​
See Also

KB ArticlesSource Code
  • DataPropertyFactory.java
  • DatabridgeMetadata.java
  • DomainModelV2.java
  • DomainModelTypeV2.java
  • todosBig_model.yaml