Understanding indices in Jazz

Authors: GeraldMitchell main.
Build basis: Collaboration Lifecycle Management (CLM) 4.0 Jazz Team Server(JTS) 4.0 Rational Team Concert(RTC) 4.0

This is guidance to understand the indices used in CLM (Jazz).

Understanding Indices and Stores

There are several stores and indices associated with your Jazz platform applications.

Indices and their function

Indices will be a direct correlation with the performance of the application. Essentially, the index is a look-up table for the information that can be more easily queried and result in faster responses.

Query Triple store and index

The query triple store index can be rebuilt using repotools command parameter -reindex scope=query.

Full Text index

full text index

The fulltext index can be found where ever your setting in the teamserver.properties of your application says it is located in the property com.ibm.team.fulltext.indexLocation

com.ibm.team.fulltext.indexLocation=/opt/IBM/JazzTeamServer/workitemindex

Note: For high availability applications, have the Jazz Team Servers reference the same location for the full text index. To keep the index up to date and available for all servers, each server teamserver.properties should update the com.ibm.team.fulltext.indexLocation in teamserver.properties to store the index for the full text on a single shared drive location.

More information on the full text search can be found in Technote 1586008

Lucene Text store and index

• What is Lucene?
  • Lucene is an open-source full-text indexing and search engine library.
  • It also has other capabilities such as spellchecking and highlighting.
  • For more information see Apache Lucene and the Getting the most out of full text search article
  • see Technote 1586008 as well

• Team Server Properties for Lucene
  • teamserver.properties to be aware of include com.ibm.team.jfs.lucene.directory and com.ibm.team.jfs.lucene.history.directory.

• rebuilding the Lucene index
  • the repotools -rebuildTextIndices commmand is used. see the rebuildTextIndices

Performance considerations

• • Because the Lucene is used for a lot of lookups, to increase performance:
    • The Lucene Index Directory com.ibm.team.jfs.lucene.directory path should be on fast storage
    • The Lucene History Index Directory com.ibm.team.jfs.lucene.history.directory path should be on fast storage
    • The full text location should be on fast storage

Database index

the database indices are .... ### fill in here

repotools functions

repotools reindex

• Repotools-(applications) -reindex: Repository tools command to regenerate indexes.
  • The application must not be running before the command is run.
  • Use the reindex command to regenerate stores.
  • By default, the query triple store and the Lucene text store are regenerated
  • The "scope" parameter can be used to rebuild the query, the text indexes, or both.
    • all: to rebuild all indexes (default) - "all" in this case encompasses query triple store and the Lucene test store indexes
    • query: to rebuild query triple store indexes
    • search: to rebuild Lucene text store indexes
    • An example

      repotools-jts.sh -reindex scope=query

    • This parameter is useful to limit the scope of the reindex to the needed store indexes, making the reindex time shorter
  • The "all" parameter to reindex both live and history indices
    • An example

      repotools-jts.sh -reindex all

  • The "baselines" parameter is whitelist (inclusive-only) set of baselines to reindex
    • A comma separated list of baselines URI, without spaces.
    • An example

      repotools-jts.sh -reindex baseline=http://jazz.net/jts/dashboards

    • This parameter is useful to limit the reindex to the needed baselines, making the reindex time shorter

repotools rebuildIndices

• Repotools-(applications) -rebuildIndices: Repository tools command to rebuild database indexes in the event of them becoming fragmented.
  • The application must not be running before the command is run. ( you can check using repotools command -isServerRunning)
  • An example

    repotools-jts.sh -rebuildindices

repotools compacttdb

• Repotools-(applications) -compacttdb: Compact the TDB
  • The application must not be running before the command is run. ( you can check using repotools command -isServerRunning)
  • The TDB indexes can grow to be large. The compacttdb command alleviates this problem by forcing a compaction of the indexes.
  • srcdir The directory containing the RDF indexes to be compacted.
  • tempdir The temporary directory to use while compacting the RDF indexes
  • An example

    repotools-jts.sh -compacttdb srcdir={location of RDF indexes} tempdir={location of temporary directory}

Possible Causes and Solutions

The queries are slow or having issues

• The query triple store indexes need to be re-indexed

The TDB needs to be compacted

Related topics: None

External links:

• Query and Search indices management in the Rational solution for Collaborative Lifecycle Management Part 1: Query, Search and indexing technologies in CLM jazz.net article 1271
• JQuery and Search indices management in the Rational solution for Collaborative Lifecycle Management Part 2: Indices storage and management: Backup, recovery and recreation jazz.net article 1272

Additional contributors: None