KB484259: Quick Search Indices

Quick Search Indices

Quick Search is the new search engine that utilizes the full-text search library – Lucene. The Quick Search Indices are generated by Lucene to speed up the search. The content of the indices is based on objects from the metadata.
Learn more:

• Create and Update Quick Search Indices
• Indices Maintained by Quick Search
• Monitor Quick Search Indices 
• Manually rebuild a Quick Search Index
• When to rebuild an Index

Create and Update

Currently, Quick Search Indices are created by InitialCrawl, which crawls metadata objects and generates the corresponding index. Usually, this is triggered when a project is first created or loaded on one environment.
Once the indices are created, they will not remain unchanged. Instead, indices will be updated accordingly once the corresponding objects are changed. Quick Search has two ways to make sure indices are updated:

1. Real-time update: Triggered right after the object is changed and saved to the metadata or deleted from the metadata.
2. Incremental update: Triggered during Intelligence Server startup when Quick Search engine finds the index status is complete and detects that there is an object change when the Intelligence Server instance is not running.

Maintained Indices

When a project is loaded, Quick Search will first check whether it needs to rebuild the index regardless if it exists in the very project. It will automatically rebuild the index (i.e., destroy the current index if it exists, and start initial crawl task to generate the index) if one of the following conditions are met: 

• Metadata is changed
• Index version does not match the current version in the Intelligence Server
• Index is invalid 

If it does not need to rebuild the index, it will check if there is an existing index for the project. If an index does not exist, the initial crawl task will be started automatically for the project. If an index exists for the project, it will start incremental crawl or resume paused crawl task, based on the index status.
If the index folder is changed via Strategy Developer, Quick Search will automatically create indices for all loaded projects.

Note: Index will not be updated in 2Tier mode. Initial crawl, incremental crawl, and teal-time update are performed in 3Tier or 4Tier mode.

Monitor Indices

The index status can be monitored via Developer:

1. In Developer, expand Administration > System Monitors > Quick Search Indices.

You can see the following when viewing the indices: 

• Project Name
• Index Status for each project
• Percentage of the crawl process (When the crawl process is ongoing, the percentage will be updated once the page is refreshed)
• Searchable Item Count (The number of items (objects) that are searchable via Quick Search)
• Last Real Time Update time
• Last Incremental update time
• Project ID
• Machine Name

Manually Rebuild a Quick Search Index

If a certain system configuration changes, you may be required to rebuild the Quick Search Index. Quick Search Indices are accessible via your System Monitors. To rebuild a search index:

1. Open a project source in Developer.
   If you are running Strategy Developer on Windows for the first time, run it as an administrator.
   Right‑click the program icon and select Run as Administrator.
   This is necessary to properly set the Windows registry keys. For more information, see KB43491.
   
2. Open Administration > System Monitors > Quick Search Indices to view the indices.
3. Right-click and select Rebuild Index.

For additional details, please refer to KB482892.

When to Rebuild an Index

The following scenarios may require you to rebuild a search index:

• If you switch the metadata with a copy of the currently used metadata (i.e., the backup of the current metadata). Quick Search cannot distinguish the copies of a metadata.
• If you change your index folder. If the index folder changed via Strategy Developer, the index for all loaded projects will be rebuilt automatically. You do not need to rebuilt the index.
• If you upgrade your environment.
• If you find the index status is in paused status for a specific project for a long time. Usually Quick Search will resume crawl process for a paused index. 
• If you can not search your objects normally.