> ## 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.

# Work Item Fields

> This page lists the work item fields that Nextedy PLANNINGBOARD reads, writes, and exposes through its data model. Fields are grouped by functional area.

***

## Core Identity Fields

These fields identify the work item and are always loaded.

| Field   | Type   | Description                                                                                                              |
| ------- | ------ | ------------------------------------------------------------------------------------------------------------------------ |
| `id`    | string | Polarion work item ID (e.g. `PROJ-42`). Read-only.                                                                       |
| `title` | string | Work item title/summary. Displayed on cards and in the sidebar.                                                          |
| `type`  | string | Work item type ID (e.g. `task`, `story`, `feature`). Used by the `wiType` widget parameter to restrict which items load. |

***

## Scheduling and Date Fields

Planningboard uses both actual and planned dates to support baseline planning and schedule variance tracking.

| Field           | Type | Description                                                                                  |
| --------------- | ---- | -------------------------------------------------------------------------------------------- |
| `start_date`    | date | Actual or scheduled start date. Used when assigning an item to a Plan.                       |
| `end_date`      | date | Actual or scheduled end date. Used with `start_date` to determine which Plan spans the item. |
| `planStartDate` | date | Originally planned start date. Distinct from `start_date`; supports baseline comparison.     |
| `planEndDate`   | date | Originally planned end date. Distinct from `end_date`; supports schedule variance tracking.  |

<Note title="Date precedence">
  `start_date` and `end_date` drive plan assignment logic. `planStartDate` and `planEndDate` are stored for baseline reference only and do not affect which Plan an item is placed in.
</Note>

***

## Effort and Capacity Fields

These fields power the capacity bar and capacity load calculations. Planningboard derives `effort`, `effortDone`, and `effortTodo` from Polarion's time-tracking fields or from a custom capacity field (configured via the `capacityField` widget parameter).

| Field        | Type   | Description                                                                                                                                                                 |
| ------------ | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `effort`     | number | Total estimated effort/work for the item. In time-tracking mode this is derived from `initialEstimate`.                                                                     |
| `effortDone` | number | Effort already completed. In time-tracking mode this is derived from `timeSpent`. For resolved items, `effortDone` is set equal to `effort` and `effortTodo` is set to `0`. |
| `effortTodo` | number | Remaining effort still required. In time-tracking mode this is derived from `remainingEstimate`.                                                                            |

### Effort Calculation Modes

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/vfRg9jxXRntLqZFW/planningboard/diagrams/reference/fields/work-item-fields/diagram-1.svg?fit=max&auto=format&n=vfRg9jxXRntLqZFW&q=85&s=69a156644a10ac98a3c5f2d5d19673f5" alt="Effort calculation modes: time-tracking mode deriving effort, effortDone, and effortTodo from initialEstimate, timeSpent, and remainingEstimate, versus custom field mode deriving them from a named custom field" width="680" height="270" data-path="planningboard/diagrams/reference/fields/work-item-fields/diagram-1.svg" />
</Frame>

<Warning title="Calculation type consistency">
  All Plans in a project must use the same calculation type (time-based or custom field). Mixing calculation types across Plans causes incorrect effort summation in capacity bars. Verify this in your Polarion project configuration before enabling capacity load.
</Warning>

### Related Widget Parameters

| Parameter           | Default  | Description                                                                   |
| ------------------- | -------- | ----------------------------------------------------------------------------- |
| `capacityLoad`      | `false`  | Enable capacity/effort tracking on work items and Plans.                      |
| `multiCapacityLoad` | `false`  | Enable per-swimlane or per-resource capacity aggregation.                     |
| `userCapacityLoad`  | `false`  | Enable user-level capacity loading when using the Teams service.              |
| `capacityField`     | *(none)* | Custom field ID to use as the effort source instead of time-tracking fields.  |
| `hoursPerDay`       | `8`      | Working hours per day used when converting Polarion duration values to hours. |

See [Capacity Parameters](/planningboard/reference/widget-parameters/capacity-parameters) for the full parameter listing.

***

## Resource Assignment Fields

These fields control which swimlane an item appears in and support multi-resource assignment scenarios.

| Field         | Type      | Description                                                                                         |
| ------------- | --------- | --------------------------------------------------------------------------------------------------- |
| `resourceId`  | string    | Single resource (user) assigned to this item. Drives swimlane placement in Assignee mode.           |
| `resourceIds` | string\[] | List of multiple resources assigned to the item. Populated when an item has more than one assignee. |

<Note title="Multi-resource assignment">
  `resourceIds` stores all assignees when multiple users are assigned. However, Planningboard's capacity load does not distribute effort across multiple assignees — the item's full effort appears under each assigned swimlane. This is a known limitation relative to Nextedy GANTT's multi-assignee support. See [Assignee Mode](/planningboard/reference/assignment-modes/assignee-mode) for details.
</Note>

### Assignment Mode Impact on Resource Fields

| Assignment Mode   | Field Used                                       | Notes                                                                                                                        |
| ----------------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
| `ASSIGNEE`        | `resourceId` / `resourceIds`                     | Swimlane = assignee from Polarion user role.                                                                                 |
| `ENUM`            | Custom enum field (configured via `enumFieldId`) | Supports single and multi-value enum fields. Status, resolution, and type fields are not supported as enum swimlane sources. |
| `PARENT`          | Parent link role                                 | Swimlane = parent work item. Does not support plan normalization (`planCellsMode`).                                          |
| `PROJECT`         | Project ID                                       | Swimlane = sub-project. Only readable sub-projects are included.                                                             |
| `SAFE_TEAM`       | SAFe team data                                   | Requires Polarion SAFe Solution.                                                                                             |
| `SAFE_TRAIN_TEAM` | ART-filtered SAFe team data                      | Requires ART ID parameter.                                                                                                   |
| `SAFE_PROGRAMS`   | SAFe program data                                | Requires portfolio-level SAFe Solution.                                                                                      |
| `none`            | *(no swimlane grouping)*                         | All items appear in a single row.                                                                                            |

See [Assignment Modes](/planningboard/reference/assignment-modes/index) for configuration details for each mode.

***

## Dependency Fields

| Field          | Type      | Description                                                                                                                                |
| -------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `dependencies` | string\[] | Set of work item IDs that this item depends on (predecessor relationships). Populated from link roles configured in `dependencyLinkRoles`. |

Dependency links are visualized as arrows on the board when **Show Dependencies** is enabled in the toolbar. The link roles that define dependency relationships are configured via the `Dependency Roles` widget parameter.

See [Work Items Parameters](/planningboard/reference/widget-parameters/work-items-parameters) for the `PARAMETER_DEPENDENCY_LINK_ROLE` setting.

***

## Sidebar Display Fields

When a user clicks a card, the **Work Item Properties** sidebar opens. The fields shown in the sidebar are configured via the `Sidebar Fields` widget parameter (`PARAMETER_SIDEBAR_FIELDS`).

| Default Sidebar Fields | Field ID    | Notes                                          |
| ---------------------- | ----------- | ---------------------------------------------- |
| Title                  | `title`     | Always visible on the card and in the sidebar. |
| Status                 | `status`    | Work item status enum.                         |
| Planned In             | `plannedIn` | Plans the item is currently assigned to.       |

Additional fields can be added by listing their Polarion field IDs in the sidebar fields configuration. Users can also personalize visible fields using the gear icon in the sidebar; these personal selections apply only to that user and affect all work items of the same type.

<Tip title="Preserving scroll position">
  When you save changes in the sidebar, Planningboard preserves your swimlane and scroll position. The board does not jump back to the top after saving.
</Tip>

***

## Card Display Fields (Item Script)

The content of each card is customizable via the **Item script** in the Advanced Parameters section. The `wiFields` API exposes work item fields for rendering.

### Commonly Used Fields in Item Scripts

```javascript theme={null}
// Display assignee on the card
wiFields.assignee().render()

// Display status
wiFields.status().render()

// Display remaining estimate
wiFields.remainingEstimate().render()

// Display a custom field by ID
wiFields.customField("myFieldId").render()
```

<Tip title="Adding assignee to cards">
  A common request is to show the assignee alongside the work item ID, title, and remaining estimate. Add `wiFields.assignee().render()` to the Item script in the Advanced properties section. See [Item Script API](/planningboard/reference/api/item-script-api) for the full `wiFields` reference.
</Tip>

See [Advanced Parameters](/planningboard/reference/widget-parameters/advanced-parameters) for the Item script parameter, and [Item Script API](/planningboard/reference/api/item-script-api) for the complete `wiFields` API surface.

***

## Work Item Type Filtering

The `wiType` widget parameter restricts which work item types are loaded onto the board. Only items matching the specified type ID are shown; items of other types are excluded from both the board and the unplanned sidebar.

| Parameter | Type   | Default              | Description                                                                      |
| --------- | ------ | -------------------- | -------------------------------------------------------------------------------- |
| `wiType`  | string | *(none — all types)* | Work item type ID to restrict displayed items (e.g. `task`, `story`, `feature`). |

Changing the work item type also affects which enum field values are available in the Rows Filter for Enumeration Field swimlane mode — enum options are type-specific and reflect the per-type enumeration configuration in Polarion.

***

## Query and Scope Fields

These parameters determine which work items are loaded onto the board.

| Parameter    | Type    | Default    | Description                                                                                       |
| ------------ | ------- | ---------- | ------------------------------------------------------------------------------------------------- |
| `query`      | string  | `NOT *:*`  | Lucene query to filter work items displayed on the board.                                         |
| `maxItems`   | number  | `1000`     | Maximum number of work items to load. Applies across all Plans.                                   |
| `addPlanned` | boolean | *(see UI)* | When enabled, loads all planned items in addition to those matched by the type and query filters. |

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/vfRg9jxXRntLqZFW/planningboard/diagrams/reference/fields/work-item-fields/diagram-2.svg?fit=max&auto=format&n=vfRg9jxXRntLqZFW&q=85&s=7ba4dcf63b185253883809a2ed705a85" alt="Field flow from Polarion Work Item through the query filter and PlanningBoardDataService field mappings to the rendered card on the board" width="680" height="480" data-path="planningboard/diagrams/reference/fields/work-item-fields/diagram-2.svg" />
</Frame>

***

## Configuration Example

The following widget parameter excerpt shows a typical Work Items configuration referencing these fields:

```properties theme={null}
# Work item type to display
wiType=story

# Lucene query — load open stories only
query=type:story AND NOT status:done

# Maximum items to load
maxItems=500

# Sidebar fields to show when clicking a card
sidebarFields=title,status,plannedIn,remainingEstimate,assignee

# Capacity field — use story points custom field instead of time tracking
capacityField=storyPoints

# Dependency link roles
dependencyLinkRoles=depends_on
```

<Note title="Sidebar fields format">
  `sidebarFields` takes a comma-separated list of Polarion field IDs. Use exact field IDs as they appear in your Polarion project configuration — wrong IDs fail silently.
</Note>

***

## Limitations

* **No multi-assignee effort distribution.** When a work item has multiple assignees (`resourceIds`), its full effort is counted under each assigned swimlane rather than split proportionally. This differs from Nextedy GANTT behavior.
* **Sub-item effort distribution not supported.** Capacity bars reflect effort on the direct work item only; child item effort is not automatically rolled up.
* **Enum swimlane restrictions.** The `status`, `resolution`, and `type` built-in Polarion fields cannot be used as Enumeration Field swimlane sources.
* **Parent mode and normalization.** Assignment mode **Parent Item** (`PARENT`) does not support plan normalization (`planCellsMode`).
* **Calculation type consistency.** All Plans in the project must use the same calculation type. Mismatches produce incorrect capacity totals with no runtime error.

***

## Related Reference Pages

* [Work Items Parameters](/planningboard/reference/widget-parameters/work-items-parameters) — widget parameters for filtering and displaying work items
* [Capacity Parameters](/planningboard/reference/widget-parameters/capacity-parameters) — effort, capacity, and teams service parameters
* [Assignment Modes](/planningboard/reference/assignment-modes/index) — how resource fields map to swimlanes
* [Item Script API](/planningboard/reference/api/item-script-api) — `wiFields` API for card content customization
* [Plan Fields](/planningboard/reference/fields/plan-fields) — fields on Plan objects (columns)
* [Resource Fields](/planningboard/reference/fields/resource-fields) — fields on resource (assignee/team) objects

<Accordion title="Sources">
  **KB Articles**

  * Planningboard interface & basic interactions
  * Planningboard Widget Parameters
  * Swimlane Assignment Types

  **Support Tickets**

  * [#5960](https://support.nextedy.com/helpdesk/tickets/5960)
  * [#6496](https://support.nextedy.com/helpdesk/tickets/6496)
  * [#6174](https://support.nextedy.com/helpdesk/tickets/6174)

  **Source Code**

  * `Config.java`
  * `PlanningBoardWidget.java`
  * `widget.vm`
  * `Item.java`
  * `enum-rows-filter.cy.ts`
</Accordion>
