Skip to main content
Skip table of contents

Upgrade Guide

Important

If you are using the older version of synapseRT (prior v8.0), 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 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

[Screenshot - IN0004_Upgrade_to_Newer_Version]


Upgrade synapseRT (version 7.x) to synapseRT latest version (v7.3.7.9 → v8.4.4.1 → Migration (Data) → latest version)

Upgrade synapseRT (version 6.x) to synapseRT version 8.4.1.0 (v6.x → v6.3.7.9 → Migration (Data) → 8.4.1.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@goldfingerholdings.com if you encounter any issues and need our assistance

Important

  • If you want to upgrade synapseRT (version 7.x) to synapseRT latest version, you need take the path: v7.3.7.9 -> v8.4.4.1 -> Migration (Data) -> v8.6.x and higher

Important

  • If you want to upgrade synapseRT (version 6.x) to synapseRT 8.4.1.0, you need take the path: v6.x -> v6.3.7.9 -> Migration (Data) -> v8.4.1.0
  1. Before installing synapseRT 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 and update the synapseRT configuration from "Administration->Add-ons->SYNAPSERT->synapseRT 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. Note down mapping values for Requirements issue type
    4. Note down mapping values for Bugs issue type

    3). 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 supported Jira versions
  3. Install synapseRT v8.4.4.1 to your Jira server; please refer to "Installation guide"
  4. Update synapseRT configuration settings from "Administration->Add-ons->SYNAPSERT->Configuration" with the following:
    a. Set the same value as is in synapseRT for "Requirements" mapping
    b. Set the same value as is in synapseRT for "Bugs" mapping
  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, 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 (v6.x & 7.x)In synapseRT (v8.x)Comments
RequirementRequirement
  1. No change
Mapped Issue TypesMapped Issue Types
  1. No change
  2. In synapseRT (v8.x), go to "Administration->Add-ons->SYNAPSERT->Configuration" to map the same issue types to Requirement
BugBug
  1. No change
Mapped Issue TypesMapped Issue Types
  1. No change
  2. In synapseRT (v8.x), go to "Administration->Add-ons->SYNAPSERT->Configuration" to map the same issue types to Defect
Test CaseTest Case
  1. No change
Mapped Issue Type
  1. synapseRT (v8.x) 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 to perform migration
Test Plan Test Plan
  1. No change
Mapped Issue Type
  1. synapseRT (v8.x) doesn't support mapping other issue types to Test Plan
  2. If you have other issue types mapped to Test Plan in synapseRT (v6.x & v7.x), please convert those tickets to the Test Plan issue type and install synapseRT (v8.x) to perform migration
SubRequirementSubRequirement
  1. No change
SubTestSubTest
  1. No change

Entities/fields change inside different issue types

Entity/FieldIn synapseRT (v6.x & v7.x)In synapseRT (v8.x)Description
TypeNameTypeName
RequirementCustom fieldParentSectionRequirements
  1. The "Parent" value has migrated to the Requirements section 
Custom fieldTest CaseSectionTest Cases
  1. Test Case has been replaced by the Test Cases section
Custom fieldTest 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 fieldBugs 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
MenuMore/Create Test CaseSection/ButtonCreate Test Case
  1. "More/Create Test Case" has been replaced by the "Create Test Case" button from the Test Cases section
MenuMore/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 CaseCustom fieldRequirementSectionRequirement
  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 fieldTest Suite (Project)SectionTest Suite
  1. The Test Suite section is now located at the right side of the window
Custom fieldTest Suite (Global)SectionTest Suite
  1. The Test Suite section is now located at the right side of the window
Custom fieldTest Case State

  1. This feature has been removed
  2. And results recorded in Test Case (without Test Plan created) will be moved to Ad Hoc Test Run
Custom fieldTest Case Steps:
- #
- Name
- Description
- Expected results
- Actual results
- State		SectionTest 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 moved to Ad Hoc Test Run
    • Actual results
    • State
Custom fieldTest Case Results

  1. This feature has been removed
SectionSub-Tasks (SubTest)SectionSub-Tasks (SubTest)
  1. This section has been kept in synapseRT
Custom fieldTest Plans TABSectionTest 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 fieldIssue Coverage TABSectionTest 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 fieldRequirement TABSectionRequirement
  1. The "Requirement" tab has been removed
  2. The user can find the information in the Requirement section
MenuMore/Create Bug

  1. This feature has been removed
  2. Creating a bug directly from a Test Case ticket is not allowed
  3. It is only allowed to create a bug from a Test Case Run in synapseRT (v8.x)
SubTest



  1. As "SubTest" is a snapshot of a corresponding Test Case, and the information has been handled in the Test Case, any synapseRT (v6.x & v7.x) extensions will be removed and no new extension will be added in synapseRT (v8.x)
  2. All information, such as Test Case steps, test execution results, etc., has migrated to test case run
Test PlanCustom fieldTest Case (SubTest Disabled)SectionTest 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 fieldTest Case (SubTest Enabled)SectionTest 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 fieldTest Plan State

  1. This feature has been removed
  2. Jira built-in "Status" is used to indicate Test Plan states
Custom fieldTest Cases TAB
Test Cycle
  1. The "Test Cases" tab has been removed
  2. Test execution history is present in "Cycle 1" after migration
BugCustom fieldTest CaseSectionTest 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 fieldRequirementSection/FieldTest 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 fieldTest Cases TAB

  1. The "Test Cases" tab has been removed
  2. The user can find the information in the Test Case section
Custom fieldRequirement TAB

  1. The "Requirement" tab has been removed
  2. The user can find the information in the Test Case section
ConfigurationMenusynapseRT Configuration/Custom Fields TABMenu
  1. This feature has been removed
  2. In synapseRT (v8.x), there is no such concept; the user is not allowed to update the name of the custom field/section.
MenusynapseRT Configuration/Issue Types TAB
Configuration/Issue Type Mapping
  1. synapseRT (v8.x) supports mapping multiple issue types to Requirement
  2. synapseRT (v8.x) supports mapping one issue type to Bug
  3. The user is not allowed to map other issue types to Test Case and Test Plan
MenusynapseRT Configuration/Advanced Settings TAB

  1. In synapseRT (v8.x), there is no "SubTest" concept
  2. synapseRT (v8.x) supports "cross-project" by default
  3. synapseRT (v8.x) follows the Jira permission control mechanism 
MenusynapseRT Test Suites Management


  1. In synapseRT (v8.x), 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


MenuJob Management

  1. In synapseRT (v8.x), there is no such concept
MenuDashboard Configuration

  1. In synapseRT (v8.x), there is no such concept
synapseRTMain MenusynapseRT

  1. In synapseRT (v8.x), the "synapseRT" menu has been removed; the user can work from the Test Suites, Test Plans, and Traceability panels
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close