Skip to main content

​
File Overview

diagram

​
Top-Level Sections

SectionTypeRequiredDescription
columnsobjectYesColumn definitions mapping binding paths to display configuration. See Columns.
sourcesarrayYesData source configurations defining entity queries and expansion. See Sources.
columnGroupsobjectNoVisual column groupings with header styling. See Column Groups.
viewsobjectNoNamed column visibility presets. See Views.
sortByarrayNoDefault sort order for rows. See Sort By.
stylesobjectNoNamed style definitions for cells and headers. See Styles.
formattersobjectNoConditional formatting rules. See Formatters.

​
columns

The columns section maps binding paths to column display configurations. Each key is a dot-separated binding path from the domain model. 
columns:
  outlineNumber:
    title: "#"
    width: 60
  title:
    title: Title
    width: "*"
    hasFocus: true
  systemRequirements.systemRequirement.title:
    title: Sys Req Title
    width: 200

​
Column Properties

PropertyTypeDefaultDescription
titlestringBinding pathDisplay label for the column header
widthnumber or string"*"Width in pixels or proportional ("*", "2*")
minWidthnumber150Minimum column width in pixels
visiblebooleantrueWhether the column is shown by default
hasFocusbooleanfalseColumn receives initial focus for editing
columnGroupstringSee applicationAssigns column to a visual group
formatterstringSee applicationReferences a conditional formatting rule
headerobjectSee applicationColumn header appearance (YAML anchor to styles)
groupBybooleanfalseEnables row grouping by this column
sortstringSee applicationDefault sort direction ("asc" or "desc")
multiItembooleanfalseDisplays multiple related items from one-to-many relationships
displaystringSee applicationProperty of a referenced object to display
isReadOnlybooleanfalsePrevents editing (deprecated; use formatter: readOnly)
For full details, see Column Properties and Binding Syntax.

​
columnGroups

Groups related columns under a shared header: 
columnGroups:
  requirements:
    groupName: Requirements
    groupStyle: blue
    headerStyle: darkBlue
    collapseTo: systemRequirements.systemRequirement.title
PropertyTypeDefaultDescription
groupNamestring(required)Display name for the group header
groupStylestringSee applicationBackground color theme
headerStylestringSee applicationHeader text color theme
collapseTostringSee applicationBinding path shown when the group is collapsed

​
views

Named column visibility presets for switching perspectives: 
views:
  Without V&V:
    columns:
      validationTestCases.validationTestCase:
        visible: false
PropertyTypeDefaultDescription
View keystring(required)View name (used in menu and URL parameter)
columnsobject(required)Column visibility overrides by binding path
columns.<binding>.visiblebooleantrueSet to false to hide a column in this view

​
sources

Data source configurations define which entities to load and how to expand relationships: 
sources:
  - id: main
    title: RTM View
    model: rtm-model
    query:
      from: UserNeed
      where: <WHERE>
      take: <TAKE>
    constraints:
      applyCurrentDocumentTo: UserNeed
    expand:
      - name: systemRequirements
        title: System Requirements
        expand:
          - name: designRequirements
            title: Design Requirements
PropertyTypeDefaultDescription
idstring(required)Unique identifier for this data source
titlestringSee applicationDisplay label for the data source
modelstring(required)Reference to the domain model name
query.fromstring(required)Root entity type to query
query.wherestringSee applicationFilter predicate (Lucene query syntax)
query.takestringSee applicationMaximum records to return
constraints.applyCurrentDocumentTostringSee applicationEntity type to scope to the current document
expandarraySee applicationNavigation properties to expand for loading related entities
expand[].namestring(required)Navigation property name from the domain model
expand[].titlestringSee applicationDisplay title for the expanded group
The model property supports dynamic expressions: model: "=context.parameters.model" resolves the model name from document parameters at runtime.

​
sortBy

Default sort configuration: 
sortBy:
  - columnId: outlineNumber
    direction: asc
  - columnId: priority
    direction: desc
PropertyTypeDefaultDescription
columnIdstring(required)Dot-separated binding path to the column
directionstring"asc""asc" (ascending) or "desc" (descending)

​
File Storage and Selection

AspectDetails
Default filenamepowersheet.yaml
Storage locationProject SVN repository or global repository
Selection methodThe nextedySheetConfig custom field on the Polarion LiveDoc document
Global configsAppear with “(Global)” suffix; ID starts with /
Project configsID is the filename without path
Editor accessAdministration > Nextedy POWERSHEET > Sheet Configurations, or click Edit Config in the Powersheet toolbar
The configuration editor supports YAML syntax highlighting, JSON Schema validation, undo/redo, and scope management (instance, template, default).

​
Built-in Styles

Powersheet provides 20 built-in styles available without explicit definition:
StylePurpose
noneNo styling
boldTitleBold text
readOnlyRead-only visual indicator
unsupportedUnsupported field indicator
grey, red, orange, green, blue, purple, tealStatus and category colors
Dark variants (darkGrey, darkRed, etc.)Darker shade alternatives
Custom styles defined in the styles section are merged on top of these defaults.

​
Complete YAML Example

columnGroups:
  userNeeds:
    groupName: User Needs
    groupStyle: blue
    headerStyle: darkBlue
    collapseTo: title
  sysReqs:
    groupName: System Requirements
    groupStyle: green
    headerStyle: darkGreen
    collapseTo: systemRequirements.systemRequirement.title

sortBy:
  - columnId: outlineNumber
    direction: asc

columns:
  outlineNumber:
    title: "#"
    width: 60
    sort: asc
  title:
    title: Title
    width: "*"
    hasFocus: true
    columnGroup: userNeeds
    formatter: boldTitle
  severity:
    title: Severity
    width: 100
    columnGroup: userNeeds
  systemRequirements.systemRequirement:
    title: System Requirement
    display: title
    width: 200
    columnGroup: sysReqs
    list:
      search:
        - title
        - id
  systemRequirements.systemRequirement.severity:
    title: Sys Req Severity
    width: 120
    columnGroup: sysReqs

views:
  Compact:
    columns:
      systemRequirements.systemRequirement.severity:
        visible: false

sources:
  - id: main
    title: RTM
    model: rtm-model
    query:
      from: UserNeed
    constraints:
      applyCurrentDocumentTo: UserNeed
    expand:
      - name: systemRequirements
        title: System Requirements
Source: Core Concepts KB article, sheet configuration service features, configuration editor features, administration page registration
KB ArticlesSource Code
  • 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
  • prod-powersheet-src/com.nextedy.powersheet/src/com/nextedy/powersheet/PowersheetProduct.java
  • prod-powersheet-src/com.nextedy.powersheet/src/com/nextedy/powersheet/PowersheetDocumentConfigurationService.java