Skip to main content

​
What you will achieve

By the end of this tutorial you will have:
  • The com.nextedy.planningboard plugin deployed on your Polarion server
  • The plugin cache cleared and Polarion restarted so the extension is recognized
  • The Nextedy PLANNINGBOARD administration section available, with the Setup and License pages accessible

​
Prerequisites

  • A running Polarion server with a version still supported by Nextedy
  • Administrator access to the Polarion server filesystem and web interface
  • The Planningboard distribution archive (nextedy_planningboard.zip) downloaded from nextedy.com/nextedy-planningboard
  • Optionally, a valid license file (*-planningboard_lic.json) from Nextedy — Planningboard also runs in trial mode without one
You can install and evaluate Planningboard without a license file. Unlicensed users can view boards in read-only mode but cannot drag cards, use the sidebar, or create Plans. See License Installation for adding a license after the initial install.
Installation flow: deploy the plugin into extensions/, delete the .config plugin cache, restart Polarion, then verify in Administration
1

Deploy the plugin files

Unpack the downloaded nextedy_planningboard.zip. Inside you will find a folder named com.nextedy.planningboard.Copy this entire folder into your Polarion extensions directory:
Replace [POLARION_INSTALL] with your actual Polarion installation path (for example /opt/polarion on Linux or C:\Polarion on Windows).
Polarion locates the plugin by the folder name com.nextedy.planningboard. Renaming it prevents the server from loading the extension.
2

Delete the configuration cache

This step is critical. Remove the cached Polarion configuration directory so Polarion detects the new plugin on the next startup:
Delete the entire .config directory (not just its contents). Polarion regenerates it on the next startup. The .config cache holds only plugin-discovery data — it contains no project configuration or work items.
Failing to delete [POLARION_INSTALL]/data/workspace/.config is the most common cause of installation problems. If you skip it, the Nextedy PLANNINGBOARD Setup and License pages appear empty with no content. This step is required for both fresh installations and updates to a newer version.
3

Restart the Polarion server

Restart Polarion so it rebuilds its plugin registry from the updated extensions/ folder:
  • Linux: systemctl restart polarion or the Polarion-provided startup script
  • Windows: restart the Polarion service through the Services management console
Wait for Polarion to fully start — this can take several minutes depending on your server and the number of installed extensions.
4

Verify the Setup page loads

After Polarion restarts, log in as an administrator and navigate to:Administration > Nextedy PLANNINGBOARD > SetupYou should see the Setup page render with content — the installed version with an up-to-date indicator, and the demo-template controls. This confirms the plugin loaded successfully and the configuration cache was rebuilt during startup.
If the Setup page loads but shows no content, the .config directory was not fully removed in the previous step. Stop Polarion, delete .config again, and restart.
5

Verify the license page

Navigate to Administration > Nextedy PLANNINGBOARD > License to check your license status. The page shows the license details (type, expiry, named- and server-user counts), with the signature field redacted for security.If you have not applied a production license, the page indicates evaluation/trial mode and Planningboard remains usable read-only. To apply a license, see License Installation.
Planningboard editing access is seat-based: it is granted to users assigned to the nextedy_planningboard_users group. Configure named users from the same License page — see License Installation.

​
Troubleshooting

If the Nextedy PLANNINGBOARD section — or its Setup/License content — does not appear after installation:
  1. Stop Polarion
  2. Delete the cache directory: [POLARION_INSTALL]/data/workspace/.config
  3. Restart Polarion
This forces Polarion to reinitialize the extension configuration and usually resolves recognition issues. If the Administration entry is missing entirely, confirm the com.nextedy.planningboard folder is present under polarion/extensions/ and was not renamed.

​
Post-installation checklist

​
Next steps

With the server plugin installed, choose your setup path:
KB Articles
  • Install Planningboard
  • How to setup Planningboard into existing projects (based on E-library template)
  • Planningboard interface & basic interactions
Support TicketsSource Code
  • Config.java
  • PlanningBoardWidgetRenderer.java
  • PlanningBoardSetupService.java
  • Item.java
  • viewLicense.vm
Last modified on July 9, 2026