HCL Commerce Developer

Installing Update Packages for HCL Commerce Developer (interactive method)

You can install HCL Commerce Developer Update Packages by using the IBM Installation Manager that you used to install HCL Commerce Developer. Ensure that you test your environment after installation. Update Packages contain fixes that correct known problems, so updating might prevent you from having to place a service call. Before you update, review the following information.

Before you begin

Important:
  • Ensure that you update both HCL Commerce and HCL Commerce Developer to the same level.
  • Installing or updating the product to a later version is a processor and memory intensive operation. Your machine can become unresponsive for extended periods of time, during which you may observe applyUpdate.bat consuming large amounts of system resources.
    Note: Allow sufficient time for the install or update process to complete as the applyUpdate.bat progress indicator can remain at 99% for up to two hours on less powerful machines.
  • Stop any Java applications that are running on your machine.
  • Ensure that Rational Application Developer is not running.
  • Disable any Web server that you configured on your machine.
  • Log in to Windows as a user with Administrator privileges.
  • If you do not have the Update Package, download and extract the Update Package that you want to install.
    1. Log in to HCL License and Delivery portal.
    2. Search for the Update Package by part number. For information about available part numbers, see HCL Commerce releases.
      Note: The Update Package can update to the target version from any previous version. For example, if you are on 9.0.0.0 and want to update to 9.0.0.2, you only need to download the 9.0.0.2 Update Package.
    3. Download and extract the package.
  • Back up any customized files.

    Many files are updated. Files that might be changed include the JSP files for starter stores and HCL Commerce Accelerator, files for Management Center, and more. Back up files in case you need to reapply any customizations.

  • Back up your database. The database updates that are included in this update cannot be undone. If you want to undo the database update, you must restore your database from a back up. For more information about how to back up, see BACKUP DATABASE COMMAND.

Procedure

  1. Open Installation Manager.
  2. Add the HCL Commerce Developer Update Package repository location to the Installation Manager:
    1. On the Start page of Installation Manager, click File > Preferences, and then click Repositories.
      The Repositories page opens, showing any available repositories, their locations, and whether they are connected.
    2. On the Repositories page, click Add Repository.
    3. In the Add Repository dialog box, click Browse. Navigate to the location of your HCL Commerce Developer Update Package directory, select the repository.config file, then click OK.
      The new repository location is listed.
    4. Click Test Connections to ensure that the Repository URL is available.
    5. Optional: If you want to save your current HCL Commerce Developer state as a back up before you install the update, then complete the following steps:
      1. On the Start page of Installation Manager, click File > >Preferences > Files for Rollback.
      2. Select Save files for rollback.
  3. From the Start page, click Update.
    The Installation Manager searches its defined repositories for available packages.
  4. Select the HCL Commerce Developer package and click Next.
    The Update packages wizard detects all of the applicable fixes. Recommended features are automatically selected.
  5. Select the updates that you want to apply and click Next.
    The update is automatically preselected.
  6. Click Next.
  7. Accept the license agreement and click Next.
    The Select the features to install panel is displayed. The feature is automatically selected.
  8. Click Next.
  9. Review the summary information and click Update to install the updates.
  10. Optional: Review the installation history by selecting File > Installation History
  11. Check for any issues in the WCDE_installdir\UpdateDelta\9.0.x.y\applyUpdate.log file.
    • The x and y values represent the Update Package level.
  12. Merge files as needed.
    If any files were added, updated or removed by the developer since the last installation, and also added, updated or removed by the update, these files are recorded during the process.
    1. Check for any issues in the WCDE_installdir\UpdateDelta\9.0.x.y\backup\merges.log file.
      Note:
      • All files that overlap with changes in the Update Package are backed up to the WCDE_installdir\UpdateDelta\9.0.x.y\backup directory before making any changes to your workspace. However, only the files that require review after installation are recorded in the merges.log.
      • It is possible that some files that are updated might have paths or information that is specific to your environment after installation. In these cases, the replacement file will contain an updated template version of the file, before any variables are replaced. You must manually merge these files, replacing the variables in the updated file with the values from the backup version of the file to ensure that your environment continues to function correctly.
    2. For each pair of files in merges.log, compare the original version with the updated version using a text file comparison tool.
    3. For each file that was described as deleted by the update process, review the original version to determine if it is still needed and make appropriate changes.
    4. If you deleted a compressed archive (ZIP, JAR, WAR) and the update process modifies that archive, the archive is recreated by the update process, but will only contain the changed files in the archive so it will be incomplete. In this case a warning is written to merges.log, recommending to rollback, restore the original archives, and reapply the update. For this reason, it is recommended that you do not delete any compressed archives, even if they are not used.
  13. Update the database to the latest HCL Commerce database schema.
    1. Back up the database.
      You need to back up because if you ever uninstall an update, you need to also restore the database to the earlier version. For more information about how to back up, see BACKUP DATABASE COMMAND.
    2. HCL Commerce Version 9.0.0.2Update the wcs.9.0.0.2.bootstrap.xml file.
      HCL is aware of an issue with an XML file in the Version 9.0.0.2 Update Package that causes the updatedb utility to fail. The fix will be resolved in the next update. Complete the following steps to immediately fix the issue and finish the update to Version 9.0.0.2.
      1. Open the WCDE_installdir/schema/data/xml/9.0.0/wcs.9.0.0.2.bootstrap.xml file for editing.
      2. Wrap the contents of the file with <import> </import>.
      3. Save the file.
    3. Run the updatedb utility to update your database.
  14. Configure the development database.
    Use the setdbtype utility to update the configuration of the development environment database.
    For more information, see Changing the development database type by using the setdbtype command.
    Important: This step is required when updating an existing HCL Commerce development environment.
  15. Set the spiuser password.

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

  16. HCL Commerce Version 9.0.0.5 or later Rebuild the search index by following these steps.
    Using Apache Solr as your search solution:
    1. Open HCL Commerce Developer in the RAD environment.
    2. Expand WebSphere Applicaton Server Liberty Profile > Servers > searchServer > resources > search > index, and delete managed-solr and solr folders.
    3. Start the Transaction server and Search server, and build the Solr search index.

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

What to do next

  1. Verify your search index data.
  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. HCL Commerce Version 9.0.0.1 only(Optional) If you enabled workspaces in HCL Commerce Developer Version 9.0.0.0 and you just installed Version 9.0.0.1, complete the following steps for workspaces to function in 9.0.0.1.
      1. Open the Administration console, and go to Application Server > server > Process definition > Java Virtual Machine. server is the name of your server, and the default value is server1.
      2. In the Generic JVM argument field of the Configuration tab, add the following string.
        -DWorkspaceTaskListEnabled=true
      3. Save your changes to the master configuration.
    4. Start or restart the test server
    5. Right-click the test server in the Servers view and select Publish.
    6. Wait for the application to finish publishing and to restart.