Exporting custom extensions from a developer toolkit environment

You can create and export an extensions.jar archive from your developer toolkit environment at any point. For instance, export extensions when you need to package your customizations for deployment into your environments, or to deploy extensions into another developer toolkit environment, or to back up your extensions.

Procedure

  1. In a command-line utility, go to the runtime/bin directory of your developer toolkit environment.
    Note: In case of containerized developer toolkit, runtime directory is the extracted runtime directory.
  2. Run the following command to create the extensions.jar archive.
    • ./sci_ant.sh -f ../devtoolkit/devtoolkit_extensions.xml export
    This command creates a customization package extensions.jar inside the parent directory of your existing developer toolkit environment file structure.
    Note: If you have customized build.properties files in the bin directory, you must pass the flag -Dincludebuildprops=true in the command while exporting the extensions to include the customized build.properties files.
    As part of the extraction process, the export tool performs certain validations on your customizations to ensure that they conform to the IBM Sterling® Order Management System cloud deployment standards. For more information about the validations that the export tool performs on your customizations, see Validations.

What to do next

Depending on your reasons for exporting your custom extensions, complete one or more of the following tasks:

  • Legacy platformIf you want to deploy the extensions into your IBM Sterling Order Management System environments, transfer the exported package to your drop server and then deploy the package to your IBM Sterling Order Management System environments. After you transfer package to your drop server, the package is imported into the IBM® UrbanCode® Deploy Selfserv tool. You can then use this tool to deploy your custom extensions into your IBM Sterling Order Management System environments. For more information about transferring the package, see Transferring deployable packages to the deployment drop server.
    Next-generation platformTo deploy extensions to your IBM Sterling Order Management System environment, upload the package in Self Service and then select the appropriate package from a list to deploy it to your IBM Sterling Order Management System environment. For more information, see Deploying a package or custom runtime image.
    Important: Always use the developer toolkit environment export capability to create a deployable package. The export process creates the extensions.jar with the file structure that is expected by Self Service or IBM UrbanCode Deploy Selfserv tool. You do not need to manually create a deployable package for the IBM Sterling Order Management System.
    Note: Before you transfer the package, rename your exported package so that you can easily identify the package within Self Service or IBM UrbanCode Deploy Selfserv tool. Use the format your_company_name-package_version.jar. For example, if your company name is mycompany and the packaged extensions are for your release version 42, your package can be named mycompany-42.jar.
  • If you exported your custom extensions to include the extensions within another developer toolkit environment, import the exported JAR archive into the other developer toolkit environment.
  • If you exported your custom extensions to back up your extensions, upload your exported JAR archive into your source code repository. For more information, see the documentation for the tools that you use for working with your repository.