Migration Feature - v2.3.0

Release Notes: Migration Feature - v2.3.0

Release Date: November 4th, 2024

This release document provides a detailed overview of the new Migration Feature, outlining its purpose, functionality, and key benefits.
It aims to help users understand how the feature facilitates seamless data or configuration transfers between systems, improving efficiency and reducing manual effort. It includes step-by-step instructions for using the feature, and highlights any technical dependencies or requirements.
By providing this information, the document ensures smooth adoption and integration of the Migration Feature into existing workflows.

 

Overview

Idea: Inspired by our existing solution for migrating grid data from TGNG Server/Datacenter to TGNG Cloud, we’ve developed a dedicated UI within the app itself to streamline the migration process. This new feature allows you to perform migrations directly from TGNG Server/Datacenter to TGNG Cloud without relying on external tools like Script Runner.

Goal: The primary goal is to simplify the migration process by providing an intuitive interface that requires minimal input. The system will automatically handle the rest, ensuring a smooth and efficient migration. Pre-requisites include connecting to an existing cloud site, which will serve as the target for the migration.

Example:

Input: Task 1 in Migration Project on Jira On Premise includes Grid 1 and Add-new Grid 1 with many types of column and data.

image-20241018-041705.png

Output: After the migration, Task 1 in Migration Project on Jira Cloud also includes Grid 1 and Add-new Grid 1 with the same grid configuration and grid data to Server.

image-20241018-041926.png

Key Features

Step-by-Step Migration Process:

A new, detailed UI guides users through the entire migration process, explaining each step and outlining all prerequisites required for a successful migration.

Progress Tracking

The migration process now features clear step indicators within the UI, allowing users to easily identify their current position in the workflow at all times.

Simplified Authentication

Authentication between Jira Server/Datacenter and Jira Cloud is streamlined with a user-friendly interface, including fields for:

  • Jira Cloud site URL

  • User email for migration

  • Protected authentication token for Jira Cloud.

Improved Grid and Column Mapping

A dedicated UI allows users to easily map source grids from Jira Server/Datacenter to target grids in Jira Cloud. Users can select source and target grids via checkboxes and map columns with matching data types.

Support Contact Integration

A direct link to the Table Grid support portal is now available, making it easy for users to ask questions or seek help during the migration process.

Real-Time Error Notifications

Users can monitor live logs and view detailed error screens to diagnose issues during the migration process.

Migration Progress Visualization

A progress bar is included to show real-time migration progress and provide an estimated time for completion.

Pre-Migration Review

Users can now review migration details before initiating the process, ensuring they are fully informed about the actions to be taken.

Instructions for Use

  • Recommend Jira version 9.4.x, 9.12.x, or newer. Jira 8.x is no longer supported.

  • We recommend using a separate Jira environment or sandbox environment (both Server/Datacenter and Cloud) for testing to ensure your production data is not impacted.

  • Important: Before running the migration, ensure that you back up your data.

Open Migration feature: Click Manage apps → Click Migration in Table Grid section

Step 1: Prerequisites

You will find all the necessary information and requirements needed before proceeding with the data migration in this step. Make sure to review this section carefully to ensure a smooth migration process.

  1. TGNG apps installed on both Jira Server / Datacenter and Jira Cloud instances

  2. All grids configuration must be manually exported from Jira Server / Datacenter instance and imported into the Jira Cloud site, or you can choose to create a new grid in the mapping screen.

  3. All Jira projects and issues that are using grids from the source instance must already be migrated to the target Cloud site

→ You need to create corresponding Projects and Issues on your Jira Cloud (same Project Key and Issue Key)

  1. All Columns in the Grid Config are made editable in the Jira Cloud site before running the script (can be changed after)

Click “Next” button at the right bottom corner to come to Step 2.

Step 2: Authentication

This is the crucial first step, where you authenticate and connect to your target Cloud instance. Ensure that all the information you provide is accurate and follows our guidelines to avoid any connection issues.

Field Name

Description

Field Name

Description

Your email account

The email account that you use for Jira Cloud

Your Instance Name

Part of Jira Cloud URL before the “.atlassian.net”

Your Jira API Token

Get it on https://id.atlassian.com/manage-profile/security/api-tokens

Your TGC API Token

Get it on API Tokens tab on Apps page/Table Grid section

https://<your-atlassian-url>.atlassian.net/plugins/servlet/ac/tge.cloud/tokens-item?s=tge.cloud__tokens-item

Your User Name

The username that you use to log in Jira Cloud

When you filled in all above fields, click “Next” button to verify your Jira Cloud account and come to Step 3.

Step 3: Select Grid

Select Grid: After authentication, you can now select the grids you wish to migrate by selecting the corresponding checkbox. Multiple grids can be selected at once.

The Single Select List/Multi Select List column type with Dynamic Options cannot be migrated to Jira Cloud. If your grid includes this setting, it will be ignored during migration.

View Projects: Additionally, you'll see useful information related to the projects associated with each grid to help guide your selection by clicking on the number of projects on each grid.

When you complete choosing grids, click “Next” button to come to Step 4.

Step 4: Mapping

On this screen, you will begin mapping grids from TGNG Server to the target grids on Jira Cloud. In default, all selected grids have the option “Add new grid” which will automatically create a new grid on Jira Cloud with the same configuration and data as Jira Server, simplifying the migration process.

Mapping grids by selecting the target grid on Jira Cloud that is corresponding to the original grid from TGNG Server.

When you complete mapping grids, click “Next” button to come to Step 5.

Or if you want to adjust the list of selected grids, you can click “Back” to come back to Step 3.

Step 5: Review

Before the migration begins, you will be able to review your selected grids and mappings. You also can go back to previous steps if any adjustment is needed.

Additionally, the number of all warnings related to the mapped grids that could impact the migration process will be displayed in the “Warning found” section, let you be noticed necessary updates before proceeding with the migration.

For example, if you're migrating grids with different configurations between Server and Cloud, a warning will appear to inform you of this discrepancy, because you need to make sure grid configuration is the same between Server and Cloud.

Step 6: Migration Process

Here we go the migration run, in this screen, you can track the progress of migration by seeing the progress bar and also the remaining time until it finishes.

You can also have option to Cancel the migration before its progress is complete by clicking “Cancel” and then click “Yes” to confirm.

When the migration is finished, please click View Result button to come to Step 7 and see the result.

Step 7: Result

Once the migration progress is complete, you will be able to see detailed information, including the number of grids successfully migrated, any grids that failed to migrate. You'll also see the total execution time and overall migration status.

Contact: If you have any questions, click “Contact” button to contact our support team through
https://tablegrid.atlassian.net/servicedesk/customer/portal/1

Download: Additionally, you can click “Download” to download the migration log for further review if needed.

View failed grids: You can view the list of grids that failed to migrate, along with the specific reasons for failure.

Retry: If you cancelled the migration in Step 6, you can use the “Retry” button to continue migrating any remaining grids that have been cancelled migration.

Click “Finish” button to finish the current migration and then go to Step 8.

Step 8: Success

When you finished each migration, you can decide to continue to migrate or not. If yes, you will go back to Step 1 to start a new migration.

Feedback and Support

For more information, visit our Support Portal here.

Conclusion

The new Migration feature is designed to streamline the transition from TGNG Server/Datacenter to TGNG Cloud by providing a user-friendly, built-in interface that simplifies the entire process. With this intuitive solution, you no longer need to depend on external tools like Script Runner, making the migration experience faster and more efficient. By automating most of the workflow, this feature significantly reduces the complexity and effort required, allowing you to focus on other priorities.

We encourage all users planning a migration to explore this new feature and experience firsthand the benefits of a seamless, efficient migration process. Make the switch to TGNG Cloud with confidence, knowing that our solution is built to make this transition as smooth as possible.