Skip to main content

​
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

diagram

​
Step 1: 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 2: Deploy the plugin to Polarion

Copy the .jar file to the Polarion extensions directory on your server: 
<POLARION_HOME>/polarion/extensions/
Polarion must be restarted after deploying or updating the plugin. Plan the deployment during a maintenance window to avoid disrupting active users.
After copying the file, restart the Polarion service: 
# 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 3: 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
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.

​
Step 4: 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/.
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.
After installation, you can create a new project from the Checklist template through Polarion’s standard project creation workflow.

​
Step 5: 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 TypeSetup TutorialCustom Field Location
Work itemsWork Items ChecklistWork Item custom fields
DocumentsDocument ChecklistModule custom fields
Test runsTest Run ChecklistTest Run custom fields
PlansPlan ChecklistPlan custom fields
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.

​
Next steps

With the plugin installed and verified, proceed to set up checklists for your target object types: After setting up your first checklist, explore Creating and Managing Templates to define reusable checklist templates, or visit Concepts to understand the template system and configuration property hierarchy.
KB ArticlesSupport TicketsSource Code
  • ChecklistSetupService.java
  • ChecklistService.java
  • ChecklistAllChecked.java
  • ChecklistSettings.java
  • ChecklistAdminServlet.java