Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Warninginfo
titleBETA Feature

This feature is currently in Beta and is only available to selected customers. If you want to participate in this Beta phase, please contact us via our support portal.

Warning

The results of the operation depend on different aspects such as the data to import as well as both your source and destination Jira instances. Do NOT delete the Checklist custom fields (server) or Checklist Definition (cloud) from the Jira source until you make sure that all the needed information was imported successfully.

In case of critical errors, the process may abort of freeze. In this event or any other unforeseen circumstances please contact us via support portal.

It is possible to import a checklist definition with all its checklists from the Server version of the add-on, or from another instance of the Cloud. For this operation you will need the data files generated with the Export feature of the Server or Cloud versions of the Okapya Checklist for Jira add-on.

This page describes how to import data into a new checklist definition. This approach is safer, because the imported data is isolated from the existing data and you have less risk of accidentally overwriting or destroying your existing checklists. If you absolutely have to, there is also a possibility to import data into an already existing definition, though that process is more dangerous and has more restrictions.

Before you Begin

  1. Update your server instance with the latest version of Checklist Server. That will ensure that you have the latest version for the exporter and that the import will go smoothly.
  2. Export from the server, all the custom field contexts that you want to move to the cloud. Each exported context will create one or more files with the following name pattern customfield_<FIELD_ID>-<CONTEXT_ID>_<FILE NUMBER>. Group together the files where <FIELD_ID> and <CONTEXT_ID> are the same.
  3. Is is very important you ONLY upload files belonging to the same context (same <FIELD_ID> and <CONTEXT_ID>). Doing otherwise will lead to undesired and unexpected results and will result in having to redo the import.
  4. When uploading a custom field context from the server, the cloud will create a new Checklist Definition that will match the custom field context.
    1. If the context is limited to specific projects and that not all of those projects are found in the cloud, the Cloud Checklist Definition context will be marked as "All Projects" and/or "All Issue Types".
    2. Some features from server are not exported (assignee, priorities, due date, advanced markdown, access permissions)
    3. Cloud does not support headers section yet. So headers are exported as normal checklist items.
    4. Statuses are not on a per checklist definition like on the server. So all statuses are exported to the Status page and will be visible to all issues. It is therefore best to ensure that similar statuses are renamed exactly to identical names on the server before being exported.
    5. If you migrate in steps, make sure that you only select specific projects during the server export.
  5. If, during the import, some projects are not found, all the checklists for these issues will be skipped.
  6. The import can be a long process so please be patient. Each import is placed in a queue and we process one import at a time. So depending on the number of people trying to import and the size of the import, it can take hours to even days.

To import a definition

...

Warnings and Errors

Please note that for the import process to be successful, the destination and source Jira instances should have the same:

  • Project keys
  • Issue type names
  • Issue keys

In case of discrepancies, you may encounter the following messages:

Missing Context (Warning)

If some projects or issue types of the definition's context cannot be found in the destination Jira, you will see the following warning:

Image Removed

The definition will still be imported, but its context will be set to "All" in order to prevent accidental data loss. Please adjust the context manually after the import is finished.

Missing Issues (Warning)

If some issue keys cannot be found in the destination Jira, the corresponding checklists will not be imported. In this case you will see the following warning:

Image Removed

Other checklists, for which the issue keys were found, will be imported as usual.

Error

If an error occurs during the import process, you will see this:

Image Removed

...

Okapya joins forces with HeroCoders

The two most popular Checklist App vendors, Okapya Software Solutions and HeroCoders, have joined forces at end of December 2021.

The Future of Checklist for Jira Cloud

Since HeroCoders already has Issue Checklist for jira. Pro and that it has a more extensive feature set than Checklist for Jira Cloud, it was decided that the unique features of Checklist for Jira Cloud would be merged into Issue Checklist. This will result in:

  • The creation of Checklist for Jira. Enterprise. This version will combine all the features of Issue Checklist for Jira. Pro with concepts unique to Checklist for Jira Cloud such as Global Items and Checklist Definitions.
  • Checklist for Jira. Enterprise should have the same price tag as the current version of Checklist for Jira Cloud and is expected to be released early summer.
  • Issue Checklist Pro will be renamed to Checklist for Jira. Pro, will keep the same feature set, and should keep the same price tag.

Migration Paths

The current migration path requires you to manually export data from the on-premise app and manually upload it to cloud. We intend the new Checklist for Jira. Enterprise app to integrate with the Jira Cloud Migration Assistant to automate the migration efforts.

User tiers of 100 users or less

For those with less than 100 users, you can chose to migrate right now to Issue Checklist for Jira. Pro or to Checklist for Jira Cloud. If you chose to proceed with Checklist for Jira Cloud:

  • The importer is still in Beta, please consult the following article: Importing data in a new Definition.
  • Some questions to determine the size of your import will be asked to you before enabling the beta.
  • Once Checklist for Jira. Enterprise is released, your data will be automatically migrated by accepting the major upgrade. We will also let you know ahead of time of the migration process.

User tiers of more than 100 users

Issue Checklist for Jira.Pro already supports importing data from the on-premise versions of Checklist for Jira and is the preferred migration path. It's also an opportunity to see if Issue Checklist. Pro meets all of your requirements. If it does, then you should stay on that app and will most likely not need to migrate to the more expansive Checklist for Jira. Enterprise. If you are extensively using the concepts of Global Items and Projects/Issue Types contexts from the on-premise app, you will then want to eventually migrate to the enterprise version. Once Checklist for Jira. Enterprise is released:

  • You will simply need to uninstall Issue Checklist for Jira. Pro and install Checklist for Jira. Enterprise. Since both apps use the same data format, no data migration will be required and you will be able to use the new functionality right away.
  • If you have a monthly subscription, the price will automatically be adjusted after subscribing to the enterprise version and will be reflected in your next monthly invoice.
  • If you have an annual subscription, you can reach out to us via our support portal and we will provide you with a promo code that will allow you to buy the enterprise subscription at a prorated price.

Note for our larger customers or customers wanting annual plans

Since our larger customers typically buy annual plans and that their needs will most likely require the enterprise version, we suggest that you directly buy your annual subscription under Checklist for Jira Cloud. This will allow you to avoid having to pay additional fees when moving to the enterprise version. We will either provide you with a free extension to your Issue Checklist for Jira. Pro trial or a complementary license until the enterprise version is released. Please contact us if you need more information.