HCL Commerce Developer

Installing HCL Commerce Developer Update Packages (silent method)

To perform a silent installation...

You can perform a silent installation of update packages using IBM Installation Manager by using a response file. This file is generated during an interactive installation and can be reused to automate installations on other machines.

Before you begin

Important:
  • Ensure you update both HCL Commerce and HCL Commerce Developer to the same level.
  • If you are upgrading from an HCL Commerce Version 9.0 to a HCL Commerce Version 9.1 release, you must back up and restore any signer certificates on your HCL Commerce development environments that you want to retain within the WebSphere Application Server trusted store.
  • HCL Commerce Version 9.1.18.0If 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.
Prepare the system
  • Update processes are resource-intensive and may significantly slow down your system.
  • On slower machines, the applyUpdate.bat process may appear to stall at 99% for up to two hours.
  • Close all Java-based applications, Rational Application Developer (RAD), and any configured web servers.
  • Log in with Administrator privileges.
Back up your environment
  • Create a full system backup before generating a response file to avoid file conflicts.
  • Back up all customized assets (for example, JSPs, Management Center files), as updates may overwrite them.
  • Back up your database since updates are permanent. (Refer to the appropriate backup instructions.)
Download the update package
  • Visit the My HCLSoftware portal.
  • Search for the update package by part number. For information about available part numbers, see HCL Commerce releases.
  • Download and extract the package. For example, to update from 9.1.0.0 to 9.1.2.0, download the 9.1.2.0 update package.
Installation process
  1. Create a response file (skip if already available):
    1. In a command prompt, go to the eclipse subdirectory in the directory where you installed IBM Installation Manager.
    2. Run the IBM Installation Manager by using the following commands to create a response file:
      Important: Ensure that you enter a file path that exists. Installation Manager does not create directories for the response file and the log file.
      • To create the response file and install the product:
        IBMIM –record response_file_path
        For example, IBMIM –record C:\WCDE_v9\installresponse.txt.
      The Installation Manager starts.
    3. Complete the installation steps interactively, pointing the repository to the extracted update package.
      The options that you choose while you use the interactive method are recorded in the response file. For more information about using the interactive method, see Installing Update Packages (interactive method).
      Remember: Ensure that you set the repository preferences to the location of the HCL Commerce Developer installation image during the recording of the response file.
    4. Click Finish, then close Installation Manager to save and finalize the response file.
      Note: The response file is generated only after you click Finish and exit Installation Manager.
    5. Revert your system back to the state it was in before you created the response file.
  2. Modify the Response.
    File, response_file_path to the machines that intend to use the file for a silent installation.
    • Copy the recorded response file to the target machine. For example, C:\WCDE_v9\installresponse.txt.
    • Open the target response file in a text editor and update the following:
      • Remove any unnecessary repositories that are in the response file.
      • Modify file paths and settings to reflect the target machine.
  3. Run the silent installation.
    • Navigate to the eclipse\tools directory of Installation Manager on the target machine:cd C:\Program Files\IBM\Installation Manager\eclipse\tools.
    • Run the silent installation: imcl.exe -input C:\WCDE_v9\installresponse.txt -log C:\logs\maintenance_install.log -acceptLicense.

      Ensure that the log directory exists beforehand. For detailed progress, add the -sP flag.

  4. Verify installation.
    • Check for errors in the update log file located at: WCDE_installdir\UpdateDelta\9.1.x.0\applyUpdate.log
      Note: The x values represent the update package level.
Post-installation
  1. Resolve file conflicts.

    After the update is applied, review any file conflicts.

    • Open the merges.log file located at:

      luaCopyEditWCDE_installdir\UpdateDelta\9.1.x.0\backup\merges.log
    • This file lists any files that were modified both by the update and by your customizations.

    • Use a file comparison tool to review and merge differences between the original and updated files.
    • For deleted files, determine whether they are still needed and restore them if necessary.
    • If a compressed archive file (such as a ZIP, JAR, or WAR) was both modified and deleted during the update, it may be incomplete. In such cases, roll back the update, restore the archive, and reapply the update.
  2. Update the Database.
  3. Set the spiuser password.

    Use the setSpiuserPassword utility to set the spiuser password.

    This step is required if you intend to update the spiuser password, or if you use the default spiuser password when updating HCL Commerce Developer from a version prior to 9.1.9.0, to a version that is 9.1.9.0 or greater.

    For more information, see Setting the spiuser password in HCL Commerce Developer.

  4. Set up search

    If you are planning on developing for the Elasticsearch-based search solution, set up your HCL Commerce Developer Search environment.

    For more information, see Setting up the HCL Commerce Developer Search environment.

  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.