Upgrading or reinstalling HCL Compass in a full-text search deployment with multiple WebSphere profiles

IBM® Installation Manager does not recognize the WebSphere® Application Server profiles associated with the full-text search feature. Consequently, if you plan to upgrade or reinstall HCL Compass, use the cqtsadmin.pl command to back up and delete these profiles. After upgrading or reinstalling HCL Compass, use the cqtsadmin.pl command again to restore the profiles.

Before you begin

This scenario includes steps to perform before and after you upgrade or reinstall HCL Compass.

The scenario assumes that you are using the SAMPL database. In a production environment, the pre-upgrade or pre-installation steps, and the post-upgrade or post-reinstallation steps can take from a few minutes to a few hours to complete, depending on the number of full-text search WebSphere Application Server profiles in your deployment. For each profile, the steps should take a few minutes to complete.

Note that you can run the cqtsadmin.pl command against any full-text search instance on the server because the command is global to all full-text search deployments on the server. After the cqtsadmin.pl command completes against one full-text search deployment, the other deployments on the server are upgraded.

Procedure

  1. Perform the following pre-upgrade or pre-install tasks.
    1. Edit the cqtsadmin-TextSearch-SAMPL.xml configuration file. Change the value of the <deleteFtsWASProfiles> tag from this:

      <newValue required="no"><newValue>

      to this:

      <newValue required="no">true<newValue>

    2. Run the cqtsadmin.pl command, with the prep_upgd_was_profiles option, in a command-prompt window. This command-line option creates a backup of all your full-text search WebSphere Application Server profile data on the server and then deletes the profiles. The backed up data is saved to the FTSBackupWASProfiles directory.
    3. Edit the cqtsadmin-TextSearch-SAMPL.xml file again. Change the value of the <deleteFtsWASProfiles> tag from this:

      <newValue required="no">true<newValue>

      to this:

      <newValue required="no"><newValue>

    The edit prevents you from accidentally rerunning this destructive command-line option.

  2. Upgrade or reinstall HCL Compass.
  3. Run the cqtsadmin.pl command again to restore all previously deployed and backed up full-text search WebSphere Application Server profiles. There are two use-case scenarios:
    • Scenario A: Restore all previously deployed and backed up full-text search WebSphere Application Server profiles to their original locations by using the restore_was_profiles command-line option:

      cqperl cqtsadmin.pl --username admin --password secret --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --restore_was_profiles D:\FTSBackupWASProfiles

    • Scenario B: Restore all previously deployed and backed up full-text search WebSphere Application Server profiles, and consolidate these profiles in one directory, by using the restore_was_profiles and fts_was_profile_home command-line options, respectively:

      cqperl cqtsadmin.pl --username admin --password secret --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --restore_was_profiles D:\FTSBackupWASProfiles --fts_was_profile_home D:\FTS.wasprofiles