Skip to main content

​
What Model Helper Does

Model Helper is a configured widget that dynamically visualizes the domain model structure and the binding paths between entities. It is especially useful when configuring the sources section of your sheet configuration, as it shows which expansion paths are available from a given starting entity.

​
Prerequisites

  • A domain model already configured in Administration > Nextedy POWERSHEET > Domain Models
  • Permissions to create a LiveReport page in your Polarion project

​
Step 1: Create the Model Helper LiveReport Page

Model Helper runs as a LiveReport page in Polarion:
  1. Navigate to your project in Polarion
  2. Create a new LiveReport page
  3. Import the Model Helper configuration as a page archive
The Model Helper page archive is provided by Nextedy. Contact your administrator or consult the Powersheet installation resources for the page archive file.

​
Step 2: Configure the Parameters

When you open the Model Helper LiveReport, you need to fill in four parameter values:
ParameterDescriptionExample
modelName of the domain model to investigatertm
projectIdProject ID where the model is definedRTM_Demo
startEntityMain entity type to use as the starting point for expansionUserNeed
depthNumber of relationship levels to expand3
Enter these values in the parameter fields at the top of the page and submit. diagram

​
Step 3: Read the Visualization

Model Helper displays:
  • Entity types as nodes showing their name and polarionType mapping
  • Relationships as connections between entities, labeled with the navigation property name
  • Expansion depth indicating how many levels deep the structure goes from the start entity
Use this information to configure your sheet’s sources section correctly, especially the expand paths.

​
Step 4: Map to Sheet Configuration Sources

Based on the Model Helper output, configure your sheet sources with the appropriate expansion paths: 
sources:
  - model: rtm
    query:
      from: UserNeed
    expand:
      - property: systemRequirements.systemRequirement
        expand:
          - property: designRequirements.designRequirement
      - property: hazards.hazard
        expand:
          - property: riskControls.riskControl
The binding paths shown in Model Helper correspond directly to the property values in your expand configuration and the column keys in your columns section.
After modifying your domain model (adding entity types or relationships), re-run the Model Helper with an updated depth to verify that the new paths appear correctly before updating your sheet configuration.

​
Step 5: Verify

You should now see the domain model visualization in the LiveReport page, showing the entity hierarchy starting from your specified startEntity down to the configured depth. Cross-reference the displayed paths with your sheet configuration to ensure consistency.

​
See Also

KB ArticlesSource Code
  • prod-powersheet-src/com.nextedy.powersheet/src/META-INF/hivemodule.xml
  • PolarionQueryProcessor.java
  • DatabridgeMetadata.java
  • prod-powersheet-src/com.nextedy.powersheet.client/src/modules/ConfigProvider/types/UserPermissions.d.ts
  • prod-powersheet-src/com.nextedy.editor/src/types.d.ts