Configure Rational ClearQuest full-text search using cqtsadmin.pl Perl script

cqtsadmin.pl is a Perl script tool that automates the steps to set up, configure, and administer IBM® Rational® ClearQuest® full-text search.

cqtsadmin.pl is one of two components of the full-text search administrator tool. The other component is cqtsadmin-dbset-userdb.xml, an XML file that is generated by the cqtsadmin.pl script. The cqtsadmin-dbset-userdb.xml file provides and holds data about full-text search deployment. You edit cqtsadmin-dbset-userdb.xml to complete your deployment.

The cqtsadmin.pl command-line options are described in the IBM Rational ClearQuest Full-Text Search Administrator’s Guide. See Full-text search configuration for the location of this document.

ClearQuest v8.0.0.5 adds support for the upgrade_solr_app command-line option, which is described in the following section.

Synopsis

: cqperl cqtsadmin.pl --username superusername --password password --dbset dbset --userdb connectionname --ftshome cqftshome [--upgrade_solr_app]

Description

When you upgrade ClearQuest and your full-text search deployments using the prep_upgd_was_profiles command and the restore_was_profiles command, the Apache Solr application is not automatically upgraded. Use the upgrade_solr_app command-line option to upgrade Apache Solr to the version that is associated with the ClearQuest version that you upgraded to. While the Apache Solr application is being upgraded, full-text search will be unavailable for 1-5 minutes.

If you have more than one full-text search deployment to upgrade, you must run the upgrade_solr_app command-line option on each deployment, one at a time.

Tip: Before you upgrade the Apache Solr application, consider backing up your full-text search deployment by using the backup_fts command-line option. Also, see the IBM Rational ClearQuest release notes to learn if the version of ClearQuest that you are upgrading to includes a new version of Apache Solr.

If after running the upgrade_solr_app command-line option you are instructed to reindex your ClearQuest records, use the fresh_batch_idx command-line option.

Example

You need to upgrade the Apache Solr application for one of your full-text search deployments after you have upgraded ClearQuest.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --upgrade_solr_app --stop_fts_was_profile --start_fts_was_profile

If after running the upgrade_solr_app command-line option you are instructed to reindex your ClearQuest database, you must run these commands. While these commands are running, ClearQuest full-text search will continue to be available.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --stop_update_idx

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --fresh_batch_idx 

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --start_update_idx

Note: The fresh_batch_idx command-line option can take anywhere from a few hours to a few days depending on how many records are in your ClearQuest database. While this command is running, ClearQuest full-text search is fully functional, but the search quality maybe affected.