SearchCellConfig commands
The SearchCellConfig commands are used to configure the location of the Search index and the IBM LanguageWare dictionaries used by Search, and to configure the file download and conversion service used when indexing file attachments.
SearchCellConfig commands
Use the MBean commands listed below to perform administrative tasks for Search. The commands are listed in alphabetical order.To run the commands, you first need to initialize the Search configuration environment. For more information about initializing the Search configuration environment, see Access the Search configuration environment.
Note: For the SearchCellConfig commands that create, update, or delete configuration data, also check out the search-config.xml file using the SearchCellConfig.checkOutConfig() command. After making your edits, you need to check in your changes using the SearchCellConfig.checkInConfig() command. When the server next restarts, your changes will take effect. Any of these changes require the indexes to be rebuilt.
SearchCellConfig.checkInConfig()
Checks in the Search configuration file. This command must be used after changes are made to the Search configuration file in order for those changes to take effect. As part of this operation , the edited copy of the Search configuration file, search-config.xml, is validated against the XSD schema definition file, search-config.xsd.
The checkInConfig command copies the updated configuration file from the temporary directory to the location of the active copy of these files and it overwrites the existing XML file.
For example:
SearchCellConfig.checkInConfig()
SearchCellConfig.checkOutConfig(String working_directory, String cell_name)
Checks out a copy of the Search configuration file to a working directory located on the file system. This command must be used before changes are made to the Search configuration file.
This command takes two arguments:
- working_directory. A file path to a temporary working directory to which the configuration XML and XSD files are copied by the checkOutConfig command. This argument is a string value.
- cell_name. The name of the IBM WAS cell hosting the IBM Connections Search application. This argument is a string value.
For example:
SearchCellConfig.checkOutConfig("/temp","foo01Cell01")
SearchCellConfig.disableAttachmentHandling()
Disables the indexing of file attachments in the Files and Wikis applications.
This command does not take any input parameters.
SearchCellConfig.disableDictionary(String languageCode)
Disables the specified LanguageWare dictionary.
This command accepts one argument:
- languageCode. The language code for the dictionary that you want to delete. This argument is a string value.
The language code typically comprises two letters conforming to the ISO standard 639-1:2002 that identifies the primary language of the dictionary. However, there are some codes that additionally define a country or variant, in which case these constituent parts are separated by a hyphen. For example, Portuguese has two variants, one for Portugal (pt-PT) and one for Brazil (pt-BR).
For example:
SearchCellConfig.disableDictionary("fr")
SearchCellConfig.enableAttachmentHandling()
Enables the indexing of file attachments in the Files and Wikis applications.
Note: If you already disabled the attachment handling of files during the last indexing, you need to rebuild the index again after enabling attachment handling. Otherwise, this command won't take effect.
This command does not take any input parameters.
SearchCellConfig.enableDictionary(String languageCode, String dictionaryPath)
Enables support for the specified LanguageWare dictionary.
This command accepts two arguments.
- languageCode. The language code for the dictionary that you want to add. This argument is a string value.
The language code typically comprises two letters conforming to the ISO standard 639-1:2002 that identifies the primary language of the dictionary. However, there are some codes that additionally define a country or variant, in which case these constituent parts are separated by a hyphen. For example, Portuguese has two variants, one for Portugal (pt-PT) and one for Brazil (pt-BR).
- dictionaryPath. The path to the directory containing the dictionary file. This argument is a string value.
For example:
SearchCellConfig.enableDictionary("fr","/opt/IBM/LotusConnections/data/shared/search/dictionary")
SearchCellConfig.listDictionaries()
Lists the LanguageWare dictionaries that are configured for Search. These dictionaries are used by common Search to support indexing multilingual content and searching in multiple languages.
This command does not take any input parameters.
SearchCellConfig.setBackupType(String type)
Specifies the type of backup that you want to create.
This command takes a single argument that specifies the backup type. This can be one of the following:
- new. Creates a new index backup every time.
- dual. Creates dual copies and overwrites the oldest existing backup.
- overwrite. Overwrites the existing index backup.
For example:
SearchCellConfig.setBackupType("new")
SearchCellConfig.setCacheExpiryTime(int numberOfDays)
Sets the number of days for which a downloaded file's indexable content is cached in the database. This information is cached for potential reuse at indexing time. If a file is not reused in the number of days specified, its entry in the database cache is deleted. If the file content has changed, the file is downloaded again and the cache is updated with the revised content.
This command allows you to ensure that the database cache used for indexing files is kept up-to-date.
The expiry time is measured in days. Specify a positive integer greater than zero.
For example:
SearchCellConfig.setCacheExpiryTime("30")
SearchCellConfig.setCacheFileSize(int cacheFileSize)
Specifies the maximum amount of indexable text per file.
The size is specified in bytes. Use a positive integer greater than zero.
The cache file size is set to 200 KB by default. This is also the maximum amount of content that can be indexed. If this value is set to a value greater than 200 KB, the Search application only caches 200 KB of data per file.
This command accepts one argument:
- cacheFileSize. The number of bytes of indexable and searchable file content stored in the database cache. This is an integer value.
For example:
SearchCellConfig.setCacheFileSize("8435456")
SearchCellConfig.setDefaultDictionary(String languageCode)
Configures the default LanguageWare dictionary used by the Search application. The default dictionary must be one of the enabled dictionaries.
This command takes a single argument:
- languageCode is the language code for the dictionary that you want to set as the default.
This language code typically comprises two letters conforming to the ISO standard 639-1:2002 that identifies the primary language of the dictionary. However, there are some codes that additionally define a country or variant, in which case these constituent parts are separated by a hyphen. For example, Portuguese has two variants, one for Portugal (pt-PT) and one for Brazil (pt-BR).
Note: A matching dictionary must exist in the list of configured dictionaries for the language that you specify as a parameter.
For example:
SearchCellConfig.setDefaultDictionary("fr")
SearchCellConfig.setDownloadThrottle(long downloadThrottle)
Sets the duration of a rest period between successive files downloads in a single file-download thread.
This command takes a single argument that specifies the download throttle size in milliseconds. The download throttle is set to 500 by default.
CAUTION: Increasing this value increases the load on the Files server.
For example:
SearchCellConfig.setDownloadThrottle("500")
SearchCellConfig.setMaxCacheEntries(int maxCacheEntries)
Sets the maximum number of cached file entries allowed in the database cache.
This command takes a single argument:
- maxCacheEntries. The number of cached file entries. This argument must be an integer greater than zero.
For example:
SearchCellConfig.setMaxCacheEntries("1000")
SearchCellConfig.setMaximumAttachmentSize(int maxAttachmentSize)
Sets the upper limit on the size of files that can be downloaded for indexing. Files above this limit are not downloaded for content indexing.
Files are downloaded to a temporary directory, which is located in the index directory. The temporary directory size available must be greater than the maximum file size allowed for content indexing.
This command accepts one argument:
- maxAttachmentSize. The maximum file size in bytes of any file attachment eligible for indexing. This is an integer value.
For example:
SearchCellConfig.setMaximumAttachmentSize("204800")
SearchCellConfig.setMaximumConcurrentDownloads(int maxConcurrentDownloads)
Sets the maximum number of threads that perform file downloading on a Search server.
This command takes a single argument that specifies the maximum number of threads. The argument must be an integer greater than zero. The default value is 3. The value of the maxConcurrentDownloads argument must not exceed the maximum number of threads set for the DefaultWorkManager Work Manager resources at the Search server scope.
CAUTION: Increasing this value increases the load on the Files server.
For example:
SearchCellConfig.setMaximumConcurrentDownloads("10")
SearchCellConfig.setMaximumCrawlerThreads(String maxThreadNumber)
Specifies the maximum number of seedlist threads that can be used when crawling. By default, the value is set to 2.
This command takes a single argument that specifies the number of threads allowed.
For example:
SearchCellConfig.setMaximumCrawlerThreads("3")
SearchCellConfig.setMaximumTempDirSize(int maxTempDirSize)
Sets the maximum size of a temporary directory used by a Search server for the files conversion process.
This command takes a single argument that specifies the maximum size in bytes. The argument must be an integer greater than zero. The default value is 100 MB.
Files are downloaded to a temporary directory, which is located in the index directory. The temporary directory size available must be greater than the maximum file size allowed for content indexing.
For example:
SearchCellConfig.setMaximumTempDirSize("51200")
SearchCellConfig.setPostBackupScript(String script)
Specifies which shell script or third-party application runs on completion of the backup task.
This command takes a single argument that specifies the name of the shell script or application file.
For example:
SearchCellConfig.setPostBackupScript("backup.sh")
Parent topic
Manage the Search index
Related tasks
Access the Search configuration environment
Enable dictionaries
Listing enabled dictionaries
Disable dictionaries
Setting the default dictionary
Configure file attachment indexing settings
Configure index backup settings
IBM Connections configuration property values
});