Skip to main content

​
What you will achieve

By the end of this tutorial, you will have a working checklist attached to a Polarion plan. You will create a custom field for plans, embed the checklist widget into the plan report page, configure a template from a plan template, and verify the setup by interacting with checklist items on a live plan.

​
Prerequisites

  • Nextedy CHECKLIST plugin installed and active (see Installation)
  • A Polarion project with administrator access
  • Permission to create custom fields and edit plan report pages
  • At least one plan or plan template in your project

​
Setup overview

diagram

​
Step 1: Create a checklist custom field for plans

Create a new custom field on the Plan object to store checklist data.
  1. Open your Polarion project and navigate to Administration > Custom Fields > Plan Custom Fields
  2. Click Add to create a new field
  3. Set the following values:
Field PropertyValue
IDplanDone
NamePlan Completion Checklist
TypeText (multi-line plain text)
  1. Save the custom field
The custom field must be of type Text (multi-line plain text). Other field types are not compatible with the Checklist plugin and will produce an error when rendering.
You should see the planDone field listed in the Plan Custom Fields table.
You can create multiple checklist custom fields for plans. For example, use planReady for Definition of Ready criteria at plan start and planDone for completion criteria at plan close.

​
Step 2: Embed the checklist widget in the plan report page

Plan checklists are displayed using a script block widget on the plan report page.
  1. Open a plan in your project
  2. Click Customize Report Page in the plan toolbar
  3. Select Customize Shared Report to share the layout configuration across plans that use the same template
Use Customize Shared Report when possible. This shares the layout between a plan and its plan template, so you only configure the checklist widget once. If you customize individual plans instead, you must repeat this step for each plan.
  1. In the report page editor, place a Script Block Widget where you want the checklist to appear
  2. Enter the following rendering call in the script block:
$checklistService.getChecklistView().plan($plan).checklist("planDone").render()
The "planDone" string in the checklist() call must match the ID of the custom field you created in Step 1. Substitute your actual field ID if it differs.
  1. Save the report page
You should now see the checklist widget on the plan page. It displays an empty checklist until you define template items.

​
Step 3: Define a checklist template via plan template

Set up a template so that plans created from a plan template automatically inherit predefined checklist items.
  1. Open your plan template in Polarion (click the template link in the plan properties)
  2. If the checklist widget is not yet visible on the plan template, repeat Step 2 for the template’s report page
  3. Add checklist items directly to the plan template’s checklist widget — for example:
    • All requirements reviewed and approved
    • Risk assessment completed
    • Test plan defined
    • Resource allocation confirmed
    • Stakeholder sign-off obtained
  4. Save the plan template
Plans created from this template will inherit the checklist items you defined. The template merge happens automatically when a plan is created.
After saving the plan template, create a new plan from that template to verify that checklist items are inherited correctly.

​
Step 4: Verify the checklist on a plan

  1. Create a new plan from the template you configured in Step 3
  2. Open the plan and scroll to the checklist section on the report page
You should see the template checklist items displayed with their initial result state (Empty).
  1. Walk through each checklist item and set its result state as you progress through the plan lifecycle:
Result StateTypical Use in Plans
OKCriterion met for this plan milestone
NOKCriterion not met — action needed
N/ACriterion not applicable to this plan
PendingCriterion deferred to next review
EmptyCriterion not yet evaluated
  1. Save the plan to persist the checklist state
The checklist data is stored in the planDone custom field on the plan object. Other team members opening the same plan see the current checklist state. diagram
You can add workflow conditions to prevent closing a plan until all mandatory checklist items are addressed. See Workflow Gates and Validation for details on configuring workflow functions and conditions for plans.

​
Next steps

Your plan checklist is now operational. Continue with these topics:
KB ArticlesSupport TicketsSource Code
  • ChecklistService.java
  • ChecklistSettings.java
  • ChecklistAllChecked.java
  • ChecklistSetupService.java
  • IChecklistService.java