> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nextedy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Reference

> The Reference section is the complete technical lookup for Nextedy PLANNINGBOARD.

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/vfRg9jxXRntLqZFW/planningboard/diagrams/reference/index/diagram-1.svg?fit=max&auto=format&n=vfRg9jxXRntLqZFW&q=85&s=72726b58f7d74789a81536f75baee92d" alt="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" width="940" height="460" data-path="planningboard/diagrams/reference/index/diagram-1.svg" />
</Frame>

<Tip title="Start here if you are new to configuration">
  [Widget Parameters](/planningboard/reference/widget-parameters/index) 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](/planningboard/getting-started/first-planning-board) first.
</Tip>

## 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](/planningboard/reference/widget-parameters/index)** — Overview of all widget parameter groups

**[Plans (Columns) Parameters](/planningboard/reference/widget-parameters/plans-parameters)** — Parameters that control which Plans appear as board columns and how they are queried

**[Swimlanes (Rows) Parameters](/planningboard/reference/widget-parameters/swimlanes-parameters)** — Parameters that control swimlane grouping, assignment type, sorting, and filtering

**[Work Items Parameters](/planningboard/reference/widget-parameters/work-items-parameters)** — Parameters that control which work items appear on the board and how cards are rendered

**[Capacity Parameters](/planningboard/reference/widget-parameters/capacity-parameters)** — Parameters that configure capacity bars, normalization, and effort tracking per swimlane

**[UI and Display Parameters](/planningboard/reference/widget-parameters/ui-parameters)** — Parameters that control board appearance, card content, and highlighting rules

**[SAFe Parameters](/planningboard/reference/widget-parameters/safe-parameters)** — Parameters specific to SAFe (Scaled Agile Framework) planning boards

**[Advanced Parameters](/planningboard/reference/widget-parameters/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](/planningboard/reference/configuration-properties/index)** — Overview of all server-side configuration properties

**[Appearance Properties](/planningboard/reference/configuration-properties/appearance-properties)** — Properties that control default board appearance and card display

**[Capacity Properties](/planningboard/reference/configuration-properties/capacity-properties)** — Properties that govern capacity calculation behaviour and normalization defaults

**[Teams Service Properties](/planningboard/reference/configuration-properties/teams-properties)** — Properties for the integrated Teams service

**[Scripting Properties](/planningboard/reference/configuration-properties/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](/planningboard/reference/api/index)** — Overview of all API surfaces

**[Scripting API](/planningboard/reference/api/scripting-api)** — Entry point for board-level scripting

**[Item Script API](/planningboard/reference/api/item-script-api)** — Methods available in per-card item scripts

**[Config Script API](/planningboard/reference/api/config-script-api)** — Methods available in board configuration scripts

**[Data Script API](/planningboard/reference/api/data-script-api)** — Methods for reading and transforming board data in scripts

**[REST API](/planningboard/reference/api/rest-api)** — HTTP endpoints exposed by the Planningboard server

**[Teams Service API](/planningboard/reference/api/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](/planningboard/reference/assignment-modes/index)** — Overview of all swimlane assignment types

**[Assignee Mode](/planningboard/reference/assignment-modes/assignee-mode)** — Groups work items by their assigned user

**[Parent Item Mode](/planningboard/reference/assignment-modes/parent-mode)** — Groups work items by their parent work item

**[Enumeration Field Mode](/planningboard/reference/assignment-modes/enum-mode)** — Groups work items by the value of an enumeration custom field

**[Project Mode](/planningboard/reference/assignment-modes/project-mode)** — Groups work items by their Polarion project

**[SAFe Team Mode](/planningboard/reference/assignment-modes/safe-team-mode)** — Groups work items by SAFe Agile Team

**[SAFe Train Team Mode](/planningboard/reference/assignment-modes/safe-train-team-mode)** — Groups work items by SAFe Agile Release Train team

**[SAFe Programs Mode](/planningboard/reference/assignment-modes/safe-programs-mode)** — Groups work items by SAFe Program

**[No Swimlanes Mode](/planningboard/reference/assignment-modes/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](/planningboard/reference/plans-modes/index)** — Overview of all Plans column source types

**[Project Plans](/planningboard/reference/plans-modes/project-plans)** — Columns sourced from standard Polarion Plans in a project

**[SAFe Sprints](/planningboard/reference/plans-modes/safe-sprints)** — Columns sourced from SAFe Sprint Plans

**[SAFe Program Increments](/planningboard/reference/plans-modes/safe-pis)** — Columns sourced from SAFe Program Increment Plans

**[SAFe Solution Trains](/planningboard/reference/plans-modes/safe-solutions)** — 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](/planningboard/reference/fields/index)** — Overview of all field categories

**[Work Item Fields](/planningboard/reference/fields/work-item-fields)** — Field identifiers for work item cards (type, status, priority, assignee, effort, custom fields)

**[Plan Fields](/planningboard/reference/fields/plan-fields)** — Field identifiers for Plan columns (name, start date, due date, capacity)

**[Resource Fields](/planningboard/reference/fields/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](/planningboard/reference/ui-elements/index)** — Overview of all board UI controls

**[Toolbar Controls](/planningboard/reference/ui-elements/toolbar)** — Buttons and controls in the board toolbar

**[Unplanned Sidebar](/planningboard/reference/ui-elements/sidebar)** — The sidebar panel listing work items not yet assigned to a Plan

**[Card Quick Actions](/planningboard/reference/ui-elements/card-quick-actions)** — Actions available on hover over a card

**[Swimlane Controls](/planningboard/reference/ui-elements/swimlane-controls)** — Controls on each swimlane row (collapse, expand, capacity indicator)

**[License Panel](/planningboard/reference/ui-elements/license-panel)** — The license status and activation panel
