Legacy platform

Deploying a customized runtime to an IBM Sterling Order Management System application with the IBM UrbanCode Deploy Selfserv tool

To update an IBM Sterling® Order Management System application to include customizations or other changes, you must use the IBM® UrbanCode® Deploy Selfserv tool to deploy a customized runtime to the application. This customized runtime must include the customizations and changes that you want to update your application to include.

With the IBM UrbanCode Deploy Selfserv tool, you can deploy a customized runtime component version to apply customizations or other changes within your development environment, master configuration, quality assurance environment, and preproduction environment.

Before you begin

Ensure that the following conditions are met:
  • You have access and login credentials for the IBM UrbanCode Deploy Selfserv tool. You can request access through a service request ticket.
  • No outstanding severity 1 or severity 2 defects exist for your target deployment environment.
  • The customizations or changes that you want to deploy are included in an available customized runtime component version. For more information about building a customized runtime to include your customizations or other changes, see Building a deployable customized runtime component version.
Tip: OMS Custom Runtime Docker image built in one environment, by 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 complete the following steps:
  • Run the Build Customized Runtime self-serve process on the DEV environment to generate an 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 that are 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 IBMid is enabled in the DEV environment and it is not enabled in the QA environment, the OMS custom runtime image that is built in the DEV environment cannot be deployed 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 fails with an error message "Use customized Image built in Production to Update production environment.". This error is thrown because certain production environment settings are missed when a OMS custom runtime image is generated by 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 run the process to update an application by deploying a customized runtime for the application, the update process completes the following actions:
  1. Stops and removes the currently deployed runtime component for the application.
  2. Retrieve the customized runtime component version to be deployed from the image repository in CodeStation.
  3. Start a new runtime component that is based on the retrieved component version.
  4. Run the entity deployer and load the factory set-up.
  5. Deploy the updated enterprise archive (EAR) file for the application.
  6. Stop and remove the agent and integration servers.
  7. Retrieve the customized runtime component version to be deployed from the image repository in CodeStation.
  8. Start new agent and integration servers that are based on the retrieved version.
Depending on which environment you are updating, the deployment process to update an IBM Sterling Order Management System application uses a different process:
  • When you are updating the development environment, master configuration, or quality assurance environment, a single server is used to deploy all components. The deployment, or update, process stops your application servers, completes any required updates, and then restarts the servers.
  • When you are updating the preproduction environment or updating the production environment before your site launches, the process uses multiple servers. The process to update components is split over multiple servers to improve performance and to allow a rolling restart of servers to keep the application available for the environment.
Updating the application does not require downtime as the database and message queues are not stopped during deployment for the application server, agent server, and integration server to be updated.

Procedure

  1. Access the IBM UrbanCode Deploy Selfserv tool dashboard.
  2. From the Dashboard tab, click the main Applications tab.
  3. Within the Applications tab, select your IBM 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 update the application to deploy changes for any of the IBM Sterling Order Management System environments that you have access. You can also deploy changes specifically for the master configuration.

    You can expand the collapsible section for each environment to view details about which components are available in the environment and the version that is deployed for each component.

  4. Request that a process is to run for the target environment by clicking the Image that shows the Request Process button. 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.
  5. On the Run Process window, select Update OMS Application from the Process menu.
    Image that shows the Run Process dialog and Update OMS Application process selection.
  6. Select or specify values for the following mandatory fields to configure the process:
    • Select Choose Versions next to the Versions field to choose the customized runtime component version that you want to deploy for the runtime (OMS-RUNT) component.

      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.

      If you have multiple versions available, you can use the Select For All menu to filter the list of versions that display in the Versions to Deploy column. You can also select either of the following check boxes to further change the list of versions that you can select:
      • Select the Show only changed components check box to show only versions that are created more recently than the version that is deployed for the runtime component. The more recent version must also pass the environment gates for the application.
      • Select the Allow invalid versions check box to allow you to select a version even if the version does not have the status that is required to deploy the version to the selected environment.
  7. Select the Restart agent / integration servers after update option, if you want to (re)start previously running agents or integration servers after the update. If you leave the option unselected, no agents or integration servers are automatically started and you have to manually start them using the "Start" processes. By default, the option is not selected.
  8. 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 customized runtime component is to be used only when it is new or it is different than the last successfully deployed version. If the chosen version is the same as the last successfully deployed version of the package, the process does not deploy the chosen version. The check box is selected by default.

      Clear the check box when you need to deploy a version regardless of whether the version 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 version to the previously deployed version. Instead, the process immediately deploys the chosen version.

    • If you want to schedule a deployment instead of deploying the specified version immediately, select Schedule Deployment and configure when you want to deploy the changes.
    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 run an update process, the following options are not used. Do not select or specify a value for these options:
    • Snapshot
    • Description
  9. 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 tool logs every action that you complete at all levels of an application to assist with troubleshooting.