Installing maintenance

WebSphere Commerce maintenance includes installing fix packs, interim fixes (APARs), and cumulative interim fixes.

Before you begin

Review the following information for a summary of the maintenance installation process; what happens during a maintenance installation, and what you need to do to ensure a successful installation. IBM releases packages for both the WebSphere Commerce Developer (test) and WebSphere Commerce (runtime) environments. Sometimes a fix is only available for one of the environments. If both are available, ensure that you download both versions (Developer and Server). You want your test environment and runtime environment to be synchronized with the same code base. It is recommended that you first update WebSphere Commerce Developer and test to ensure that everything works as expected (including your customizations) before you update your WebSphere Commerce runtime environment.
Note: Some fixes require steps after installation to enable or turn on new behavior that is introduced with the fix. Every maintenance package includes instructions in a *readme.htm file that describes how to install and, if necessary, how to enable the fix. Ensure that you follow the instructions in the *readme.htm.
The following table provides hints and tips for installing and enabling certain fixes.
Maintenance overview table for both WebSphere Commerce Developer and WebSphere Commerce.
WebSphere Commerce Developer WebSphere Commerce
Environment-specific packages Ensure that you install the developer version of the fix onto WebSphere Commerce Developer environments. WebSphere Commerce Developer packages include the text developer in the file name. For example, JR53164.fep_6.0.0.0_developer.zip. Ensure that you install the server version of the fix onto WebSphere Commerce runtime environments. WebSphere Commerce packages include the text server in the file name. For example, JR53164.fep_6.0.0.0_server.zip.
How to install a maintenance package
  • To install a fix pack, use the IBM Installation Manager.
  • To install an interim fix, use the WebSphere Commerce Update Installer.
  • To install a fix pack or interim fix, use the WebSphere Commerce Update Installer.
  • You first need to update the product installation directory, and then update the instance.
Enablement steps after you install a store-related fix To ensure that your store customizations are not overwritten, fixes that update starter store JSP files or widgets are not automatically updated for your published store. Instead:
  • JSP and widget updates are included in the .sar packages under the WCDE_installdir/components/store-enhancements/starterstores/ConsumerDirect/ directory.
  • Development files are updated in WCDE_installdir/workspace/Stores (but no customizable store files are updated here)
To apply store updates to your currently published store, see Enabling store-related interim fixes.
To ensure that your store customizations are not overwritten, fixes that update starter store JSP files or widgets are not automatically updated for your published store. Instead:
  • When you update the product installation directory, JSP and widget updates are included in the .sar packages under the WC_installdir/components/store-enhancements/starterstores/ConsumerDirect/ directory.
  • When you update an instance, JSP and widget updates are included in the .sar packages under the WC_installdir/instances/instance_name/starterstores/ConsumerDirect/ directory.
  • Development files such as java files and configuration files are updated in WC_profiledir/installedApps/WC_instance_name_cell/WC_instance_name.ear.

    Since the EAR file is updated, you need to redeploy all custom assets in the EAR file. For more information, see Deploying customized assets

To apply store updates to your currently published store, see Enabling store-related interim fixes.
Enablement steps after you install a Management Center-related fix Updates to the Management Center framework are automatically applied but you might need to rebuild the OpenLaszlo project to see the changes.
  1. Open WebSphere Commerce Developer.
  2. Open the Enterprise Explorer view. Right-click LOBTools and then click Build OpenLaszlo Project.
  3. Clear browser cache before you launch Management Center.
Updates to the Management Center framework are automatically applied and the installation process recompiles LOBTools for you. If you followed all guidelines on how to extend Management Center, your updates will not be lost so you do not have to redeploy LOBTools. If for some reason you have to redeploy LOBTools, see Packaging Management Center files for deployment.

If you do not see the expected changes to Management Center after you install a fix, try clearing the browser cache and then relaunch Management Center.

Enablement steps after you install a WebSphere Commerce search-related fix Refer to the *readme.htm that is included in the maintenance package that you downloaded. You might need to rebuild the search index (run the di-buildindex utility) or you might need to set up a new search index (run the setupSearchIndex utility). Refer to the *readme.htm that is included in the maintenance package that you downloaded. You might need to rebuild the search index (run the di-buildindex utility) or you might need to set up a new search index (run the setupSearchIndex utility).
Best practices to ensure that your customizations are not overwritten by a maintenance update.
  • Most WebSphere Commerce assets can be customized or extended. Before you customize assets, it is recommended that you refer to IBM tutorials or examples throughout the IBM Knowledge Center. For tutorials, see Tutorials.
  • For Java classes, there is less risk that customizations are overwritten by a maintenance update because extended and customized classes are created in the dedicated *ExtensionData and *ExtensionLogic projects and use unique package names.
  • For assets other than Java assets such as .xml, .tpl, .properties files, WebSphere Commerce provides extension points where you can make your changes. For example, a maintenance update might update the wc-component.xml configuration file. If you want to add custom configurations, ensure that you follow IBM guidelines and create an extended configuration file. Do not directly update the default configuration file. For more information, see Changing properties in the component configuration file (wc-component.xml) (WC EAR).
  • If you must customize a WebSphere Commerce default asset that might get overwritten by a maintenance update, then document the customization. If the file is replaced during a maintenance update, then ensure that the customization is restored.
Refer to the following subtopics for instructions on how to install a maintenance package.