Skip to main content

​
What you will achieve

By the end of this tutorial you will have:
  • A LiveReport page with a Planningboard widget embedded
  • Plans from your project displayed as columns on the board
  • Work items arranged as cards in swimlanes grouped by assignee
  • A capacity bar visible per swimlane

​
Prerequisites

  • Planningboard is installed on your Polarion server. See Installation if you have not done this yet.
  • A valid Planningboard license is active. See License Installation.
  • You have edit rights on at least one Polarion project that contains Plans and work items.
  • Your Polarion user has the planningboard role assigned (ask your administrator if unsure).
1

Open Documents & Pages in your project

Navigate to your Polarion project and open the Documents & Pages section from the left sidebar.Choose the space where you want to host the board — for example, Planning.
If your project uses the E-Library template, a Planning space is already present. You can create the board page directly inside it.
What you should see: The space opens and shows any existing LiveDoc and Wiki pages in that space.
2

Create a new LiveReport page

Inside the Planning space, click New and select LiveReport Page. Name the page Planningboard.
Planningboard runs as a widget embedded in a LiveReport page. It does not work in a standard LiveDoc or Wiki page — use a LiveReport page specifically.
What you should see: A blank LiveReport page editor opens.
3

Insert the Planning Board widget

In the page editor, open the widget picker. Scroll through the available widgets and select Plans - Planningboard.What you should see: The widget is inserted onto the page and Planningboard loads immediately using the project’s default planning settings. You will see columns (Plans) and swimlanes (assignees) populated from your project data.
If no plans appear, your project may not yet have any Plans defined. Create at least one Plan in Polarion’s plan management view before continuing.
4

Review the default widget configuration

Click the widget’s settings icon (gear/wrench) to open its parameters. The default configuration uses:Leave all parameters at their defaults for now. Save the widget configuration.What you should see: The board refreshes and displays your project’s Plans as columns, with work items arranged as cards in swimlane rows — one row per assignee.
5

Understand the board layout

Board grid with an Unplanned column and Sprint 1-3 columns, and swimlane rows for alice, bob, and Not Assigned/Other, showing work-item cards and capacity bars
  • Columns — each column represents one Plan (sprint, release, etc.)
  • Swimlanes — each row groups cards for one assignee
  • Cards — each card is a work item; its ID and title are shown on the card
  • Capacity bar — shown below the assignee name; tracks allocated vs. available capacity for that swimlane
  • Unplanned column — work items not yet assigned to any Plan appear here
6

Enable capacity tracking (optional)

To activate the capacity bar, open the widget parameters again and set the capacityField parameter to the ID of your work item field that holds story points or hours (for example, storyPoints).
Save and reload. The capacity bar in each swimlane now reflects the total effort of cards relative to the Plan’s available capacity.
Capacity configuration parameters are whitespace-sensitive. Do not add spaces around the = sign in widget parameter values.
What you should see: Each swimlane row shows a colored capacity bar. The bar turns red when a swimlane is over-allocated.
7

Save and publish the page

Click Save to publish your LiveReport page. The board is now accessible to other project members who have the planningboard role.
Users without a Planningboard license can view the board in read-only mode — they see all cards and swimlanes but cannot drag cards, create Plans, or access the sidebar. Licensed users have full editing capabilities including drag-and-drop scheduling.
What you should see: The page is saved and the Planningboard is live for your team.

​
Troubleshooting

Board shows “No Plans found” Check that your project has at least one Plan and that the plansMode parameter is set to PROJECT_PLANS. If your project uses a custom plan structure, consult your administrator about the correct plansQuery value. All cards appear in the Unplanned column Work items appear as unplanned when they are not assigned to any Plan. Drag them from the Unplanned column into the appropriate Plan column to schedule them. Capacity bar shows zero for all swimlanes The capacity bar requires the capacityField parameter to be set to a valid work item field ID. Verify the field ID exists in your project’s work item type configuration.

​
Next steps

Now that your first board is running, explore these topics to get more from Planningboard:
  • Basic Board Interactions — drag cards between Plans, use the sidebar, and refresh the board
  • Setup into Existing Projects — configure Planningboard for projects with custom work item types and fields
  • Guides — deeper configuration guides for swimlanes, capacity, Plan queries, and card appearance
  • Reference — complete widget parameter reference
KB Articles
  • How to setup Planningboard into existing projects (based on E-library template)
  • Install Planningboard
  • Introduction to Planningboard
Support TicketsSource Code
  • Config.java
  • PlanningBoardWidgetRenderer.java
  • PlanningBoardSetupService.java
  • Item.java
  • licenseReadonly.cy.ts
Last modified on July 10, 2026