Skip to main content

Prerequisites

  • The custom field must already be defined in Siemens Polarion ALM (under Administration > Work Items > Custom Fields)
  • Access to the domain model and sheet configuration YAML files via Administration > Nextedy POWERSHEET

Step 1: Add the Property to the Domain Model

Open your domain model YAML and add the custom field under the appropriate entity type’s properties section. Use the Polarion custom field ID as the property name:
domainModelTypes:
  UserNeed:
    polarionType: user_need
    properties:
      title: ~
      description: ~
      severity: ~
      c_priority:
        readable: true
        updatable: true
The property name (e.g., c_priority) must match the Polarion custom field ID exactly. Polarion custom fields typically use the c_ prefix.
If the property name in the domain model does not match the Polarion custom field ID, the field will not load data. Double-check the field ID in Administration > Work Items > Custom Fields.

Step 2: Configure Permissions

Control field visibility and editability with the readable and updatable properties:
PropertyDefaultEffect
readabletrueControls whether the field is visible in the sheet
updatabletrueControls whether the field can be edited
# Read-only custom field
c_approvalStatus:
  readable: true
  updatable: false
Built-in fields like id and outlineNumber are automatically read-only regardless of the updatable setting.

Step 3: Add the Column to the Sheet Configuration

Reference the property in your sheet configuration’s columns section:
columns:
  c_priority:
    title: Priority
    width: 100
For custom fields on related entities, use the full binding path through the navigation property:
columns:
  systemRequirements.systemRequirement.c_priority:
    title: SR Priority
    width: 100

Step 4: Configure the Field Type (Optional)

Powersheet automatically detects the field type from Polarion metadata. The following type mappings are handled automatically:
Polarion TypeBehavior in Powersheet
String / TextInline text editor
IntegerNumeric editor
Float / CurrencyNumeric editor with decimal
BooleanCheckbox
DateDate picker
EnumDropdown with options
For enum-type custom fields, Powersheet auto-discovers the enumeration and creates the appropriate dropdown picker. See Configure an Enum Field for advanced enum configuration. diagram

Step 5: Verify

Reload the powersheet document. You should now see the custom field column displayed with the title you specified. Edit a cell value, save, and confirm the value persists in Polarion.
Open the work item in Polarion’s standard form view to confirm the custom field value matches what you entered in Powersheet.

See Also

Source Code
  • Property.java
  • SaveTest.java
  • MetadataTest.java
  • prod-powersheet-src/com.nextedy.powersheet.client/cypress/fixtures/models/permissions.yaml
  • DataPropertyFactory.java