New checklist storage & migration

Overview

Starting from version 5.0.0 we introduce a new checklist data storage for Server and Data Center.

From the very beginning, our addon provided a smooth experience for administrators to install add-on and start using Checklists on Jira instance with no additional configuration.

We used Jira Issue Property as the main storage for checklist data. Installing “Checklists” and “Smart Checklist Progress” custom fields allowed users to get access to some extended features. Check https://railsware.atlassian.net/wiki/spaces/CHKSDC/pages/2349925102/Custom+Fields documentation.

But due to the growing user’s demand for new features and improvement for already existing - we introduce new storage based on the client Jira database and custom field “Smart Checklist” of a unique type.

Benefits it brings

  • Custom Statuses implementation

  • Improved search functions

  • Checklist view in Search, Jira Dashboard, and Confluence Jira widgets

  • Better support for Jira Server → Cloud migration

With these changes, Jira issue property com.railsware.SmartChecklist.checklist is not supposed to be the main checklist storage. But, if you have an Automation set up to read/write checklists - you may still use this property along with “Checklists” custom field

Migration

Before applying migration to v5.0+ on the Production instance make sure it’s tested on your Test or Dev instance

For the new users - no action required. While installing an addon - a new field is installed automatically and Smart Checklist start saving data there right away

For existing users - once you manually access your Jira tickets with checklists they will be migrated to new storage. You may also initiate a migration process to transfer your historical checklist at once. Good news - it’s just a matter of one click!

Note: Admin permissions required.

Steps

  1. Navigate to Admin console

  2. Smart Checklist Settings → Global Settings

  3. Click ”Migrate in the “Migrate” section.

  4. Done!

Run “Re-Indexing” manually after the migration is done in order to enable searching through checklists value.

It may take some time to migrate data on instances with a big amount of projects.

“Re-start Migration” will re-synchronize all available checklist storages (custom fields). Might be useful for existing customers who want to change old “Checklists” and “Smart Checklist” custom fields configured manually to new fields added by the addon.

 

Note: if you want to overwrite existing checklists in the database that were already migrated - use “Force existing checklists update”. That is useful, for instance, if you used to work on version 5.0+, then switched back to 4.16 (old storage) and then updated back to 5.0+.