Skip to content

Latest commit

 

History

History
231 lines (151 loc) · 6.68 KB

generate-deployment-configuration-abap-c06b9cb.md

File metadata and controls

231 lines (151 loc) · 6.68 KB

Generate Deployment Configuration ABAP

ABAP Prerequisites

The deployment to ABAP task allows deploying SAP Fiori applications to SAP systems using the SAPUI5 Repository OData service.

Prerequisites:

  • SAP component SAP_UI 7.53 or higher is installed in your SAP system.

    Note:

    For systems below 7.53, the alternative is to upload the application.

  • Service needs to be enabled and accessible from your development environment (activate and maintain services).

  • For operations on a SAPUI5 ABAP repository, you need the S_DEVELOP authorization.

Limitations

  • The task does not create ABAP transports, therefore, it requires an existing transport if the target ABAP package requires a transport.
  • Basic Authentication (user and password based authentication) is supported for all back-end systems. Additional support for OAuth2 authentication is provided for ABAP systems on SAP Business Technology Platform.

Generation of Deployment Configurations

In order to create deployment configuration, launch the deployment configuration wizard from the Command Palette entry: Fiori: Add Deployment Configuration and chose the SAP Fiori project you would like to configure, or you can launch from the command line using the command: npx fiori add deploy-config while in the required SAP Fiori project folder.

You are prompted for the required information and then the ui5-deploy.yaml file is created based on your input and the content of the existing ui5.yaml file used for preview. In addition to creating the configuration, the create deployment command will also update your package.json file so that you can execute npm run deploy afterwards to deploy your application. See Deployment of Application.

When prompted, add or choose:

Please choose the target

ABAP

Select Target System

Choose a system from your SAP saved systems or provide a Target system URL(VS Code only).

Destination

Choose the deployment destination from list provided (SAP Business Application Studio only).

Enter client

Add a new client or leave as default.

SAPUI5 ABAP Repository

Add a name for the deployed application.

Deployment Description

Add the optional description for the deployed application.

Package

Add a valid package name.

How do you want to enter Transport Request
  • Enter manually: Manually provide the transport request.
  • Choose from existing: The applicable list of transport requests and their description is retrieved from the target system and displayed in a list for you to choose from. If the list of transport requests is unable to be retrieved from the target system, a user must provide the entry manually.
  • Create new: A new transport request is automatically created for use. If the transport request is unable to be created from the target system, the user must provide the entry manually. The generated transport request will have the description: Created by SAP Fiori tools for ABAP repository <repository name>, where <repository name> refers to the name of the deployed application.
  • Create during deployment: The transport request is automatically created the first time the application is deployed. If the transport request is unable to be created from the target system, deployment fails. The generated transport request will have a description: Created by SAP Open UX Tools for ABAP repository <repository name>, where <repository name> refers to the name of the deployed application.

Transport Request

When prompted, either choose a transport request from the list or add a valid transport request.

Example Configuration - ABAP

Executing ui5 build --config ui5-deploy.yaml in your project with the configuration below in a ui5-deploy.yaml file manually added to the project, would deploy all files of your dist folder except files ending with .test.js and the internal.md file. The target system is XYZ with client 200. Username and password for authentication is read from the environment variables XYZ_USER and XYZ_PASSWORD.

Based on this example, the application is created and updated as /TEST/SAMPLE_APP in package /TEST/UPLOAD and all changes is recorded in transport request XYZQ300582.

Sample content of the ui5-deploy.yaml file:

Sample Code:

builder:
  customTasks:
  - name: deploy-to-abap
    afterTask: replaceVersion
    configuration:
      target:
        url: https://XYZ.sap-system.corp:44311
        client: 200
        auth: basic
      credentials:
        username: env:XYZ_USER
        password: env:XYZ_PASSWORD
      app:
        name: /TEST/SAMPLE_APP
        package: /TEST/UPLOAD
        transport: XYZQ300582
      exclude:
      - .*\.test.js
      - internal.md

Example Configuration - Additional Params

For example, you can add additional settings params such as sap-language to your yaml file.

Sample content of the ui5-deploy.yaml file:

Sample Code:

builder:
  customTasks:
  - name: deploy-to-abap
    afterTask: replaceVersion
    configuration:
      target:
        url: https://XYZ.sap-system.corp:44311
        client: 200
        auth: basic
        params: 
          sap-language: en
      credentials:
        username: env:XYZ_USER
        password: env:XYZ_PASSWORD
      app:
        name: /TEST/SAMPLE_APP
        package: /TEST/UPLOAD
        transport: XYZQ300582
      exclude:
      - .*\.test.js
      - internal.md