Removing record types from the search index

You can remove record types from the full-text search index so that these record types are no longer searchable.

Before you begin

This scenario should take approximately 10 minutes to complete regardless of the size of your HCL Compass database.

About this task

This scenario assumes that you have deployed full-text search on the SAMPL database as described in Enabling full-text search on the SAMPL database, and have added a new record type named ChangeRequest as described in Adding record types to the search index. You want to remove the ChangeRequest record type from the search index.

Procedure

  1. Edit the cqtsadmin-TextSearch-SAMPL.xml configuration file. Change the value of the <removeRecordType> XML tag from this:
    <newValue required="no"></newValue>

    to this:

    <newValue required="no">ChangeRequest</newValue>
  2. Optional: To remove multiple record types, separate each with a semicolon (;). The next example also removes the TestCase record type from the search index:
    <newValue required="no">ChangeRequest;TestCase</newValue>
  3. Run the cqtsadmin.pl command, with the remove_record_type option, in a command prompt window.
    Important: In a production environment, be sure to back up your deployment before running the cqtsadmin.pl command with the remove_record_type option.

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

    Running the cqtsadmin.pl command with the remove_record_type option is a stateful operation. If you stop the command or it stops because of an error, when you rerun the command, it resumes from where it left off and runs to completion.

  4. Edit the cqtsadmin-TextSearch-SAMPL.xml file again to remove the ChangeRequest record type that you added to the <removeRecordType> tag in Step 1.

Results

You have removed the ChangeRequest record type from the search index. HCL Compass Web client users must log off and log on again to notice this change in the search results.