Repository tools command to rebuild text indexes

Use the rebuildTextIndices command to rebuild the database text indexes.

Purpose

The Jazz™ Team Server manages a directory outside the database that stores all data that is necessary to process full text queries. The location of the directory is configured in the teamserver.properties file. Thus, when the rebuildTextIndices command is run, the full text directory is created in the location as stated in the properties file.

With this command, it is possible to create this directory and index all artifacts from the database again to make them searchable with full text queries. The following list is some scenarios where creating the database and indexing artifacts again might be necessary:

  • The server moved to a new location and the full text directory was not copied, thus the full text directory must be re-created.
  • A new Jazz server is set up with an existing database, and there is a new teamserver.properties file and thus, a new location for the full text directory.
  • You run a quick search for a work item or an artifact and no search result is returned.
  • You run a full text search for a work item or an artifact and an error occurs.
By default, any lines longer than 2000 characters in a work item or attachment are skipped during indexing. To process all the lines, or to change the default limitation of 2000 characters, complete the following steps:
  1. Go to the JazzInstallDir/server directory and open repotool-app for editing, where app is ccm or qm.
  2. Search for set DEFINE=%DEFINE_INIT% and after the line add the following lines:
    set DEFINE=%DEFINE% "-Dcom.ibm.team.repository.restrictStackTraceLineLength=false"
    set DEFINE=%DEFINE% "-Dcom.ibm.team.repository.stackTraceLineLength=2000"
  3. When this system property is set to true, any lines longer than 2000 characters will be skipped during indexing. To adjust the default character limit, change the value of -Dcom.ibm.team.repository.stackTraceLineLength to an integer. If the value is set to 0, indexing will be skipped.
Note: It is not necessary to run this command when upgrading from one version to another because the full text index is created again.

In addition, this command is not applicable to Requirements Management because Requirements Management keeps the text indexes in the Jazz Foundation Services (JFS) indexes. Instead, run the repotools-rm -reindex all command. For -reindex command details, see Repository tools command to regenerate indexes topic.

Important: You must shut down the server before you run the command.

Parameters

Attribute Description Required Default
teamserver.properties The file system path to the teamserver.properties file. No conf/application/teamserver.properties

where application is jts, ccm, am, rm, qm, gc, dcc, or relm.

logFile Path to the log file. No repotools-application_rebuildTextIndices.log

where application is jts, ccm, am, rm, qm, gc, dcc, or relm.

Example

The following example is for Jazz Team Server. To use this command for the Change and Configuration Management application run repotools-ccm, for the Requirements Management application run repotools-rm, for the Quality Management application run repotools-qm, for the Global Configuration Management application run repotools-gc, for the Data Collection Component application run repotools-dcc, and for the Rational Engineering Lifecycle Manager run repotools-relm from the server directory.

For Windows operating system Open a command prompt and enter this command:

cd C:\Program Files\IBM\JazzTeamServer\server\
repotools-jts.bat -rebuildTextIndices teamserver.properties=conf\jts\teamserver.properties

For Unix operating systems Open a command line and enter this command:

cd opt/IBM/JazzTeamServer/server/
./repotools-jts.sh -rebuildTextIndices teamserver.properties=conf/jts/teamserver.properties

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki