Skip to main content
Tree diagram of the Reference section's seven top-level categories: Widget Parameters, Configuration Properties, API Reference, Assignment Modes, Plans Modes, Fields, and UI Elements
Widget Parameters covers the most frequently used options — they control what Plans appear as columns, how swimlanes are grouped, and how capacity is tracked. If you are setting up a board for the first time, see Create Your First Planningboard first.

Widget Parameters

Widget parameters configure each individual board instance embedded in a Polarion page. Set them in the widget editor when inserting the board widget. Widget Parameters — Overview of all widget parameter groups Plans (Columns) Parameters — Parameters that control which Plans appear as board columns and how they are queried Swimlanes (Rows) Parameters — Parameters that control swimlane grouping, assignment type, sorting, and filtering Work Items Parameters — Parameters that control which work items appear on the board and how cards are rendered Capacity Parameters — Parameters that configure capacity bars, normalization, and effort tracking per swimlane UI and Display Parameters — Parameters that control board appearance, card content, and highlighting rules SAFe Parameters — Parameters specific to SAFe (Scaled Agile Framework) planning boards Advanced Parameters — Low-level and infrequently changed parameters for specialized configurations

Configuration Properties

Configuration properties are system-wide settings applied at the server or project level. They are set in administration properties files rather than per-widget. Configuration Properties — Overview of all server-side configuration properties Appearance Properties — Properties that control default board appearance and card display Capacity Properties — Properties that govern capacity calculation behaviour and normalization defaults Teams Service Properties — Properties for the integrated Teams service Scripting Properties — Properties that enable and configure the scripting extension points

API Reference

The scripting and REST interfaces let you extend board behaviour programmatically. API Reference — Overview of all API surfaces Scripting API — Entry point for board-level scripting Item Script API — Methods available in per-card item scripts Config Script API — Methods available in board configuration scripts Data Script API — Methods for reading and transforming board data in scripts REST API — HTTP endpoints exposed by the Planningboard server Teams Service API — API for the Teams service integration

Assignment Modes

Assignment modes determine how swimlane rows are populated — which field or relationship maps each work item to a swimlane. Assignment Modes — Overview of all swimlane assignment types Assignee Mode — Groups work items by their assigned user Parent Item Mode — Groups work items by their parent work item Enumeration Field Mode — Groups work items by the value of an enumeration custom field Project Mode — Groups work items by their Polarion project SAFe Team Mode — Groups work items by SAFe Agile Team SAFe Train Team Mode — Groups work items by SAFe Agile Release Train team SAFe Programs Mode — Groups work items by SAFe Program No Swimlanes Mode — Displays all work items in a single row with no grouping

Plans Modes

Plans modes control how Plan columns are sourced — from standard Polarion Plans, or from SAFe planning structures. Plans Modes — Overview of all Plans column source types Project Plans — Columns sourced from standard Polarion Plans in a project SAFe Sprints — Columns sourced from SAFe Sprint Plans SAFe Program Increments — Columns sourced from SAFe Program Increment Plans SAFe Solution Trains — Columns sourced from SAFe Solution Train Plans

Fields

Field reference pages list the identifiers, types, and descriptions for fields used in widget parameters and scripts. Fields — Overview of all field categories Work Item Fields — Field identifiers for work item cards (type, status, priority, assignee, effort, custom fields) Plan Fields — Field identifiers for Plan columns (name, start date, due date, capacity) Resource Fields — Field identifiers for resource and capacity data

UI Elements

UI element pages describe each interactive control in the board interface — what it does and where to find it. UI Elements — Overview of all board UI controls Toolbar Controls — Buttons and controls in the board toolbar Unplanned Sidebar — The sidebar panel listing work items not yet assigned to a Plan Card Quick Actions — Actions available on hover over a card Swimlane Controls — Controls on each swimlane row (collapse, expand, capacity indicator) License Panel — The license status and activation panel
Last modified on July 9, 2026