Next-generation platform

Deploying customizations

After you upload a customization package in Self Service, you can use the command-line interface to deploy customization packages to your environments.

Note: In older environments, you can use the --upgrade flag to specify whether you want to upgrade to the latest or second-latest version.

Procedure

  1. Run the following command and provide the name of the package that was previously uploaded in Self Service.
    ssctl customization deploy
    Note: You can use this command to deploy only those customization packages that are uploaded in Self Service. You cannot deploy a customization package that is available in your local system.
  2. If you are using a configuration file, set the --config argument, and then point it to your configuration file.
  3. If you are not using a configuration file, ensure that you set the --token, --tenant-code, and --environment-name arguments.
    Note: Steps 2 and 3 are required only if the token and the tenantCode are not set in the myconfig.json file.
  4. If you have a customization package such as myfile.jar that is already uploaded in Self Service, use the following command to deploy it in your environment such as the development environment.
    ssctl customization deploy --customization-file myfile.jar --environment-name dev-1 --config myconfig.json

Results

The command exits with a return code, which indicates success or failure of the deployment. A nonzero exit code from ssctl indicates an error while deploying the customization package.