The Two Scopes
Configuration files — both domain models and sheet configurations — can be stored at two levels in the Polarion repository:| Scope | Where It Lives | Visibility | Naming Convention |
|---|---|---|---|
| Global | Repository-level (global) configuration directory | Available to all projects | Displayed with (Global) suffix in pickers |
| Project-specific | Project-level configuration directory | Available only within that project | Displayed by filename |
Why Two Scopes Exist
In enterprise environments, multiple Polarion projects often share the same engineering methodology. A medical device program might have separate projects for hardware, software, and system integration, but all three follow the same traceability model (e.g.,UserNeed to SystemRequirement to DesignRequirement). Without a global scope, administrators would need to duplicate identical domain models and sheet configurations in every project.
The global scope provides a single source of truth for shared configurations. Individual projects can then:
- Use global configurations as-is
- Define project-specific configurations that supplement the global ones
- Create project-specific configurations that address unique project needs
Administration Interface
Both global and project-specific configurations are managed through the Polarion administration interface. Powersheet adds administration pages under Administration > Nextedy POWERSHEET, organized into:- Data Models — manage domain model YAML files
- Sheet Configurations — manage sheet configuration YAML files
| Scope Level | Configuration Property |
|---|---|
| Project | projectScope = true |
| Project Group | projectGroupScope = true |
| Repository (Global) | repositoryScope = true |
How Configuration Files Are Discovered
When a Powersheet document loads, it needs to resolve its sheet configuration and domain model. The configuration discovery process scans both global and project-specific directories for YAML files:- Global configurations are scanned first. Their IDs start with
/and their display names include a(Global)suffix. - Project-specific configurations are scanned next. Their IDs use the filename without a path prefix, and their display names use the filename without the file extension suffix.
Domain Models: Global vs Project
Domain models follow the same scoping pattern as sheet configurations. When a sheet configuration references a model by name (via themodel property in the sources section), Powersheet resolves the model from both global and project-specific directories.
This separation is particularly valuable when:
- Entity types are consistent across projects but individual projects have different Polarion work item type IDs. Each project can define its own domain model with the same entity names but different
polarionTypemappings. - Relationships vary by project. The global model can define the common traceability chain, while project-specific models add relationships unique to a given project.
Sheet Configurations: Global vs Project
Sheet configurations define columns, views, formatters, sources, and styles. A global sheet configuration provides a standard layout that all projects can use, while project-specific configurations can tailor column visibility, column groups, or styling to local needs. Thesources section of a sheet configuration references a domain model by name. If the model exists at both global and project level, the project-level model takes precedence for that project.
Project-Specific Properties
Beyond YAML configuration files, Powersheet also reads project-level properties from Polarion’s configuration system. These properties control runtime behavior:| Property | Purpose |
|---|---|
| Powersheet document query | Lucene query identifying which documents appear in Powersheet Drive |
| Sheet configuration field ID | Custom field linking documents to their configuration |
| Open button title | Text displayed on the “Open in Powersheet” button |
The exact override behavior when both a global and project-specific configuration share the same filename should be verified in your Powersheet installation, as resolution precedence may depend on the version.
When to Use Each Scope
| Scenario | Recommended Scope |
|---|---|
| Standard RTM traceability model used across all projects | Global |
| Organization-wide column layout for compliance views | Global |
| Project with unique entity types not used elsewhere | Project-specific |
| Experimenting with a new configuration before standardizing | Project-specific |
Adjusting polarionType mappings for a migrated project | Project-specific |
Related Pages
- YAML Configuration System — how configuration files are structured
- Data Model vs Sheet Configuration — understanding the two configuration layers
- Powersheet Architecture — where configuration fits in the overall system
- Core Components — the building blocks of Powersheet
Sources
Sources
KB ArticlesSource Code
prod-powersheet-src/com.nextedy.powersheet.client/cypress/e2e/admin/admin.cy.tsprod-powersheet-src/com.nextedy.powersheet/src/com/nextedy/powersheet/enumProvider/SheetConfigEnumProvider.javaSaveTest.javaprod-powersheet-src/com.nextedy.powersheet/src/META-INF/hivemodule.xmlprod-powersheet-src/com.nextedy.powersheet.client/src/modules/DocumentProvider/DocumentProvider.tsx