Building a deployable customized runtime component version

As part of deploying a package to add customizations, custom fixes, or other changes to an IBM Sterling® Order Management System, you must build a new deployable customized runtime component version. You can use this new version of the runtime component (OMS-RUNT) for an IBM Sterling Order Management System to update your IBM Sterling Order Management System application to include the extensions and changes within your deployable package.

Before you begin

Ensure that the following conditions are met:

The deployable package conforms to the required technical specifications.
When you build a customized runtime component version with this tool, IBM® UrbanCode® Deploy Selfserv tool uses standardized deployment scripts to apply the changes within your package to the component version. For the IBM UrbanCode Deploy Selfserv tool to use these scripts and successfully deploy changes, your package must conform to the technical specifications.
All functional, system, performance, and user acceptance testing are completed and all test cases are successfully passed.
You have access and login credentials for the IBM UrbanCode Deploy Selfserv tool. You can request access through a service request ticket.

Tip: OMS Custom Runtime Docker image built in one environment, using the Build Customized Runtime self-serve process, can be used to update other IBM Sterling Order Management System environments provided following conditions are met:

All the configurations (including IBMid) are same for both the environments.
There are no environment-specific properties, such as Cognos related properties, in the customer_overrides.properties file.

For example, if IBMid is disabled in both DEV & QA environments and you want to deploy the same version of OMS Custom Runtime image on both the environments, you need to do the following:

Run the Build Customized Runtime self-serve process on the DEV environment to generate a OMS Custom Runtime image with image tag as "client-custompackage-envruntimetag". For example, fvt-noCustomPackage-dev19.1.2_DEV_20190103-0107.
Run the Update OMS Application self-serve process on the QA environment and select the same OMS Custom Runtime image (fvt-noCustomPackage-dev19.1.2_DEV_20190103-0107) that you generated on the DEV environment. The QA environment gets updated with the selected custom image with all the customizations applied and all the applications deployed successfully.

SI users do not have to run Build Customized Runtime self-serve process again on QA environment. They can deploy the same customization package which is already built in the DEV environment and thus save time.

However, if the DEV environment has IBMid enabled and QA does not, using the OMS custom runtime image built in the DEV environment won't work in the QA environment.

Note:

Also, if a non-production customized runtime image is used to update the production environment, the Update OMS Application self-serve process will fail with an error message "Use customized Image built in Production to Update production environment.". This is because certain production environment settings are missed when a OMS custom runtime image is generated using a lower environment is used for updating the production environment.

Therefore, make sure that you always run the Build Customized Runtime self-serve process and use the generated OMS custom runtime image tag to update the production environment.

About this task

When you use the self-service deployment process to build a customized runtime component version that includes customizations or changes from within a deployable package, the process completes the following tasks:

Retrieve a base runtime component version image from the image repository to use as the foundation for building a new customized runtime component version.
Copy any custom assets and code, such as for SaaS extensions, from the deployable package. The process includes these assets and code within the appropriate locations in the customized runtime component version that is being created.
Include assets for deploying any channel applications that need to operate within your customized runtime.
Before building and deploying the customization package, the process checks whether the version of the JAR file that is uploaded matches with the version of the runtime environment in the cloud. Only if the version matches, the process proceeds to the next task. Otherwise, the task fails and the process does not proceed to the next task.
The process failure can occur because of the following reasons:
- Base version of IBM Sterling™ Order Management System Developer Toolkit on the local runtime sandbox is lower than the base version IBM Sterling Order Management System Developer Toolkit on cloud. In such a scenario, the SI must download the latest version of IBM Sterling Order Management System Developer Toolkit and update his existing IBM Sterling Order Management System Developer Toolkit with the same before exporting customization package to cloud.
- Base version of IBM Sterling Order Management System Developer Toolkit on the local runtime sandbox is higher than the base version IBM Sterling Order Management System Developer Toolkit on cloud. This happens only when you are using a preview release of IBM Sterling Order Management System Developer Toolkit, which you have not downloaded from the cloud environment. In such a scenario, the customization packages from local runtime sandbox must be exported to cloud after the cloud environment has been upgraded to the same base version of the IBM Sterling Order Management System Developer Toolkit as the preview release of IBM Sterling Order Management System Developer Toolkit.
An enterprise archive (EAR) file and a light-weight agent are generated for the new customized runtime component version.
Commit the assets and code to create a reusable customize runtime component version that you can deploy to the runtime component for your service within multiple environments. After executing the IBM UrbanCode Deploy Selfserv tool process, the new version of the BCR (Build Customized Runtime) is stored within Urban Code Deploy's CodeStation. When you are ready to update your IBM Sterling Order Management System application, see Update OMS.
Typically, BCR takes approximately 45-50 minutes to complete, if all applications are selected. Once BCR process is successful, you must wait approximately 10 minutes to allow UCD to import the custom runtime image tag created during the BCR process. You can confirm that the import is complete when you choose versions as part of the Update OMS process. If the required version is available, then the import is complete. To avoid the additional step of manually running the Update OMS process, it is recommended that you select Initiate Update OMS as part of the BCR process.

Procedure

Access the IBM UrbanCode Deploy Selfserv tool dashboard.
From the Dashboard tab, click the main Applications tab.
Within the Applications tab, select your Sterling Order Management System application. Then, click the Environments tab for that application.
The Environments tab is the entry point for running processes for an application and displays all of the environments for which you have access for the application.
You can build a customize runtime container for any of the IBM Sterling Order Management System environments that you have access.
Request that a process is to run for the target environment by clicking the Request Process icon for the environment.
The IBM UrbanCode Deploy Selfserv tool displays a window with options for you to specify and configure the process that you want to run.
On the Run Process window, select Build Customized Runtime from the Process menu.
Select or specify values for the following mandatory fields to configure the process:
- Select Choose Versions next to the Versions field to choose the deployable package (build artifact) version that includes extensions and changes that you want to include in the runtime version that you are building. Select a version for the following components that comprise the runtime component:
  - OMS-Custom
    Select a version for the OMS-Custom component when you are including the customization.jar in the runtime component version that you are building.
  Click Add and use the menus to find the version that you want to deploy for a component. After you select the version, click OK.
By default, the Initiate Update OMS option is not selected. In case of nightly builds or if you want to kick start the update OMS process after BCR, select this option when running the Build Customized Runtime process. When BCR completes, Update OMS will be kick started and a user can check the UCD history to see the status of the Update OMS process. If there is an issue with Update OMS, repeat the Update OMS process only. Do not repeat BCR.
Select or specify values for any of the following options to further configure the process:
- Select the Only Changed Versions option to indicate that a chosen version of a deployable package is to be used only when it is new or it is different than the last successfully deployed version. If the chosen package is the same as the last successfully deployed version of the package, the process does not deploy the chosen package into the component version that is being built. The check box is selected by default.
  Clear the check box when you need to deploy a version of package regardless of whether the package was previously deployed. For instance, if you need to redeploy the package. When you clear the check box, the process does not compare the chosen package to the previously deployed package. Instead, the process immediately deploys the chosen package to build the new component version.
- If you need to include the Call Center application in the enterprise archive that is being built for the customized runtime, select the Deploy Call Center application check box.
- If you want to include the Sterling Store application in the enterprise archive that is being built for the customized runtime, select the Deploy Web-based Sterling Store application check box.
- If you want to include the Sterling Field Sales application in the enterprise archive that is being built for the customized runtime, select the Deploy Sterling Field Sales application check box.
Note: Some options that display in the Run Process window might not be used for completing the process that you selected. For instance, when you select to build a customized runtime for the IBM Sterling Order Management System, the following options are not used. Do not select or specify values for these options.
- Snapshot
- Schedule Deployment
- Description
Click Submit to run the process with your selected options.
The process begins and the Progress Execution log screen displays for you to view the progress and status of the process and of any subprocesses. You can use this view to see all of the sub-processes that are running to complete the overall process. You can also view the logs for the processes when you need to complete any troubleshooting.
The IBM UrbanCode Deploy Selfserv tool logs every action that you complete at all levels of an application to assist with troubleshooting.

What to do next

Deploy the newly built customized runtime component version to the appropriate environments to complete deploying your customizations and changes to your IBM Sterling Order Management System application. For more information, see Deploying a customized runtime to an IBM Sterling Order Management System application with the IBM UrbanCode Deploy Selfserv tool