Getting Started: Sheet Configurations

What this article is about

• Where Sheet Configuration is located
• How to create a new configuration
• What other available actions exist
• How to assign the sheet configuration for the specific document
• What are the main settings shown in the sheet configuration YAML file

TABLE OF CONTENTS

• What this article is about
• 1. Where to locate and create new Sheet Configurations
  • Other available actions:
  • Create a new sheet configuration.
  • Edit the existing configuration.
  • Duplicate and Delete the configuration.
  • Download the configuration.
• 2. Assign configuration to a specific document
  • Create a new custom field
  • Add a field reference to the Configuration Properties
  • Select the corresponding configuration in the Document Properties
• Main Sheet settings
• Column Groups
• Columns
• Views
• sortBy

1. Where to locate and create new Sheet Configurations

All sheet configurations are located in the Polarion Administration - Nextedy POWERSHEET - Sheet Configurations section.

You can perform any action to modify the sheet configuration from that location.

There are 2 types of Sheet Configurations:

• Global
• Project-specific

where some of them can be applied on a global or project level, accordingly.

Other available actions:

From the Sheet Configurations menu, apart from having the overview of all configured sheets, it is possible to perform the following actions:

• Create a new sheet configuration.

When creating a new Sheet configuration, it is possible to choose what configuration to use as a 'base' for it.

Select "System Default" if you have none, or if unsure which one to use from already existing configurations.

• Edit the existing configuration.

You can edit the already existing configuration either from this section or by opening the sheet configuration from the powersheet page itself.

To edit the configuration from the specific Powersheet, go to Menu - Configuration - Edit Sheet Configuration.

• Duplicate and Delete the configuration.

Duplicate functionality is especially nice in case you want to perform some slight adjustments to one of the already existing Models.

In this case, instead of creating a new one, it is possible just to duplicate and modify the already existing configuration.

• Download the configuration.

When opening a configuration file itself, it is also possible to download it in a YAML format. 

2. Assign configuration to a specific document

The process of assigning a configuration to a document is done via a dedicated document custom field.

• Create a new custom field

Create a new custom field of type Enum: Nextedy - Sheet Config

By default, we suggest defining the field ID as: nextedySheetConfig

• Add a field reference to the Configuration Properties

The field ID may be defined differently from the suggested one.

In that case, it needs to be specified in the Polarion Administration - Configuration Properties:

com.nextedy.powersheet.sheetConfigFieldId=fieldID

• Select the corresponding configuration in the Document Properties

Once you have a document that should get a specific configuration, select that sheet configuration from the Enum list in the newly created custom field.

After this, when the current document is opened from the Powersheet Drive, the sheet structure will be inherited from the selected configuration. 

Main Sheet settings

Sheet configuration consists of a few main sections:

• columnGroups
• columns
• views
• styles
• formatters
• sources
• sortBy

Column Groups

columnGroups is the sheet setting that allows you to collect a dedicated set of columns under one common group header. 

This way, 2 header levels are supported.

Optionally, it is possible to define different styles for each group.
The styling is described in the separate article: click here

Columns

The most important part of the sheet configuration is the column configuration. 

For each column, visible on the Powersheet, there shall be a dedicated column setting that defines how this column is presented on the sheet.

Full Column Configuration Guide is available: click here

Views

Configured views allow you to switch easily between different preconfigured column sets.

The full Views Configuration Guide is available:  click here

sortBy

Defines default client-side sorting. Supports multiple columns & custom order.

The full sortBy Configuration Guide is available: click here

sortBy:
      - columnId: outlineNumber
        direction: asc

For any assistance, please don’t hesitate to reach out by submitting a ticket here.