Setup into New Projects

​

What you will achieve

• A new Polarion project created from the Planningboard demo template
• A LiveReport page with a working Planningboard widget embedded
• Sample Plans and work items arranged on the board, ready to explore

​

Prerequisites

• Planningboard is installed on your Polarion server (see Installation)
• A valid Planningboard license is applied (see License Installation)
• You have Polarion Administration access

1

Open the Planningboard Administration setup page

1. Log in to Polarion and click the top-level Administration link (gear icon or the global Administration project).
2. In the left navigation, locate Planningboard and click Setup.

What you should see: The Planningboard Setup page lists available actions, including an option to install the demo project template.

If Planningboard does not appear in the Administration navigation, the plugin is not loaded. Verify the installation steps in Installation — in particular that the .config file was deleted and Polarion was restarted.

---

2

Install the demo project template

On the Planningboard Setup page, follow the on-screen instructions to install the demo template into Polarion’s project template registry.What you should see: A confirmation message that the template was installed successfully. The template is stored in Polarion’s template repository and will be available when you create a new project in the next step.

The installation is transactional — if anything fails, it rolls back automatically and no partial template is left behind. Re-run the setup action after resolving any error.

---

3

Create a new project from the template

1. Navigate to Polarion Administration > Projects and click Create Project.
2. On the template selection screen, choose the Planningboard template (it appears in the list after Step 2).
3. Fill in the project name, ID, and any other required fields, then confirm.

What you should see: Polarion creates the project and pre-populates it with sample Plans, work items, and the Planningboard page.

---

4

Open the planning board page

1. Switch to your newly created project.
2. Open Documents & Pages in the left navigation.
3. Navigate to the Planning space and open the Planningboard LiveReport page.

What you should see: The Planningboard widget loads and displays the sample Plans as columns and work items as cards organised in swimlanes. The capacity bar for each swimlane shows the current load.

The board defaults to showing the last 1 completed Plan (lastPlans = 1) and the next 5 upcoming Plans (nextPlans = 5). You can adjust these via the widget parameters once you begin customising the board.

---

5

Explore the board

Take a few minutes to orient yourself:

• Cards — each work item appears as a card. Cards display the work item ID and title, for example MAP-531 - My Story.
• Swimlanes — rows that group cards by assignee (the default assignmentMode). Drag a card from one swimlane to another to reassign it.
• Capacity bar — the bar at the top of each swimlane shows load relative to capacity for the selected Plan.
• Sidebar — licensed users see an editing sidebar with filters and tools. Unlicensed users can view the board in read-only mode but cannot drag cards or access the sidebar.

Users without a Planningboard license can view the board (cards, swimlanes, capacity bars) but editing actions — dragging cards, accessing the sidebar, creating or showing unplanned items — are disabled for them.

---

​

Widget parameter reference (overview)

​

Next steps

• Create Your First Planningboard — walk through building a board from scratch on an existing project
• Basic Board Interactions — learn drag-and-drop, the sidebar, and filtering
• Setup into Existing Projects — add Planningboard to a project you already have