Skip to main content

​
What you will achieve

By the end of this tutorial you will have:
  • A nextedySheetConfig custom field configured on documents
  • A LiveDoc assigned to your sheet configuration
  • A working powersheet document accessible from the Powersheet Drive

​
Prerequisites

diagram

​
Step 1: Create the nextedySheetConfig custom field

The process of assigning a sheet configuration to a document is done via a dedicated document custom field. Navigate to your Polarion project’s document custom field configuration and create a new field:
SettingValue
IDnextedySheetConfig
NameNextedy Sheet Config
TypeEnum: Nextedy - Sheet Config
You should see: The new custom field appears in the document field list with the Nextedy - Sheet Config enum type, which dynamically discovers available sheet configuration files from the repository.
The field ID and name can be customized. If you use a different ID, you must specify it in the Polarion Administration > Configuration Properties with: com.nextedy.powersheet.sheetConfigFieldId=yourFieldId

​
Step 2: Create a LiveDoc

Create a new LiveDoc in your project. Give it a descriptive name (e.g., “User Needs Specification”). In the document properties, set the Nextedy Sheet Config field to your sheet configuration name (e.g., rtm-sheet). You should see: The nextedySheetConfig field shows a dropdown with the available sheet configurations discovered from both project and global locations.
If no configurations appear in the dropdown, verify that your sheet configuration was saved correctly in Administration > Nextedy POWERSHEET > Sheet Configurations. The enum provider scans the repository for available YAML files.

​
Step 3: Add the Open with Powersheet button (optional)

To allow users to easily switch from the LiveDoc view to the Powersheet view, navigate to the LiveDoc sidebar and add the following Velocity code to a Wiki content block: 
$openPowersheetButton.renderOpenPowersheetButton($document)
You should see: An “Open with Nextedy POWERSHEET” button appears in the LiveDoc, allowing users to jump directly to the sheet view.

​
Step 4: Open the document from Powersheet Drive

Navigate to the Powersheet Drive in the left sidebar. Your new document should appear in the list. Click the document name to open it in the Powersheet view. You should see: The sheet loads with the columns defined in your sheet configuration. If the project contains work items matching the UserNeed type, they appear as rows with their related SystemRequirement items expandable beneath them.
If the sheet appears empty, it means there are no work items matching your domain model’s entity types yet. You can add rows directly in the sheet using the add button in the toolbar. New entities are created with default values from the entity factory configuration.

​
Step 5: Test basic operations

With the sheet open, try the following operations:
  1. Add a row — click the add button to create a new UserNeed work item
  2. Edit a cell — click on the title cell and type a name
  3. Save — click the save button to persist your changes to Polarion
You should see: New work items are created in Polarion, editable directly in the sheet. The save button becomes enabled when you make changes and is disabled after a successful save.

​
Next steps

KB ArticlesSupport TicketsSource Code
  • prod-powersheet-src/com.nextedy.powersheet/src/com/nextedy/powersheet/PowersheetService.java
  • prod-powersheet-src/com.nextedy.powersheet/src/com/nextedy/powersheet/PowersheetProduct.java
  • prod-powersheet-src/com.nextedy.powersheet.client/src/modules/ConfigProvider/types/UserPermissions.d.ts
  • prod-powersheet-src/com.nextedy.powersheet/src/META-INF/hivemodule.xml
  • prod-powersheet-src/com.nextedy.powersheet/src/com/nextedy/powersheet/PowersheetConfigProperties.java