Entity Types and Properties - Nextedy Documentation

How do I define entity types in the data model?

Entity types are defined in the domainModelTypes section of the YAML file using map format only — each key is the entity type name, and the value contains its configuration. The polarionType property maps the entity type to a Polarion work item type.

domainModelTypes:
  UserNeed:
    polarionType: user_need
    properties:
      description:
      severity:
  SystemRequirement:
    polarionType: sys_req
    properties:
      description:
      severity:

Map format onlyThe domainModelTypes section must use map format (keyed by type name). Array format is not supported and will not work.

How do entity type properties work?

Each entry under properties defines a field exposed in the Powersheet sheet. Properties are listed as keys under the entity type. Key property attributes include:

Attribute	Purpose	Default
`name`	Client-facing property name	Required
`serverName`	Polarion field name override	Same as `name`
`customFieldName`	Polarion custom field ID	—
`readable`	Can be read by users	`true`
`updatable`	Can be modified by users	`true`
`scalar`	Single value vs. collection	`true`
`enumValues`	Valid enum option IDs	—

Use serverName to alias Polarion field names to more user-friendly names, and customFieldName when a property maps to a Polarion custom field rather than a built-in field.