Skip to main content

​
What you will achieve

By the end of this tutorial you will have:
  • A working sheet configuration with columns for UserNeed and related SystemRequirement entities
  • A data source that queries and expands the entity hierarchy
  • A configuration linked to your domain model

​
Prerequisites

​
Step 1: Open the sheet configuration administration

Navigate to Administration > Nextedy POWERSHEET > Sheet Configurations. Click New at the project level. Select System Default as the base and give your configuration a name (e.g., rtm-sheet). You should see: A new sheet configuration file opens in the editor with default template content. diagram

​
Step 2: Define columns

Replace the editor content with the following YAML. This defines columns for the root UserNeed entity and a nested column for related SystemRequirement entities: 
columns:
  title:
    header: User Need
    width: 250
  severity:
    header: Severity
    width: 120
  systemRequirements.systemRequirement:
    header: System Requirement
    width: 200
  systemRequirements.systemRequirement.severity:
    header: SR Severity
    width: 120
Each key under columns is a binding path that references properties from your domain model. The dot-separated path systemRequirements.systemRequirement navigates through the relationship defined in the domain model (using the fromNavPropName value). You should see: Four column definitions in the YAML editor.
The binding path systemRequirements.systemRequirement uses the navigation property name from your domain model’s fromNavPropName. The first segment (systemRequirements) is the navigation property; the second segment (systemRequirement) accesses the target entity type.

​
Step 3: Define the data source

Add a sources section below the columns. This tells Powersheet which domain model to use and how to query the data: 
sources:
  - model: rtm
    query:
      from: UserNeed
    expand:
      - systemRequirements:
          expand:
            - systemRequirement
The model value must match the name of the domain model you created. The query.from specifies the root entity type. The expand section defines which relationships to follow when loading data. You should see: The complete configuration now has both columns and sources sections.
The query.from value must be a domainModelTypes name from your domain model (e.g., UserNeed), not a Polarion work item type ID (e.g., userNeed). This is a common source of errors.

​
Step 4: Connect the configuration to the domain model

Under the Sources section of the editor, verify that the model value references the domain model you created in the previous tutorial. If your domain model is named rtm, use model: rtm. Save the sheet configuration.

​
Step 5: Review the complete configuration

Your complete sheet configuration should look like this: 
columns:
  title:
    header: User Need
    width: 250
  severity:
    header: Severity
    width: 120
  systemRequirements.systemRequirement:
    header: System Requirement
    width: 200
  systemRequirements.systemRequirement.severity:
    header: SR Severity
    width: 120

sources:
  - model: rtm
    query:
      from: UserNeed
    expand:
      - systemRequirements:
          expand:
            - systemRequirement
You should see: The configuration saves without errors.
Start with a minimal configuration like this one and extend it incrementally. Add one column or one entity type at a time. This makes it much easier to isolate and fix any configuration errors.

​
Next steps

KB ArticlesSupport TicketsSource Code
  • prod-powersheet-src/com.nextedy.powersheet.client/ltc-repo/packages/common/types/api/document.ts
  • prod-powersheet-src/com.nextedy.powersheet/src/com/nextedy/powersheet/PowersheetProduct.java
  • prod-powersheet-src/com.nextedy.powersheet/src/com/nextedy/powersheet/PowersheetService.java
  • prod-powersheet-src/com.nextedy.powersheet.client/ltc-repo/packages/common/types/domain/document.ts
  • prod-powersheet-src/com.nextedy.powersheet/src/META-INF/hivemodule.xml