IndexLoad URL

The IndexLoad URL is used to call Index Load, so that you can populate WebSphere Commerce search index data, for example, contract prices.

URL structure

http://hostname:port/search/indexload/command?query_parameters: The fully qualified name of your WebSphere Commerce Server, the indexload path, command and query parameters.

Parameter values

The following parameters can be specified:

command

The following commands can be specified:

config

Displays indexing configurations that are defined in the Index Load XML file.

clear

Deletes all contents from all index cores that are defined in the Index Load XML file.

merge

Merges all unloaded index data directories that are defined in the Index Load XML file.

Note: Ensure that all source index Solr cores are offline before they are merged. To do so, perform one of the following steps:

Use the unload action for each core that is not offline. For example:


http://hostname:3737/solr/admin/cores?action=UNLOAD&core=source_index_core_name

or,

Copy the source index data directory to a template directory. Then, in the wc-indexload-merge.xml file, use the template directory's index data as the input.

For more information about the Index Load configuration files for merging, see Index Load configuration files for merging indexes.

optimize

Optimizes contents from all index cores that are defined in the Index Load XML file.

start

Performs indexing by using configurations that are defined in the Index Load XML file.

stop

Stops all Index Load operations on the search server.

status

Reviews the status of Index Load on the search server.

profile

The name of the Index Load profile.

The profile name is used to look up the configuration file name when the Index Load servlet is initialized.

detail

Returns more detailed index-related information.

The default value is false.

Alternatively, you can view a list of all the available Index Load parameters by going to the following URL in your environment:

http://hostname:port/search/indexload/usage

Example

Sample usage
Sample URL	Description
http://`hostname`:`port`/search/indexload/start?profile=price&detail=true	Performs indexing by using the price profile, and returns more detailed information.
http://`hostname`:`port`/search/indexload/status?profile=price	Checks the status for the price profile.
http://`hostname`:`port`/search/indexload/merge?profile=merge&detail=true	Merges all unloaded index data directories, and returns more detailed information.

Overriding Index Load configurations using URL parameters

You can override configurations defined in the Index Load XML files using URL parameters. This is useful when experimenting with different tuning parameters, as you do not need to logon to the machine's file system to make configuration updates for each change.

For example, when experimenting with tuning parameters, the ParallelThreads parameter defines the number of threads to be used. To override this value, include the configuration name and value in the query parameter when invoking the IndexLoad URL:


http://hostname:port/search/indexload/start?profile=price&detail=true&ParallelThreads=10

You can overwrite any tuning parameters using the Index Load URL. Then, when satisfied, you can update the configuration files.