Creating and configuring the entity file

Create and configure the entity file.

Before you begin

The entity file contains all submittable record types in the ClearQuest database. These record types and associated fields are candidates for full-text search. After creating the entity file, you can configure the file to select only those record types and associated fields that you want to index.
Tip: You can omit this task if you want to index all record types and associated fields in the user database.
Attention: At a minimum, the following three fields must be indexed for the full-text search feature to function:
  • record_type
  • dbid
  • version
Indexing additional fields increases the benefits of the full-text search feature without significantly increasing the size of the index.

About this task

The following variables are used in path names in this topic:
db_name
Name of the user database
dbset_name
Name of the database set

Procedure

  1. Run the cqtssetup.pl command with the -o Entity option, as described in the cqtssetup.pl reference help.

    The output is an entity file that contains all submittable record types in the user database. The entity file has the following name:

    Entity-db_name-dbset_name.txt

  2. Edit the entity file to select only those submittable record types and associated fields that you want to index. Instructions for editing the entity file are included in the cqtssetup.pl reference help.
    You have now created the master entity file. Reuse this file when you create the ClearQuest search properties file and the Solr search file by specifying the -f option to the cqtssetup.pl command .
    Attention: Failure to reuse the master entity file when you create the ClearQuest search properties file and the Solr search file will result in indexing all fields of all submittable record types.
  3. Copy the entity file to the Solr home directory (for example, on Windows, CQ.Solr\db_name\Solr\solr; on the UNIX system and Linux, CQ.Solr/db_name/Solr/solr), which you defined previously when you established the location of the Lucene index.

Feedback