Skip to main content

​
Prerequisites

  • The custom field must already be defined in Polarion (Administration > Custom Fields)
  • The entity type must exist in your domainModelTypes section
  • Access to the domain model YAML via Menu > Configuration > Edit Model

​
Step 1: Identify the Custom Field

Locate the custom field ID in Polarion. Custom field IDs typically use the c_ prefix.
Polarion SettingExample
Custom field IDc_probability
Display nameProbability
Field typeEnum / String / Integer
Applicable work item typeshazard

​
Step 2: Add the Property (Simple Form)

For most cases, add the property name directly under the entity type’s properties section. The property name must match the Polarion field name. 
domainModelTypes:
  UserNeed:
    polarionType: userNeed
    properties:
      description:
      severity:
      component:
      c_customRating:
Setting the value to null (empty after the colon) uses default configuration: the property is readable, updatable, and uses the property name as the Polarion field name.

​
Step 3: Add the Property (Extended Form)

For custom fields that need additional configuration, use the extended property format. 
domainModelTypes:
  Hazard:
    polarionType: hazard
    properties:
      description:
      severity:
      c_probability:
        customFieldName: c_probability
        readable: true
        updatable: true

​
Property Configuration Options

PropertyTypeDefaultDescription
namestring(key name)Property name used in queries and binding paths.
customFieldNamestringNonePolarion custom field ID. Required when the property name differs from the field ID.
readablebooleantrueControls whether the property is visible in the sheet.
updatablebooleantrueControls whether the property can be edited in the sheet.
scalarbooleantruetrue for single values, false for collections.
storagestringSee applicationPersistence mechanism for the property.
enumValuesarrayNoneAllowed values when the property type is an enumeration.
diagram

​
Step 4: Add a Column for the Property

After adding the property to the domain model, reference it in your sheet configuration: 
columns:
  c_customRating:
    title: Custom Rating
    width: 120
For properties on related entity types, use the full binding path: 
columns:
  systemRequirements.systemRequirement.c_customRating:
    title: SR Rating
    width: 120

​
Step 5: Configure Enum Properties

If the custom field is an enumeration, you can optionally constrain the allowed values: 
domainModelTypes:
  Hazard:
    polarionType: hazard
    properties:
      c_probability:
        enumValues:
          - frequent
          - probable
          - occasional
          - remote
          - improbable
Enum values must match the exact option IDs defined in Polarion’s enumeration configuration. Check Administration > Enumerations for the correct IDs.

​
Step 6: Configure Read-Only Properties

To make a property visible but not editable: 
properties:
  c_calculatedScore:
    readable: true
    updatable: false

​
Step 7: Verify

  1. Save the domain model
  2. Reload the powersheet document
  3. You should now see the custom property displayed in the sheet column
If the column shows empty values, verify:
  • The customFieldName matches the Polarion field ID exactly
  • The custom field is defined for the correct work item type in Polarion
  • The property readable is not set to false
Built-in Polarion fields (like description, severity, title) do not need a customFieldName. Custom fields (prefixed with c_) require the exact Polarion custom field ID. Using the wrong field ID results in empty columns without error messages.

​
See Also

Source Code
  • DatabridgeMetadata.java
  • DomainModelTypeV2.java
  • prod-powersheet-src/com.nextedy.powersheet.client/cypress/fixtures/models/permissions.yaml
  • prod-powersheet-src/com.nextedy.powersheet.client/cypress/fixtures/models/constraints-base.yaml
  • rtm_model.yaml