Things To Consider When Upgrading TDM

Products

• CA Test Data Manager (Data Finder / Grid Tools)

Issue/Introduction

What are the high level steps for upgrading TDM?

Environment

Release : 4.7, 4.8, 4.8.1, 4.9

Component : Test Data Manager - All Components

Resolution

THINGS TO CONSIDER WHEN UPGRADING TDM

Please notice that the order of upgrading the components has changed starting with TDM release 4.8. In the older release of TDM it was important to first upgrade the Datamaker component, since Datamaker controlled the TDM repository database (gtrep) migration. This changed in TDM release 4.8, and now the TDM Portal controls the TDM repository database (gtrep) migration. Therefore, when upgrading TDM release 4.8 and newer, you MUST first upgrade the TDM Portal component before upgrading the other TDM components.

• Verify the system requirements meet the requirements for the new release.
  
  
• Check the TDM Patches Page, located at https://support.broadcom.com/external/content/release-announcements/Test-Data-Manager-TDM-Patches/16649#GTDataMakerPB4.8, and download the latest component patches for the release you are upgrading to.
  
  
• Remember that you may not be able to jump straight to the latest GA release. You can only jump two releases ahead:
  For example, If you are upgrading from 4.2 to 4.9 the upgrade path would look like: 4.2 -> 4.4 -> 4.6 -> 4.8 - 4.9

Note: It's recommended to back up each iteration of the gtrep database, and run maintenance after each upgrade of the gtrep database.

 

 

PRE UPGRADE TASKS:

• Verify prerequisites have been met
  
  
• Keep all the passwords for the gtrep repository database user and any other environment specify passwords handy. It also a good idea to have the OrientDB database root password handy, in case you need direct access to the OrientDB.
  
  
• Prior to the upgrade, make a backup of the TDM repository database (gtrep).
  
  
• Take a snapshot of the TDM Server and Database Server (optional)
  
  
• Download the TDM Software from Broadcom Support Portal - Enterprise Software - Products Download page (https://support.broadcom.com/enterprise-software/download-center), and transfer the download to the TDM servers.
  
  
• Inform TDM users the application will not be available during the upgrade.

 

 

UPGRADE STEPS FOR TDM 4.7 AND OLDER:

Upgrade GT Server Components:

1. Stop the Remote Publish Engine and TDoD Services.
   
   
2. Rename the rep.xml to OLD_rep.xml. The default location is C:\Program Files(x86)\Grid-Tools\GTDatamaker.
   
   
3. Take a backup of the following folders:
   • C:\Grid-Tools
   • C:\Program Files\Grid-Tools
   • C:\Program Files(x86)\Grid-Tools
     
     
4. Run the GTServer.exe from the downloaded installation media.
   
   
5. Run the upgrade script to upgrade the repository (gtrep).
   
   
6. Finish upgrading the remaining components.

 

 

Upgrading TDM Portal:

1. Stop the CA Test Data Manager Portal service.
   
   
2. Stop the OrientDB service
   
   
3. Navigate to %ProgramData%\CA\CA Test Data Manager Portal\logs and delete the contents of the logs directory.
   
   
4. Take a back up the following directories:
   • %ProgramData%\CA\CA Test Data Manager Portal\
   • C:\Program Files\CA\CA Test Data Manager Portal\
     
     
5. Run the TDMPortal.exe from the downloaded installation media.
   
   
6. Complete Upgrade

 

 

UPGRADE STEPS FOR TDM 4.8 AND NEWER:

Upgrading TDM Portal:

1. Stop the CA Test Data Manager Portal Service
   
   
2. Stop the OrientDB service
   
   
3. Navigate to %ProgramData%\CA\CA Test Data Manager Portal\logs and delete the contents of the logs directory.
   
   
4. Take a back up the following directories:
   • %ProgramData%\CA\CA Test Data Manager Portal\
   • C:\Program Files\CA\CA Test Data Manager Portal\
     
     
5. Run the TDMPortal.exe from the downloaded installation media.
   
   
6. Check the C:\ProgramData\CA\CA Test Data Manager Portal\logs\TDMSchemaManagementStartup.log to ensure the gtrep upgrade ran without issues.
   
   
7. Complete the Portal upgrade
   
   

Upgrading GT Server Components:

1. Stop the Remote Publish and TDoD services if running.
   
   
2. Rename the rep.xml to OLD_rep.xml. The default location is C:\Program Files (x86)\Grid-Tools\GTDatamaker.
   
   
3. Take a backup of the following folders:
   • C:\Grid-Tools
   • C:\Program Files\Grid-Tools
   • C:\Program Files(x86)\Grid-Tools
     
     
4. Run the GTServer.exe from the downloaded installation media.
   
   
5. Complete the upgrade of the remaining components.
   
   
6. Log into GTDatamaker and create a new rep.xml

 

RESTORING THE ORIENTDB DATABASE (optional):

If by chance something goes wrong with the OrientDB database, and you need to restore the data from your backed up file, you will need to take the following actions:

1. Stop the CA Test Data Manager Portal service
   
   
2. Stop the OrientDB service
   
   
3. Restore the following files from the backup you made of the %ProgramData%\CA\CA test Data Manager Portal\ directory
   • %ProgramData%\CA\CA test Data Manager Portal\objects
   • %ProgramData%\CA\CA test Data Manager Portal\orientdb\databases
     
     
4. Navigate to %ProgramData%\CA\CA Test Data Manager Portal\logs and delete the contents of the logs directory.
   
   
5. Start the OrientDB service
   
   
6. Start the CA Test Data Manager Portal service

 

Additional Information

The TDM Upgrade documentation can be found at the following locations:

• Upgrading TDM Portal in Docker - https://techdocs.broadcom.com/us/en/ca-enterprise-software/devops/test-data-management/4-9/installing/upgrade-test-data-manager-portal/upgrade-tdm-portal-in-docker.html
• Upgrading TDM Portal in Windows - https://techdocs.broadcom.com/us/en/ca-enterprise-software/devops/test-data-management/4-9/installing/upgrade-test-data-manager-portal/upgrade-tdm-portal-in-windows.html
• Upgrading TDM Product Components -  https://techdocs.broadcom.com/us/en/ca-enterprise-software/devops/test-data-management/4-9/installing/upgrade-product-components.html