Skip to main content
See also: Domain Model Types | Relationships | Permissions

​
Property Definition Overview

diagram

​
Property Configuration Properties

NameTypeDefaultDescription
namestringNone (required)Property name as exposed in queries and column bindings. Must be unique within the entity type.
serverNamestringSame as nameOptional override for the actual Polarion field name when it differs from the client-facing property name. Allows aliasing Polarion field names to more user-friendly names.
customFieldNamestringNoneSpecifies the Polarion custom field ID for properties stored in custom fields. Required when property maps to a custom field rather than a built-in work item field.
typestringNoneData type of the property (string, integer, date, enum, etc.). Determines validation and rendering behavior.
storagestringNoneDefines how the property value is persisted in Polarion (e.g., work item field, linked items). Critical for navigation properties and relationships.
enumValuesarrayNoneList of valid enum option IDs when property type is an enumeration. Values must match Polarion enum IDs.
readablebooleantrueControls whether the property can be read by users. Set to false to hide internal properties. See Permissions.
updatablebooleantrueControls whether the property can be modified by users. Set to false to enforce read-only properties. See Permissions.
scalarbooleantrueIndicates whether property holds a single value (true) or a collection (false). Affects data binding and query expansion.
navigabilitystringNoneDefines navigation direction for relationship properties (one-way, two-way). Controls whether relationships can be traversed in queries using expand clauses.

​
Defining Properties in YAML

Properties are declared within each entity type under the properties key. Simple property declarations use null values to indicate the property exists without additional constraints: 
domainModelTypes:
  UserNeed:
    polarionType: userNeed
    properties:
      title:
      description:
      severity:
      component:
      type:
A property set to null (or left empty after the colon) inherits default settings. The property name is used as the Polarion field name unless serverName or customFieldName is specified.

​
Properties with Explicit Configuration

When a property requires custom settings, provide an object with the desired attributes: 
domainModelTypes:
  SystemRequirement:
    polarionType: systemRequirement
    properties:
      title:
      description:
      severity:
      customRating:
        customFieldName: c_rating
        type: enum
        enumValues:
          - high
          - medium
          - low
      internalNotes:
        readable: false
        updatable: false
Properties can also represent relationships to other entity types. These navigation properties are created automatically from Relationships definitions but can also be declared inline: 
domainModelTypes:
  TodoItem:
    properties:
      title:
      description:
      tasks:
        to: Task
        cardinality: one-to-many
NameTypeDefaultDescription
tostringNone (data field)Specifies the target entity type for a navigation property, creating a relationship to another domain model type.
cardinalitystringNoneRelationship multiplicity for navigation properties: one-to-one, one-to-many, many-to-one, many-to-many.
Domain model type names referenced in to must be single words without spaces or special characters. They must match a domainModelTypes name — not a Polarion work item type ID.

​
Built-in Properties

All work item entity types automatically include these built-in properties:
PropertyTypeDescription
objectIdstringUnique primary key identifier. Read-only.
idstringPolarion work item ID. Read-only.
titlestringWork item title/name.
projectIdstringForeign key to the containing project.
outlineNumberstringPosition in document hierarchy. Automatically managed by Polarion.

​
Special Entity Properties

The built-in Document and Chapter entity types have specialized property behavior:
  • Document properties include: moduleFolder, moduleName, title, type, allowedWITypes — some of these are create-only (set during document creation, read-only thereafter)
  • Chapter represents Polarion headings and is used for document structure elements

​
Complete YAML Example

domainModelTypes:
  Document:
    properties:
      title:
      type:

  Chapter:

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

  SystemRequirement:
    polarionType: systemRequirement
    properties:
      title:
      description:
      severity:
      component:
      customPriority:
        customFieldName: c_priority
        type: enum
        enumValues:
          - critical
          - high
          - medium
          - low
        readable: true
        updatable: true

  DesignRequirement:
    polarionType: designOutput
    properties:
      title:
      description:
      severity:

relationships:
  - from: UserNeed
    to: SystemRequirement
    cardinality: one-to-many
    storage: linkedWorkItems
    linkRole: refines
    direct:
      name: systemRequirements
    back:
      name: userNeeds
Related pages: Domain Model Types | Constraints | Storage | Permissions | Binding Syntax
KB ArticlesSupport TicketsSource Code
  • prod-powersheet-src/com.nextedy.powersheet.client/cypress/fixtures/models/constraints-base.yaml
  • todosBig_model.yaml
  • Property.java
  • sf_model.yaml
  • model.yaml