Skip to main content

Configuration Not Loading

Symptoms

  • RISKSHEET displays with default configuration instead of your custom settings
  • Changes to risksheet.json have no effect
  • Configuration editor shows empty or default values

Resolution Steps

  1. Verify Configuration File Location Check the configuration hierarchy in this order:
  2. Check templateDoc Field Open your RISKSHEET document properties and verify:
    • The templateDoc field points to the correct template document
    • The template document exists and is accessible
    • The template document has a risksheet.json attachment
  3. Validate Configuration Syntax Open Menu > Configuration > Edit Risksheet Configuration and check for:
    • JSON syntax errors (missing commas, brackets)
    • YAML mode error highlighting (available in version 25.5.0+)
    • Red error indicators in the configuration editor
Starting with version 25.5.0, the configuration editor includes a history feature. If your configuration suddenly breaks, you can view and restore previous working versions.

RISKSHEET Topic Missing from Sidebar

Symptoms

  • RISKSHEET topic does not appear in Polarion sidebar
  • Cannot access RISKSHEET interface after installation

Resolution Steps

  1. Install Demo Project First RISKSHEET requires at least one demo project to be installed:
    • Navigate to Administration > Setup > Install Demo Project
    • Install the FMEA or HARA template project
    • This creates the necessary topic registration
  2. Add Topic Configuration Manually If the demo project is installed but the topic is still missing:
    • Navigate to Administration > Portal > Topics
    • Add: <topic id="risksheet"/>
    • Save the configuration
    • Refresh your browser
Many administrators attempt to configure RISKSHEET in existing projects without first installing a demo project. The demo project installation is a prerequisite that registers the RISKSHEET topic with Polarion.

Template Not Appearing in Document Creation

Symptoms

  • Template dropdown is empty when clicking ”+ New Blank Document”
  • Expected template not listed

Resolution Steps

  1. Verify Template Path Configuration Check Administration > Configuration Properties:
    nextedy.risksheet.risksheetTemplatePath=Risks/Risk Analysis
    
    • Ensure the path matches the actual document location
    • For multiple templates, verify comma-separated syntax
    • Path format: SpaceName/Document Name
  2. Check Template Document Type Verify the template document:
    • Is of type riskSpecification (or your configured type)
    • Has the templateDoc custom field configured
    • Is accessible to your user account
  3. Verify Document Type Configuration Ensure document types are registered:
    nextedy.risksheet.riskDocumentType=riskSpecification
    
    For multiple types:
    nextedy.risksheet.riskDocumentType=(softwareReqSpecification riskSpecification)
    

Configuration Changes Not Taking Effect

Symptoms

  • Edited risksheet.json but changes don’t appear
  • Configuration reverts to previous state

Resolution Steps

  1. Clear Browser Cache
    • Press Ctrl+Shift+R (Windows/Linux) or Cmd+Shift+R (Mac)
    • Force reload the RISKSHEET page
  2. Check Configuration Scope Understand where your changes apply:
    Configuration LocationScope
    Document attachmentSingle document only
    Template attachmentAll documents from this template
    Global templateAll projects using this global template
  3. Verify Write Permissions
    • Ensure you have edit permissions on the document
    • Check that the risksheet.json file is not read-only
    • Confirm you have canAdmin permissions
For development/testing environments, you can bypass the admin check with:
nextedy.risksheet.disable_admin_check=true
Never use this in production!

Work Item Type Not Recognized

Symptoms

  • “Type not found” errors in configuration
  • Work items don’t appear in RISKSHEET
  • Cannot create new risk items

Resolution Steps

  1. Verify Work Item Type Exists
    • Navigate to Administration > Work Items > Types
    • Confirm the type name matches your configuration exactly
    • Type names are case-sensitive
  2. Check dataTypes Configuration
    {
      "dataTypes": {
        "risk": {
          "type": "risk",   Must match actual type ID
          "role": "relates_to"
        }
      }
    }
    
  3. Review Type Permissions
    • Ensure your user role can create/edit this work item type
    • Check project-level permissions
    • Verify workflow allows state transitions

Diagnostic Checklist

Use this checklist to systematically diagnose configuration issues:
☐ Demo project installed via Administration
☐ RISKSHEET topic appears in sidebar
☐ Work item types created and configured
☐ Document types created with templateDoc field
☐ Template document created with risksheet.json attached
☐ nextedy.risksheet.risksheetTemplatePath configured
☐ nextedy.risksheet.riskDocumentType configured
☐ User has admin permissions (canAdmin=true)
☐ Browser cache cleared after configuration changes
☐ Configuration syntax validated (no JSON/YAML errors)

Verification

After resolving configuration issues, you should:
  • See your custom columns and layout in RISKSHEET
  • Be able to create documents from templates
  • Successfully edit cells and save changes
  • Observe configuration changes immediately after browser refresh

See Also

Source Code
  • OpenHelpCommand.ts
  • PolarionAppConfigManager.java