Skip to main content

What you will achieve

By the end of this tutorial you will have a working Planningboard embedded in a LiveReport page inside your existing Polarion project, ready for you to configure Plans and swimlanes.

Prerequisites

  • Planningboard is installed on your Polarion server (see Installation)
  • A valid Planningboard license is applied (see License Installation)
  • You have project administrator access to the target Polarion project
  • The project contains at least one Plan with work items

1

Open Documents & Pages in your project

Navigate to your existing project in Siemens Polarion ALM and open the Documents & Pages section from the left sidebar.Choose a space where you want to host the Planningboard. For most teams the Planning space is a natural home, but you can use any space you have write access to.
Documents and Pages sidebar showing project spaces including Default Space, Design, Development, Maintenance, Planning, Reports, and Requirements — with Planning highlighted
If your project has no dedicated planning space, create one now. A descriptive space name such as Planning makes it easy for team members to find the board later.
What you should see: The Documents & Pages tree for your project, listing existing spaces and pages.
2

Create a new LiveReport page

Inside the chosen space, create a new LiveReport Page and give it a recognizable name such as PlanningBoard.
Create LiveReport Page dialog with Title set to PlanningBoard, Name (ID) set to PlanningBoard, and Space set to Planning
Planningboard runs as a widget embedded inside a LiveReport page. It cannot be placed on a plain Wiki page — you must use a LiveReport page type.
What you should see: A blank LiveReport page open in edit mode, ready for widgets to be added.
3

Insert the Planningboard widget

With the LiveReport page open in edit mode, open the widget picker. From the list of available widgets, select Plans - Planningboard.
Widget picker open on the Plans tab showing available plan widgets including Planning Board highlighted with a red border
The widget is inserted into the page and loads the Planningboard using the project’s existing Plan structure.What you should see: The Planningboard widget renders on the page, displaying cards grouped into swimlanes based on the default configuration. Plans detected from the project appear as columns.
Only one Planningboard widget is supported per page. If you need boards for multiple teams or planning levels, create a separate LiveReport page for each board.

4

Verify the board loads correctly

Save the page and view it in read mode. Confirm that:
  • Plans appear as columns across the board
  • Work items appear as cards within the swimlanes
  • Swimlanes are populated (the default assignmentMode groups items by assignee)
If the board appears empty, your project’s Plans may not match the default query. See Step 5 to configure the Plan query.What you should see: A board with at least one Plan column and cards placed in swimlane rows corresponding to assignees.
5

Configure the widget parameters (optional first pass)

Click the widget’s settings icon to open its parameter panel. The two most important parameters for an initial setup are:
ParameterPurposeExample value
plansQueryLucene query selecting which Plans appear on the boardtype:releasePlan
wiTypeWork item type filter restricting which items load as cardsstory
assignmentModeHow work items map to swimlanesASSIGNEE
lastPlansNumber of past Plans to show1 (default)
nextPlansNumber of future Plans to show5 (default)
Minimal example — show release plans containing stories, grouped by assignee:
plansQuery   = type:releasePlan
wiType       = story
assignmentMode = ASSIGNEE
lastPlans    = 1
nextPlans    = 5
Start with the defaults before tuning. The board is usable without any parameter changes if your project already has Plans and assigned work items.
What you should see: After saving the widget parameters, the board refreshes to show only the Plans and work items matching your filters.

Setup flow at a glance

Setup flow from an existing Polarion project through Documents and Pages, creating a LiveReport page, inserting the widget, configuring parameters, and assigning licenses, ending with the board ready for planning

Next steps

With the board running in your project, explore these topics to get more out of Planningboard:
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
  • capacityHelperData.cy.ts
  • Item.java
Last modified on July 9, 2026