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

> By the end of this tutorial, you will have Nextedy CHECKLIST installed on your Polarion instance, verified the plugin is active, and confirmed access to the administration interface.

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

By the end of this tutorial, you will have Nextedy CHECKLIST installed on your Polarion instance, verified the plugin is active, and confirmed access to the administration interface. You will be ready to set up your first checklist on any supported object type.

## Prerequisites

* A running Polarion ALM instance with administrator access
* Access to the Polarion server file system for deploying plugins
* A valid Nextedy CHECKLIST license (or trial license)

## Installation overview

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/Jklvz9qm2AdmIvBG/checklist/diagrams/getting-started/installation/diagram-1.svg?fit=max&auto=format&n=Jklvz9qm2AdmIvBG&q=85&s=0b2040c4e3798313b3344a1c05e4d134" alt="diagram" style={{ maxWidth: "740px", width: "100%" }} width="740" height="190" data-path="checklist/diagrams/getting-started/installation/diagram-1.svg" />
</Frame>

<Steps>
  <Step title="Obtain the plugin package">
    Download the Nextedy CHECKLIST plugin package from your Nextedy account or the link provided by your Nextedy representative. The package is a single `.jar` file.

    You should have a file named similar to `com.nextedy.polarion.checklist-<version>.jar`.
  </Step>

  <Step title="Deploy the plugin to Polarion">
    Copy the `.jar` file to the Polarion extensions directory on your server:

    ```
    <POLARION_HOME>/polarion/extensions/
    ```

    <Warning title="Restart required">
      Polarion must be restarted after deploying or updating the plugin. Plan the deployment during a maintenance window to avoid disrupting active users.
    </Warning>

    After copying the file, restart the Polarion service:

    ```bash theme={null}
    # Linux
    sudo systemctl restart polarion

    # Windows
    net stop polarion
    net start polarion
    ```

    When the restart completes, the Checklist plugin loads automatically as part of Polarion's plugin framework.
  </Step>

  <Step title="Verify the installation">
    Open your browser and navigate to the Checklist administration page:

    ```
    https://<your-polarion-server>/polarion/nxchecklist/admin
    ```

    You should see the Nextedy CHECKLIST License page displaying:

    * The product name and current version number
    * Your license status (valid, trial, or unlicensed)
    * A link to the support documentation at the Nextedy support portal

    <Tip title="Version check">
      The administration page shows the runtime version of the plugin. You can compare this against the latest available version to determine if an update is available. The version check URL is `https://download.nextedy.com/checklist/bnum.txt`.
    </Tip>
  </Step>

  <Step title="Install the project template">
    Nextedy CHECKLIST includes a bundled project template that provides a preconfigured demo project. You can install this template from the administration interface to explore a working example.

    Navigate to the administration page and use the template installation option. The template installs to the Polarion repository at `/.polarion/projects/templates/`.

    <Note title="Template already exists">
      If a previous version of the template is already installed, the installer removes the existing template before uploading the new version. Back up any customizations before reinstalling.
    </Note>

    After installation, you can create a new project from the Checklist template through Polarion's standard project creation workflow.
  </Step>

  <Step title="Confirm custom field support">
    Before creating your first checklist, verify that you can create custom fields in your target project:

    1. Open your Polarion project
    2. Navigate to **Administration > Custom Fields**
    3. Confirm you have permission to create new fields of type **Text (multi-line plain text)**

    This field type is required for all checklist custom fields. You will create specific fields in the per-object-type setup tutorials.

    | Object Type | Setup Tutorial                                                          | Custom Field Location   |
    | ----------- | ----------------------------------------------------------------------- | ----------------------- |
    | Work items  | [Work Items Checklist](/checklist/getting-started/work-items-checklist) | Work Item custom fields |
    | Documents   | [Document Checklist](/checklist/getting-started/document-checklist)     | Module custom fields    |
    | Test runs   | [Test Run Checklist](/checklist/getting-started/test-run-checklist)     | Test Run custom fields  |
    | Plans       | [Plan Checklist](/checklist/getting-started/plan-checklist)             | Plan custom fields      |

    <Info title="Verify in application">
      The exact navigation path for custom field creation may vary depending on your Polarion version and configuration. Consult your Polarion administration guide if the menu paths differ.
    </Info>
  </Step>
</Steps>

## Next steps

With the plugin installed and verified, proceed to set up checklists for your target object types:

* [Work Items Checklist](/checklist/getting-started/work-items-checklist) -- the most common starting point for Definition of Done enforcement
* [Document Checklist](/checklist/getting-started/document-checklist) -- add checklists to LiveDocs for document review tracking
* [Test Run Checklist](/checklist/getting-started/test-run-checklist) -- attach checklists to test runs for execution verification
* [Plan Checklist](/checklist/getting-started/plan-checklist) -- add checklists to plans for milestone gate tracking

After setting up your first checklist, explore [Creating and Managing Templates](/checklist/guides/templates) to define reusable checklist templates, or visit [Concepts](/checklist/concepts/index) to understand the template system and configuration property hierarchy.

<LastReviewed date="2026-07-02" />