Additional steps for WebSphere Commerce search interim fixes: Setting up the search index

Some WebSphere Commerce search-related interim fixes require you to set up the search index. The readme file for the interim fix indicates whether this step is necessary.

Procedure

  1. Complete one of the following tasks:
    • LinuxAIXLog on as a WebSphere Commerce non-root user.
    • For IBM i OS operating systemLog on with a user profile that has *SECOFR authority.
    • WindowsLog on with a user ID that is a member of the Windows Administration group.
  2. Go to the following directory:
    • WC_installdir\components\foundation\subcomponents\search\bin
    • WebSphere Commerce DeveloperWCDE_installdir\components\foundation\subcomponents\search\bin
  3. Run the search index setup utility, additionally specifying the configWCforSolrUpdate or configSolrCoresUpdate actions, and the includeUpdate parameter:
    • Windows setupSearchIndex.bat [-action action] [-includeUpdate true | false] [util-specific-params]
    • LinuxAIXsetupSearchIndex.sh [-action action] [-includeUpdate true | false] [util-specific-params]
    • WebSphere Commerce DevelopersetupSearchIndex.bat [-action action] [-includeUpdate true | false] [util-specific-params]
    Where:
    action
    Prepares the search index for certain scenarios.
    The following actions support applying optional features provided by interim fixes:
    configWCforSolrUpdate
    Configures WebSphere Commerce to apply updates to existing cores.
    configSolrCoresUpdate
    Configures Solr to apply updates to existing cores.
    configSolrCoresAdvUpdate
    Optional: If you are using the managed configuration, configures an existing advanced file structure for the type that is specified in the propFile property file.
    configHorizontalShardsUpdate
    Optional: If you are using sharding, configures indexing for existing horizontal shards.
    configParallelShardsUpdate
    Optional: If you are using sharding, configures indexing for existing parallel shards.
    Apply multiple actions by specifying them in quotes, separated by a comma. For example: -action "configWCforSolrUpdate,configSolrCoresUpdate".
    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.
    This parameter is required when setting up the search index for a new master catalog, or adding a new store language. It is not required if configWCforSolrUpdate or configSolrCoresUpdate are used.
    The default value is false.
    util-specific-params
    For more information about utility-specific parameters and actions that are not related to applying optional features provided by interim fixes, see setupSearchIndex utility.
    Note: This utility recreates search index processing templates and recreates the search index structure. A back up of your search directories are created to preserve your search customizations. The back up directories are created under Search_home/pre-processConfig and Search_home/solr/home with a timestamp appended for the MC_MasterCatalogId folder.
  4. Ensure that the utility runs successfully.
    Consult the following table for the utility results:
    Search setup utility results
    Results Description
    Search index setup successfully completed without errors. The utility ran successfully.
    Search index setup successfully completed with warnings. Check the log file for more information. The utility ran successfully but with warnings. Some warnings might be generated during the setup index process. However, they might not be important. For example, if the utility skips existing cores.
    Search index setup successfully completed with errors. Check the log file for more information. The utility ran successfully but with errors. The job did not completely finish setup. Check the log file to see where the problem occurred.
    Search index setup not successful. An unrecoverable error has occurred. Check the log file for more information. The utility did not run successfully. Check the log file to see where the problem occurred.
    To ensure that the utility ran successfully, check the log file:
    • Local machine: WC_installdir/components/foundation/subcomponents/search/config/logging.properties
    • Remote machine: working_dir/search/config/logging.properties
    If the log file indicates an error, correct the issue and run the utility again. If you require more logging information to correct the issue, update the logging level from INFO to FINEST:
    
# Default global logging level, INFO
com.ibm.commerce.level=FINEST
    Updating the logging level to FINEST lists all details as the utility runs. Use this level if you encounter errors or exceptions and you need additional information for troubleshooting. For more information, see Enabling tracing and logging for WebSphere Commerce Search.
  5. Restart the WebSphere Commerce search server.
  6. Merge your customizations back into the newly created templates, if necessary.
  7. Preprocessing the WebSphere Commerce search index.
  8. Building the WebSphere Commerce search index.