di-buildindex utility

Parameter values

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 above 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 the above step 2 when building the search index.

localename

Optional: The locale to index.

• All
• de_DE
• en_US
• es_ES
• fr_FR
• it_IT
• ja_JP
• ko_KR
• pl_PL
• pt_BR
• ro_RO
• ru_RU
• zh_CN
• zh_TW

The default value is All.

indextype

Optional: Indicates the search engine index to set up for a more granular level of indexing.

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.

dbuser (Optional)

Required for DB2 and Oracle databases:

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

The user ID connecting to the database.

Optional for Derby databases.

dbuserpwd (Optional)

Required for DB2 and Oracle databases: The password for the user who is connecting to the database.

Alternatively, you can use the passwordFile parameter to specify the encrypted password from a file.

Optional for Derby databases.

fullbuild

Optional: A flag that indicates whether it is a full index build. The accepted values are either true or false. The default value is true.

statusInterval

Optional: The interval in milliseconds that the utility uses to check the index building status. The default value is 10,000 milliseconds.

Note: If it takes too long to index many languages, reduce the status interval to a lower value.

searchuser

Optional: The user name of the search server. This parameter is required if WebSphere Application Security is enabled for HCL Commerce Search.

searchuserpwd

Optional: The password of the search server user. This parameter is required if WebSphere Application Security is enabled for HCL Commerce Search. Alternatively, you can use the passwordFile parameter to specify the encrypted password from a file.

solrConnTimeout

Optional: The time in milliseconds that the Solr connection stays open before it times out. The default value is 100 milliseconds. Use this parameter if you encounter timeout issues when you run the di-buildindex utility.

soTimeout

Optional: The time in milliseconds that the socket read stays open before it times out. Use this parameter if you encounter timeout issues when you run the di-buildindex utility.

workspace

Optional: The workspace index to build. This value is case-sensitive. If specified, the specified workspace index is built. If not specified, the base schema index is built. The default value is to build the base schema index.

To get the workspace ID, either:

• Open the workspace in the Workspace Management tool in the Management Center. The workspace code is the workspace ID; or
• If the workspace has an active task group, run the following SQL query: select * from cmwsschema, where the workspace ID is listed under the workspace column.

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.

retries

Optional: Indicates the number of times the utility retries sending a status command check to the Solr server before indicating that the di-buildindex utility has failed. Retries might help resolve minor issues during the index build. For example, to recover from temporary networking errors.

passwordFile

Optional: The full path to the password.properties file that contains password values used by this utility. For instance, C:\password.properties.

The password.properties file can contains one of the two following parameters:

dbUserPassword=encrypted_database_pwd

where encrypted_database_pwd is a password that is encrypted with the wcs_encrypt utility (without specifying the Merchant key).

searchAdminPassword=encrypted_search_user_pwd 

where encrypted_search_user_pwd is the search server user password and is encrypted with the wcs_encrypt utility (without specifying the Merchant key).

Example

Data import process completed successfully with no errors.

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