Migrating an existing GTREP Repository Database and TDM Portal Installation to a new set of servers
search cancel

Migrating an existing GTREP Repository Database and TDM Portal Installation to a new set of servers

book

Article ID: 223564

calendar_today

Updated On:

Products

CA Test Data Manager (Data Finder / Grid Tools)

Issue/Introduction

We have an older release of TDM and gtrep repository database that are hosted on older systems. We need to migrate them to a new set of servers. One server will be hosting all the TDM applications, and the other will be hosting the gtrep repository database. We would like to know what steps are required to migrate TDM and the existing gtrep database to a new set of servers.

 

Environment

Release : 4.9 and later

Component : TDM Web Portal

Resolution

 

Pre-migration/upgrade steps that must be performed on the old servers:

  1. Have your DBA take a new backup of the existing GTREP database to a file. This should be a full back of the database. 
    Note: If your use case doesn't require you to move the GTREP repository database to a new database server, you can jump to step 4.

  2. Have your DBA create a schema and user account on the new database server, that can be used for your new GTREP Database instance.
    For simplicity’s sake and documentation purposes, we will call this GTREP_NEW, but it can be the same schema name used on the old database server.

  3. Have the DBA restore the GTREP backup file to the new schema, GTREP_NEW
    Note: If the GTREP database is not changing, the first three steps can be skipped. However, best practice recommends having the DBA take a backup of the GTREP database, since it's very important to keep the GTREP data and OrientDB data in sync.

  4. For TDM Portal, please stop the CA Test Data Manager Portal service, and the OrientDB service and back up the following folders:
    • C:\Program Files\CA\CA Test Data Manager Portal. This will back up the entire TDM Portal installation. However, if you do not have enough available disk space to back up the entire TDM Portal directory, then we recommend backing up the TDM Portal configurations files, which are located in C:\Program Files\CA\CA Test Data Manager Portal\conf
    • %ProgramData%\CA\CA Test Data Manager Portal\. This will back up things such as the OrienDB database files, custom classifiers, Portal job logs, etc. If you need to conserve file space, you can only back up the subdirectories that apply for your TDM environment:
      1. audit_logs - (optional) - This is where the audit logs are kept.
      2. classifiers - (optional) - You will want to back up this directory if you have custom classifiers placed here.
      3. Jobs - (optional): this will back up job logs and CSV files of masking jobs that were run from Portal.
      4. object- (Required) - This will back up objects registered for projects.
      5. orientdb- (Required) - This will back up the OrientDB database files.
        NOTE: You must stop the OrientDB service before backing up these files. It's very important to keep the GTREP data and OrientDB data in sync. Therefore, you need to take this backup at the same time the DBA is backing up the GTREP repository database.
  5. For Fast Data Masker (FDM), please back up the following files:
    • %AppData%\Grid-Tools\FastDataMasker - This will back up your FDM connection profiles as well as masking configurations and options files.

      Note: If there are more than one user launching FDM from the server, you will need to back up each of the C:\Users\<Username>\AppData\Roaming\Grid-Tools\FastDataMasker directories, as each user It will have their own set of connection profiles, masking settings, and options files.

  6. For Javelin, please back up the following files:
    • %AppData%\Grid-Tools\Javelin (optional) logs: Contains the logs of the executed Javelin flows. RecentFile.txt – is a list of recently executed flows.

      Note: If there are more than one user launching Javelin from the server, you will need to back up each of the C:\Users\<Username>\AppData\Roaming\Grid-Tools\Javelin directories, as each user will have their own set of records and RecentFile.txt files.

    • Also, you will want to locate where users are keeping their *.vwf (Javelin Flow) files and copy them to the new server.

  7. It's recommended to go to the TDM Patches page, and download the latest TDM patches for the release of TDM you will be installing, before you install the GA (General Availability) release of TDM. This way, you can patch your new installation, with the latest enhancements and fixes. 

Installation steps on the new server:

  1. Install TDM Portal on your new server using the TDMWeb (Portal) patch you downloaded. If you did not download the latest TDM Portal patch, you can use the TDM Portal installation that is shipped in the TDM GA (Full Package) release.
     
    1. Extract the TDMWeb-4.10.xxx.0.zip file to a temporary directory of your choice.
    2. Run setup_CA Test Data Manager Portal4.10.xxx.0.exe with administrator privileges.
    3. Enter the connection parameters for the GTREP database. The installation will ask for the repository connection information. If you are also setting up a new GTREP repository, provide the necessary information to connect to the GREP_NEW schema.
    4. Follow the installation wizard.
    5. Uncheck the Start TDM Portal check box, as we do not want the CA Test Data Manager Portal service to start yet.
    6. Stop the OrientDB service.
    7. Restore the files you backed up from %ProgramData% to their proper location. 
    8. Verify that the CA Test Data Manager Portal Service is configured to start with the correct service account. By default, this is the local system account. 
    9. Restart the OrientDB service.
    10. Restart the CA Test Data Manager Portal service.
    11. Verify that the TDM Portal has connected to the gtrep database and can access the TDM Portal. 

      Note: This is a good time to check out all your projects and self-service tiles are available.

  2. Install the GA version of GT Server. This will install the previously required software, along with all remaining TDM components, including the GTEDI utility.

    Note: You only need to run setup_GTServer_4.10.0.xxx.exe. Do not run any of the other executables.

    1.  Extract the file CA-TestDataManager-FullPackage-4.10.zip to a temporary directory of your choice.
    2. Run setup_GTServer_4.10.0.1011.exe with administrator privileges. 
    3. Accept all default software installation prerequisites.
    4. Uncheck any of the TDM components that you know you don't need. For example, uncheck HP ALM if you know that you do not need to integrate TDM with HP ALM. (optional)
    5. Verify that the installation directory is correct. By default, the GTServer and TDM components will be installed in C:
    6. Follow the installation wizard.

  3. Update GT Datamaker by installing the latest patch.

    1. Extract the GTDataMaker-4.10.xxxx.0.zip file to a temporary directory of your choice.
    2. Run setup_GTDatamaker.exe with administrator privileges.
    3. Follow the installation wizard.

  4. Update GT Subset by installing the latest patch
    1. Extract the Subset-4.10.xxx.0.zip file to the GT DataMaker installation directory.  By default, this is C:\Program Files (x86)\Grid-Tools\GTDatamaker.
  5. Update FDM by installing the latest patch.
    1. Extract the FastDataMasker-4.10.xxxx.0.zip file to a temporary directory of your choice.
    2. Run setup_FastDataMasker.exe with administrator privileges.
    3. Follow the Installation wizard.
    4. Restore any of the FDM files you backed up from the old server.

  6. Update Javelin by installing the latest patch.
    1. Extract the Javelin-4.10.xxx.0.zip file to a temporary directory of your choice.
    2. Run setup_Javelin_4.10.xxx.0.exe with administrator privileges.
    3. Follow the installation wizard.
    4. Restore any of the Javelin files you backed up from the previous server.

 

Additional Information

NOTE: Be mindful of the limitations Windows Server OS has on hostname restrictions.

https://docs.microsoft.com/en-us/troubleshoot/windows-server/identity/naming-conventions-for-computer-domain-site-ou

NOTE: If making changes to the hostname of the machine where TDM Portal is installed, you will need to modify the %ProgramFiles%\CA\CA Test Data Manager Portal\conf\application.properties file, and restart the CA Test Data Manager Portal service. Also, check the system environment variables for the TDM_PORTAL_URL variable, this will also need to use the new hostname. If you are using TDoD, you will also need to modify the C:Grid-Tools\TDoD\TDOD_WebUI\Web.config file.