Move an existing ClearQuest Full-Text Search deployment to a new host without reindexing

Technote (FAQ)


Question

How do you move an existing IBM Rational ClearQuest (CQ) Full-Text Search deployment to a new host without reindexing or redeploying from scratch?

Answer

Assumptions:

  • To use this technote, you must have previously deployed CQ FTS using the ClearQuest Full-Text Search Administration Tool, not the older manual procedure using cqtssetup.pl.
  • host-A = original host, host-B = destination host
  • On host-A, your Full-Text Search (FTS) deployment is for the database set called "FTSMove" and your user database name is "SAMPL".
  • On host-A, your FTS home is C:\FTS.Search
  • On host-B, you already have Rational ClearQuest (CQ) full-text search installed and an up-to-date copy of the Full-Text Search Administrator tool. Tool improvements occasionally occur. See the change log on the download page for 7.1, or get updates when patching Rational ClearQuest 8.0.
  • In this technote example, you move your FTS deployment into a new drive for host-B (E:) and into a new FTS home (E:\FTS.Search_New).
  • For CQ 8.0 only: ClearQuest 8.0 mandates the creation of one WebSphere Application Server profile for each FTS indexed ClearQuest user database. On host-B, the creation of your FTS WebSphere profile is at a new location (E:\FTS.Profiles_New).


Note: FTS remains available throughout this activity, except for the index not being up-to-date with your CQ database. This availability is the same for the duration it takes you to completes steps 2 though 6, and remaining user sessions have attempted to recycle logins.

The steps in this technote illustrate how to move your existing FTS deployment from host-A to host-B. This technote also demonstrates how to redeploy FTS on a different drive on host-B and to a different FTS home directory. If you require the same structure on host-B that you have on host-A, substitute drive "C" for "E" and directory "CQ.Search" for "CQ.Search_New" on host-B. Those values mirror the original structure you have on host-A.

  1. Start on host-A.

  2. At the command prompt, issue this FTSA command:

     cqperl cqtsadmin.pl --username admin --password admin --dbset FTSMove --userdb SAMPL --ftshome C:\FTS.Search --stop_update_idx

    This command stops the update mode of the crawler. However, CQ Web FTS continues working. This is important so that in the next step, there is a successful copying of the FTS deployment.

  3. Copy the entire directory of your existing FTS deployment from host-A to host-B. On host-B, it does not have to be on the same drive as it was on host-A, or into the same FTS home directory.

    Copy from: C:\FTS.Search\FTSMove_SAMPL

    ... to: E:\FTS.Search_New\FTSMove_SAMPL

    Note: In this example, you deploy onto a different drive and FTS home (E:\FTS.Search_New) instead of the structure from host-A. If you choose to keep the same structure on host-B, then your destination on host-B would be: C:\FTS.Search

  4. Move to host-B.

  5. Edit this file:

    E:\FTS.Search_New\FTSMove_SAMPL\cqtsadmin-FTSMove-SAMPL.xml

    Change this <destination>:

    <newValue required="yes">C:/FTS.Search/</newValue>

    ... to:

    <newValue required="yes">E:/FTS.Search_New/</newValue>

    Change this <entityFile>:

    <newValue required="no">C:/FTS.Search/FTSMove_SAMPL/Entity-FTSMove-SAMPL.txt</newValue>

    ...
    to:

    <newValue required="no">E:/FTS.Search_New/FTSMove_SAMPL/Entity-FTSMove-SAMPL.txt</newValue>

    If using ClearQuest 8.0, change this <ftsWASProfileHome>:

    <newValue required="no"></newValue>

    ... to:

    <newValue required="no">E:/FTS.Profiles_New/</newValue>

    These changes establish the new FTSA values for the move on host-B.

  6. At the command prompt, issue a FTSA command to create the WebSphere Application Server profile for your deployment on host-B. The "--ftshome" argument points to the new location.

    For CQ 7.1.2.x, you do not need to execute this command if a FTS index is using the default WebSphere profile "cqsearchprofile". This profile already exists by default on the new host. To find out if your FTS deployment uses the default "cqsearchprofile", look at this file:

    E:\FTS.Search_New\FTSMove_SAMPL\AboutThisFTS.txt

    This file contains the WebSphere Application Server profile name. If the profile name is other than "cqsearchprofile", follow this step 4 on CQ 7.1.2.x, as well.

    For CQ 7.1.2.x:

    cqperl cqtsadmin.pl --username admin --password admin --dbset FTSMove --userdb SAMPL --ftshome (E:\FTS.Search_New). --create_fts_was_profile automatic

    For CQ 8.0.x:

    cqperl cqtsadmin.pl --username admin --password admin --dbset FTSMove --userdb SAMPL --ftshome (E:\FTS.Search_New). --create_fts_was_profile automatic --fts_was_profile_home (E:\FTS.Profiles_New).

    Note: Profiles other than "cqsearchprofile" require additional administrative responsibility when upgrading ClearQuest patches, refer to the ClearQuest Full Text Search Administration Guide for details.

  7. At the command prompt, issue FTSA command to update the CQ Search Property file to reflect the new location of your FTS deployment. This command also updates the encrypted password and key file. Again, the "--ftshome" argument points to the new location:

    cqperl cqtsadmin.pl --username admin --password admin --dbset FTSMove --userdb SAMPL --ftshome (E:\FTS.Search_New). --update_fts_prop_files

    Note: See the important notice regarding this step if your Entity file and CQ Search Properties XML file do not accurately reflect the attributes of each other.

  8. At the command prompt, issue the FTSA command that enables FTS on host-B and initiates index updating. CQ Web will not send the request to host-B until the completion of step seven. Again, the "--ftshome" argument points to the new location:

    cqperl cqtsadmin.pl --username admin --password admin --dbset FTSMove --userdb SAMPL --ftshome (E:\FTS.Search_New). --stop_fts_was_profile --set_solr_home --start_update_idx --set_was_max_mem --start_fts_was_profile

  9. At the command prompt, issue the FTSA command to direct FTS searches from CQ Web to host-B instead of host-A. Again, the "--ftshome" argument points to the new location:

    cqperl cqtsadmin.pl --username admin --password admin --dbset FTSMove --userdb SAMPL --ftshome (E:\FTS.Search_New). --enable_cqweb_fts

    Note: Once this command completes, any CQ Web user still logged into CQ Web must logoff for their session to pickup FTS on host-B. The next step disables FTS on host-A, resulting in users still logged in seeing errors when attempting FTS searches. You have the option to delay step eight until all users have had the opportunity to timeout or login again.

  10. Move to host-A.

  11. At the command prompt, issue the FTSA command to stop the FTS server profile on host-A. This results in host-A being unable to accept FTS requests.

    cqperl cqtsadmin.pl --username admin --password admin --dbset FTSMove --userdb SAMPL --ftshome C:\FTS.Search_New --stop_fts_was_profile

  12. Users were actively using CQ Web must log off and login again. Try CQ FTS to verify that it works.

Important notice:

You might have manually modified the CQ Search Properties XML file in a way that causes it to be out of sync with the Entity file. For example, this can happen when adding or removing record types or fields.

Issuing the FTSA command "--update_fts_prop_files" resets the CQ Search Properties XML file to the definition in the entity file. To address this issue, you can manually correct the two files, such that the Entity file reflects what is in the CQ Search Properties XML file.

Alternatively, you can use this workaround:

Note: If using this workaround, you must perform it immediately proceeding the completion of step five this technote.

  1. Open your CQ Search Property file on host-A. Copy all the text between "<CQEntityList>" to "</CQEntityList>" into the clipboard.

  2. Open your CQ Search Property file on host-B. Replace all the text between "<CQEntityList>" to "</CQEntityList>" with what is in your CQ Property file from host-A.

  3. On host-B, issue the FTSA command to use the updated CQ Search Property file.

    cqperl cqtsadmin.pl --username admin --password admin --dbset FTSMove --userdb SAMPL --ftshome (E:\FTS.Search_New). --enable_cqweb_fts

CQ Web users must logoff for their session to pickup this change.

Rate this page:

(0 users)Average rating

Document information


More support for:

Rational ClearQuest
Full-Text Search

Software version:

7.1, 7.1.1, 7.1.2, 8.0

Operating system(s):

Windows

Reference #:

1587519

Modified date:

2012-11-15

Translate my page

Machine Translation

Content navigation