What you will achieve
By the end of this tutorial you will have:
- The
nextedySheetConfig custom field created for documents in your project
- The Powersheet topic added to your project’s navigation views
- Powersheet Drive visible in the left sidebar, listing all configured powersheet documents
Prerequisites
- Powersheet plugin installed and licensed (see Installing Powersheet)
- Administrator access to the Polarion project
- At least one sheet configuration uploaded to Administration > Nextedy POWERSHEET > Sheet Configurations
Without completing these steps, Powersheet Drive will not appear in the sidebar and documents cannot be associated with sheet configurations. Both the custom field and the navigation topic are required.
Step 1: Create the nextedySheetConfig custom field
Before Powersheet Drive can discover documents, each document needs a custom field that stores the reference to its sheet configuration file. You must create this field at the project level.
- Navigate to Administration > Documents & Pages > Document Custom Fields
- Add a new custom field with these settings:
| Setting | Value |
|---|
| ID | nextedySheetConfig |
| Name | Nextedy Sheet Config |
| Type | Enum (single value) |
- Save the custom field definition
You should see: The nextedySheetConfig field listed among your document custom fields. Powersheet automatically populates the enum options through the @NextedySheetConfigs enum provider, which discovers all uploaded sheet configuration files.
The enum provider dynamically lists all sheet configuration YAML files that have been uploaded through Administration > Nextedy POWERSHEET > Sheet Configurations. You do not need to manually define the enum values.
Step 2: Open the Topics configuration
Navigate to Administration > Portal > Topics in your Polarion project.
You should see: A list of views (such as admin, team, docspec) with their configured topics. Each view defines which sidebar topics are visible for users assigned to that view.
Step 3: Add the Powersheet topic
Add the following topic entry to each view where Powersheet should be available:
Add this entry to the admin, team, and docspec views so that all relevant user roles can see the Powersheet Drive in the sidebar.
You should see: The topic entry appears in the view configuration alongside other topics like Documents, Work Items, and Plans.
Adding the topic to a view makes Powersheet Drive visible for all users assigned to that view. You can selectively enable it for specific roles by only adding it to certain views.
Step 4: Assign a sheet configuration to a document
For Powersheet Drive to list a document, the document must have its nextedySheetConfig field set to a valid sheet configuration.
- Open a LiveDoc in your project
- Open the document properties panel
- Set the Nextedy Sheet Config field to one of the available sheet configurations
- Save the document
You should see: The selected sheet configuration name appears in the document properties. This document will now be discoverable by Powersheet Drive.
Step 5: Verify the Powersheet Drive
Save the topics configuration and navigate to your project home page. In the left sidebar, you should now see the Powersheet Drive entry.
You should see: Clicking Powersheet Drive displays a list of all documents in your project that have a valid nextedySheetConfig custom field value. Each document entry opens directly in the Powersheet sheet view.
If no documents appear in Powersheet Drive, verify that at least one document has a sheet configuration assigned in its nextedySheetConfig field. The drive discovers documents by querying for all documents where this field is populated.
Step 6: Open a document with Powersheet
Click any document listed in Powersheet Drive. Powersheet loads the associated sheet configuration and domain model, then renders the hierarchical sheet with your configured columns and expansion paths.
You should see: The document opens in the Powersheet sheet view showing the configured columns, entity types, and hierarchical data. The toolbar provides access to editing, filtering, sorting, and export features.
You can also open any document with Powersheet using the Open with Powersheet button that appears in the Polarion document toolbar. This button is available on any document that has a sheet configuration assigned.
Configuration scope
Domain model and sheet configuration files can be managed at multiple levels through the Polarion administration interface:
- Administration > Nextedy POWERSHEET > Domain Models — for domain model YAML files
- Administration > Nextedy POWERSHEET > Sheet Configurations — for sheet configuration YAML files
| Configuration scope | Description |
|---|
| Project | Configuration files specific to one project |
| Project Group | Configuration files shared across projects in a group |
| Global | Configuration files shared across all projects |
Troubleshooting
| Symptom | Cause | Solution |
|---|
| Powersheet Drive not in sidebar | Topic not added to view | Add <topic id="powersheet"/> to the relevant view in Administration > Portal > Topics |
| Drive shows empty list | No documents configured | Assign a sheet configuration to at least one document via its nextedySheetConfig field |
nextedySheetConfig field not available | Custom field not created | Create the custom field in Administration > Documents & Pages > Document Custom Fields |
| No enum options in config field | No configs uploaded | Upload at least one sheet configuration through Administration > Nextedy POWERSHEET > Sheet Configurations |
Next steps
