setupSearchIndex utility

Parameter values

instance

The name of the WebSphere Commerce instance with which you are working.

action

Prepares the search index for certain scenarios, such as configuring or resetting search cores.

Action names that end with Update as its suffix indicate that the action applies to an existing core, instead of setting up a new core.

The following actions are supported when setting up the search index locally:

configWCforReset

When used with the configSolrCoresReset parameter, resets search cores on the WebSphere Commerce server after a previous search index is already setup. When search cores are reset, all core-related information, such as XML configuration files and database information is deleted.

To reset all Solr cores, set the masterCatalogId parameter to all when using this action.

configSolrCoresReset

Resets search cores on the Solr machine.

When search cores are reset, all core-related information, such as XML configuration files and database information is deleted.

If masterCatalogId is set to all, all Solr cores are reset.

configWCScheduleforCatalogFilter

Uses the EXPRESSION table for entitlement.

Note: You must install the interim fix for APAR JR53113 to use this action. For more information, see Enabling interim fix JR53113.

The following actions are supported when setting up the search index remotely:

configWCforSolr

Sets up search on the WebSphere Commerce machine when you are setting up the search index remotely.

configWCforReset

Resets search cores on the WebSphere Commerce machine, after a search index has already been previously setup.

When search cores are reset, all core-related information, such as XML configuration files and database information is deleted.

configSolrCores

Sets up the search cores on the Solr machine when you are setting up the search index remotely.

configSolrCoresReset

Resets search cores on the Solr machine.

When search cores are reset, all core-related information, such as XML configuration files and database information is deleted.

If masterCatalogId is set to all, all Solr cores are reset.

The following actions support sharding:

configHorizontalShards

Configures indexing for new horizontal shards.

configHorizontalShardsUpdate

Configures indexing for existing horizontal shards.

configParallelShards

Configures indexing for new parallel shards, which creates horizontal shards, plus one vertical shard.

configParallelShardsUpdate

Configures indexing for existing parallel shards.

configShardsReset

Deletes all existing shards.

The following actions support the managed configuration:

configSolrCoresAdv

Sets up the advanced file structure for the type that is specified in the propFile property file.

configSolrCoresAdvUpdate

Updates an existing advanced file structure for the type that is specified in the propFile property file. This action is used to apply features provided by interim fixes. For more information, see Additional steps for WebSphere Commerce search interim fixes: Setting up the search index.

configSolrCoresAdvReset

Resets the advanced file structure for the specified master catalog ID and the type that is specified in the propFile property file.

configWCforSolrAdv

Updates the remote database based on the remote database information that is provided in the propFile property file.

configWCforSolrAdvLocal

Updates the local database based on the local database information that is provided in the propFile property file.

The following actions support applying optional features provided by interim fixes:

configWCforSolrUpdate

Configures WebSphere Commerce to apply updates.

configSolrCoresUpdate

Configures Solr to apply updates.

propFile

The full path to the loading.properties input properties file.

includeUpdate

Indicates whether the utility should apply optional features provided by interim fixes. For example, features that exist in the catalog-update and template-update directories. The default value is false. For more information, see Additional steps for WebSphere Commerce search interim fixes: Setting up the search index.

masterCatalogId

Required: The ID of the master catalog (for example, 10101).

If you do not know the master catalog ID, run the following SQL:

SQL: select * from catalog where IDENTIFIER='STORE_IDENTIFIER'

To find the master catalog ID for an Extended Site store:

1. Find the store ID:

   select * from storeent where IDENTIFIER='STORE_IDENTIFIER'
   

2. Use the storeent_id as the store_id in the following SQL to find the catalog asset store ID of this Extended Site store:

   
   select * from storerel where store_id=XXXXXX and streltyp_id=-4 and relatedstore_id not in (XXXXXX)
   

   Where XXXXXX is the storeent_id from the SQL in step 1 when building the search index.
3. Get the master catalog ID:

   
   select * from storecat where storeent_id=YYYYYY and mastercatalog='1'
   

   Where YYYYYY is the relatedstore_id from step 2 when building the search index.

dbuser

The name of the user that is connecting to the database.

The user ID connecting to the database.

dbuserpwd

The password for the user that is connecting to the database.

indextype

Optional: Indicates the search engine index to set up. Valid values:

CatalogEntry

Sets up the index for catalog entries in the master catalog.

CatalogGroup

Sets up the index for categories in the master catalog.

If you do not use the indextype parameter, both the CatalogEntry and CatalogGroup indexes are built by default.

indexsubtype

Optional: Indicates the search engine index subtypes to set up. Valid values:

Inventory

Sets up the index for inventory data.

The inventory index supports only stores by using the non-ATP inventory system.

Important: When specified, the utility skips updating the wc-search.xml file. Therefore, you must first setup the master catalog index before setting up the inventory index.

searchServerName

This is the host name of the Solr web server, if Solr uses a web server. If Solr does not use a web server, set searchServerName to the host name of the Solr server.

searchServerPort

The search server port.

The default value is:

• 3737

searchServiceContextRoot

The search service context root. For the Solr related action such as configSolrCores and configWCforSolr, the default value is /solr.

setupWebContent

The flag that indicates whether to prepare the basepath and storeid for building the site content index. If false, the basepath and storeid are not added to the config column in the SRCHCONFEXT table. The default value is true.

Note: Exceptions might occur if your site contains a large number of extended sites and you run setupWebContent. To avoid this issue, enable autoIndex within the droidConfig.xml file. For more information, see Troubleshooting: Large number of extended sites causes exceptions when you set up the search index.

dbauser

The name of the DBA user.

This parameter is paired with the dbauserpwd parameter to create the workspace indexes. Otherwise, the workspace indexes are not created.

dbauserpwd

The password of the DBA user.

This parameter is paired with the dbauser parameter to create the workspace indexes. Otherwise, the workspace indexes are not created.

createAll

Indicates whether to create cores for all available workspaces, including non-allocated workspaces. Otherwise, cores are only created for allocated workspaces.

The default value is false, where cores are only created for allocated workspaces.

dbURL

¹ The database URL the utility uses to connect to the database. If not provided, the utility constructs a database URL based on the default database value.

searchQueryServerName

The name of the query server (workload balancer) when WebSphere Commerce search is setup in a clustered environment with a repeater.

If not specified, the SearchServerName value is used.

searchQueryServerPort

The port of the query server (workload balancer) when WebSphere Commerce search is setup in a clustered environment with a repeater.

If not specified, the SearchServerPort value is used.

setupMode

Indicates the setup mode for the setup search index script. This is required when you are running the script on a remote machine, where the value is set as remote.

wcServerName

The WebSphere Commerce web server name (host_name).

wcServerPort

The WebSphere Commerce web server port. For example, 80.

WAS_home

The installation path for WebSphere Application Server.

Pass in this value to avoid missing Java version errors.

solrhome

The location of the Solr home directory path that contains the index data of Solr. The value must be an absolute path.

The default value is:

• WCDE_installdir/search/solr/home
• WC_installdir/instances/instance_name/search/solr/home
• WC_instance_root/instances/instance_name/search/solr/home

dbserver

The database server name to be connected.

dbport

The database port to be connected.

dbtype

The database type. For instance, Cloudscape, db2, or oracle.

dbname

The database name to be connected.

Example

Ensure that the utility runs successfully.

You can get more logging information by updating the logging level from INFO to FINEST:

# Default global logging level, INFO
.level=FINEST

# Default global logging level, INFO
com.ibm.commerce.level=FINEST

For more information about the log file, and to enable more logging details, see Enabling tracing and logging for WebSphere Commerce search.