Upgrade Guide

Important

If you are using the older version of synapseRT, and are upgrading to synapseRT 8.x, please follow Upgrade instructions carefully!

If there is a newer version released to Atlassian Marketplace, you can upgrade your add-on using the following:

  1. Login to JIRA as a system administrator, then click the "COG" icon in the top right corner of the page and select "Add-ons"

  2. Select "Add-ons" from the administration menu, then click the “Manage add-ons” link from the left panel

  3. Find the synapseRT NextGen add-on from the list, then click it

  4. Click the “Upgrade” button

  5. Once the upgrade process is done, installation of the latest version is complete

IN0004_Upgrade_to_Newer_Version.jpg

[Screenshot - IN0004_Upgrade_to_Newer_Version]

 


Upgrade synapseRT (version JIRA 7.x) to synapseRT NextGen (version 8.x to 8.4.3.1) 

Upgrade synapseRT (version JIRA 6.x) to synapseRT NextGen (version 8.4.0.0)

 

Important
  • It is highly recommended to perform this migration and verify data on your stage before doing this on production

  • It is highly recommended to take a backup of your JIRA instance before performing this task

  • It is highly recommended to perform this task only during offline hours when no one is using the application

  • Please contact support@go2group.com if you encounter any issues and need our assistance

Important
  • If you want to upgrade synapseRT (version 7.x) to synapseRT NextGen (version 8.5.1 and higher), you need take the path: v7.x -> v8.4.x -> Migration (Data) -> v8.5.x and higher

 

  1. Before installing synapseRT NextGen to your JIRA server:
    1). Check if you have other issue types mapped to "Test Case" and "Test Plan" in synapseRT. If you do, convert the tickets to Test Case and Test Plan issue types; for help with this, please refer to "

    Moving an issue

    ."
    2). Check if you have multiple issue types mapped to "Bug" in synapseRT. If you do, you need to combine them into one. You can convert other bugs in different issue types to the one you want to keep; for help with this, please refer to "

    Moving an issue

    ."
         Note: From v8.4.0.1 on towards, we support mapping multiple issue types to "Bug". So it is not necessary to convert issue types from this version in order to do migration. Just do same issue type mapping settings and start your migration.
    3). Check and update the synapseRT configuration from "Administration->Add-ons->SYNAPSERT->synaspeRT Configuration->Issue Types" with the following:

    1. Select "Test Case" as Test Case issue type

    2. Select "Test Plan" as Test Plan issue type

    3. Leave only one issue type as Bug issue type

    4. Note down mapping values for Requirement issue type

    4). Check if any JIRA services are configured for synapseRT (prior to version 8.0) e.g 'Synapse Bonfire Service'. If you do, you need remove these JIRA services manually:

    1. Log in as a user with the JIRA System Administrator permission

    2. Choose Administration > System

    3. Select Advanced > Services to open a page showing all the configured services

    4. Click the Delete link associated with the service you wish to remove

  2. Make sure your JIRA server has already been upgraded to JIRA 7.x; please refer to synapseRT NextGen supported JIRA versions

  3. Install synapseRT NextGen to your JIRA server; please refer to "Installation guide"

  4. Update synapseRT NextGen configuration settings from "Administration->Add-ons->SYNAPSERT->Configuration" with the following:
    a. Set the same value as is in synapseRT for "Requirement" mapping
    b. Set the same value as is in synapseRT for Bug

  5. Complete the migration process by following these steps:
    a. Go to "Administration->Add-ons->SYNAPSERT->Migration"
    b. Click the "Migrate" button and wait until the migration process is complete

  6. As workflows created from old synapseRT (prior to version 8.0) are no more required by synapseRT NextGen, we request to remove the Postfunctions offered by old SynapseRT from your workflows or assign any newly created workflow or JIRA default workflow to them.  Otherwise you may face an error 'Could not load FunctionProvider class' when you execute your workflow actions. 

Changes are made once the upgrading and migration are complete

Issue types change

In synapseRT

In synapseRT NextGen

Comments

Requirement

Requirement

  1. No change

Mapped Issue Types

Mapped Issue Types

  1. No change

  2. In synpaseRT NextGen, go to "Administration->Add-ons->SYNAPSERT->Configuration" to map the same issue types to Requirement

Bug

Bug

  1. No change

Mapped Issue Types

Mapped Issue Type

  1. synapseRT NextGen supports mapping only one issue type to Bug

  2. If you have multiple issue types mapped to Bug in synapseRT, please convert them to Bug issue type and install synapseRT NextGen to perform migration

Test Case

Test Case

  1. No change

Mapped Issue Type

  1. synapseRT NextGen doesn't support mapping other issue types to Test Case

  2. If you have other issue types mapped to Test Case in synapseRT, please convert those tickets to the Test Case issue type and install synapseRT NextGen to perform migration

Test Plan 

Test Plan

  1. No change

Mapped Issue Type

  1. synapseRT NextGen doesn't support mapping other issue types to Test Plan

  2. If you have other issue types mapped to Test Plan in synapseRT, please convert those tickets to the Test Plan issue type and install synapseRT NextGen to perform migration

SubRequirement

SubRequirement

  1. No change

SubTest

SubTest

  1. No change

Entities/fields change inside different issue types

Entity/Field

In synapseRT

In synapseRT NextGen

Description

Type

Name

Type

Name

Requirement

Custom field

Parent

Section

Requirements

  1. The "Parent" value has migrated to the Requirements section 

Custom field

Test Case

Section

Test Cases

  1. Test Case has been replaced by the Test Cases section

Custom field

Test Case Coverage TAB

  1. The "Test Case Coverage" tab has been removed

  2. The user can find the information in the Test Cases section

Custom field

Bugs TAB

  1. The "Bugs" tab has been removed

  2. As bugs are linked to a Test Case, users can find the information in the Test Cases section

Menu

More/Create Test Case

Section/Button

Create Test Case

  1. "More/Create Test Case" has been replaced by the "Create Test Case" button from the Test Cases section

Menu

More/Create Bug

  1. This feature has been removed

  2. Creating a bug directly from a requirement ticket is not allowed

SubRequirement

  1. There is no change for this issue type

Test Case

Custom field

Requirement

Section

Requirement

  1. The "Requirement" value has migrated to the Requirement section

  2. Any Test Case hierarchy will be dropped, keeping only the Requirements covered by the Test Case

Custom field

Test Suite (Project)

Section

Test Suite

  1. The Test Suite section is now located at the right side of the window

Custom field

Test Suite (Global)

Section

Test Suite

  1. The Test Suite section is now located at the right side of the window

Custom field

Test Case State

  1. This feature has been removed

  2. Updating a Test Case result without adding it to a Test Plan is not allowed

Custom field

Test Case Steps:
- #
- Name
- Description
- Expected results
- Actual results
- State

Section

Test Steps:
- #
- Step
- Expected Result

  1. The "Name" and "Description" values have been combined and migrated to the Step field

  2. Values in these fields will be dropped:

    • Actual results

    • State

Custom field

Test Case Results

  1. This feature has been removed

Section

Sub-Tasks (SubTest)

Section

Sub-Tasks (SubTest)

  1. This section has been kept in synapseRT NextGen

Custom field

Test Plans TAB

Section

Test Plan

  1. The "Test Plans" tab has been removed

  2. The "Test Plans" value has migrated to the Test Plan section

  3. The Test Plan section is now located at the right side of the window

Custom field

Issue Coverage TAB

Section

Test Plan

  1. The "Issue Coverage" tab has been removed

  2. Expand a Test Case from the Test Plan section to check the test execution history

Custom field

Requirement TAB

Section

Requirement

  1. The "Requirement" tab has been removed

  2. The user can find the information in the Requirement section

Menu

More/Create Bug

  1. This feature has been removed

  2. Creating a bug directly from a Test Case ticket is not allowed

  3. One is only allowed to create a bug from a Test Case run in synapseRT NextGen

SubTest

  1. As "SubTest" is a snapshot of a corresponding Test Case, and the information has been handled in the Test Case, any synapseRT extensions will be removed and no new extension will be added in synapseRT NextGen

  2. All information, such as Test Case steps, test execution results, etc., has migrated to test case run

Test Plan

Custom field

Test Case (SubTest Disabled)

Section

Test Case

Test Cycle

  1. SubTest members have not migrated, instead their Parents (Test Case) have migrated to the Test Case section

  2. The Test Case execution result has migrated to "Cycle 1"  by default, and the Test Cycle status is default to "ACTIVE"

Custom field

Test Case (SubTest Enabled)

Section

Test Case

Test Cycle

  1. Test Case members have migrated to the Test Case section

  2. The Test Case execution result has migrated to "Cycle 1"  by default, and the Test Cycle status is default to "ACTIVE"

Custom field

Test Plan State

  1. This feature has been removed

  2. JIRA built-in "Status" is used to indicate Test Plan states

Custom field

Test Cases TAB

Test Cycle

  1. The "Test Cases" tab has been removed

  2. Test execution history is present in "Cycle 1" after migration

Bug

Custom field

Test Case

Section

Test Case

  1. The "Test Case" value has migrated to the Test Case section

  2. The Test Case section is now located at the right side of the window

Custom field

Requirement

Section/Field

Test Case/Requirement

  1. The "Requirement" value has migrated to the Requirement column from the Test Case section

  2. Please note that any bug relationships associated with the Requirement will be dropped

Custom field

Test Cases TAB

  1. The "Test Cases" tab has been removed

  2. The user can find the information in the Test Case section

Custom field

Requirement TAB

  1. The "Requirement" tab has been removed

  2. The user can find the information in the Test Case section

Configuration

Menu

synapseRT Configuration/Custom Fields TAB

Menu

  1. This feature has been removed

  2. In synapseRT NextGen, there is no such concept; the user is not allowed to update the name of the custom field/section.

Menu

synapseRT Configuration/Issue Types TAB

Configuration/Issue Type Mapping

  1. synapseRT NextGen supports mapping multiple issue types to Requirement

  2. synapseRT NextGen supports mapping one issue type to Bug

  3. The user is not allowed to map other issue types to Test Case and Test Plan

Menu

synapseRT Configuration/Advanced Settings TAB

  1. In synapseRT NextGen, there is no "SubTest" concept

  2. synapseRT NextGen supports "cross-project" by default

  3. synapseRT NextGen follows the JIRA permission control mechanism 

Menu

synapseRT Test Suites Management

 

  1. In synapseRT NextGen, there is no "Global" test suite concept

  2. Any Global test suite will migrate to the Test Suites panel in each JIRA project

  3. Any "Project" test suite will migrate to that particular project

 

Menu

Job Management

  1. In synapseRT NextGen, there is no such concept

Menu

Dashboard Configuration

  1. In synapseRT NextGen, there is no such concept

synapseRT

Main Menu

synapseRT

  1. In synapseRT NextGen, the "synapseRT" menu has been removed; the user can work from the Test Suites, Test Plans, and Traceability panels