HCL Commerce Developer

Installing HCL Commerce Developer Update Packages (interactive method)

You can install HCL Commerce Developer Update Packages by using IBM Installation Manager the same tool used for the initial installation ofHCL Commerce Developer. These update packages include fixes for known issues, and applying them is strongly recommended to maintain stability and avoid the need for future service calls.

Ensure that you thoroughly test your environment after applying an update.

Before you begin

Synchronize versions
  • Ensure that both HCL Commerce and HCL Commerce Developer are updated to the same version.
  • If you are upgrading from HCL Commerce Version 9.0 to HCL Commerce Version 9.1, back up and restore the signer certificates in the WebSphere Application Server trusted certificate store.
  • If you are upgrading from version 9.0.1.x to 9.1.18.0 or later, you must first upgrade to 9.0.1.21 before proceeding to 9.1.18.0 or higher.
Optimize your system
  • Update operations are resource-intensive. On slower machines, the applyUpdate.bat process may appear to hang at 99% for up to two hours this is expected behavior.
  • Close all Java-based applications, including Rational Application Developer (RAD) and any configured web servers.
  • Log in to Windows with administrator privileges.
Download the update package (if not already available)
  • Log in to My HCLSoftware portal.
  • Locate the update package using its part number. For information about available part numbers, see HCL Commerce releases.
  • Download and extract the contents of the package. For example, to update from version 9.1.0.0 to 9.1.2.0, download and extract the 9.1.2.0 Update Package.
Back up your environment
  • Save copies of all customized files, such as: JSP files and Management Center configurations. These files may be overwritten during the update.
  • Back up your database, as update changes are permanent and cannot be undone. Refer to the BACKUP DATABASE COMMAND for command syntax and procedures.
Installation process
  1. Launch IBM Installation Manager.
    • Open the IBM Installation Manager application.
  2. Add the update package repository.
    • Navigate to File > Preferences and then click Repositories.

    • On the Repositories page, click Add Repository.
    • In the Add Repository dialog box, click Browse.
    • Locate the update package folder, select the repository.config file, and click OK.
    • Click Test Connections to ensure the repository is accessible.
    • Enable Rollback Support
      • On the Start page of Installation Manager, click File > >Preferences > Files for Rollback.
      • Select Save files for rollback to enable rollback capability.
  3. Apply the update.
    • From the Start page, click Update.
    • Select the HCL Commerce Developer package and click Next. The update packages wizard detects all of the applicable fixes. Recommended features are automatically selected.
    • Select the updates that you want to apply and click Next. The update is automatically preselected.
    • Click Next.
    • Review the summary information and click Update to install the updates.
    • Review Installation History: Review the installation history by selecting File > Installation History.
  4. Verify the installation.
    • Check the update log file located at WCDE_installdir\UpdateDelta\9.1.x.0\applyUpdate.log.
      • The x values represent the update package level.
Post-installation steps
  1. Merge file conflicts.
    • Review the merges.log file located at WCDE_installdir\UpdateDelta\9.1.x.0\backup\merges.log.

      This log lists files that were modified by both the update and your environment.

    • Files modified by both the update and your changes are backed up at WCDE_installdir\UpdateDelta\9.1.x.0\backup.
    • Use a text comparison tool to compare the original and updated versions of each file listed in merges.log.
    • For any deleted files, determine if they are still needed and take appropriate action.
    • If a compressed archive (for example, .zip, .jar, .war) was deleted and previously modified, the update may be incomplete. In such cases: Roll back the update, restore the archive file and reapply the update.
  2. Update the database.
  3. Set the spiuser password (if required).
  4. Set up elasticsearch search
  5. Rebuild the search index.

    For Apache Solr:

    • Open HCL Commerce Developer in the RAD environment.
    • Expand WebSphere Application Server Liberty Profile > Servers > searchServer > resources > search > index, and delete managed-solr and solr folders.
    • Start the Transaction server, Search server, and Store server, then build the Solr search index.
      • Update CRS and Transaction Server JNDI Settings.
        Modify the following file to configure the JNDI settings for both the CRS and Transaction Server to point to Solr:
        C:\IBM\WebSphere\Liberty\usr\servers\crsServer\configDropins\overrides\jndi.xml
        
        Add or update the necessary Solr JNDI configuration entries.
      • Update Name Bindings Configuration.
        Update the following file to reflect the Solr configuration:
        C:\WCDE_V9\wasprofile\config\cells\localhost\nodes\localhost\servers\server1\namebindings.xml
        
        Make sure all relevant references to Solr are correctly set.

      For more information about building the Solr index, see Building the HCL Commerce Search index.

    For Elasticsearch:

    • Issue the following command from within a REST client. POST https://ingestServerHostname:ingestServerPort/connectors/auth.reindex/run?storeId=11 .
    • Authenticate with username spiuser and the correct password:
      • HCL Commerce versions 9.1.0.0 through 9.1.8.0: spiuser / passw0rd.
      • HCL Commerceversion 9.1.9.0 and greater: spiuser / QxV7uCk6RRiwvPVaa4wdD78jaHi2za8ssjneNMdu3vgqi.
    • Replace storeId=11 with your store’s actual ID:
      • AuroraESite: storeId=1
      • AuroraB2BSite: storeId=2
      • Emerald storeId=11
      • Sapphire storeId=12

      OR

      From a command prompt, issue the following command:

      curl --user spiuser:spi_plain_text_password --insecure -X POST "https://ingestServerHostname:ingestServerPort/connectors/auth.reindex/run?storeId=11"
      This call will return a runID value. For example:
      { "runId": "i-26144b4d-cd1c-4679-b2c2-870fc27e6095" }
    • Monitor the indexing progress using.

      GET
      GET https://ingestServerHostname:ingestServerPort/connectors/auth.reindex/runs/[runId]/status 

      OR

      via curl
      curl --user spiuser:spi_plain_text_password --insecure -X GET \
      "https://ingestServerHostname:ingestServerPort/connectors/auth.reindex/runs/[runId]/status"
      
    • Wait until the process is complete.

      The progress percentage is approximate. To view detailed logs, remove /status from the URL in the GET request if issues occur.

What to do next

  1. Verify your search index data.
    • Store data: http://ElasticSearchServerName:30200/auth.store/_search
    • Category data: http://ElasticSearchServerName:30200/auth.storeId.category/_search
    • Product data: http://ElasticSearchServerName:30200/auth.storeId.product/_search
  2. Refresh the workspace and republish the application after the update is completed.
    1. Open HCL Commerce Developer and switch to the Enterprise Explorer view.
    2. In the Explorer view, select all projects and select File > Refresh (or the F5 keyboard shortcut) to refresh the projects in the workspace.
    3. Start or restart the test server
    4. Right-click the test server in the Servers view and select Publish.
    5. Wait for the application to finish publishing and to restart.