Skip to main content

​
What You Will Achieve

By the end of this tutorial, you will have:
  • ✅ Opened and navigated the configuration editor
  • ✅ Added a custom column to your risksheet
  • ✅ Configured basic display properties
  • ✅ Saved and tested your configuration changes
  • ✅ Understood the relationship between templates and documents

​
Prerequisites

Before starting this tutorial, ensure you have:
  • Completed Create Your First Risksheet
  • A working RISKSHEET document open in your browser
  • Edit permissions for the document in Polarion
  • Administrator role in your Polarion project (required for configuration changes)
Configuration changes apply to the entire RISKSHEET document and all users who access it. Template-level changes affect all documents created from that template.

​
Step 1: Open the Configuration Editor

From your open RISKSHEET document, click the ⚙️ Settings icon in the top toolbar, then select Edit Configuration. What you should see: The configuration editor opens in a new browser tab or window. The editor displays a JSON structure containing your document’s configuration properties.
If the configuration editor doesn’t open, check that your browser allows popups from the Polarion domain. Some browsers block popups by default.

​
Step 2: Understand the Configuration Structure

The configuration editor shows your risksheet.json file with several main sections:
  • global — Interface settings (culture, help URLs, refresh behavior)
  • headers — Row and column header dimensions
  • levels — Hierarchical structure definition
  • dataTypes — Risk and task type configuration
  • columns — Column definitions (the focus of this tutorial)
  • views — Saved view configurations
  • reviews — Review workflow settings
What you should see: A collapsible JSON tree structure with these top-level properties. The columns array contains all visible columns in your risksheet.
For a complete reference of all configuration properties, see Configuration Properties Index.

​
Step 3: Add a Custom Text Column

Scroll to the columns array in the configuration editor. Click Add Column or manually add a new column object at the end of the array: 
{
  "id": "customNotes",
  "label": "Analysis Notes",
  "field": "description",
  "width": 200,
  "editable": true
}
Property explanations:
  • id: Unique identifier for this column (must be unique within the document)
  • label: Display name shown in the column header
  • field: Maps to the Polarion work item field (use description for rich text)
  • width: Column width in pixels
  • editable: Allows users to edit cells directly in the risksheet
What you should see: The new column definition appears in the columns array. The JSON syntax should be valid (no red error indicators).
Frequently used Polarion fields include: title, description, status, assignee, created, updated, severity, and custom fields prefixed with custom_.

​
Step 4: Configure Row Header Width

Locate the headers section and find the rowHeader object. Modify the width property: 
"headers": {
  "rowHeader": {
    "width": 120,
    "renderer": null
  },
  "columnHeader": {
    "height": null
  }
}
Change "width": 90 to "width": 120 to provide more space for work item IDs and titles in the row header. What you should see: The width value updates to 120. This change will increase the row header column width when you save.

​
Step 5: Enable Automatic Refresh on Save

In the global section, locate or add the refreshOnSave property: 
"global": {
  "culture": null,
  "help": null,
  "refreshOnSave": true,
  "addAsSubmenu": null,
  "suggestTextFields": null
}
Set refreshOnSave to true. This automatically reloads the risksheet after saving changes, ensuring you always see the most current data. What you should see: The refreshOnSave property set to true in the global configuration.
With refreshOnSave enabled, RISKSHEET displays a warning if you have unsaved changes before refreshing. This prevents accidental data loss.

​
Step 6: Save the Configuration

Click the Save button at the top of the configuration editor. What you should see: A confirmation message indicating the configuration was saved successfully. The editor may close automatically or remain open depending on your Polarion settings.

​
Step 7: Verify Your Changes

Return to your RISKSHEET document tab and click the 🔄 Refresh button in the toolbar. What you should see:
  1. The row header column width increases to 120 pixels
  2. A new “Analysis Notes” column appears in your risksheet
  3. The column is editable (click a cell to verify)
  4. All existing data remains intact
Testing the configuration:
Before ConfigurationAfter Configuration
ColumnsID, Title, RiskID, Title, Risk, Analysis Notes
Header widthNarrowWider (120px)
New column—Analysis Notes (editable)
Click into an “Analysis Notes” cell and type some text. Press Enter or click outside the cell to confirm the edit.
If you make a mistake while editing, press Ctrl+Z (Windows/Linux) or Cmd+Z (Mac) to undo your last change before saving.

​
Step 8: Save Your Work

After adding content to the new column, click the 💾 Save button in the RISKSHEET toolbar. What you should see: Because refreshOnSave is enabled, the risksheet automatically refreshes after saving. Your changes persist and are visible to all users with access to the document.

​
Understanding Template vs. Document Configuration

You just modified the document configuration, which applies only to this specific RISKSHEET document. To apply the same configuration to all new documents:
  1. Navigate to the template document (e.g., “FMEA Template”)
  2. Open its configuration editor
  3. Make the same changes
  4. Save the template
New documents created from that template will inherit the updated configuration.
Document-level configuration overrides template-level configuration. For details, see Configuration Hierarchy.

​
Common Configuration Tasks

Now that you understand the basics, you can explore these common configuration scenarios:
TaskConfiguration PropertyGuide
Add dropdown columnscolumns[].type = "enum"Configure Enum Columns
Show linked itemscolumns[].type = "itemlink"Configure Upstream Traceability Columns
Create calculated fieldscolumns[].formulaConfigure Calculated Columns
Set up user assignmentscolumns[].type = "userref"Add Assignee Column
Customize headersheaders.rowHeader.rendererConfigure Row Header Styles

​
Next Steps

→ Continue your learning: 💡 Explore advanced features:
Source Code
  • RisksheetViewServlet.java
  • AppConfig.ts
  • CommandFactory.ts