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

# Installation and Licensing

> Install the Nextedy CHECKLIST plugin on your Polarion server and confirm it's licensed before setting up any checklists.

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>;
};

## Install the plugin

1. Download the latest distribution from the [Checklist download page](https://checklist.nextedy.com/download).
2. Stop the Polarion service.
3. Unzip the downloaded `checklist.zip`.
4. Copy the `com.nextedy.polarion.checklist` folder into `[POLARION_INSTALL]/polarion/extension`.
5. If you already have a production license, copy the `checklist_lic.json` file into `[POLARION_INSTALL]/polarion/license` , or add it later manually through the Polarion UI once the plugin is already installed.
6. Delete `[POLARION_INSTALL]/data/workspace/.config`.
7. Start the Polarion service.

<Warning>
  **Don't skip step 6**

  Deleting `[POLARION_INSTALL]/data/workspace/.config` is required for the plugin to register correctly. Skipping this step is a common cause of the plugin not appearing after installation.
</Warning>

## Check the license status

Nextedy CHECKLIST ships with an admin/license page reachable from Polarion administration under **Administration > Nextedy CHECKLIST**. This page shows:

* The plugin version, resolved from the installed bundle
* Current license status
* Links to documentation (support), pricing (get a quote), the latest-version check, the download page, the changelog, and the setup guide

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/892YPUCat-q05Sxp/checklist/diagrams/guides/installation/diagram-1.svg?fit=max&auto=format&n=892YPUCat-q05Sxp&q=85&s=e4ea801ecb2b7905320039d7a513c0d4" alt="diagram" style={{ maxWidth: "640px", width: "100%" }} width="640" height="220" data-path="checklist/diagrams/guides/installation/diagram-1.svg" />
</Frame>

If the license is not in **OK** status, a colored banner appears wherever a checklist is rendered (work item form, LiveDoc panel, test run, or plan), with links to Help & Documentation, Contact us, and Get a quote.

<Info>
  **Verify in application**

  The exact banner colors and thresholds (invalid vs. info-status) are determined by the license state reported by the admin page; confirm current wording and color coding directly on your instance.
</Info>

## Set up your first checklist

Installation only makes the plugin available — you still need to create a custom field and wire it into a form, LiveDoc, test run, or plan before a checklist appears anywhere:

* Work items: see [Set Up a Work Item Checklist](/checklist/guides/setup/work-items)
* Documents (LiveDocs): see [Set Up a Document (LiveDoc) Checklist](/checklist/guides/setup/documents)

<Tip>
  **Project template available**

  Nextedy CHECKLIST ships a ready-made Polarion project template (`checklist_template`) that administrators can apply when creating new projects, giving you a working example configuration to start from.
</Tip>

## Security considerations

For security guidance that applies to all Nextedy Polarion add-ons — including the platform vs. add-on responsibility model, administrator permissions, input handling, and recommended configuration — see the common security guidance article on the Nextedy support portal. Refer to the Checklist-specific section within that document for product-specific details.

<Warning>
  **Common pitfall: incomplete setup after install**

  Installing the plugin and restarting Polarion is not enough on its own. The plugin must still be paired with a custom field and a form extension (work items) or a wiki block (documents) before it does anything visible. Follow the appropriate setup guide immediately after installing.
</Warning>

## Verification

You should now see **Administration > Nextedy CHECKLIST** in your Polarion administration menu, showing the installed version and a license status that is not an error banner. If the license is not **OK**, resolve that before proceeding to checklist setup — the same banner will otherwise appear on every checklist you configure.

## See also

* [Set Up a Work Item Checklist](/checklist/guides/setup/work-items)
* [Set Up a Document (LiveDoc) Checklist](/checklist/guides/setup/documents)
* [Create a Checklist Template](/checklist/guides/templates/create-a-template)
* [Control Who Can Change the Checklist](/checklist/guides/permissions)

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

  * How to control who can change the list and when ?
  * Nextedy CHECKLIST - Installation Guide (new)

  **Support Tickets**

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

  **Source Code**

  * `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/ChecklistAdminServlet.java`
  * `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/internal/ChecklistAdminService.java`
  * `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/ChecklistItem.java`
  * `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/ChecklistView.java`
  * `proc-checklist-src/com.nextedy.polarion.checklist/src/com/nextedy/polarion/checklist/DocumentChecklistView.java`
</Accordion>

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