Merging customizations into the latest Order Hub code base

Order Hub enhancements and updates are included as part of the monthly IBM® Sterling™ Order Management System Software release schedule. If you used the customization by code approach to customize any of the files that are changed in the updates, you may want to merge your customizations onto the latest Order Hub code base.

About this task

As an on-premises customer, you determine when to apply a new fix pack to your environment. When you install a new fix pack, it is optional to merge the customizations onto the latest Order Hub code base. The existing customizations work in the upgraded environment, and no changes are required. However, if you customized a route by using the customization by code method, any fixes that IBM implemented in that route are not available in the environment. To have the fixes from IBM included, you need to merge the customizations onto the new code base.

Before you merge customizations, make sure that you complete the following tasks.
  • Review the Order Hub release notes to see the fixes that are included in the fix pack.
  • Decide that you want to apply the fix pack.
  • Review the list of changed files in the Order Hub release notes.
  • Determine whether you used the customization by code approach to customize one or more of the changed files that are included in the fix pack.
  • Apply the fix pack to update your developer environment code to the latest Order Hub code base.
Note: If you created new applications or pages or used the customization by configuration approach, you do not need to take any additional action. The updates do not affect your customizations.
Note: Open source libraries often apply fixes that you want to keep current with. As a best practice, and as IBM modules move to higher Angular versions, periodically check and update the package.json files in the new applications to use the new library versions.

Procedure

  1. Extract the new Order Hub source code.

For on-premises traditional customers
The source code is in <runtime>/repository/orderhub/code/orderhub/on-prem-source.tar.
  1. Create a directory where you want to do the development work. See the following example. 
    mkdir -p orderhub-code/lib
  2. Extract the lib.tar file:
    tar -xf <runtime>/repository/orderhub/code/orderhub/lib.tar --directory=orderhub-code/lib
  3. Extract the on-prem-source.tar file. See the following example.
    tar -xf <runtime>/repository/orderhub/code/orderhub/on-prem-source.tar --directory=orderhub-code
For on-premises container customers
In the updated developer toolkit environment, run the following command to extract the new Order Hub source code.
./om-compose.sh extract-orderhub-code oms

  1. If you customized by using the differential customizations approach, recompile your customizations by copying your customized files to the directory for the Order Hub code. Make sure to follow the existing directory structure. Most of the customized files are in src-custom folders.
  2. If you customized by using the customization by overrides approach, merge your customizations.
    1. Copy your customized files to the directory for Order Hub code, following the existing directory structure. Most of the customized files are in src-custom folders.
    2. Use a comparison tool to identify the differences between your customized files and the new file from IBM. Copy the file that is provided by IBM to the src-custom directory. To implement your customizations, merge your custom files into the new IBM file.
    3. If you customized files that are provided by IBM that are not in the src-custom folder, such as the package.json file, merge your custom changes into the new file that is provided by IBM.
  3. Build the customizations locally. For more information, see Building the customizations.
  4. Test the customizations locally. For more information, see Testing the customizations.
  5. Deploy your customizations. For more information, see Deploying the customizations.