Create a background index

Use SearchService.startBackgroundIndex.to create a background index. Using this command helps you to remove inconsistencies from the Search index without the need for downtime while the index is rebuilt.

Start wsadmin.sh.

The SearchService.startBackgroundIndex command allows you to create a background index in a specified location. When using this command, the Search application performs a full crawl of the specified applications and then builds the index at the chosen location. If an index already exists at the location, the crawl resumes from the resume point stored in the Search index at that location.

A file called INDEX.READY is created in the specified location when the background index is complete.

To create a background index.

1. Start wsadmin...
   cd app_server_root/profiles/Dmgr01/bin
   ./wsadmin.sh -lang jython

2. Initialize the Search environment, and start the Search script interpreter:
   execfile("searchAdmin.py")

   If successful

   Search Administration initialized

3. Run:

   SearchService.startBackgroundIndex(String persistenceLocation, String extractedFileContentLocation, String indexLocation, String applications, String jobs, Boolean isIndexingMultiThreaded)

   Create a background index in the specified location. This command crawls the seedlists for the specified applications, saves the seedlists to the specified persistence location, extracts the file content, and then builds a Search index for the applications at the specified index location.

   We can optionally run social analytics indexing jobs at the end of the background indexing operation. Alternatively, we can run the SearchService.startSandBackgroundIndex to create a background index for the social analytics service. See Create a background index for the social analytics service. This command takes the following arguments:

   persistenceLocation

   Location to save the application seedlists.

   extractedFileContentLocation

   The file content extraction location. Use the same location specified when we previously extracted the file content using the SearchService.startBackgroundFileContentExtraction command or SearchService.startBackgroundIndex. Otherwise, specify an empty directory as the location for storing the extracted file content.

   indexLocation

   Location to create the background index.

   applications

   Names of the applications to include in the index crawl. Valid values:

   • activities

   • all_configured
   • blogs
   • calendar
   • communities
   • dogear
   • ecm_files
   • files
   • forums
   • people_finder
   • profiles
   • status_updates
   • wikis

   Use all_configured rather than listing all the indexable applications to index all the applications.

   To queue up multiple applications for indexing, run a single instance of SearchService.startBackgroundIndex.with the names of the applications to index listed with a comma separator between them. If we run multiple instances of the command with a single application specified as a parameter, a lock is established when we run the first command so that only the first application specified is indexed successfully.

   jobs

   Names of the social analytics post-processing indexers that examine, index, and produce new output based on the data in the index. Valid values: evidence, graph, manageremployees, tags, taggedby, and communitymembership. Use a comma to separate multiple values. Close the widget palette. .

   isIndexingMultiThreaded

   A boolean value that specifies whether the index build should be multithreaded. This parameter is optional.

   Examples:

   SearchService.startBackgroundIndex("/opt/IBM/Connections/data/local/search/backgroundCrawl", 
   "/opt/IBM/Connections/data/local/search/backgroundExtracted", 
   "/opt/IBM/LotusConnections1/data/search/background/backgroundIndex", "activities, blogs, calendar, communities, dogear, files, forums, profiles, wikis, status_updates", "communitymembership, graph")

   SearchService.startBackgroundIndex("/opt/IBM/Connections/data/local/search/backgroundCrawl", "/opt/IBM/Connections/data/local/search/backgroundExtracted", "/opt/IBM/LotusConnections1/data/search/background/backgroundIndex", "all_configured")

What to do next

• To start using the new index, complete the steps for restoring an index as described in Restore the Search index. The steps that perform vary depending on the deployment type.

• Copy the extracted file content to the directory specified by the WAS environmental variable EXTRACTED_FILE_STORE so the files do not have to be converted again unnecessarily during indexing. For more information about the EXTRACTED_FILE_STORE variable, see WAS environment variables.

Parent topic:
Create background indexes

Related:

Restore the Search index

Related:

Create a background index for the social analytics service

Related reference:

WAS environment variables