@sapse/business-application-studio-extension-management

SAP Business Application Studio Extension Management

@sapse/business-application-studio-extension-management is the CLI used to deploy SAP Business Application Studio extensions to the SAP Business Application Studio Extension Management.

Prerequisites

• A maintained Node.js version.

Installation

Run the following command from the terminal: npm install -g @sapse/business-application-studio-extension-management

Deploying Your Extension from SAP Business Application Studio

When deploying an extension from SAP Business Application Studio, you don't need to enter your dev space credentials or environment. The CLI deploys the extension to your SAP Business Application Studio subaccount if you are logged in. You must have an extension deployer role.

Deploying Your Extension from a Continuous Integration (CI) Environment

When deploying from a CI environment, credentials can be configured using the following environment variables:

• WING_USER
• WING_PASSWORD

Notes

• It is highly recommended to work with a technical user in the CI environment.
• If the user profile requires two-factor authentication, open wex from your SAP Business Application Studio dev space or enter the credentials of a technical user.

Extension File

Create an extension file. For example, you can use the "extension.json" filename:

{
  "apiVersion": "1",
  "name": "extension-test",
  "version": "0.0.1",
  "yeomanPackages": [
    {
      "name": "generator-jhipster",
      "versionRange": "6.2.0"
    }
  ],
  "vscodeExtensions": [
    {
      "name": "vscode-prettier",
      "versionRange": "2.3.5",
      "source": "npm"
    }
  ]
}

Deploy Extension Command

Deploy your extension based on the "extension.json" file:

wex deploy -e <SAP Business Application Studio host>

Deploy a specific extension file:

wex deploy -e <SAP Business Application Studio host> -f <path to extension file>

Deploy with verbose:

wex deploy -e <SAP Business Application Studio host> -f <path to extension file> --verbose

Deploy to your subaccount from your SAP Business Application Studio dev space:

wex deploy -f <path to extension file>