Next-generation platform

Downloading the containerized developer toolkit on the next-generation platform

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

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 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 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 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 Inventory Visibility and Store Inventory Management cloud environments. Hence, SIs 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 devtoolkit environment.
  • After extracting, do not alter any value pertaining to the Sterling 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 SIs 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. Note that such an environment is not connected to Sterling 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 the Self Service tool 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 the Self Service tool.
  2. Select the organization.
  3. Click the Self Service menu, and then click Downloads.
    Note: You can download the latest toolkit and any of your environment-specific developer toolkit before selecting your environment.
    1. Click Latest toolkit to download the latest version of the developer toolkit or click Toolkit for <environment> to download an environment-specific developer toolkit.
    2. In the License information page, click I agree to accept the license agreement.
    3. The developer toolkit is downloaded in your local workstation based on your selection.
      • The latest version of the developer toolkit is downloaded as devtoolkit_latest.tar in your local workstation.
      • The developer toolkit for your environment is downloaded as devtoolkit_<runtimeversion_the_env_is_in>.tar in your local workstation.
  4. You can also download the developer toolkit by using the following options.
    1. To download the latest version of the developer toolkit, complete the following steps.
      1. Click Download latest toolkit from your username menu.
      2. In the License information page, click I agree to accept the license agreement.
      3. The latest version of the developer toolkit is downloaded as devtoolkit_latest.tar in your local workstation.

        This developer toolkit corresponds to the latest minor or major version of the runtime image that is released. Your cloud environment can be on this version or a lower version.

    2. To download an environment-specific developer toolkit, complete the following steps.
      1. From the Self Service menu, click Environments.
      2. Select the environment for which you want to download the developer toolkit.
      3. In the Environment details tab, click Download developer toolkit to download the developer toolkit that is specific to your selected environment.
      4. In the License information page, click I agree to accept the license agreement.
      5. The developer toolkit for your environment is downloaded as devtoolkit_<runtimeversion_the_env_is_in>.tar in your local workstation.

        This developer toolkit corresponds to the runtime image for the exact version on which your cloud environment is currently running.

  5. Rename the tar file that you have downloaded 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 pre-existing 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.