How Planningboard Signals Errors
Planningboard uses an error indicator built into the board toolbar. The indicator reflects the current state of the widget configuration and any scripts it evaluates at render time.- Editor view — if you have edit permissions on the widget, the error indicator shows the full detail: which property failed, what the script evaluated to, and where.
- User view — users without edit access see a generic warning indicator. They cannot proceed until an editor resolves the issue.
The board may still render partially even when an error is present. The error indicator shows that at least one configuration or script evaluation failed — it does not necessarily mean the whole board is blank.
1
Open the Error Detail
- On the Planningboard page, look for the warning indicator in the toolbar (top-right area of the board).
- If you have widget-editor access, click the indicator to expand the error detail panel.
- Read the full error message. Note:
- The property name involved (e.g., a widget parameter like
plansQuery, a swimlane assignment expression, or a script field). - The error type (syntax error, null reference, unresolved variable, etc.).
- The script excerpt or value that triggered the error, if shown.
- The property name involved (e.g., a widget parameter like
2
Locate the Failing Configuration
Open the widget’s configuration panel (Edit > Widget Parameters in the Polarion page editor). Cross-reference the property name from the error detail with the corresponding widget parameter.Common parameters that drive script evaluation:
See Widget Parameters Overview for a full parameter reference.
3
Fix Common Error Patterns
Plan query syntax error
Symptom: Board shows no columns (Plans), error mentionsplansQuery or a Lucene parse failure.Fix: Open the widget configuration and correct the plansQuery value. Lucene queries are case-sensitive for field names. Example of a valid query:- Field names exactly match Polarion field IDs (e.g.,
type.id, nottypeId). - String values are unquoted when they contain no spaces, or double-quoted when they do.
- Boolean operators (
AND,OR,NOT) are uppercase.
Enum swimlane field not supported
Symptom: Swimlanes do not render, error references the resource field or assignment mode.Fix: Planningboard’sENUM assignment mode supports IEnumType fields and IListType fields whose items are IEnumType. The following field types are not supported as swimlane assignment fields: status, resolution, and type. Switch to a custom enum field or choose a different assignment mode.Capacity configuration whitespace
Symptom: Capacity bar values appear zero or incorrect, or an error references capacity parsing.Fix: Capacity configuration parameters are whitespace-sensitive. Remove leading or trailing spaces from all capacity-related widget parameter values:Velocity template / card content error
Symptom: Cards render blank or show a raw error string; error mentions a template property or variable.Fix: Card content templates use Velocity syntax. Common causes:- Referencing a custom field using
$workItem.customFields.myField— this form does not return the value. Use$workItem.getValue("myField")instead. - Referencing an enum-typed field without calling
.getName()— the rawEnumOption[...]object is printed instead of the label. - An undefined variable reference (
$myVar) with no fallback — Velocity prints the literal$myVarstring when the variable is null.
Page parameter not resolved
Symptom: Board ignores URL-driven filters or shows an error about an unresolved parameter.Fix: The page parameter name in the widget configuration must exactly match the parameter name declared in the page header or URL. Names are case-sensitive. See Use Page Parameters and Dynamic Filtering with Page Parameters for the declaration syntax.4
Refresh the Board After Fixing
After correcting a widget parameter, save the widget configuration, then use the board’s Refresh control (or reload the page) to force the board to re-fetch all data from the server. A refresh reloads all Plans and work items and resets the board state.
5
Diagnose Infinite Loading or Blank Board
If the board never finishes loading (infinite spinner) and no error indicator appears, the issue may not be a script error:
- Open the browser developer tools (F12) and check the Network tab for failed or blocked requests to the Polarion server.
- If requests are being blocked by a firewall or proxy, this is a network-layer issue — not a Planningboard script error. Refer to Network and Firewall Requirements for the list of required endpoints.
- If requests reach the server but return error responses (HTTP 4xx/5xx), check the Polarion server logs and verify the widget configuration is valid.
Verification
After applying your fix:- Save the widget configuration.
- Reload the Planningboard page.
- You should now see the board render without the warning indicator in the toolbar, Plans appear as columns, and work item cards distributed across swimlanes as expected.
See Also
- Widget Parameters Overview — full reference for all widget parameters
- Config Scripts — authoring configuration scripts
- Item Scripts — authoring per-item scripts
- Dynamic Filtering with Page Parameters — page parameter syntax and usage
- Network and Firewall Requirements — required endpoints and proxy configuration
- Common Errors — broader Planningboard error reference
Sources
Sources
KB Articles
- Troubleshooting Script Errors in Planningboard
commons.jsPlanningBoardWidgetDependenciesProcessor.javaPlanningBoardWidgetRenderer.java