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

# Set Up a Plan Checklist (Tutorial)

> This tutorial walks you through setting up a Nextedy CHECKLIST to control Polarion plans.

export const LastReviewed = ({date}) => {
  if (!date) return null;
  const formatted = new Date(`${date}T00:00:00Z`).toLocaleDateString("en-US", {
    year: "numeric",
    month: "long",
    day: "numeric",
    timeZone: "UTC"
  });
  return <p className="mt-10 text-sm text-gray-400 dark:text-zinc-500 not-prose">
      Last reviewed on {formatted}
    </p>;
};

## What you will achieve

You will create a custom field to hold plan checklist data, place a script block on the plan report to render the checklist, and configure a plan template so new plans start with the same predefined checklist items.

## Prerequisites

* Administrator access to **Project Administration** in Polarion
* Permission to create custom fields
* Permission to customize plan report pages
* An existing plan (or plan template) to attach the checklist to

<Steps>
  <Step title="Create a custom field">
    In **Project Administration**, create a new custom field of type **Text (multi-line plain text)**. This field stores the checklist's item text and result states for the plan.

    <Note>
      You can set up multiple checklist custom fields if you need more than one checklist on a plan (for example, separate DoD and DoR checklists).
    </Note>

    **What you should see:** the new custom field listed among your plan custom fields, with type **Text (multi-line plain text)**.
  </Step>

  <Step title="Show the checklist on the plan report">
    Next, make the checklist visible by adding it to the plan's report page.

    1. Open your plan, click the gear/actions menu, and choose **Customize Plan Report**.
    2. If possible, select **Customize Shared Report** so the same report layout is used across your plan and plan template — this avoids repeating the setup for every individual plan.
    3. Place a **Script Block Widget** wherever you want the checklist to appear on the page, and enter:

    ```text theme={null}
    $checklistService.getChecklistView().plan($plan).checklist("planDone").render()
    ```

    Here, `planDone` refers to the ID of the checklist custom field you created in Step 1 — replace it with your own field ID if you named it differently.

    4. Save the report.

    **What you should see:** the checklist section now appears on the plan report page, initially empty since no items have been defined yet.
  </Step>

  <Step title="Define a checklist template">
    Attaching the checklist to a plan template lets every new plan created from that template start with the same predefined items.

    1. Open your plan template by clicking the template link in the plan's properties.
    2. If the checklist isn't visible on this plan template yet, repeat Step 2 for the template.
    3. Set your checklist items on the template.

    **What you should see:** the checklist you defined on the template now also appears — pre-populated — on any plan created from that template.

    <Tip>
      **Templates propagate automatically**

      Once the template plan has a checklist configured, new plans created from it inherit the same checklist items automatically. You don't need to repeat the report configuration for each new plan.
    </Tip>

    <Warning>
      **Repeat the report setup per plan if not shared**

      If you did not use **Customize Shared Report** in Step 2, you'll need to repeat that step for every individual plan and its template separately.
    </Warning>
  </Step>
</Steps>

## Next steps

* Explore the [Getting Started](/checklist/getting-started/index) section for the equivalent tutorial on [test run checklists](/checklist/getting-started/setup-test-run-checklist) or [work item checklists](/checklist/getting-started/your-first-checklist)
* Visit the [Guides](/checklist/guides/index) section to define a reusable checklist template in more detail and configure permissions
* Check the [Concepts](/checklist/concepts/index) section to understand checklist items, result states, and templates
* See the [Reference](/checklist/reference/index) section for configuration property details

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

  * Setup New Plan Checklist
  * Setup new Work Items checklist
  * Setup New Test Run Checklist

  **Support Tickets**

  * [#235](https://support.nextedy.com/helpdesk/tickets/235)
  * [#418](https://support.nextedy.com/helpdesk/tickets/418)
  * [#325](https://support.nextedy.com/helpdesk/tickets/325)

  **Source Code**

  * `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/ChecklistServlet.java`
  * `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/ChecklistConf.java`
  * `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/IChecklistService.java`
  * `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/wf/ChecklistMandatoryChecked.java`
  * `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/internal/ChecklistService.java`
</Accordion>

<LastReviewed date="2026-08-31" />