Skip to main content

What you will achieve

By the end of this tutorial you will have:
  • Placed your production license file in the correct Polarion directory
  • Verified the license status in the Planningboard administration interface
  • Confirmed that licensed users can drag cards, use the sidebar, and create Plans

Prerequisites

  • Planningboard is already installed on your Polarion server (see Installation)
  • You have access to the Polarion server file system (or can ask your system administrator)
  • You have received a license file named <PREFIX>-planningboard_lic.json from Nextedy
Planningboard runs in 30-day evaluation mode when no production license is present. In evaluation mode the board is read-only for all users — cards cannot be dragged, the sidebar is hidden, the Create New Plan button is not shown, and the Show Unplanned toggle is unavailable. View access to board content is retained.

1

Locate your license file

Your license file was delivered by Nextedy when you purchased Planningboard. Its name follows the pattern:
For example: acme-planningboard_lic.json.If you cannot find your license file, contact support@nextedy.com.
2

Copy the license file to the Polarion license directory

Place the license file inside the Polarion installation’s license folder:
Replace [POLARION_INSTALL] with your actual Polarion installation path (for example /opt/polarion on Linux).
The file name must remain exactly as delivered. Renaming the file can prevent the license from being recognized.

3

Delete the `.config` cache directory

Polarion caches plugin state in a .config directory. You must remove it so Polarion picks up the new license on the next start.
The .config directory holds only plugin discovery caches — no project data. Deleting it does not slow Polarion down and is recommended by Polarion support whenever a plugin changes.

4

Restart the Polarion server

Restart your Polarion server using your organization’s standard procedure. The server must fully start before you proceed.What you should see: Polarion starts normally with no errors related to Planningboard in the server log.
5

Verify the license in the administration interface

  1. Log in to Polarion as an administrator.
  2. Navigate to Administration > Nextedy PLANNINGBOARD.
  3. Open the Setup (or license) page.
You will see a color-coded status panel:
License status panel showing the three states: Valid (green, editing enabled), Info/Warning (blue, check the message), and Invalid (red, read-only enforced)
The panel also shows the full license details. The signature field is automatically redacted from the display — this is intentional and does not affect validation.What you should see: A green panel confirming the license is valid.
The license signature is hidden in the UI for security. The server validates it server-side — you do not need to see it.

6

Confirm editing is available

Open a Planningboard page in any project. Verify the following are now visible and functional for licensed users:
Planningboard enforces license-based access control per user. Users who do not hold a Planningboard license will still see the board in read-only mode — they can view cards and swimlanes but cannot drag, edit, or plan. This is by design to support collaboration and transparency.

License states reference


Next steps

With a valid license installed, continue setting up your project:
KB Articles
  • Install Planningboard
  • How to setup Planningboard into existing projects (based on E-library template)
  • Planningboard interface & basic interactions
Support TicketsSource Code
  • viewLicense.vm
  • licenseReadonly.cy.ts
  • Config.java
  • PlanningBoardWidgetRenderer.java
  • PlanningBoardSetupService.java
Last modified on July 9, 2026