PLANNINGBOARD Widget Parameters

Modified on Thu, 16 Oct at 1:50 PM

In this article, we describe the main widget parameters that you can set up for Planningboard.

TABLE OF CONTENTS

Parameters for Work Items
Parameters for Plans (Columns)
Queries
Swimlanes (Rows)
New Plan
- 1. New Plan without Teams
- 2. New Plan with Teams
Unplanned Sidebar
Advanced

Parameters for Work Items

Specify what WIs shall be shown on the Planningboard.

- Scope: define the project scope for the current board.

- Query type: specify the type of the query(if used).
- Query: specify what WIs shall be shown on the board.

- Add Planned: enable this option if you'd like to load all planned items in addition to ones selected in the Type and Query fields.

- Sort by: define the way of sorting the cards;

- Dependency Roles: set dependency roles between cards if needed;

- Sidebar Fields: select what fields will be visible on the sidebar when clicking on the card.

Parameters for Plans (Columns)

Specify what Plans shall be shown as Columns.

- Plans Type: select a plan type that corresponds to your configuration.

Note: In case you need one of the SAFe types, contact support to help you with the configuration.

- Plans: define what plans will be shown as columns on the Planning Board;

- Normalization: check this article to learn more about Normalization (What is "Normalization")

- Show # of last plans: decide how many last plans to load.

- Show # of next plans: decide how many next plans to load.

- Show Capacity Load: enable visualization of the load for each plan.

- Assign to Parent Plan: when enabled, the planned WI will be automatically assigned and planned to the parent Plan of the currently added Plan. See the example:

Property disabled: WI is planned in Iteration 4

Property enabled: WI is also planned in the Parent Plan (Version 1.0)

- Report Link: decide if you want to open an additional link by clicking on a column label. The link can be parameterised by a plan linked to a selected column.

Example of the report link:

/polarion/#/project/${plan.objectId.projectId}/wiki/SOME_REPOT?plan=${plan.objectId.itemId}

Queries

Specify queries for the Unplanned section of the PB.

- Queries: create some custom queries and easily access the specific unplanned cards right from the Planning board.

Example:
Create a query for work items with the status 'reviewed'. It will show you all the corresponding cards under the Unplanned section.

Swimlanes (Rows)

Specify what shall be shown as Swimlanes on the Planningboard.

- Assignment Type: choose one of the available type options according to the project configuration.
- User Role: This line may vary depending on the chosen assignment type.

- Report Link: decide if you want to open an additional link by clicking on a swimlane label. The link can be parameterised by the resource linked to a selected swimlane. See the following example of the report link value:

/polarion/#/project/PlanningBoard/wiki/SOME_REPOT?user=${r.objectId.itemId}

New Plan

You can create a new plan directly from the Planningboard. By enabling this feature, an option to create a new plan appears in the toolbar:

Define the rules for creating a new plan:

- Template ID: define what type of plan will be created when you add a new one, based on your Polarion project setup (examples: iteration, release)

- Parent ID: decide if you want to create new plans under a specific parent

- Plan Name Pattern: the display name of the plan as it appears in the column header. Predefined for using Teams. If you don't use them, don't forget to change to the pattern.

- Plan ID Pattern: specify the ID pattern new plans should follow. Predefined for using Teams. If you don't use them, don't forget to change to the pattern.

- New Plan Duration: specify the duration of newly created plans

- Enable Teams: If your project uses an additional selection method for plans (e.g., Teams), these can be set up here.

- Teams: specify the name and ID of your Teams

- Last Plan Query: defines the query that will be used to find the "last plan". By default, if empty, it looks for the latest plan in the same project and of the same template type.

- Last Plan Sort: defines how the system decides which plan from the query is the last one. If empty, it sorts by dueDate (plans with the latest due date are treated as the last plan).

Examples:

1. New Plan without Teams

This setup creates new iteration plans without using Teams - meaning it always creates only one plan at a time. In this example, we specify the 'Parent ID' because the project contains multiple Versions, but we want new iterations created only under Version_3_0. The 'Enable Teams' option is disabled:

Currently, Iterations 1, 2, and 3 already exist under parent Version_3_0:

When we click the plus (+) button in the toolbar, a confirmation window appears where we can review the values:

After creating the new plan and refreshing the widget, we can see Iteration 4 added under the parent version:

2. New Plan with Teams

This setup creates new iteration plans with Teams, meaning it creates multiple plans at a time (one for each team). First, we made a Team Custom Field based on an enumeration list (e.g., Alpha, Beta, Gamma):

Then, in the Widget Parameters, we enabled Teams and defined the available Teams:

In our widget, Iteration 1 already contains three plans: Alpha, Beta, Gamma:

When we click the plus (+) button, the system automatically creates a second set of plans: Iteration 2 - Alpha, Beta, Gamma:

Specify the properties for the Unplanned sidebar.

- Load parents: when setting this property to 1+, all unplanned cards will be grouped according to the parent.

- Parent Roles: specify the parent role that shall be considered for the property above.
- Width: specify what % of the screen the unplanned section shall take.