Next-generation platform

Downloading the containerized developer toolkit on the next-generation platform

You can download the containerized developer toolkit by using Self Service.

Before you begin

Ensure that your local workstation meets the expected system requirements that are described in the Prerequisites.

If you have downloaded the latest version of the developer toolkit, you can skip this procedure and directly follow the instructions in the Setting up the containerized developer toolkit environment.

Important: Some important points to note related to the usage of devtoolkit_extras.tar file are:
  • The devtoolkit_extras.tar contains information about Sterling™ Intelligent Promising Inventory Visibility and Store Inventory Management tenants on cloud, to which your local developer toolkit connects.
  • The devtoolkit_docker.tar and the devtoolkit_extras.tar files must be in the same directory.
  • These Sterling Intelligent Promising Inventory Visibility and Store Inventory Management tenants are dedicated to your developer toolkit instance. These tenants must not be shared between multiple developer toolkit instances because it can lead to data inconsistency issues in the Sterling Intelligent Promising Inventory Visibility and Store Inventory Management cloud environments. Hence, system integrators and developers are advised not to share a devtoolkit_extras.tar file to set up multiple local developer toolkits, as this can cause functional issues for your developer toolkit environment.
  • After extracting, do not alter any value pertaining to the Sterling Intelligent Promising Inventory Visibility and Store Inventory Management tenants either in the devtoolkit_extras.tar file, or in any of its contents.
  • You are provided only a finite number of devtoolkit_extras.tar files. Hence, you can set up only a finite number of developer toolkit local instances. If you have more system integrators or developers who need access to a developer toolkit instance than the available number of extras files, you can try one of the following workarounds:
    • If you are doing only UI customization development and not functional testing, you can set up a local developer toolkit without downloading or extracting the devtoolkit_extras.tar file. Such an environment is not connected to Sterling Intelligent Promising Inventory Visibility and Store Inventory Management and hence is not an actual reflection of your Sterling Order Management System cloud environments.
    • You can install the developer toolkit in a shared server rather than local workstations, thus allowing multiple developers or SIs to work on the same developer toolkit environment.

About this task

You can download the developer toolkit version from Self Service based on your requirement.
  • Download the latest version of the developer toolkit for testing before you implement it in your environment.
  • Download the environment-specific developer toolkit for your environment.

Procedure

  1. Log in to Self Service.
  2. Select the organization.
    Note: You can download the latest toolkit (for JDK 8) or Preview toolkit (for JDK 21) and any of your environment-specific developer toolkit before selecting your environment. The version of environment-specific developer toolkit is based on whether the environment has been upgraded to JDK 21 or still at JDK 8.
  3. To download the environment-specific version of the developer toolkit, complete the following steps:
    1. Click the Self Service menu, and then click Downloads.
    2. Click Toolkit for <environment> to download an environment-specific developer toolkit.
    3. In the License information page, click I agree to accept the license agreement.
    4. The developer toolkit is downloaded in your local workstation based on your selection.

      The developer toolkit for your environment is downloaded as devtoolkit_<runtimeversion_the_env_is_in>.tar in your local workstation.

      Note: The environment-specific developer toolkit that is downloaded in this step can either be for JDK8 or JDK 21 based on whether the environment has been upgraded or not.
  4. You can also download the developer toolkit for specific versions by using the following options.
    JDK 8 developer toolkit
    To download the latest version of the JDK 8 developer toolkit, complete the following steps.
    1. Click the Self Service menu, and then click Downloads.
    2. Click Download latest toolkit from your username menu.
    3. In the License information page, click I agree to accept the license agreement.
    4. The latest version of the developer toolkit is downloaded as devtoolkit_latest.tar in your local workstation.
    JDK 21 developer toolkit
    To download the latest version of the JDK 21 developer toolkit, complete the following steps.
    1. Click the Self Service menu, and then click Downloads.
    2. Click Download Preview toolkit to download the latest version of the developer toolkit with Java SDK 21.
    3. In the License information page, click I agree to accept the license agreement.
    4. The developer toolkit for your environment is downloaded as devtoolkit_docker_jdk21.tar in your local workstation.
    Important:
    • The version-specific developer toolkit that is downloaded in this step corresponds to the major or minor version of the runtime image that is released.

      Your cloud environment can be on this version or a lower version of the runtime image.

    • You must test your customization code in both JDK 8 and JDK 21 versions of the developer toolkit. The custom codebase must be compatible to run in both the JVM versions.
    • The customization package that is built with a particular version of the developer toolkit must only be deployed on that version of the environment. For example, customization package that is built from the JDK 8 developer toolkit must be deployed only on the JDK 8 environment and the customization package that is built from the JDK 21 developer toolkit must be deployed only on the JDK 21 environment.
  5. Rename the tar file that you have downloaded from the environment-specific or the version-specific developer toolkit to devtoolkit_docker.tar.
  6. If you have downloaded the devtoolkit_extras.tar file previously, you can download the updated devtoolkit_extras.tar file from the same location from where you downloaded it earlier and replace your preexisting devtoolkit_extras.tar with the newly downloaded file.

    If you do not know the location from where to download the devtoolkit_extras.tar, contact your Customer administrator.

What to do next

Set up a containerized developer toolkit environment to build and test the extensions for your IBM Sterling Order Management System solution. For more information, see Setting up the containerized developer toolkit environment.