Add a Custom Property - Nextedy Documentation

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 data model YAML via Menu > Configuration > Edit Model

Identify the Custom Field

Locate the custom field ID in Polarion. Custom field IDs typically use the c_ prefix.

Polarion Setting	Example
Custom field ID	`c_probability`
Display name	Probability
Field type	Enum / String / Integer
Applicable work item types	`hazard`

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.

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

Property	Type	Default	Description
`name`	string	(key name)	Property name used in queries and binding paths.
`customFieldName`	string	None	Polarion custom field ID. Required when the property name differs from the field ID.
`readable`	boolean	`true`	Controls whether the property is visible in the sheet.
`updatable`	boolean	`true`	Controls whether the property can be edited in the sheet.
`scalar`	boolean	`true`	`true` for single values, `false` for collections.

Add a Column for the Property

After adding the property to the data 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

Configure Enum Properties

If the custom field is an enumeration, you can optionally constrain the allowed values:

domainModelTypes:
  Hazard:
    polarionType: hazard
    properties:
      c_probability:

Enum values must match the exact option IDs defined in Polarion’s enumeration configuration. Check Administration > Enumerations for the correct IDs.

Configure Read-Only Properties

To make a property visible but not editable:

properties:
  c_calculatedScore:
    readable: true
    updatable: false

Verify

Save the data model
Reload the powersheet document
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.

​Prerequisites

​Property Configuration Options

​See Also

Prerequisites

Property Configuration Options

See Also