SearchCellConfig commands

Home

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. To run the MBean commands listed in the following table, you first need to initialize the search configuration environment. For more information about initializing the search configuration environment, see Accessing the search configuration environment.
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 commands
Command Description
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.
SearchCellConfig.addDictionary(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) and one for Brazil (pt-BR).
dictionaryPath. The path to the containing the dictionary file. This argument is a string value.

For example:
SearchCellConfig.addDictionary("fr","/opt/WebSphere/LotusConnections/dictionaries")
To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
SearchCellConfig.setDefaultDictionary(String languageCode)
Configures the default LanguageWare dictionary used by the search feature. The default dictionary must be one of the enabled dictionaries.
At indexing time, when content is analyzed, an attempt is made to guess which of the enabled LanguageWare dictionaries should be used when applying the text analysis process. If the attempt is unsuccessful or if the language guessed does not have a corresponding dictionary enabled, the default dictionary is used.
The default dictionary is also used at search time. Language guessing is not used at search time to determine which dictionary is used, the language is specified as part of the HTTP request. If there is a problem loading the dictionary corresponding to the language specified or if there is no corresponding dictionary enabled, then the default dictionary is used. This command accepts one argument:

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) and one for Brazil (pt-BR).

For example:
SearchCellConfig.setDefaultDictionary("fr")
To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
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) and one for Brazil (pt-BR).

For example:
SearchCellConfig.disableDictionary("fr")
To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
SearchCellConfig.enableAttachmentHandling() Enables the indexing of files in the Files feature. This command refers explicitly to attachments in the Files feature. It does not affect whether metadata in the files, such as tags or descriptions, is indexed.This command does not take any input parameters.
To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
SearchCellConfig.disableAttachmentHandling() Disables the indexing of files in the Files feature.This command does not take any input parameters.
To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
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 The temporary 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 argument is an integer value.

For example:
SearchCellConfig.setMaximumAttachmentSize("204800")
To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
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. This command accepts one argument:

numberOfDays. The expiry time measured in days. This argument is an integer value. Specify a positive integer greater than zero.

For example:
SearchCellConfig.setCacheExpiryTime("30")
To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
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 feature 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 argument is an integer value.

For example:
SearchCellConfig.setCacheFileSize("8435456")
To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
SearchCellConfig.setMaximumConcurrentDownloads(int maxConcurrentDownloads)
Sets the maximum number of threads that perform file downloading on a search server.This command takes a single argument:

maxConcurrentDownloads. The number of threads. This argument must be an integer greater than zero. The default is 3. CAUTION:Increasing this value increases the load on the Files server.

For example:
SearchCellConfig.setMaximumConcurrentDownloads("10")
To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
SearchCellConfig.setMaximumTempDirSize(int maxTempDirSize)
Sets the maximum size of a temporary used by a search server for the file conversion process.
Files are downloaded to a temporary directory, which is located in the index directory. The temporary size available must be greater than the maximum file size allowed for content indexing. This command takes a single argument:

maxTempDirSize. The maximum size in bytes. This argument must be an integer greater than zero. The default value is 100 MB.

For example:
SearchCellConfig.setMaximumTempDirSize("51200")
To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
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:

downloadThrottle. The download throttle size in milliseconds. This argument is a long value. 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")
To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
SearchCellConfig.checkOutConfig(String working_directory, String cell_name)
Checks out a copy of the search configuration file to a working 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 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 WebSphere Application Server cell hosting the IBM Lotus Connections search feature. This argument is a string value.

For example:
SearchConfigService.checkOutConfig("/temp","foo01Cell01")
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 to the location of the active copy of these files and it overwrites the existing XML file. For example:
SearchConfig.checkInConfig()
SearchCellConfig.checkOutProxyConfig(String working_directory, String cell_name)
Checks out a copy of the proxy template file to a working located on the file system. This command must be used before configuring the Ajax proxy for the search feature.This command takes two arguments:

working_directory. A file path to the temporary working to which the search proxy configuration template and XSD files are copied by the checkOutConfig command. This argument is a string value.
cell_name. The name of the WebSphere Application Server cell hosting the Lotus Connections feature. This argument is required even in stand-alone deployments. This argument is a string value.

For example:
SearchConfigService.checkOutProxyConfig("/temp","foo01Cell01")
SearchCellConfig.checkInProxyConfig()
Checks in the search proxy configuration file. This command must be used after changes are made to the search proxy configuration file in order for those changes to take effect.For example:
SearchConfigService.checkInProxyConfig("/temp","foo01Cell01")
Manage the index

Related tasks

Accessing the search configuration environment
Enable dictionaries
Listing enabled dictionaries
Disabling a dictionary
Set the default dictionary
Configure file attachment indexing settings

+
Search Tips | Advanced Search

Command	Description
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.
SearchCellConfig.addDictionary(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) and one for Brazil (pt-BR). dictionaryPath. The path to the containing the dictionary file. This argument is a string value. For example: SearchCellConfig.addDictionary("fr","/opt/WebSphere/LotusConnections/dictionaries") To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
SearchCellConfig.setDefaultDictionary(String languageCode)	Configures the default LanguageWare dictionary used by the search feature. The default dictionary must be one of the enabled dictionaries. At indexing time, when content is analyzed, an attempt is made to guess which of the enabled LanguageWare dictionaries should be used when applying the text analysis process. If the attempt is unsuccessful or if the language guessed does not have a corresponding dictionary enabled, the default dictionary is used. The default dictionary is also used at search time. Language guessing is not used at search time to determine which dictionary is used, the language is specified as part of the HTTP request. If there is a problem loading the dictionary corresponding to the language specified or if there is no corresponding dictionary enabled, then the default dictionary is used. This command accepts one argument: 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) and one for Brazil (pt-BR). For example: SearchCellConfig.setDefaultDictionary("fr") To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
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) and one for Brazil (pt-BR). For example: SearchCellConfig.disableDictionary("fr") To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
SearchCellConfig.enableAttachmentHandling()	Enables the indexing of files in the Files feature. This command refers explicitly to attachments in the Files feature. It does not affect whether metadata in the files, such as tags or descriptions, is indexed.This command does not take any input parameters. To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
SearchCellConfig.disableAttachmentHandling()	Disables the indexing of files in the Files feature.This command does not take any input parameters. To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
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 The temporary 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 argument is an integer value. For example: SearchCellConfig.setMaximumAttachmentSize("204800") To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
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. This command accepts one argument: numberOfDays. The expiry time measured in days. This argument is an integer value. Specify a positive integer greater than zero. For example: SearchCellConfig.setCacheExpiryTime("30") To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
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 feature 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 argument is an integer value. For example: SearchCellConfig.setCacheFileSize("8435456") To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
SearchCellConfig.setMaximumConcurrentDownloads(int maxConcurrentDownloads)	Sets the maximum number of threads that perform file downloading on a search server.This command takes a single argument: maxConcurrentDownloads. The number of threads. This argument must be an integer greater than zero. The default is 3. CAUTION:Increasing this value increases the load on the Files server. For example: SearchCellConfig.setMaximumConcurrentDownloads("10") To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
SearchCellConfig.setMaximumTempDirSize(int maxTempDirSize)	Sets the maximum size of a temporary used by a search server for the file conversion process. Files are downloaded to a temporary directory, which is located in the index directory. The temporary size available must be greater than the maximum file size allowed for content indexing. This command takes a single argument: maxTempDirSize. The maximum size in bytes. This argument must be an integer greater than zero. The default value is 100 MB. For example: SearchCellConfig.setMaximumTempDirSize("51200") To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
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: downloadThrottle. The download throttle size in milliseconds. This argument is a long value. 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") To use this command, first check out the search configuration file using the SearchCellConfig.checkOutConfig() command. After making your changes, check the search configuration file back in using the SearchCellConfig.checkInConfig() command.
SearchCellConfig.checkOutConfig(String working_directory, String cell_name)	Checks out a copy of the search configuration file to a working 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 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 WebSphere Application Server cell hosting the IBM Lotus Connections search feature. This argument is a string value. For example: SearchConfigService.checkOutConfig("/temp","foo01Cell01")
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 to the location of the active copy of these files and it overwrites the existing XML file. For example: SearchConfig.checkInConfig()
SearchCellConfig.checkOutProxyConfig(String working_directory, String cell_name)	Checks out a copy of the proxy template file to a working located on the file system. This command must be used before configuring the Ajax proxy for the search feature.This command takes two arguments: working_directory. A file path to the temporary working to which the search proxy configuration template and XSD files are copied by the checkOutConfig command. This argument is a string value. cell_name. The name of the WebSphere Application Server cell hosting the Lotus Connections feature. This argument is required even in stand-alone deployments. This argument is a string value. For example: SearchConfigService.checkOutProxyConfig("/temp","foo01Cell01")
SearchCellConfig.checkInProxyConfig()	Checks in the search proxy configuration file. This command must be used after changes are made to the search proxy configuration file in order for those changes to take effect.For example: SearchConfigService.checkInProxyConfig("/temp","foo01Cell01")