Skip to main content

​
Configuration Basics

​
What is a sheet configuration?

A sheet configuration is a YAML file that defines how Powersheet displays and interacts with data from the domain model. It specifies columns, data sources, views, column groups, formatters, and sorting behavior. Each Powersheet document references a sheet configuration through the nextedySheetConfig custom field. Configurations are managed in Administration > Nextedy POWERSHEET > Sheet Configurations. See Creating Your First Sheet Configuration for a step-by-step tutorial.

​
How does a sheet configuration relate to the domain model?

The sheet configuration depends on the domain model for entity type definitions, relationships, and property metadata. Column binding paths in the configuration reference properties and expansion paths defined in the domain model. The model property in the sources section specifies which domain model to use. If the model and configuration do not match, you will see errors when loading the sheet. diagram

​
Should I start with a complex configuration or build incrementally?

Start with the simplest possible configuration — a single entity type, a few columns, and one data source. Verify that the basic setup loads correctly, then extend gradually by adding relationships, column groups, and formatters. Jumping to a complex multi-entity configuration leads to difficult-to-diagnose errors.
See Incremental Configuration Approach for a recommended step-by-step build strategy.

​
Columns and Binding Paths

​
How do column binding paths work?

Column keys in the YAML use dot-separated binding paths that follow the expansion paths defined in the domain model. A simple property like title maps directly to the base entity, while a multi-level path like systemRequirements.systemRequirement.severity navigates through a relationship to access a property on a related entity type. Each segment of the path corresponds to a navigation property in the domain model. 
columns:
  title:
    title: "Title"
    width: 250
    hasFocus: true
  systemRequirements.systemRequirement.severity:
    title: "Req Severity"
    width: 100
    formatter: severity-formatter

​
What column properties can I configure?

Each column supports several configuration properties:
PropertyTypeDescription
titlestringDisplay header text
widthnumberColumn width in pixels
visiblebooleanShow in default view (default: true)
hasFocusbooleanReceives focus when editing a row
formatterstringName of a formatter for conditional styling
columnGroupstringAssociates column with a visual group
Column visibility can be overridden in named views, allowing different analysis perspectives without changing the base configuration.

​
Data Sources and Scoping

​
How do data sources work in the sheet configuration?

The sources section defines how Powersheet queries data from Polarion. Each data source specifies a model reference, a from entity type, optional where filters, expand paths for loading related entities, and take limits. Powersheet automatically applies document-scoping constraints to all queries, ensuring data is filtered to the current document context. 
sources:
  - model: my-rtm-model
    from: UserNeed
    where: "type:user_need"
    take: 500
    expand:
      - systemRequirements

​
Can I use dynamic values in my configuration?

Yes. Sheet configurations support $context expressions that are resolved at runtime. For example, $context.parameters.model lets you resolve the model name from document parameters rather than hardcoding it. Dynamic values are also used in constraint definitions to route entity creation based on the source entity type.

​
Can multiple documents share the same configuration?

Yes. Sheet configurations are standalone YAML files stored in the repository. Multiple Powersheet documents can reference the same configuration file through the nextedySheetConfig custom field. This is the recommended approach for maintaining consistent views across related documents. Global configurations (stored at the repository level) can be shared across all projects in your Polarion instance.

​
Document Management

​
How are Powersheet documents created?

Powersheet documents are created as Polarion LiveDoc modules with a specific document type (typically containing “powersheet”). You can create documents through the Powersheet administration interface by specifying a name, folder location, and the sheet configuration to use. Documents can also be created by duplicating an existing template, which copies the module structure and content from another project.

​
What shows up in the Powersheet Drive sidebar?

Powersheet Drive displays all documents matching the configured document query in the project. By default, it lists all documents of type powersheet. You can customize which documents appear by configuring the com.powersheet.powersheetDocumentQuery project property to include additional document types or apply custom filters. See Setting Up Navigation for details on configuring Powersheet Drive.
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.client/cypress/fixtures/configurations/constraints_composing.template.yaml
  • prod-powersheet-src/com.nextedy.powersheet/src/com/nextedy/powersheet/enumProvider/SheetConfigEnumProvider.java
  • prod-powersheet-src/com.nextedy.powersheet.client/src/modules/Powersheet/Powersheet.tsx
  • prod-powersheet-src/com.nextedy.powersheet/src/META-INF/hivemodule.xml