You are on page 1of 178

2/6/2024

SAP Business Application Studio


Generated on: 2024-02-06 09:28:22 GMT+0000

SAP Business Application Studio | Cloud

PUBLIC

Original content: https://help.sap.com/docs/SAP Business Application Studio/9d1db9835307451daa8c930fbd9ab264?


locale=en-US&state=PRODUCTION&version=Cloud

Warning

This document has been generated from the SAP Help Portal and is an incomplete version of the official SAP product
documentation. The information included in custom documentation may not re ect the arrangement of topics in the SAP Help
Portal, and may be missing important aspects and/or correlations to other topics. For this reason, it is not for productive use.

For more information, please visit the https://help.sap.com/docs/disclaimer.

This is custom documentation. For more information, please visit the SAP Help Portal 1
2/6/2024

What Is SAP Business Application Studio?


SAP Business Application Studio is a new SAP Business Technology Platform (SAP BTP) service that offers a modern
development environment tailored for efficient development of business applications for the SAP Intelligent Enterprise.

SAP Business Application Studio is based on Code-OSS, an open source used for building Visual Studio Code. Available as a
cloud service, SAP Business Application Studio provides a desktop-like experience similar to leading IDEs, with command line
and optimized editors. At the heart of SAP Business Application Studio are the dev spaces. The dev spaces are comparable to
isolated virtual machines in the cloud containing tailored tools and preinstalled runtimes per business scenario, such as SAP
Fiori, SAP S/4HANA extensions, Work ow, Mobile and more. This simpli es and saves time in setting up your development
environment and allows you to efficiently develop, test, build, and run your solution locally or in the cloud.

 Tip
The English version of this guide is open for contributions and feedback using GitHub. This allows you to get in contact with
responsible authors of SAP Help Portal pages and the development team to discuss documentation-related issues. To
contribute to this guide, or to provide feedback, choose the corresponding option on SAP Help Portal:

Edit: Contribute to a documentation page. This option opens a pull request on GitHub.

Feedback: Provide feedback about a documentation page. This option opens an issue on GitHub.

You need a GitHub account to use these options. For more information, see the introduction video .

Scenarios
SAP Business Application Studio provides a tailor-made development environment for various development scenarios, such as
SAP Fiori, SAP S/4HANA extension, and Work ow. With each of these scenarios, you can create different types of applications.

In the Dev Space Types section, you can learn about each scenario.

Capabilities
In SAP Business Application Studio, you are provided with one or more dev spaces. A dev space is a development environment
with all the tools, capabilities, and resources needed for developing your application. Each type of application requires a
different development environment. Based on the type of application that you choose to build, you're provided with a different
set of tools. You can add additional tools to supplement the application with additional extensions for the scenario.

The dev space is an isolated development environment providing a local-like development experience. Among other tools, it
provides terminal access to the le system so that you can run various commands. You can test-run your application in the dev
space itself without deploying to the target runtime (Cloud Foundry), almost as if you were working on your own desktop.

Unlike other desktop IDEs, SAP Business Application Studio is equipped with various tools specially built for developing business
applications in the SAP ecosystem.

These tools cover the end-to-end development cycle:

Clone an existing project with a Git client or create a new project using templates.

Use editors for SAP-speci c technologies.

Easily test your application on your dev space while consuming services from remote sources.

Build and deploy the application as a multitarget application (MTA).

This is custom documentation. For more information, please visit the SAP Help Portal 2
2/6/2024

Availability
The following browsers are supported for working in SAP Business Application Studio. Additional browsers will be added over
time.

 Note
Unless speci cally stated, only the latest browser version is supported.

Mozilla Firefox

Google Chrome

Microsoft Edge

You can nd the regions where SAP Business Application Studio is available in the Pricing tab of the SAP Discovery Center .

What's New for SAP Business Application Studio


Technical Environment Title Description Action Lifecycle
Component

SAP Cloud Development You can now access the most used functions from the Quick Info General
Business Foundry Experience Access bar in the Storyboard. See Storyboard. only Availabili
Application
If the Quick Access bar is not visible in the Storyboard view,
Studio
make sure it has not been hidden by another view.

SAP Cloud Development You can now access the most used functions from the Quick Info General
Business Foundry Experience Access bar in the Explorer view. See Explorer. only Availabili
Application
Studio

This is custom documentation. For more information, please visit the SAP Help Portal 3
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud Development New Code-OSS features have been released. You can learn about Info General
Business Foundry Experience these features in the release notes for VS Code 1.84.. See VS only Availabili
Application Code Updates .
Studio

SAP Cloud Service Center You can now add a service to an SAP Fiori project with a UI from Info General
Business Foundry the Service Center. See SAP System Service Provider. only Availabili
Application
Studio

SAP Cloud Calculation Views In the calculation view editor in the SAP HANA Native Application Info General
Business Foundry extension for SAP Business Application Studio, when you add or only Availabili
Application delete columns in a calculation view, you can now propagate
Studio these changes recursively to dependent views. This is
particularly bene cial in stacked scenarios for maintaining
consistency across the views. See Propagate Adding and
Deleting Columns to Dependent Views.

SAP Cloud Calculation Views In the calculation view editor in the SAP HANA Native Application Info General
Business Foundry extension for SAP Business Application Studio, for greater only Availabili
Application exibility when maintaining labels for column names, you can
Studio now generate labels automatically using SQL expressions. For
example, convert the column name to lower case and add a
pre x. See Assign Labels to Columns.

SAP Cloud Calculation Views In the calculation view editor in the SAP HANA Native Application Info General
Business Foundry extension for SAP Business Application Studio, the Where Used only Availabili
Application dialog now also lets you check for dependencies across HDI
Studio containers. See Where-Used Functionality.

SAP Cloud Calculation Views In the calculation view editor in the SAP HANA Native Application Info General
Business Foundry extension for SAP Business Application Studio, lter mapping is only Availabili
Application now also supported for non-equi joins. See Map Filters Between
Studio Join Partners.

SAP Cloud Calculation Views In the calculation view editor in the SAP HANA Native Application Info General
Business Foundry extension for SAP Business Application Studio, you can now use only Availabili
Application a Refresh button to reload the data sources in an already
Studio opened calculation view. Previously, when modi ed data sources
were redeployed, you had to reopen the editor to retrieve the
updated information. See Refreshing Data Sources.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, you can use the new lter feature in the only Availabili
Application Tooling dependency viewer in SAP HANA Database Explorer to hide
Studio selected object types. See View Database Objects with the
Database Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, the refresh button in the dependency viewer only Availabili
Application Tooling in SAP HANA Database Explorer now retrieves data stored in
Studio cache to improve performance. See View Database Objects with
the Database Explorer.

This is custom documentation. For more information, please visit the SAP Help Portal 4
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, the SAP HANA Database Explorer now only Availabili
Application Tooling enables you to generate the SQL statement used to insert the
Studio database object into the database and display the statement in
a new SQL console, where you can run the INSERT statement and
view the results. See View Database Objects with the Database
Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, the dependency viewer in SAP HANA only Availabili
Application Tooling Database Explorer now enables you to view the metadata for the
Studio objects displayed in a dependency graph. See View Database
Objects with the Database Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, the dependency viewer in SAP HANA only Availabili
Application Tooling Database Explorer now allows you to expand and collapse a
Studio dependency graph. See View Database Objects with the
Database Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, the SAP HANA Project Explorer now provides only Availabili
Application Tooling a Wizard that guides you through the process of creating a new
Studio instance of an HDI container service. See Create an HDI-
Container Service Instance.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, a new Wizard guides you through the process only Availabili
Application Tooling of granting HDI privileges on schemas in an HDI container. See
Studio Grant HDI-Container Schema Privileges to a Selected User or
User Role.

SAP Cloud Service Center When working in a Full Stack Cloud Application or a Full-Stack Info General
Business Foundry Application Using Productivity Tools dev space, you can now only Availabili
Application explore SAP S/4HANA Cloud events that are published from the
Studio Uni ed Customer Landscape. You can also add events to your
project from the Service Center and then consume them. See
Add SAP S/4HANA or SAP S/4HANA Cloud Events.

SAP Cloud Development The following Java extensions have been upgraded: Info General
Business Foundry Experience Language support for Java for VS Code only Availabili
Application
Java debugger
Studio
Spring Tools 4

Java test support

Project manager for Java

 Note
As a result of this upgrade, next time you open your dev
space, you will be prompted to install the Dependency
Analytics extension. We recommend you select Never (since
this extension is not supported by SAP Business Application
Studio).

This is custom documentation. For more information, please visit the SAP Help Portal 5
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud Development New Code-OSS features have been released. Info General
Business Foundry Experience You can learn about these features in the release notes for VS only Availabili
Application Code 1.83. See VS Code Updates .
Studio

SAP Cloud Development We have upgraded the Python extension to use the newest Info General
Business Foundry Experience Python version. only Availabili
Application
 Note
Studio
This upgrade might require you to update the libraries you
installed in your project.

SAP Cloud Development SAP Business Application Studio now uses asdf to select which Info General
Business Foundry Experience Node.js and Java runtime versions to install and use for only Availabili
Application developing your application. As part of this change, only one
Studio Java and Node.js version is installed by default, and officially
supported in SAP Business Application Studio.

The change will affect all dev spaces. See Runtime Version
Management.

SAP Cloud Development SAP Business Application Studio now scans your Running dev Info General
Business Foundry Experience spaces for malware every 10 minutes. See Detect Malware in the only Availabili
Application Dev Spaces.
Studio

SAP Cloud Git You can now use OAuth to authenticate your GitHub user. Info General
Business Foundry only Availabili
See Enabling OAuth in GitHub Enterprise.
Application
Studio

SAP Cloud Development New Code-OSS features have been released. Info General
Business Foundry Experience You can learn about these features in the release notes for VS only Availabili
Application Code 1.82. See VS Code Updates .
Studio

SAP Cloud Development You can now enable the Docker Image Builder extension to build Info General
Business Foundry Experience docker images. It supports build, login, and push commands. only Availabili
Application
Studio  Note
The image is not persistent.

See Additional Extensions.

SAP Cloud Development with If you have a subscription to SAP Build, you can now enable your Info General
Business Foundry Productivity Tools project’s service destinations to be discoverable for only Availabili
Application consumption in SAP Build product. See Enable Discovery to SAP
Studio Build.

SAP Cloud Development A new tool will be introduced that will allow users to instal their Info General
Business Foundry Experience own version of Node.js and Java runtime. only Availabili
Application
As part of this change, only 1 Java and Node.js version will be
Studio
installed by default, and will be officially supported in SAP
Business Application Studio.

The default versions installed will be Node.js 18 and Java 17.


Other versions can still be installed by the user.

This is custom documentation. For more information, please visit the SAP Help Portal 6
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, it is now possible to use the artifact-creation only Availabili
Application Tooling Wizard to generate enterprise-search con guration
Studio (.hdbeshconfig) artifacts. See Enterprise Search
Con gurations (.hdbeshcon g).

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, it is now possible to use the SAP HANA only Availabili
Application Tooling Projects Explorer to delete a database connection. See Bind
Studio Applications to Database Services with SAP HANA Projects
Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, it is now possible to use the SAP HANA only Availabili
Application Tooling Database Explorer to bind new database connections to
Studio application-managed service instances. See Bind an Application
to a Service Managed by the Service Manager.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, it is now possible to use the SAP HANA only Availabili
Application Tooling Database Explorer to visualize the connections between
Studio database objects with the dependency viewer. See View
Database Objects with the Database Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, it is now possible to use the SAP HANA only Availabili
Application Tooling Database Explorer to view the metadata of procedures and
Studio functions in the catalog browser. See View Database Objects
with the Database Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, it is now possible to con gure a user only Availabili
Application Tooling preference to set the maximum size of a large object (LOB)
Studio displayed in the SAP HANA Database Explorer . See User
Preferences for SAP HANA Native Application Development
Tools.

SAP Cloud Calculation Views You can now change the order and sequence of data sources in Info General
Business Foundry nodes that support multiple data sources. See Changing the only Availabili
Application Sequence of Data Sources in Nodes.
Studio

SAP Cloud Calculation Views You can now change the order and sequence of elements Info General
Business Foundry (columns, parameters, etc.) in calculation views, for example, in only Availabili
Application the Mapping pane, the Calculated Columns pane, the Restricted
Studio Columns panes, and the Snapshots pane. See Changing the
Sequence of Elements.

SAP Cloud Calculation Views In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Application Studio the calculation-view editor now enables you only Availabili
Application to generate multidimensional statements (MDS) data and de ne
Studio an MDS cube on a calculation view. See De ne an MDS Cube
Based on Elements in a Calculation View.

SAP Cloud Calculation Views In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Application Studio the calculation-view editor now enables you only Availabili
Application to see where objects are used and what the impact and
Studio dependencies are. See Checking Object Dependencies and
Where Used Functionality.

This is custom documentation. For more information, please visit the SAP Help Portal 7
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud Calculation Views In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Application Studio the calculation-view editor now enables you only Availabili
Application to dispay a list of output parameters in the user-de ned function
Studio (UDF) tab of the expressions editor. See Checking Object
Dependencies.

SAP Cloud Calculation Views In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Application Studio the calculation-view editor now enables you only Availabili
Application to select speci c T009/T009B tables (or synonyms pointing to
Studio T009/T009B tables) when generating scal time-table data.
See Create Time-Related Tables and Generate Time Data.

SAP Cloud Calculation Views In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Application Studio the calculation-view editor now enables you only Availabili
Application to con gure lter mapping in the same way as you con gure join
Studio mapping. See Map Filters Between Join Partners.

SAP Cloud Calculation Views In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Application Studio the calculation-view editor now enables you only Availabili
Application to rename and refactor calculation views and propagate the
Studio changes recursively through consuming views. See Renaming
and Refactoring Calculation Views.

SAP Cloud Development with When working in a Full-Stack Application Using Productivity Info General
Business Foundry Productivity Tools Tools dev space, you can now enable your project’s service only Availabili
Application destinations to be discoverable for consumption in SAP Build
Studio products, such as SAP Build Apps and SAP Process Automation.
See Enable Discovery to SAP Build.

SAP Cloud Development with When working in a Full-Stack Application Using Productivity Info General
Business Foundry Productivity Tools Tools dev space, you can now share your deployed multitenant only Availabili
Application application with others by subscribing to the application and
Studio then sending the destination to them. This update provides
automation for multitenant application subscription, with routes
created and mapped automatically. See Enable SaaS in Your
Application in the Guide Center.

SAP Cloud Service Center You can now add an SAP Business One system to your SAP Info General
Business Foundry Business Application Studio subaccount from the Service only Availabili
Application Center. See SAP System Service Provider.
Studio

SAP Cloud Extension Project You can now create an SAPUI5 extension project to extend a Info General
Business Foundry legacy SAP Fiori application from an on-premise ABAP system. only Availabili
Application See Create the Project.
Studio

SAP Cloud Security Security recommendations for SAP Business Application Studio Info General
Business Foundry Recommendations are now available to help you to secure its con guration and only Availabili
Application operation in your landscape. For more information, see SAP BTP
Studio Security Recommendations.

SAP Cloud Development New Code-OSS features have been released. Info General
Business Foundry Experience only Availabili
More help when editor is readonly
Application
Studio With the introduction of readonly mode in VS Code
last milestone, editors can be readonly due to
workspace con guration.

This is custom documentation. For more information, please visit the SAP Help Portal 8
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

This milestone, we enhanced the noti cation message in


the editor when you try to type in a readonly editor and in
some cases provide a link to change the
files.readonly settings.

Editor group split sizing changed to 'auto'

A new value for the


workbench.editor.splitSizing setting called
auto is the new default. In this mode, splitting an editor
group distributes the available size evenly to all editor
groups only if none of the editor groups has been
resized. Otherwise, the space of the split editor group is
divided in half and placed in the new editor group.

The intent of this change is to not break layouts that you


have created when you split, but still preserve the
previous default behavior of distributing the size evenly
otherwise.

Resizable content hover

It is now possible to resize the content hover control. You


can hover over the control borders and drag the sashes
to change the size of the hover.

Terminal - Image Support

Images in the terminal, which were previewed last


release, are now enabled by default. Images in a terminal
typically work by encoding the image pixel data as text,
which is written to the terminal via a special escape
sequence. The current protocols supported are sixel
and the inline images protocol pioneered by iTerm.

To test images manually, you can download and cat a


.six example le from the libsixel repository .

This feature can be disabled by setting:

"terminal.integrated.enableImages": false

Testing - Terminal output support

Previously, test output shown in the Test Results view


would always be shown in an embedded text editor. This
stripped it of rich styling such as colors, styles, and
symbols it may have had when run in a terminal. In this
release, we show output in a real xterm.js terminal.

Now that the Test Results view is fully featured, the


commands to Show Test Output have been redirected
to open the Test Results view instead of creating a
temporary terminal.

This list is based on the VS Code Updates document.

SAP Cloud Development SAP Business Application Studio now supports Info General
Business Foundry Experience `login.cf.sap.hana.ondemand.com` as a trusted domain, only Availabili
Application including the cf endpoint links.
Studio

This is custom documentation. For more information, please visit the SAP Help Portal 9
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, it is now possible to change the sequence of only Availabili
Application Tooling data sources in nodes. See SAP HANA Developer Guide for XS
Studio Advanced Model (SAP Business App Studio).

SAP Cloud Development JAVA 17 is now the default Java version for SAP Business Info General
Business Foundry Experience Application Studio. You can manually change the default version only Availabili
Application from the command pallete.
Studio
Open the command palette and select JAVA Set Default JDK.

SAP Cloud Service Center When working in a Full Stack Cloud Application or a Full-Stack Info General
Business Foundry Application Using Productivity Tools dev space, you can now only Availabili
Application add SAP S/4HANA or SAP S/4HANA Cloud events to your
Studio project from the Service Center and then consume them. See
Add SAP S/4HANA or SAP S/4HANA Cloud Events.

SAP Cloud Development You can now enable the Python Tools extension to improve your Info General
Business Foundry Experience Python coding experience. only Availabili
Application
Studio

SAP Cloud Development with When working in a Full-Stack Application Using Productivity Info General
Business Foundry Productivity Tools Tools dev space, you can now create a multitenant (SaaS) only Availabili
Application application, which you can share among several consumer
Studio subaccounts within your SAP BTP global account. See Enabling
Multitenancy.

SAP Cloud MTA You can now select a speci c MTA extension le for deployment. Info General
Business Foundry See Building and Deploying Multitarget Applications. only Availabili
Application
Studio

SAP Cloud Storyboard When working in an SAP Fiori dev space, you can now use the Info General
Business Foundry storyboard to trigger the graphical editors and other tools only Availabili
Application required to develop an SAP Fiori elements application. See
Studio Storyboard.

SAP Cloud Calculation Views You can now choose which display option is started by Data Info General
Business Foundry Preview: only Availabili
Application
Analysis (default)
Studio
Raw Data

See Con guring Data Preview Behavior.

SAP Cloud Calculation Views You can now open the SQL Editor from the context menu of the Info General
Business Foundry calculation view nodes. See Preview Calculation View Output. only Availabili
Application
Studio

SAP Cloud Calculation Views User-de ned functions are now permitted in non-equi-join Info General
Business Foundry expressions, data masking expressions, and restricted columns. only Availabili
Application See User-De ned Functions.
Studio

This is custom documentation. For more information, please visit the SAP Help Portal 10
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud Calculation Views You can now specify start and end times for application-time- Info General
Business Foundry period tables. See Add System Time and Application Time. only Availabili
Application
Studio

SAP Cloud Calculation Views You can now add objects to calculation views based on Info General
Business Foundry associations, and also add objects with join information. See only Availabili
Application Add Objects Based on Association.
Studio

SAP Cloud Calculation Views Optimize join columns are now supported for non-equi-joins. See Info General
Business Foundry Optimize Join Execution. only Availabili
Application
Studio

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, it is now possible to lter by name the list of only Availabili
Application Tooling objects displayed in the CATALOG pane of the embedded SAP
Studio HANA Database Explorer. See View Database Objects with the
Database Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, use the SAP HANA Project Explorer to bind only Availabili
Application Tooling an application to a service managed by the Service Manager.
Studio See Bind an Application to a Service Managed by the Service
Manager.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, you can now lter by name the list of only Availabili
Application Tooling databases displayed in the embedded SAP HANA Database
Studio Explorer. See View Database Objects with the Database
Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, you can now use the embedded SAP HANA only Availabili
Application Tooling Database Explorer to create SQL CALL statements. See View
Studio Database Objects with the Database Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, the SAP HANA Project Explorer now displays only Availabili
Application Tooling a warning if an application is using an outdated version of the
Studio HDI deployer (@sap/hdi-deploy). See Deploy Artifacts with
SAP HANA Projects Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, you can now use the SAP HANA artifact- only Availabili
Application Tooling creation Wizard to add a job-schedule artifact
Studio (.hdbschedulerjob) to your database application. See
Scheduler Jobs (.hdbschedulerjob).

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, you can now use the SAP HANA Project only Availabili
Application Tooling Explorer to bind an application to a database schema service.
Studio See Bind an Application to a Database Schema Service.

SAP Cloud Development with When you select a Full-Stack Application Using Productivity Info General
Business Foundry Productivity Tools Tools dev space, the storyboard opens by default as the initial only Availabili
Application view. See Get Started.
Studio

This is custom documentation. For more information, please visit the SAP Help Portal 11
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud Development with When working in a Full-Stack Application Using Productivity Info General
Business Foundry Productivity Tools Tools dev space, you can now use the context menu in the only Availabili
Application Project Explorer view to deploy, delete, or view your last
Studio deployed project. See Deploy an Application.

SAP Cloud Git You can now select the changes you want to commit or discard in Info General
Business Foundry the Simpli ed Git view. See Commit Changes in the Simpli ed only Availabili
Application Git View and Perform Actions in the Pending Changes Section.
Studio

SAP Cloud Development You can now enable the Headless Testing Framework extension Info General
Business Foundry Experience for your dev space. only Availabili
Application
This extension allows you to run cross-platform end-to-end tests
Studio
on a UI5 application, with selectors compatible to OPA5.

See Using BAS with wdi5 .

SAP Cloud Storyboard In the storyboard, you can now create data models and service Info General
Business Foundry entities from the column headers or from the toolbar. only Availabili
Application
In the settings, you can de ne if you want them created in the
Studio
default namespace or service or to select the location manually.

SAP Cloud Service Center In the Service Center, you can now search for a service within a Info General
Business Foundry package from the SAP Business Accelerator Hub, the API only Availabili
Application business hub enterprise, or the Uni ed Customer Landscape
Studio service provider. See SAP Business Accelerator Hub Service
Provider.

SAP Cloud Service Center You can now edit the data source for an SAP System service Info General
Business Foundry from the Storyboard. See Storyboard and Project Explorer. only Availabili
Application
Studio

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, you can now use the SAP HANA Project only Availabili
Application Tooling Explorer to include trace information in the deployment log
Studio displayed in the terminal pane. See User Preferences for SAP
HANA Native Application Development Tools.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, you can now use the Database Explorer's only Availabili
Application Tooling SQL console as a custom editor. See Use the SQL Console for
Studio SAP HANA to Query the Database.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, you can now use the Project Explorer to only Availabili
Application Tooling provide support for SAP Cloud Application Programming (CAP)
Studio projects and access to tools that help you to maintain native
SAP HANA database artifacts. See Working with the SAP Cloud
Application Programming Model.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, you can now display syntax suggestions and only Availabili
Application Tooling dependency information in a side panel in the Database
Studio Explorer's SQL console. See Use the SQL Console for SAP HANA
to Query the Database.

This is custom documentation. For more information, please visit the SAP Help Portal 12
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud CAP You can no longer use SAP Business Application Studio run Info General
Business Foundry con gurations to create and run CAP Java applications based on only Availabili
Application the classic Java stack. (The CAP classic Java stack was
Studio deprecated in 2021.) To continue using SAP Business
Application Studio run con gurations for CAP Java applications,
migrate to the new CAP Java stack. See Java Migration Towards
the new CAP Java SDK .

SAP Cloud Java SAP Business Application Studio now supports JAVA 17. You can Info General
Business Foundry select this version from the command palette. Open the only Availabili
Application command palette and select JAVA Set Default JDK.
Studio

SAP Cloud Service Center You can now open a diagram to see the service entities, their Info General
Business Foundry properties, and the relationships between the entities from the only Availabili
Application Service Center. See SAP System Service Provider.
Studio

SAP Cloud Git You can now use the Simpli ed Git view to perform Git Info General
Business Foundry operations and manage Git repositories in SAP Business only Availabili
Application Application Studio. See Using the Simpli ed Git View.
Studio

SAP Cloud Development with In the Full-Stack Application Using Productivity Tools dev Info General
Business Foundry Productivity Tools space, a run con guration is automatically generated when you only Availabili
Application add an external data model to a service from the SAP System
Studio service provider. See Add an External Data Model.

SAP Cloud Development with In the Full-Stack Application Using Productivity Tools dev Info General
Business Foundry Productivity Tools space, a run con guration is automatically generated when you only Availabili
Application add an external data model to a service from the SAP Business
Studio Accelerator Hub or the API business hub enterprise. See Add an
External Data Model.

SAP Cloud Extension Project You can now migrate and extend existing SAPUI5 applications Info General
Business Foundry that reside in the SAPUI5 ABAP repository. See Extend SAPUI5 only Availabili
Application Applications.
Studio

SAP Cloud Adaptation Project With Adaptation Project, you can now create manifest app Info General
Business Foundry descriptor changes using a wizard. The possible types of only Availabili
Application changes are - Replace OData Service, Add Annotation le, Add
Studio OData Service and SAPUI5 Model, and Add Component usage.
See Adding App Descriptor Changes.

SAP Cloud Service Center The Service Center now includes the following additions that Info General
Business Foundry make it easier to get started: only Availabili
Application The HELP section provides an overview of the Service
Studio Center and links to detailed documentation for each
service provider.

The SAP System service provider includes a button to


add a system for the rst time. See SAP System Service
Provider..

SAP Cloud Calculation Views Apply lters to both partners of a join. Filters that are applied to Info General
Business Foundry one join partner can also be applied to mapped columns of the only Availabili
Application other join partner. See Map Filters Between Join Partners.
Studio

This is custom documentation. For more information, please visit the SAP Help Portal 13
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud Calculation Views The following new options are available for snapshots in a Info General
Business Foundry calculation view: only Availabili
Application
Create Snapshot After Deployment Automatically
Studio
Keep Snapshot During Redeployment

Mode of Generated Procedure

See Create Snapshots.

SAP Cloud Calculation Views The calculation view editor now lets you undo and redo Info General
Business Foundry operations on calculation views. See Undo and Redo Modeling only Availabili
Application Operations.
Studio

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, the SAP HANA projects explorer now only Availabili
Application Tooling provides direct access to online help for the speci c database
Studio artifact type that you are creating. See Add Database Artifacts
to your SAP HANA Cloud Database Application.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, you can now use the SAP HANA Project only Availabili
Application Tooling Explorer to recover design-time artifacts by binding to a user-
Studio provided service. See Restore Design-time Artifacts from the
Database.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, the SAP HANA Project Explorer now supports only Availabili
Application Tooling the multitarget resource type org.cloudfoundry.managed-
Studio service. See Con gure an SAP CAP Application to Work with
Native SAP HANA Artifacts.

SAP Cloud SAP HANA In the SAP HANA Native Application extension for SAP Business Info General
Business Foundry Development Application Studio, the SAP HANA Project Explorer now enables only Availabili
Application Tooling you to set (in user preferences) the automatic con guration of
Studio the "development mode" feature when deploying migration
tables. See User Preferences for SAP HANA Native Application
Development Tools and Migration Tables (SAP HANA Cloud HDI
Reference).

SAP Cloud Development You can now con gure and run continuous integration and Info General
Business Foundry Experience delivery (CI/CD) pipelines that automatically build, test, and only Availabili
Application deploy your code changes to speed up your development and
Studio delivery cycles. See Continuous Integration and Delivery.

SAP Cloud Service Center You can now add an SAP Cloud for Customer system to your SAP General
Business Foundry Business Application Studio subaccount from the Service Availabili
Application Center. See SAP System Service Provider.
Studio

SAP Cloud Service Center The Uni ed Customer Landscape service provider is now Info General
Business Foundry integrated in the Service Center. You can use the services from only Availabili
Application registered SAP S/4HANA Cloud systems as data sources in your
Studio application or for application development. See Uni ed
Customer Landscape Service Provider.

This is custom documentation. For more information, please visit the SAP Help Portal 14
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud Development SAP Business Application Studio now uses Code-OSS, the open Info General
Business Foundry Experience source used for building Visual Studio Code. This change comes only Availabili
Application with many user experience improvements that will speed up
Studio your productivity.

All business functionality is still available. Some basic IDE


capabilities have been updated. Once you are used to the new
UI, your development experience will be better and faster.

SAP Cloud Dev Space You can now provide feedback regarding your development Info General
Business Foundry Manager experience in SAP Business Application Studio by taking our only Availabili
Application survey.
Studio
You can access the survey from the menu bar in the Dev Space
Manager.

SAP Cloud Calculation Views You can now add temporal information (system time and Info General
Business Foundry application time) to the de nition of a calculation view. See Add only Availabili
Application System Time and Application Time.
Studio

SAP Cloud Calculation Views You can now apply greedy join pruning to join executions. This Info General
Business Foundry can improve the performance of queries in situations in which only Availabili
Application joins are not required for data correctness. See Con gure
Studio Greedy Join Pruning.

SAP Cloud Calculation Views Window Functions have been enhanced. See Create Window Info General
Business Foundry Function Nodes. only Availabili
Application
Studio

SAP Cloud SAP HANA In the SAP HANA Native Application extension, you can now use Info General
Business Foundry Development the standard database-artifact creation wizard to add a virtual only Availabili
Application Tooling table to your database application. See Create Virtual Tables.
Studio

SAP Cloud SAP HANA In the SAP HANA Native Application extension, it is now possible Info General
Business Foundry Development to use the Database Explorer's SQL console to select local or only Availabili
Application Tooling SAP HANA database connections. See Use the SQL Console for
Studio SAP HANA to Query the Database.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, the Database Info General
Business Foundry Development Explorer's SQL console now provides new context menu items only Availabili
Application Tooling that enable you to open SQL les and display the contents
Studio directly in the SQL console itself. See Use the SQL Console for
SAP HANA to Query the Database.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, new context- Info General
Business Foundry Development menu items in the Database Explorer enable you to generate a only Availabili
Application Tooling SELECT or CALL statement for supported database artifacts.
Studio See View Database Objects with the Database Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, it is now possible Info General
Business Foundry Development to view the data of supported artifacts in the Database only Availabili
Application Tooling Explorer's SQL console. See View Database Objects with the
Studio Database Explorer and Use the SQL Console for SAP HANA to
Query the Database.

This is custom documentation. For more information, please visit the SAP Help Portal 15
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud SAP HANA In the SAP HANA Native Application, the Project Explorer now Info General
Business Foundry Development enables you to bind a database module to a user-provided only Availabili
Application Tooling service. See Deploy Artifacts and Set up Database Connections
Studio with SAP HANA Projects Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, the Project Info General
Business Foundry Development Explorer now displays a warning if services bound to a database only Availabili
Application Tooling modules do not match the current Cloud Foundry space. Users
Studio can choose to automatically unbind these services by setting a
user preference. See Deploy Artifacts and Set up Database
Connections with SAP HANA Projects Explorer and User
Preferences for SAP HANA Native Application Development
Tools.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, the Project Info General
Business Foundry Development Explorer now displays a warning if services bound to a database only Availabili
Application Tooling modules do not match the database ID de ned in the
Studio mta.yaml le. See Deploy Artifacts and Set up Database
Connections with SAP HANA Projects Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, you can now use Info General
Business Foundry Development the Project Explorer to recover design-time artifacts in your only Availabili
Application Tooling workspace from the deployed artifacts in an HDI container. See
Studio Restore Design-time Artifacts from the Database.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, you can now use Info General
Business Foundry Development the Project Explorer to synchronize the deployment state of a only Availabili
Application Tooling database module with the deployment state from the database.
Studio See Deploy Artifacts and Set up Database Connections with SAP
HANA Projects Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension,you can now use Info General
Business Foundry Development the Project Explorer to create a procedure grantor when adding a only Availabili
Application Tooling new database connection. See Deploy Artifacts and Set up
Studio Database Connections with SAP HANA Projects Explorer.

SAP Cloud Guided Answers You can now open the Guided Answers from the command Info General
Business Foundry palette to troubleshoot SAP Business Application Studio. only Availabili
Application
Studio

SAP Cloud Development with In Low-Code-Based Full-Stack Cloud Application dev spaces, Info General
Business Foundry Productivity Tools you can now con gure and run continuous integration and only Availabili
Application delivery (CI/CD) pipelines that automatically build, test, and
Studio deploy your code changes to speed up your development and
delivery cycles. See Continuous Integration and Delivery.

SAP Cloud Development with In Low-Code-Based Full-Stack Cloud Application dev spaces, Info General
Business Foundry Productivity Tools you can now use the Get started with SAP Business Application only Availabili
Application Studio booster to set up your subaccount for developing low-
Studio code business applications. See Initial Setup.

SAP Cloud Development with In Low-Code-Based Full-Stack Cloud Application dev spaces, Info General
Business Foundry Productivity Tools you can now extend an existing service or create an SAP only Availabili
Application S/4HANA service with additional elds with guided steps from
Studio the Guided Development tool. See Creating an SAP S/4HANA
Application.

This is custom documentation. For more information, please visit the SAP Help Portal 16
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud Development with In Low-Code-Based Full-Stack Cloud Application dev spaces, Info General
Business Foundry Productivity Tools you can now extend an existing service or create an SAP only Availabili
Application S/4HANA service with additional elds with guided steps from
Studio the Guided Development tool. See Creating an SAP S/4HANA
Application.

SAP Cloud Node.js Version The Node.js version for Theia was updated to Node.js 16.15.0. Info General
Business Foundry only Availabili
Application
Studio

SAP Cloud Service Center The API business hub enterprise service provider is now Info General
Business Foundry integrated in the Service Center. You can explore OData-based only Availabili
Application services from the API Business Hub Enterprise. See API
Studio Business Hub Enterprise Service Provider.

SAP Cloud Calculation Views You can now create snapshots based on a speci c query in a Info General
Business Foundry calculation view. See Create Query Snapshots. only Availabili
Application
Studio

SAP Cloud Calculation Views A new aggregation option MEDIAN is available for: Info General
Business Foundry only Availabili
Measures in a calculation view with aggregation or star
Application
join
Studio
Calculated columns with measure type, if client side
aggregation is enabled

Mapping for a node, if the column is a measure

See Supported View Nodes for Modeling Calculation Views.

SAP Cloud Calculation Views You can now map session variables to input parameters. Up to Info General
Business Foundry now, it was only possible to map parameters and variables to only Availabili
Application input parameters. See Supported View Nodes for Modeling
Studio Calculation Views.

SAP Cloud Calculation Views You can now quickly nd out where elements in a calculation Info General
Business Foundry view, such as calculated columns, input parameters, restricted only Availabili
Application columns, or variables, are used. See Where Used Functionality.
Studio

SAP Cloud SAP HANA You can now use the SAP HANA Native Application extension to Info General
Business Foundry Development export a package that includes selected objects from an SAP only Availabili
Application Tooling HANA HDI container, for example, if required for testing by
Studio support teams. See Export an SAP HDI Container for Support
Purposes.

SAP Cloud SAP HANA You can now create a default " hdbgrants" le for the automatic Info General
Business Foundry Development assignment of privileges when adding a new database only Availabili
Application Tooling connection in the SAP HANA Projects explorer in the SAP HANA
Studio Native Application extension. See Deploy Artifacts and Set up
Database Connections with SAP HANA Projects Explorer.

This is custom documentation. For more information, please visit the SAP Help Portal 17
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud SAP HANA In the SAP HANA Native Application extension, you can now set Info General
Business Foundry Development the user preference "auto-commit" in the SAP HANA SQL only Availabili
Application Tooling Console to ensure that any changes to the database required by
Studio the code you run in the SQL Console are performed
immediately, for example, when inserting or updating data in
tables. See Use the SQL Console for SAP HANA to Query the
Database.

SAP Cloud SAP HANA You can now use the SAP HANA SQL Console in the SAP HANA Info General
Business Foundry Development Native Application extension for SAP Business Application to run only Availabili
Application Tooling SQL queries that include parameters. See Use the SQL Console
Studio for SAP HANA to Query the Database.

SAP Cloud SAP HANA The SAP HANA Projects explorer in the SAP HANA Native Info General
Business Foundry Development Application extension now checks the details of the target only Availabili
Application Tooling schema details when binding to an existing service. See Deploy
Studio Artifacts and Set up Database Connections with SAP HANA
Projects Explorer.

SAP Cloud SAP HANA You can now switch between database connections in the SAP Info General
Business Foundry Development HANA SQL Console in the SAP HANA Native Application only Availabili
Application Tooling extension for SAP Business Application. See Use the SQL
Studio Console for SAP HANA to Query the Database.

SAP Cloud SAP HANA You can now use context-sensitive menus in the SAP HANA Info General
Business Foundry Development Databases explorer's Catalog Browser in the SAP HANA Native only Availabili
Application Tooling Application extension to copy the simple or fully quali ed name
Studio of a database object to the clipboard. See View Database
Objects with the Database Explorer.

SAP Cloud SAP HANA You can now use the SAP HANA Databases explorer's Catalog Info General
Business Foundry Development Browser in the SAP HANA Native Application extension to only Availabili
Application Tooling generate the SQL code that was used to create the selected
Studio database object. See View Database Objects with the Database
Explorer.

SAP Cloud SAP HANA You can now use the SAP HANA Projects explorer in the SAP Info General
Business Foundry Development HANA Native Application extension to bind a user-provided only Availabili
Application Tooling service to a target HDI container. See Deploy Artifacts and Set
Studio up Database Connections with SAP HANA Projects Explorer.

SAP Cloud SAP HANA You can now use the SAP HANA Projects explorer in the SAP Info General
Business Foundry Development HANA Native Application extension to bind to (or unbind from) only Availabili
Application Tooling all services displayed in the Database Connections pane. See
Studio Deploy Artifacts and Set up Database Connections with SAP
HANA Projects Explorer and View Database Objects with the
Database Explorer.

SAP Cloud Service Center You can now preview the entity data of an SAP Business Info General
Business Foundry Accelerator Hub service before application creation from the only Availabili
Application Service Center. See SAP Business Accelerator Hub Service
Studio Provider.

SAP Cloud Service Center You can now search for a service in an ABAP service catalog from Info General
Business Foundry the Service Center. See SAP System Service Provider. only Availabili
Application
Studio

This is custom documentation. For more information, please visit the SAP Help Portal 18
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud Service Center You can now preview the entity data of a SAP System service Info General
Business Foundry before application creation from the Service Center. See SAP only Availabili
Application System Service Provider.
Studio

SAP Cloud Dev Space You can now select the Low-Code-Based Full-Stack Cloud Info General
Business Foundry Manager Application dev space type to easily develop, test, build, and only Availabili
Application deploy applications. See Low-Code-Based Full-Stack Cloud
Studio Application.

SAP Cloud Node.js Version The Node.js version for Theia was updated to Node.js 14. Info General
Business Foundry only Availabili
Application
Studio

SAP Cloud SAP HANA The database-explorer tools can now be used with local Info General
Business Foundry Development database connections on ARM platforms. Note that the only Availabili
Application Tooling limitations of the SAP HANA "hdb" Node.js client apply, for
Studio example, SAP HANA User Store connections are not available.
See Deploy Artifacts and Set up Database Connections with SAP
HANA Projects Explorer.

SAP Cloud SAP HANA The SAP HANA Native Application extension now provides Info General
Business Foundry Development access to SAP HANA database development tools from an SAP only Availabili
Application Tooling CAP project. See Con gure an SAP CAP Application to Work with
Studio Native SAP HANA Artifacts.

SAP Cloud SAP HANA During the creation of a new application project, the SAP HANA Info General
Business Foundry Development Native Application extension now checks if the project's only Availabili
Application Tooling .gitignore le contains an entry for the SAP HANA native
Studio database application .env le. See Create a New Business
Application Project.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, the list of SAP Info General
Business Foundry Development HANA Database Explorer connections can be hidden using the only Availabili
Application Tooling Show Database Explorer Connections setting in User
Studio Preferences. See User Preferences for SAP HANA Native
Application Development Tools.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, local database Info General
Business Foundry Development connections can now be added using credentials stored in the only Availabili
Application Tooling SAP HANA User Store. See Deploy Artifacts and Set up
Studio Database Connections with SAP HANA Projects Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, the SQL console Info General
Business Foundry Development can open content from (and save content to) les. See Use the only Availabili
Application Tooling SQL Console for SAP HANA to Query the Database.
Studio

SAP Cloud SAP HANA In the SAP HANA Native Application extension, the SAP HANA Info General
Business Foundry Development Database Explorer on SAP Business Technology Platform can only Availabili
Application Tooling now be opened from each SAP HANA Database Explorer
Studio connection. See View Database Objects with the Database
Explorer.

This is custom documentation. For more information, please visit the SAP Help Portal 19
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud SAP HANA In the SAP HANA Native Application extension, the catalog Info General
Business Foundry Development browser now shows the list of database objects. The objects can only Availabili
Application Tooling be ltered by schema. The ( ltered) list of objects can be also
Studio be searched using the standard Visual Studio Code functionality
for the tree view. See View Database Objects with the Database
Explorer.

SAP Cloud SAP HANA The SAP HANA Native Application extension now provides Info General
Business Foundry Development context-sensitive descriptions of tags and properties in JSON- only Availabili
Application Tooling based HDI artifacts, for example: hdbrole and hdbrolecon g,
Studio hdbgrants, hdbsynonym and hdbsynonymcon g. For common
scenarios, templates are provided, too. See Create a Database
Role (Getting Started).

SAP Cloud SAP HANA The SAP HANA Native Application extension now provides JSON Info General
Business Foundry Development syntax validation for the HDI artifacts hdbtabledata and only Availabili
Application Tooling hdblogicalschemacon g. See SAP HDI Artifact Types and Build
Studio Plug-ins Reference (SAP HANA Cloud Database).

SAP Cloud SAP HANA In the SAP HANA Native Application extension, you can now use Info General
Business Foundry Development the project explorer to bind a module to the default service. A only Availabili
Application Tooling new option also enables you to bind (and unbind) all the services
Studio speci ed in an application's mta.yaml le. When binding a
module to an existing service, a new warning is shown. See
Deploy Artifacts and Set up Database Connections with SAP
HANA Projects Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, the project Info General
Business Foundry Development explorer now provides a setting for clearing the deployment log only Availabili
Application Tooling when a new deployment is started. See Deploy Artifacts and Set
Studio up Database Connections with SAP HANA Projects Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, you can now Info General
Business Foundry Development validate connection details when adding a new database only Availabili
Application Tooling connection to a project.
Studio See Deploy Artifacts and Set up Database Connections with SAP
HANA Projects Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, a con rmation Info General
Business Foundry Development dialog is now displayed asking if auto-undeploy should be only Availabili
Application Tooling disabled when binding an application to an existing container.
Studio See Deploy Artifacts and Set up Database Connections with SAP
HANA Projects Explorer.

SAP Cloud SAP HANA In the SAP HANA Native Application extension, the project Info General
Business Foundry Development explorer now shows HDI con guration les in the application only Availabili
Application Tooling project's le tree. See Deploy Artifacts and Set up Database
Studio Connections with SAP HANA Projects Explorer.

SAP Cloud Calculation Views Input parameters of a calculation view can now be mapped to Info General
Business Foundry the input parameters of a consumed calculation view if this only Availabili
Application calculation view is consumed via SDA. See Map Input
Studio Parameters.

SAP Cloud Calculation Views When replacing a node of a calculation view, it is now also Info General
Business Foundry possible to map input parameters. See Replacing Nodes and only Availabili
Application Data Sources.
Studio

This is custom documentation. For more information, please visit the SAP Help Portal 20
2/6/2024

Technical Environment Title Description Action Lifecycle


Component

SAP Cloud Calculation Views A new con guration option was added to explicitly con gure Info General
Business Foundry whether a data preview query should be automatically executed. only Availabili
Application See Preview Calculation View Output.
Studio

SAP Cloud Calculation Views The data preview allows the preview of hierarchies on SAP HANA Info General
Business Foundry Cloud. See Preview Calculation View Output. only Availabili
Application
Studio

SAP Cloud Calculation Views In addition to constant mapping and the use of pruning Info General
Business Foundry con guration table, column-based pruning is now also only Availabili
Application supported.
Studio
Column-based pruning allows you to prune individual data
sources of a union node, based on whether a data source
contributes certain columns. See Create Column-Based Pruning.

SAP Cloud Calculation Views In the Find Data Source dialog, you can now select/unselect Info General
Business Foundry ʻShow Services’ to show/hide the Service column in the result only Availabili
Application table, which contains the service information of each object in
Studio the table. See Create Calculation Views.

SAP Cloud Support for There is no longer a limit on the number of applications (ports) Info General
Business Foundry Dynamic Routing running at the same time. only Availabili
Application
Studio

2021 What's New for SAP Business Application Studio (Archive)


Core Components, 2019

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2021-12-
Business Suite - Foundry been updated to include xes and only 20
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.19.0 .

SAP Extension Cloud Service When you add a data model to a CAP Info Changed 2021-12-
Business Suite - Foundry Center project from the Service Center, XML only 06
Application Development and CDS les are now generated in the
Studio Efficiency project folder. See SAP System Service
Provider and SAP Business Accelerator
Hub Service Provider.

SAP Extension Cloud SAP HANA Calculation views can now be Info New 2021-12-
Business Suite - Foundry con gured to evaluate masked data only 06
Application Development based on the session user who is
Studio Efficiency running the underlying SQL query rather
than the user calling the calculation
view. See Mask Column Values.

This is custom documentation. For more information, please visit the SAP Help Portal 21
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud SAP HANA The list of execution hints for Info New 2021-12-
Business Suite - Foundry calculation views is now easier to nd only 06
Application Development and has been expanded and improved.
Studio Efficiency In addition, each execution hints now
includes a short description and, where
appropriate, a suggested value. See
Quick Reference: Calculation View
Properties (Execution Hints).

SAP Extension Cloud SAP HANA It is now possible to deploy artifacts Info New 2021-12-
Business Suite - Foundry directly from the Get Started with SAP only 06
Application Development HANA Cloud tutorial in the Guided
Studio Efficiency Development tool in SAP Business
Application Studio. See Guided
Development Get Started with SAP
HANA Cloud Deploy Artifacts from
SAP HANA Project Explorer in SAP
Business Application Studio.

SAP Extension Cloud SAP HANA You can now use the SQL console for Info New 2021-12-
Business Suite - Foundry SAP HANA to execute SQL code only 06
Application Development directly from the integrated
Studio Efficiency development environment (IDE) in SAP
Business Application Studio. See Use
the SQL Console for SAP HANA to
Query the Database.

SAP Extension Cloud SAP HANA Enable data preview using a different Info New 2021-12-
Business Suite - Foundry database use. See Preview Calculation only 06
Application Development View Output.
Studio Efficiency

SAP Extension Cloud SAP HANA Improved usability when debugging a Info Changed 2021-12-
Business Suite - Foundry calculation view. See Debug Calculation only 06
Application Development Views.
Studio Efficiency

SAP Extension Cloud SAP HANA The default join in a star join is set to Info Changed 2021-12-
Business Suite - Foundry left-outer instead of referential. See only 06
Application Development Supported Join Types.
Studio Efficiency

SAP Extension Cloud SAP HANA Calculated columns, input parameters, Info New 2021-12-
Business Suite - Foundry and restricted columns can be ltered. only 06
Application Development See Working With Attributes and
Studio Efficiency Measures.

SAP Extension Cloud SAP HANA Roles can be chosen graphically when Info New 2021-12-
Business Suite - Foundry creating a synonym. See Create only 06
Application Development Calculation Views.
Studio Efficiency

SAP Extension Cloud SAP HANA You can con gure additional keyboard Info Changed 2021-12-
Business Suite - Foundry shortcuts for various modeling actions. only 06
Application Development See Calculation View Editor: Keyboard
Studio Efficiency Shortcuts.

This is custom documentation. For more information, please visit the SAP Help Portal 22
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud Service You can now click to connect to an Info Changed 2021-11-
Business Suite - Foundry Center ABAP system directly from the Service only 22
Application Development Center, without using the connect
Studio Efficiency button. See SAP System Service
Provider.

SAP Extension Cloud Theia SAP Business Application Studio has Info New 2021-09-
Business Suite - Foundry been updated to include xes and only 26
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.15.0

SAP Extension Cloud Service You can now generate a sample service Info New 2021-09-
Business Suite - Foundry Center based on selected entities when adding only 13
Application Development a data model to a CAP project from the
Studio Efficiency Service Center. See Service Center.

SAP Extension Cloud SAP HANA When you include objects in a Info New 2021-09-
Business Suite - Foundry calculation view that are outside a only 10
Application Development project, the calculation view editor can
Studio Efficiency now display the name of the service
through which an external object is
accessible. See Consume Objects That
are not Included in Your Development
Project.

SAP Extension Cloud Service The SAP Business Accelerator Hub Info New 2021-08-
Business Suite - Foundry Center service provider is now displayed in the only 29
Application Development Service Center. You can explore OData-
Studio Efficiency based services from 5 SAP products.
See SAP Business Accelerator Hub
Service Provider.

SAP Extension Cloud HTML5 You can now create an HTML5 project Info New 2021-08-
Business Suite - Foundry Application based on the selected SAP Business only 29
Application Development Development Accelerator Hub service and locally run
Studio Efficiency it from SAP Business Application
Studio. See Run Your HTML5
Application with the SAP Business
Accelerator Hub.

SAP Extension Cloud SAP Fiori You can now create an SAP Fiori project Info New 2021-08-
Business Suite - Foundry Development based on the selected SAP Business only 29
Application Development Accelerator Hub service and locally run
Studio Efficiency it from SAP Business Application
Studio. See Develop SAP Fiori
Applications with SAP Fiori tools.

This is custom documentation. For more information, please visit the SAP Help Portal 23
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud SAP HANA The Calculation View Editor has the Info New 2021-08-
Business Suite - Foundry following new features: only 10
Application Development You can de ne your own
Studio Efficiency keyboard shortcuts for common
modeling actions in the
calculation. See Calculation
View Editor: Keyboard
Shortcuts

You can copy and paste


elements such as input
parameters, variables,
calculated columns, restricted
columns, and hierarchies. See
Copying Calculation View
Elements

You can change the join type


and cardinality directly from
the Properties view when a non-
equi-join uses an expression.
See Create Joins.

SAP Extension Cloud SAP HANA You can now create Document Store Info Changed 2021-08-
Business Suite - Foundry Collection Index only 10
Application Development (hdbcollectionindex) artifacts in
Studio Efficiency projects with feature version 1006 or
higher. See Document Store Collection
Index (.hdbcollectionindex).

SAP Extension Cloud SAP HANA The con guration of new projects now Info New 2021-08-
Business Suite - Foundry includes a mapping for Document Store only 10
Application Development Collection Index
Studio Efficiency (hdbcollectionindex) artifacts.

SAP Extension Cloud CAP You can now create CAP applications Info New 2021-07-
Business Suite - Foundry when working in any type of dev space only 17
Application Development by selecting the CAP Tools additional
Studio Efficiency extension. Selecting this extension will
automatically select any other
additional extension that is required to
have all the CAP capabilities within the
current dev space. See Creating a
Project.

SAP Extension Cloud HTML5 You can now create, run, build, and Info New 2021-07-
Business Suite - Foundry Application deploy a React.js HTML5 application to only 04
Application Development Development the Cloud Foundry environment. See
Studio Efficiency Developing an HTML5 Application for
Cloud Foundry.

SAP Extension Cloud Free Tier The SAP Business Application Studio Info New 2021-07-
Business Suite - Foundry free tier is now available. See only 01
Application Development Application Plans.
Studio Efficiency

SAP Extension Cloud Service You can now create an SAP Fiori Info New 2021-06-
Business Suite - Foundry Center application from the Service Center. only 21
Application Development See Service Center.
Studio Efficiency

This is custom documentation. For more information, please visit the SAP Help Portal 24
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2021-06-
Business Suite - Foundry been updated to include xes and only 21
Application Digital improvements that are part of Eclipse
Studio Process Theia 1.13.0 .
Automation

SAP Extension Cloud SAP HANA When using the SAP HANA Native Info New 2021-06-
Business Suite - Foundry Application development tools to only 21
Application Development create a database artifact, the last-
Studio Efficiency used path is now stored as a
workspace setting, which you can edit
and con gure manually, too. See Add
Database Artifacts to your SAP HANA
Cloud Database Application.

SAP Extension Cloud SAP HANA You can now use the SAP HANA Info New 2021-06-
Business Suite - Foundry calculation view graphical editor to only 21
Application Development reference and include objects outside
Studio Efficiency of a project much more easily. See SAP
HANA Cloud, SAP HANA Database
Modeling Guide for SAP Business
Application Studio.

SAP Extension Cloud SAP HANA You can now use the Replace data Info New 2021-06-
Business Suite - Foundry source dialog in the SAP HANA only 21
Application Development calculation view graphical editor to
Studio Efficiency con gure and edit data sources more
easily. See SAP HANA Cloud, SAP
HANA Database Modeling Guide for
SAP Business Application Studio.

SAP Extension Cloud SAP HANA You can now use the SAP HANA Info New 2021-06-
Business Suite - Foundry calculation view graphical editor to only 21
Application Development replace a data source with an existing
Studio Efficiency node within a calculation view. See SAP
HANA Cloud, SAP HANA Database
Modeling Guide for SAP Business
Application Studio.

SAP Extension Cloud SAP HANA You can now use the SAP HANA Info New 2021-06-
Business Suite - Foundry calculation view graphical editor to only 21
Application Development change the order of variables and
Studio Efficiency parameters in the semantics node of a
calculation view. See SAP HANA Cloud,
SAP HANA Database Modeling Guide
for SAP Business Application Studio.

SAP Extension Cloud Service The V4 services are now supported in Info New 2021-06-
Business Suite - Foundry Center the Service Center catalog. See Service only 06
Application Development Center.
Studio Efficiency

SAP Extension Cloud SAPUI5 You can now use Cloud Foundry Info New 2021-05-
Business Suite - Foundry Adaptation business services as base apps for only 26
Application Development Projects creating an SAPUI5 Adaptation Project
Studio Efficiency and deploy the built project to the
Cloud Foundry environment. See Create
an Adaptation Project on Cloud Foundry.

This is custom documentation. For more information, please visit the SAP Help Portal 25
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud Service You can now add a service to a CAP Info New 2021-05-
Business Suite - Foundry Center project from the Service Center. See only 09
Application Development Service Center.
Studio Efficiency

SAP Extension Cloud HTML5 The Basic HTML5 Application template Info New 2021-05-
Business Suite - Foundry Application is now available when creating an only 09
Application Development Development HTML5 project from the template
Studio Efficiency wizard. See Create an HTML5 Project.

SAP Extension Cloud CAP You can now run your CAP Java Info New 2021-05-
Business Suite - Foundry application using remote Cloud Foundry only 09
Application Development services that are bound to the
Studio Efficiency application. See Creating Run
Con gurations for CAP Java
Applications.

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2021-05-
Business Suite - Foundry been updated to include xes and only 09
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.12.0 .

SAP Extension Cloud Service You can now add new systems Info New 2021-04-
Business Suite - Foundry Center (destinations) to the SAP Business only 25
Application Development Application Studio account from the
Studio Efficiency Service Center. See Service Center.

SAP Extension Cloud SAP HANA You can now use the graphical user Info New 2021-04-
Business Suite - Foundry interface to choose a time-data table only 25
Application Development when creating a time-based dimension
Studio Efficiency calculation view. See SAP HANA Cloud,
SAP HANA Database Developer Guide
for Cloud Foundry Multitarget
Applications.

SAP Extension Cloud SAP HANA You can now validate the JSON schema Info New 2021-04-
Business Suite - Foundry when creating JSON-based database only 25
Application Development artifacts. See SAP HANA Cloud, SAP
Studio Efficiency HANA Database Developer Guide for
Cloud Foundry Multitarget Applications.

SAP Extension Cloud SAP HANA You can now perform the following Info New 2021-04-
Business Suite - Foundry actions when creating a calculation view only 25
Application Development using the graphical editor:
Studio Efficiency
Calculation-view refactoring.

Display a data preview of a


calculation view.

Display an intermediate data


preview directly from
calculation-view nodes.

SAP HANA Cloud, SAP HANA Database


Developer Guide for Cloud Foundry
Multitarget Applications

This is custom documentation. For more information, please visit the SAP Help Portal 26
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud SAP HANA A .gitignore le is now added at the Info New 2021-04-
Business Suite - Foundry project level when a new project is only 25
Application Development created. See SAP HANA Cloud, SAP
Studio Efficiency HANA Database Developer Guide for
Cloud Foundry Multitarget Applications.

SAP Extension Cloud SAP Fiori The SAP Fiori Freestyle Project and the Info Changed 2021-04-
Business Suite - Foundry Development SAP Fiori Freestyle Module templates only 25
Application Development have been deprecated. These
Studio Efficiency templates are no longer displayed in
the wizards during project and module
creation. You can still access these
templates by entering Open Template
Wizard in the command palette.

SAP Extension Cloud Service You can now explore services from your Info New 2021-04-
Business Suite - Foundry Center SAP Business Application Studio only 11
Application Development account destination using the Service
Studio Efficiency Center. The services can be used as
data sources in your application and
you can trigger application
development from the Service Center.
See Service Center.

SAP Extension Cloud HTML5 You can now create, run, build, and Info New 2021-04-
Business Suite - Foundry Application deploy a Vue.js HTML5 application to only 11
Application Development Development the Cloud Foundry environment. See
Studio Efficiency Developing an HTML5 Application for
Cloud Foundry.

SAP Extension Cloud Java You can now con gure the Java version Info Changed 2021-04-
Business Suite - Foundry in your Java applications to either only 11
Application Development JavaSE-11 or JavaSE-1.8. See
Studio Efficiency Additional Extensions.

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2021-03-
Business Suite - Foundry been updated to include xes and only 29
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.11.0 .

SAP Extension Cloud Java You can now develop Java applications Info New 2021-03-
Business Suite - Foundry using the Java development tools in only 14
Application Development any dev space.
Studio Efficiency

SAP Extension Cloud Java The Java development tools now Info New 2021-03-
Business Suite - Foundry include the Java Test Runner and only 14
Application Development Project Manager for Java extensions.
Studio Efficiency

SAP Extension Cloud SAP HANA You can now create a user-provided Info New 2021-02-
Business Suite - Foundry service using the deployment target only 28
Application Development container database information.
Studio Efficiency

SAP Extension Cloud Welcome The Welcome page now includes Info Changed 2021-02-
Business Suite - Foundry Page sample projects depending on the only 28
Application Development extensions enabled in your dev space.
Studio Efficiency

This is custom documentation. For more information, please visit the SAP Help Portal 27
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud CAP The CDS graphical modeler is now part Info Changed 2021-02-
Business Suite - Foundry of the CAP prede ned extensions. only 28
Application Development There is no need to enable it manually.
Studio Efficiency See Full Stack Cloud Application.

SAP Extension Cloud CAP The CAP Node run con gurations now Info Changed 2021-02-
Business Suite - Foundry support db dependencies of only 28
Application Development `kind:sql`.
Studio Efficiency

SAP Extension Cloud CAP The 'cds-dk' has been updated to Info Changed 2021-02-
Business Suite - Foundry version 3.4.0. only 28
Application Development
Studio Efficiency

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2021-02-
Business Suite - Foundry been updated to include xes and only 28
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.10.0 .

SAP Extension Cloud Task You can now build and deploy MTA Info New 2021-02-
Business Suite - Foundry Explorer projects for speci c SAP scenarios only 14
Application Development using the Task Explorer. You can create
Studio Efficiency and edit the task parameters using a
dedicated UI. See Task Explorer.

SAP Extension Cloud Storyboard The Storyboard feature is now available Info New 2021-02-
Business Suite - Foundry for CAP applications. The Storyboard is only 14
Application Development a detailed graphical view for CAP
Studio Efficiency applications, presenting their logical
components and the connections
between them. See Storyboard and
Project Explorer.

SAP Extension Cloud CAP Changes to CAP Node Run Info Changed 2021-02-
Business Suite - Foundry Con gurations: All run con gurations only 14
Application Development that were created without a pro le will
Studio Efficiency now re ect their development pro le. In
addition, when a new run con guration
is created, it will be created as a
con guration for the development
pro le unless another pro le is
speci ed. See Creating Run
Con gurations for CAP Node
Applications.

SAP Extension Cloud Import Files You can now import any ZIP project Info New 2021-01-
Business Suite - Foundry from your local le system to SAP only 31
Application Development Business Application Studio.
Studio Efficiency

SAP Extension Cloud Landing Page When opening SAP Business Info New 2021-01-
Business Suite - Foundry Application Studio for the rst time, or only 31
Application Development when you have no dev spaces, the
Studio Efficiency landing page opens. The landing page
guides you through features of SAP
Business Application Studio and
enables creation of dev spaces of
different types.

This is custom documentation. For more information, please visit the SAP Help Portal 28
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud CAP The 'cds-dk' has been updated to Info Changed 2021-01-
Business Suite - Foundry version 3.3.3. only 31
Application Development
Studio Efficiency

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2021-01-
Business Suite - Foundry been updated to include xes and only 31
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.9.0 .

SAP Extension Cloud SAP Fiori You can now use the new approuter Info New 2021-01-
Business Suite - Foundry Development con guration template to add an only 17
Application Development approuter con guration with its
Studio Efficiency dependencies to your MTA project. The
template adds an additional managed
or standalone approuter to an existing
“mta.yaml” le.

SAP Extension Cloud CAP You can now install 'cds-dk' versions Info New 2021-01-
Business Suite - Foundry from the terminal. The updated version only 17
Application Development overwrites the default version provided
Studio Efficiency with the extension. Restarting the dev
space will not revert the change.

SAP Extension Cloud Running SAP You can now run your application locally, Info Changed 2021-01-
Business Suite - Foundry Fiori without binding an xsuaa service, when only 17
Application Development Applications you have the 2.0.1 version of the html5-
Studio Efficiency repo-mock dev dependency.

2020 What's New for SAP Business Application Studio (Archive)


Core Components, 2019

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud Extension From the new Extensions View, you can Info New 2020-12-
Business Suite - Foundry Development now extend your dev space with VS only 27
Application Development Code extensions from the Open VSX
Studio Efficiency Registry . You can also create your
own SAP Business Application Studio
extensions, which include the VS Code
extensions and the Yeoman generators
that you want to install, and make
them available in your subaccount.
See Extending SAP Business
Application Studio .

SAP Extension Cloud Application SAP Business Application Studio Info Changed 2020-12-
Business Suite - Foundry Wizard developers can now type a template only 27
Application Development name in the command palette to
Studio Efficiency trigger the relevant wizard.

SAP Extension Cloud Welcome Page The Welcome page now has a new look Info Changed 2020-12-
Business Suite - Foundry and feel. only 27
Application Development
Studio Efficiency

This is custom documentation. For more information, please visit the SAP Help Portal 29
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2020-12-
Business Suite - Foundry been updated to include xes and only 27
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.8.0 .

SAP Extension Cloud SAP HANA The SAP HANA Tools are now Info New 2020-12-
Business Suite - Foundry available. You can now create an SAP only 21
Application Development HANA native application dev space in
Studio Efficiency SAP Business Application Studio or
add the tools as an additional
extension to other dev spaces. See
SAP HANA Native Application.

SAP Extension Cloud CAP The 'cds-dk' has been updated to Info Changed 2020-11-
Business Suite - Foundry version 3.2.0. only 22
Application Development
Studio Efficiency

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2020-11-
Business Suite - Foundry been updated to include xes and only 22
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.7.0 .

SAP Extension Cloud Guided You can now use the Guided Info New 2020-10-
Business Suite - Foundry Development Development tool to execute common only 25
Application Development development tasks for speci c SAP
Studio Efficiency scenarios based on the best practices
de ned by SAP experts. See Guided
Development.

SAP Extension Cloud Extension You can now prompt information, error, Info New 2020-10-
Business Suite - Foundry Development and warning messages via only 25
Application Development noti cations in the Project Creation
Studio Efficiency wizard steps. See Create a Project
Using the Wizard.

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2020-10-
Business Suite - Foundry been updated to include xes and only 25
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.6.0 .

SAP Extension Cloud Dev Space You can now add extensions to an Info New 2020-10-
Business Suite - Foundry Manager existing dev space. See Working in the only 11
Application Development Dev Space Manager.
Studio Efficiency

SAP Extension Cloud Running SAP You can now run multiple SAP Fiori Info New 2020-10-
Business Suite - Foundry Fiori applications as components in the only 11
Application Development Applications SAP Fiori launchpad sandbox. See Run
Studio Efficiency Applications in the SAP Fiori
Launchpad Environment.

SAP Extension Cloud Project You can now open the Project Wizard Info New 2020-10-
Business Suite - Foundry Wizard from the File menu. See Create a only 11
Application Development Project Using the Wizard.
Studio Efficiency

This is custom documentation. For more information, please visit the SAP Help Portal 30
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud CAP You can now create run con gurations Info New 2020-10-
Business Suite - Foundry for CAP Java applications for speci c only 11
Application Development runtime Spring Boot pro les. See
Studio Efficiency Creating Run Con gurations for CAP
Java Applications.

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2020-10-
Business Suite - Foundry been updated to include xes and only 11
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.5.0 .

SAP Extension Cloud Installing You can now install external generators Info New 2020-10-
Business Suite - Foundry Generators from the npm registry to SAP only 05
Application Development Business Application Studio. You can
Studio Efficiency then access these generators from the
Yeoman UI wizard to use the
templates. See Explore and Install
Generators.

SAP Extension Cloud Running SAP You can now bind multiple data Info New 2020-
Business Suite - Foundry Fiori sources to your run con guration. See only 09-29
Application Development Applications Creating Run Con gurations for SAP
Studio Efficiency Fiori Applications.

SAP Extension Cloud CAP You can now create run con gurations Info New 2020-
Business Suite - Foundry for CAP Node applications for speci c only 09-29
Application Development runtime pro les. See Creating Run
Studio Efficiency Con gurations for CAP Node
Applications.

SAP Extension Cloud MTA You can now edit the MTA descriptor Info New 2020-
Business Suite - Foundry le (mta.yaml) using the MTA Editor. only 09-29
Application Development See MTA Editor.
Studio Efficiency

SAP Extension Cloud Running SAP You can now run an SAP Fiori Info New 2020-
Business Suite - Foundry Fiori application locally with an SAP only 09-13
Application Development Applications Business Accelerator Hub service. See
Studio Efficiency Run Your Application with the SAP
Business Accelerator Hub.

SAP Extension Cloud CAP You can now use the CDS Graphical Info New 2020-
Business Suite - Foundry Modeler when developing CAP only 08-30
Application Development applications. See Design CDS Models
Studio Efficiency Using SAP Business Application
Studio

SAP Extension Cloud Running SAP You can now run your SAP Fiori Info New 2020-
Business Suite - Foundry Fiori project's automated tests using only 08-30
Application Development Applications Karma. See Run Automated Tests of
Studio Efficiency Your Application.

SAP Extension Cloud SAP Fiori You can now add an SAP Fiori module Info New 2020-
Business Suite - Foundry Development to an existing MTA project. See Add an only 08-30
Application Development Additional SAP Fiori Application to
Studio Efficiency Your Project.

This is custom documentation. For more information, please visit the SAP Help Portal 31
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud SAP Fiori You can now use quick x for missing Info Changed 2020-
Business Suite - Foundry Development IDs in XML view les. See Validation of only 08-30
Application Development Stable IDs.
Studio Efficiency

SAP Extension Cloud SAP Fiori You can now develop an SAP Fiori Info New 2020-
Business Suite - Foundry Development application consuming a CAP service, only 08-16
Application Development run it locally, build, and deploy it to
Studio Efficiency Cloud Foundry. See Developing an SAP
Fiori Application for a CAP Project.

SAP Extension Cloud SAP Fiori You can now develop an SAP Fiori Info New 2020-
Business Suite - Foundry Development application consuming a service from only 08-16
Application Development an ABAP Cloud System, run it locally,
Studio Efficiency build, and deploy it to Cloud Foundry,
using the managed approuter or a
standalone approuter. See Develop an
Application for Cloud Foundry.

SAP Extension Cloud SAP Fiori You can now develop an SAP Fiori Info New 2020-
Business Suite - Foundry Development application and deploy it to an ABAP only 08-16
Application Development Cloud System. See Developing an SAP
Studio Efficiency Fiori Application Based on an ABAP
Cloud System Service.

SAP Extension Cloud SAP Fiori You can now perform "abap deploy" in Info New 2020-
Business Suite - Foundry Deployment your local environment, outside of SAP only 08-16
Application Development Business Application Studio. See
Studio Efficiency abap-deploy npm documentation
and Deploy to the SAPUI5 ABAP
Repository.

SAP Extension Cloud CAP Development of CAP applications is Info New 2020-
Business Suite - Foundry now available in the China (Shanghai) only 08-16
Application Development region.
Studio Efficiency

SAP Extension Cloud SAP Fiori You can now deploy your SAP Fiori Info New 2020-
Business Suite - Foundry Development application to the SAPUI5 ABAP only 08-02
Application Development Repository in SAP S/4HANA Cloud.
Studio Efficiency See Deploy to the SAPUI5 ABAP
Repository.

SAP Extension Cloud CAP You can now use Spring-boot tools Info New 2020-
Business Suite - Foundry when developing Spring-boot only 08-02
Application Development applications. See spring-projects .
Studio Efficiency

SAP Extension Cloud CAP SAP Business Application Studio has Info Changed 2020-
Business Suite - Foundry been updated to include SapMachine only 08-02
Application Development 11. See SapMachine .
Studio Efficiency

SAP Extension Cloud SAP Fiori The XML UI5 code validation is now Info Changed 2020-
Business Suite - Foundry Development enhanced with stable ID checks. See only 08-02
Application Development Validation of Stable IDs.
Studio Efficiency

This is custom documentation. For more information, please visit the SAP Help Portal 32
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud SAP Fiori SAP Fiori is now selected by default Info Changed 2020-
Business Suite - Foundry Development when choosing the type of dev space only 08-02
Application Development to create in SAP Business Application
Studio Efficiency Studio.

SAP Extension Cloud Trial When you subscribe to SAP Business Info New 2020-07-
Business Suite - Foundry landscape Application Studio in the Trial only 19
Application Development Landscape, the relevant roles are
Studio Efficiency automatically assigned to the account.

SAP Extension Cloud CAP You can now run your CAP Node.js Info New 2020-07-
Business Suite - Foundry application from the Run only 19
Application Development Con gurations view and bind it to an
Studio Efficiency instance of SAP HANA Cloud or an
instance of hanatrial. See Creating Run
Con gurations for CAP Node
Applications.

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2020-07-
Business Suite - Foundry been updated to include xes and only 19
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.3.0.

SAP Extension Cloud SAP Fiori You can develop SAP Fiori applications Info New 2020-
Business Suite - Foundry Development for Cloud Foundry using the approuter only 06-28
Application Development on the subaccount level and run an
Studio Efficiency HTML5 application managed by SAP
BTP. See Create an SAP Fiori Project
and Deploy Your Application.

SAP Extension Cloud CAP You can now run your CAP Node Info New 2020-
Business Suite - Foundry application from the Run only 06-28
Application Development Con gurations view and bind it to a
Studio Efficiency destination. See Creating Run
Con gurations for CAP Node
Applications.

SAP Extension Cloud CAP You can now run your CAP Node Info New 2020-
Business Suite - Foundry application from the Run only 06-28
Application Development Con gurations view using mock OData
Studio Efficiency services. See Creating Run
Con gurations for CAP Node
Applications.

SAP Extension Cloud CAP You can now run your CAP Node Info New 2020-
Business Suite - Foundry application from the Run only 06-28
Application Development Con gurations view and deploy it out-
Studio Efficiency of-the-box to an SAP HANA database.
See Creating Run Con gurations for
CAP Node Applications.

SAP Extension Cloud Theia It is now possible to open concurrent Info New 2020-
Business Suite - Foundry embedded graphical editors in SAP only 06-28
Application Development Business Application Studio and even
Studio Efficiency display them side by side.

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2020-
Business Suite - Foundry been updated to include xes and only 06-28
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.2.0.

This is custom documentation. For more information, please visit the SAP Help Portal 33
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud SAP Fiori The XML UI5 code validation is now Info Changed 2020-
Business Suite - Foundry Development enhanced with type aggregation and only 06-28
Application Development deprecation checks. See Develop Your
Studio Efficiency Application.

SAP Extension Cloud SAP Fiori The XML UI5 code assist provides Info Changed 2020-
Business Suite - Foundry Development settings for deprecated and only 06-28
Application Development experimental element proposals. See
Studio Efficiency Develop Your Application.

SAP Extension Cloud SAP Fiori SAPUI5 Adaptation Project is now Info New 2020-
Business Suite - Foundry Development available in SAP Business Application only 06-21
Application Development Studio. You can create an app variant
Studio Efficiency for an existing SAP Fiori application
and make use of the extension
capabilities for UI5 controls. See
Extending an SAP Fiori Application.

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2020-
Business Suite - Foundry been updated to include xes and only 06-21
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.1.0.

SAP Extension Cloud Dev Space You can now open a dev space in a Info New 2020-
Business Suite - Foundry Manager separate browser tab. only 06-21
Application Development
Studio Efficiency

SAP Extension Cloud SAP Fiori The XML UI5 code validation is now Info New 2020-
Business Suite - Foundry Development enhanced with duplicate ID and only 06-21
Application Development aggregation cardinality checks. See
Studio Efficiency Develop Your Application.

SAP Extension Cloud SAP Fiori You can now develop using Fiori Info New 2020-
Business Suite - Foundry Development elements. only 06-21
Application Development
Studio Efficiency

SAP Extension Cloud Application The Application Wizard has been Info Changed 2020-
Business Suite - Foundry Wizard enhanced. Steps are now clickable only 06-07
Application Development and you can press 'Enter' in the login
Studio Efficiency control.

SAP Extension Cloud Run The Run Con guration tree shows Info New 2020-
Business Suite - Foundry Con gurations 'shared' dependencies. only 06-07
Application Development
Studio Efficiency

SAP Extension Cloud SAP Fiori You can now add a launchpad to an Info New 2020-
Business Suite - Foundry Development SAP Fiori project with a Cloud Foundry only 06-07
Application Development target runtime. See Basic
Studio Efficiency Development Flow in SAP Business
Application Studio.

SAP Extension Cloud SAP BTP SAP Business Application Studio Trial Info New 2020-
Business Suite - Foundry Regions is now available in the AWS US East only 05-24
Application Development (VA) region.
Studio Efficiency

This is custom documentation. For more information, please visit the SAP Help Portal 34
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud SAP Fiori You can now deploy SAP Fiori Info New 2020-
Business Suite - Foundry Deployment applications to the HTML5 repository only 05-24
Application Development using the Generic Application Content
Studio Efficiency Deployer (GACD).

SAP Extension Cloud Theia SAP Business Application Studio has Info Changed 2020-
Business Suite - Foundry been updated to include xes and only 05-24
Application Development improvements that are part of Eclipse
Studio Efficiency Theia 1.0.0.

SAP Extension Cloud Application The New Application wizard now has Info New 2020-
Business Suite - Foundry Wizard a Back button. You can go to previous only 05-10
Application Development steps to change or view your entries.
Studio Efficiency

SAP Extension Cloud Application You can now choose the location where Info Changed 2020-
Business Suite - Foundry Wizard the new projects should be generated. only 05-10
Application Development
Studio Efficiency

SAP Extension Cloud Consume SAP You can now insert a direct URL to Info Changed 2020-
Business Suite - Foundry Services consume a service and bind it to your only 05-10
Application Development project.
Studio Efficiency

SAP Extension Cloud MTA With the new Cloud MTA Build Tool Info New 2020-
Business Suite - Foundry version 1.0.14, you can use the module only 05-10
Application Development build features directly in SAP
Studio Efficiency Business Application Studio. See
Auxiliary Commands .

SAP Extension Cloud CAP You can now run your CAP Node Info New 2020-
Business Suite - Foundry application from the Run only 05-10
Application Development Con guration view and bind to a local
Studio Efficiency sqlite database.

SAP Extension Cloud SAP Fiori You can now specify a package and Info New 2020-
Business Suite - Foundry Development transport when deploying an SAP Fiori only 05-10
Application Development application to ABAP.
Studio Efficiency

SAP Extension Cloud CAP The 'cds-dk' has been updated to Info Changed 2020-
Business Suite - Foundry version 1.6.4 and the 'generator-cap- only 04-26
Application Development project' to version 1.0.6.
Studio Efficiency

SAP Extension Cloud CAP You can now view data models from Info New 2020-
Business Suite - Foundry external services in the CAP project only 04-26
Application Development explorer.
Studio Efficiency

SAP Extension Cloud SAP Fiori When using freestyle templates, you Info New 2020-
Business Suite - Foundry project can now consume services and bind only 04-26
Application Development creation entities.
Studio Efficiency

SAP Extension Cloud Run You can now con gure multiple data Info New 2020-
Business Suite - Foundry Con gurations sources in SAP Fiori run con gurations only 04-26
Application Development for Cloud Foundry. Cloud Foundry login
Studio Efficiency is not required.

This is custom documentation. For more information, please visit the SAP Help Portal 35
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud SAP Fiori You can now get SAPUI5 code assist Info New 2020-
Business Suite - Foundry Development for XML views and fragments. only 04-26
Application Development
Studio Efficiency

SAP Extension Cloud SAP Fiori You can now get code validation for the Info New 2020-
Business Suite - Foundry Development application descriptor only 04-26
Application Development (manifest.json le).
Studio Efficiency

SAP Extension Cloud Cloud Foundry When you create a service instance, Info New 2020-
Business Suite - Foundry Tools you can outline the service only 04-26
Application Development parameters.
Studio Efficiency

SAP Extension Cloud SAP Fiori You can now deploy HTML5 modules Info New 2020-
Business Suite - Foundry Deployment independently, using the 'HTML5 only 04-26
Application Development Applications repository CLI' plugin.
Studio Efficiency You can then inspect these modules in
runtime. See Deploy Your Application.

SAP Extension Cloud SQL Tools We have updated the SQL Tools to Info Changed 2020-
Business Suite - Foundry version 0.21.6. With this version, you only 04-12
Application Development can now connect to SAP HANA as a
Studio Efficiency Service (HaaS).

SAP Extension Cloud CAP You can now create a CAP application Info New 2020-
Business Suite - Foundry using the command palette or the only 04-12
Application Development terminal.
Studio Efficiency

SAP Extension Cloud Data Privacy When an account is closed or when an Info Changed 2020-
Business Suite - Foundry administrator unsubscribes from SAP only 04-12
Application Development Business Application Studio, all the
Studio Efficiency tenant's data is deleted automatically.

SAP Extension Cloud Project A default run con guration is now Info New 2020-
Business Suite - Foundry Wizard Tool created as part of the project wizard only 04-12
Application Development ow. You can create a project from
Studio Efficiency template and run it.

 Note
Not applicable for CAP
applications.

SAP Extension Cloud Project When the project wizard ends, you can Info New 2020-
Business Suite - Foundry Wizard Tool now choose between Open New only 04-12
Application Development Workspace to open the generated
Studio Efficiency project in the root, or Add to
Workspace to work in multi-root.

SAP Extension Cloud Run You can now run an SAP Fiori Info New 2020-
Business Suite - Foundry Con gurations application with a Cloud Foundry only 04-12
Application Development target runtime consuming an ABAP on-
Studio Efficiency premise service.

This is custom documentation. For more information, please visit the SAP Help Portal 36
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud Consuming You can now perform service Info New 2020-
Business Suite - Foundry SAP Services exploration in both the V2 and v4 only 03-29
Application Development formats.
Studio Efficiency

SAP Extension Cloud Cloud Foundry The Cloud Foundry tools have been Info Changed 2020-
Business Suite - Foundry Tools moved to the 'npm' package so that only 03-29
Application Development they can be used externally.
Studio Efficiency

SAP Extension Cloud Project New features have been added to the Info Changed 2020-
Business Suite - Foundry Creation project wizard, such as displaying only 03-29
Application Development prompts in advance, login control, and
Studio Efficiency browse control.

SAP Extension Cloud Run When running an SAP Fiori app locally, Info New 2020-
Business Suite - Foundry Con gurations you can now select the SAPUI5 only 03-29
Application Development version. See Creating Run
Studio Efficiency Con gurations for SAP Fiori
Applications.

SAP Extension Cloud Extensions SAP Mobile Services Info New 2020-
Business Suite - Foundry only 03-15
Use the Mobile Development Kit
Application Development
(MDK) editor to edit various aspects
Studio Efficiency
of your MDK application such as
validating and bundling the MDK app,
creating MDK metadata objects, and
deploying the MDK app to Mobile
Services. You can also use the MBT
tool to create an OData CSDL le and
generate an OData service in Java
from an OData CSDL le. See Setting
Up the Editor in SAP Business
Application Studio.

SAP Extension Cloud Run You can now use Local Run with test Info New 2020-
Business Suite - Foundry Con gurations (mock) data when testing the only 03-15
Application Development "Consume SAP Services" tool in VS
Studio Efficiency Code.

SAP Extension Cloud Consuming When running a CAP Node application Info New 2020-
Business Suite - Foundry SAP Services using the Run Con guration view, you only 03-15
Application Development can now easily bind it to depending
Studio Efficiency Cloud Foundry services. See Creating
Run Con gurations for CAP Node
Applications.

SAP Extension Cloud Extensions The following tools are now installed Info New 2020-
Business Suite - Foundry and exposed via the CLI as part of the only 03-15
Application Development Basic Tools extension: make, bzip2,
Studio Efficiency patch, perl, tar, sqlite3, vim, zip, and
pv.

SAP Extension Cloud Run Freestyle SAPUI5 templates are Info New 2020-
Business Suite - Foundry Con gurations available for project creation using the only 03-15
Application Development terminal. See Create an SAP Fiori
Studio Efficiency Project.

This is custom documentation. For more information, please visit the SAP Help Portal 37
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud Run The development dependencies to Info New 2020-
Business Suite - Foundry Con gurations SAP Fiori projects are now installed only 03-15
Application Development upon project creation.
Studio Efficiency

SAP Extension Cloud Run When running an SAP Fiori app locally, Info New 2020-
Business Suite - Foundry Con gurations you can now select if you want to run it only 03-15
Application Development from the 'build' folder or from the
Studio Efficiency 'source' folder. See Creating Run
Con gurations for SAP Fiori
Applications.

SAP Extension Cloud Run You can now choose the relevant HTML Info New 2020-
Business Suite - Foundry Con gurations le, such as a QUnit test or a mock only 03-01
Application Development server, when creating run
Studio Efficiency con gurations for a SAP Fiori
application deployed to Cloud
Foundry. See Creating Run
Con gurations for SAP Fiori
Applications.

SAP Extension Cloud Working with You can now use the Project Explorer Info New 2020-
Business Suite - Foundry CAP feature for CAP applications. See only 03-01
Application Development Applications Storyboard and Project Explorer.
Studio Efficiency

SAP Extension Cloud Running SAP You can now select an HTML le from Info New 2020-
Business Suite - Foundry Fiori the Run Con gurations view to run only 03-01
Application Development Applications your SAP Fiori project.
Studio Efficiency

SAP Extension Cloud Develop You can now develop an SAP Fiori Info New 2020-
Business Suite - Foundry Application application consuming a service from only 02-16
Application Development Based on an the ABAP Service Catalog. See
Studio Efficiency ABAP Service Developing an SAP Fiori Application
Catalog Based on an SAP S/4HANA or ECC
System.

SAP Extension Cloud Run You can now create and manage a run Info New 2020-
Business Suite - Foundry Con gurations con guration for the Java service of an only 02-02
Application Development MTA application via the Run
Studio Efficiency Con gurations view. See Creating
Run Con gurations for Java Modules.

 Note
Available in AWS and Azure regions
only.

This is custom documentation. For more information, please visit the SAP Help Portal 38
2/6/2024

Technical Capability Environment Title Description Action Type Available


Component as of

SAP Extension Cloud Run You can now create run con gurations Info New 2020-
Business Suite - Foundry Con gurations for CAP applications and the Java only 02-02
Application Development service of MTAs within a multi-root
Studio Efficiency workspace. See Multi-root
Workspaces .

 Note
Available in AWS and Azure regions
only.

SAP Extension Cloud Extensions You can now trigger an MTA build and Info New 2020-
Business Suite - Foundry deploy it from a context menu and the only 02-02
Application Development command palette. See Building and
Studio Efficiency Deploying Multitarget Applications.

SAP Extension Cloud Deploy to You can now deploy an existing SAP Info New 2020-
Business Suite - Foundry ABAP Fiori project from SAP Business only 02-02
Application Development Application Studio to the SAPUI5
Studio Efficiency ABAP repository. See Deploy to the
SAPUI5 ABAP Repository.

SAP Extension Cloud Develop You can now develop an SAP Fiori Info New 2020-
Business Suite - Foundry Application application consuming a service from only 02-02
Application Development Based on ABAP Cloud System Service catalog.
Studio Efficiency ABAP Cloud See Developing an SAP Fiori
System Application Based on an ABAP Cloud
System Service.

SAP Extension Cloud Extensions You can use the VS Code REST Client Info New 2020-01-
Business Suite - Foundry in your dev spaces. See VS Code only 16
Application Development REST Client .
Studio Efficiency
 Note
Available in AWS and Azure regions
only.

SAP Extension Cloud CDS We have updated the CDS extension Info New 2020-01-
Business Suite - Foundry Extensions to use @sap/cds-dk version 1.3.1. only 16
Application Development
Studio Efficiency  Note
Available in AWS and Azure regions
only.

SAP Extension Cloud Consuming You can now select a data source for Info New 2019-11-
Business Suite - Foundry SAP Services your project from the service catalog only 14
Application Development of an ABAP system. The destination
Studio Efficiency will appear with the "Catalog"
descriptor. See Consuming SAP
Services.

Developer Guide

This is custom documentation. For more information, please visit the SAP Help Portal 39
2/6/2024
With SAP Business Application Studio, you can develop business applications for the Intelligent Enterprise.

 Note
To work in SAP Business Application Studio, your subaccount must be subscribed to the SAP Business Application Studio
application. See Set Up SAP Business Application Studio.

If you are woking in a trial account, follow the procedure in Getting Started with a Trial Account.

Dev Spaces in SAP Business Application Studio


A dev space is a development environment with the tools, capabilities, and resources needed for developing your
application.
Working in SAP Business Application Studio
SAP Business Application Studio provides the features needed for the entire life cycle of your application, from the
moment you create the project until it is ready to be deployed.
Working with a Trial Account
Get a trial account to experience SAP Business Application Studio for free.
Restrictions
When using SAP Business Application Studio, there are user restrictions on computing resources and project
components to ensure optimal performance.
Troubleshooting
Explore the Guided Answers for troubleshooting issues in SAP Business Application Studio.
Contact SAP Support
We suggest you report an incident or error through the SAP Support Portal.

Dev Spaces in SAP Business Application Studio


A dev space is a development environment with the tools, capabilities, and resources needed for developing your application.

A dev space provides tailored tools and pre-installed runtimes for your business scenario. This simpli es and saves time in
setting up your development environment and allows you to efficiently develop, test, build, and run your solution locally or in the
cloud.

Each dev space type contains a set of prede ned extensions that help improve your experience.

An SAP Business Application Studio extension is a set of tools that help you perform a speci c development task. For example,
the Java Tools extension provides you with the tools that you need to develop a Java application. The Fiori Tools extension
includes the templates, CLI, and code completion required to create an SAP Fiori application.

During dev space creation, you can choose to add additional extensions to the dev space. The additional extensions provide
additional tools to supplement the application with additional components for the scenario to your developer environment. See
Additional Extensions.

You can also add extensions to an existing dev space. See Add Extensions to Your Dev Space.

When creating a new dev space, select the dev space type that best ts the application you want to create. See Dev Space
Types.

Con gure Your Dev Space Settings


You can con gure your preferred settings for working in the dev space:

This is custom documentation. For more information, please visit the SAP Help Portal 40
2/6/2024
1. Open your dev space.

2. Navigate to File Preferences Settings .

3. Con gure your settings:

Keyboard shortcuts

Color theme

File icon theme

General preferences

 Note
Settings are relevant per dev space. You must con gure your settings for each dev space separately.

You can create, delete, stop, and start dev spaces. You can also download dev space content, and import dev space content. See
Working in the Dev Space Manager.

 Note
Dev spaces not used for more than 30 days are archived to save on disk space. You can still access them just like any other
dev space, but they might take up to 1 minute longer to load.

Using Additional Tools


It is possible to install additional tools on a dev space or consume additional software components for developing applications
using the terminal, the dedicated UI, or directly in the code.

 Note
SAP provides you with a mechanism to access third party sites to view and download open-source, 3rd party or its own tools,
libraries, or software components (“Extensions”) to dev spaces in SAP Business Application Studio. Using this mechanism,
you can view and install Extensions at your own risk.

SAP does not certify or endorse any of the third-party sites or Extensions, and they are not part of SAP Business Application
Studio.

You must ensure that you have all the necessary rights to use these Extensions.

You are responsible for all aspects of the Extensions, including maintenance, management, security, and support.

You will assume all responsibility for any negative effects caused by or relating to the Extensions.

SAP may disable any dev space that includes Extensions that cause system malfunction or that SAP reasonably believes
may cause harm to SAP systems.

Working in the Dev Space Manager


You can create, delete, stop, and start dev spaces. You can also download dev space content, and import dev space content.

Create a Dev Space


This is custom documentation. For more information, please visit the SAP Help Portal 41
2/6/2024
You can generate a dev space to create and manage applications. You can select the application type that includes the
extensions that you need to do a development task.

1. Open SAP Business Application Studio and log in with your credentials.

2. Click Create Dev Space.

3. Enter a name for the dev space.

4. Select the relevant application type.

5. (Optional) Select the relevant additional extensions to enhance your space.

You can also add or remove extensions later. See the Add Extensions to Your Dev Space section.

6. Click Create Dev Space.

 Note
You can only click the button if you entered a dev space name.

 Note
Dev Space creation is in uenced by the application plan you are using.

If you are using a productive account, see SAP Business Application Studio Restrictions.

If you are using a free account, see Free Plan Restrictions.

Stop, Start, or Delete Your Dev Space


If you don't need to work with your dev space for a while, you can stop your dev space. When your dev space is running, it
consumes memory, energy, and CPU. If you don't use your dev space and it sits idle for a while, the dev space is stopped.

When you restart your stopped dev space, all content in your dev space, including les and settings, are available. If you want to
apply updates to extensions and bug xes, you must stop your dev space and start it again.

You can also delete your dev space.

 Note
By creating a dev space, you create a project and le system for yourself. If you delete your dev space, you can't recover it.
We recommend syncing, backing up, and saving your project to a Git repository. See Connect to Your Git Source Control
System.

Add or Remove Extensions


You can change the extensions you selected for your dev space.

1. From the Dev Space Manager, click to edit the dev space.

 Note
To edit an extension, the dev space must be in the stopped state.

2. Select the additional SAP extensions that you want to add, or clear the checkmark from extensions you want to remove.

3. Click Save Changes.

This is custom documentation. For more information, please visit the SAP Help Portal 42
2/6/2024

Download Dev Space Content


You can download the dev space content in the following situations:

When your dev space is in the RUNNING state to save the dev space contents.

When your dev space is in the ERROR state to recover your data and move the contents to another dev space.

To download the content of your dev space, click and then Download.

If your dev space is in the ERROR state, after the download begins, the dev space state changes to STARTING. The dev space
state then changes to SAFE MODE and then the tar le downloads.

After the dev space changes to SAFE MODE, it's not possible to return to the RUNNING state. You can only download the dev
space content and delete the dev space.

When the export process is complete, the tar le, with the dev space content, is downloaded.

 Note
After exporting the dev space content, check the size of the dev space before uploading. Make sure that the size doesn't
exceed 10 GB.

Import Dev Space Content


After downloading the dev space content, you can import the content to another dev space:

1. Create a new dev space, start it, and open it.

2. From the Explorer view, click Open Folder.

The path to the user folder (/home/user/) is displayed in the command palette.

3. Click OK to open the user folder.

4. Right-click the projects folder and click Upload...

5. From the Downloads folder, choose the le with the dev space content.

6. Right-click the projects folder and click Open in Integrated Terminal.

7. Enter the following command to uncompress the uploaded le:

tar xvzf <Your.tar.gzFile>

Dev Space Types


When creating a new dev space, select the dev space type that best ts the application you want to create.

SAP Business Application Studio has the following dev space types:

SAP Fiori: Develop SAP Fiori applications based on various environments, including Cloud Foundry, ABAP Cloud, and SAP
S/4HANA.

Full-Stack Application Using Productivity Tools: Easily develop, test, build, and deploy apps using high productivity tools.

This is custom documentation. For more information, please visit the SAP Help Portal 43
2/6/2024
Full Stack Cloud Application: Build business services, business applications, and extend S/4HANA using the SAP Cloud
Application Programming Model, Fiori and Java or Node.js .

SAP HANA Native Application: Build and deploy native SAP HANA applications or analytical models. This dev space
contains a comprehensive set of editors to support the creation of database artifacts (calculation views, tables,
SQLScript procedures, and more), as well as tools to enable an end-to-end development ow from project creation to
the deployment to the SAP BTP.

SAP Mobile Application: The SAP Mobile Development Kit (MDK) lets you customize, deploy, and manage your
customized iOS and Android apps in the cloud.

Basic: Contains the SAP basic tools extension.

SAP Fiori
Develop SAP Fiori applications based on various environments: Cloud Foundry, ABAP on-prem, and ABAP Cloud.

See Developing and Extending SAP Fiori Applications.

Migration from SAP Web IDE

If you have projects that were created using SAP Web IDE, you can migrate them to SAP Business Application Studio. See
Migration.

The SAP Fiori scenario contains the following prede ned extensions:

SAPUI5 Adaptation Project

Allows you to extend SAPUI5 applications, using the Adaptation Project and the Visual Editor. See Extending SAP Fiori
Applications.

Basic Tools

Allows you to optimize your web development work ow. The extension includes capabilities such as a code editor, le
management capabilities, split view and window management, preferences and settings.

Fiori Freestyle Tools

Allows you to optimize your Fiori-based development. This extension provides Fiori templates with the following tools:

UI5 CLI

Grunt CLI

abap-deploy CLI

HTML5 Runner

Allows you to locally run HTML5 applications. This extension includes the HTML5 application runner and run
con gurations.

See Create Run Con gurations for HTML5 Applications.

MTA Tools

Allows you to perform operations such as build, deployment, and validation on multitarget applications. The following
tools will be installed as part of the extension:

Cloud Foundry environment CLI

This is custom documentation. For more information, please visit the SAP Help Portal 44
2/6/2024
Cloud Foundry environment deployment plugin

Cloud MTA Build Tool

MTA module runner (VS Code extension)

See MTA Tools.

SAP Fiori Tools

Allows you to simplify the development of SAP Fiori elements applications by providing extensions that can help you
create applications, visualize navigation, automatically generate code, and more. The following extensions will be
installed:

Fiori elements Yeoman Generator

Application Modeler

Guided Development

Service Modeler

XML Annotation Language Server

See Getting Started with SAP Fiori tools.

Startup Server

Allows you to leverage a trigger and perform an action.

SAPUI5 Layout Editor & Extensibility

Allows you to visually develop your XML view and extend an existing SAPUI5 application that resides in the SAPUI5 ABAP
repository.

See Working with the Layout Editor and Extending an SAP Fiori Application for an On-Premise System.

Full-Stack Application Using Productivity Tools


Easily develop, test, build, and deploy apps using high productivity tools.

See Develop a Business Application Using Productivity Tools.

The Full-Stack Application Using Productivity Tools scenario contains the following prede ned extensions:

Basic Tools

Allows you to optimize your web development work ow. The extension includes capabilities such as a code editor, le
management capabilities, split view and window management, preferences and settings.

CDS Graphical Modeler

Allows you to design SAP core data service models in SAP Cloud Business Application development projects.

The extension includes the CDS Editor, which provides capabilities for SAP business developers to visually design SAP
CDS models. Models include artifacts, such as entities, types, unstructured types, enums, arrayed types, events,
associations and compositions, and projects and services, which accelerate SAP Cloud Business Application
development.

See Design CDS Models Using SAP Business Application Studio.

CAP Tools
This is custom documentation. For more information, please visit the SAP Help Portal 45
2/6/2024
Allows you to develop applications based on CDS using the CDS command line and tools.

Includes enhanced code editors and database management capabilities.

Productivity Tools

Collection of low code tools enabling developers to easily build full stack applications for desktop and mobile use.

Mobile Services App Development Tools

Allows you to build end to end mobile applications. From modeling and generating OData services, creating mobile native
apps from metadata with MDK to building content for SAP Mobile Cards.

Fiori Freestyle Tools

Allows you to optimize your Fiori-based development. This extension provides Fiori templates with the following tools:

UI5 CLI

Grunt CLI

abap-deploy CLI

HTML5 Runner

Allows you to locally run HTML5 applications. This extension includes the HTML5 application runner and run
con gurations.

See Create Run Con gurations for HTML5 Applications.

Java Tools

Allows you to develop, test, and run Java applications. Includes debugging capabilities and enhanced code editors.

MTA Tools

Allows you to perform operations such as build, deployment, and validation on multitarget applications. The following
tools are installed as part of the extension:

Cloud Foundry environment CLI

Cloud Foundry environment deployment plugin

Cloud MTA Build Tool

MTA module runner (VS Code extension)

See MTA Tools.

SAP Fiori Tools

Allows you to simplify the development of SAP Fiori elements applications by providing extensions that can help you
create applications, visualize navigation, automatically generate code, and more. The following extensions are installed:

Fiori elements Yeoman Generator

Application Modeler

Guided Development

Service Modeler

XML Annotation Language Server

See SAP Fiori Tools.

This is custom documentation. For more information, please visit the SAP Help Portal 46
2/6/2024
Startup Server

Allows you to leverage a trigger and perform an action.

SAPUI5 Layout Editor & Extensibility

Allows you to visually develop your XML view and extend an existing SAPUI5 application that resides in the SAPUI5 ABAP
repository.

See Working with the Layout Editor and Extend SAPUI5 Applications.

Full Stack Cloud Application


Build business services and business applications and extend SAP S/4HANA using SAP Cloud Application Programming Model,
SAP Fiori, and Java or Node.js.

See Developing a CAP Application in SAP Business Application Studio.

The Full Stack Cloud Application scenario contains the following prede ned extensions:

Basic Tools

Allows you to optimize your web development work ow. The extension includes capabilities such as a code editor, le
management capabilities, split view and window management, preferences and settings.

CDS Graphical Modeler

Allows you to design SAP core data service models in SAP Cloud Business Application development projects.

The extension includes the CDS Editor, which provides capabilities for SAP business developers to visually design SAP
CDS models. Models include artifacts, such as entities, types, unstructured types, enums, arrayed types, events,
associations and compositions, and projects and services, which accelerate SAP Cloud Business Application
development.

See Design CDS Models Using SAP Business Application Studio.

CAP Tools

Allows you to develop CAP applications using the CDS command-line and tools. Includes enhanced code and graphical
editors, database management capabilities, and tools for running your application.

Fiori Application

Allows you to create a Fiori application, using the Yeoman generator.

Fiori Freestyle Tools

Allows you to optimize your Fiori-based development. This extension provides Fiori templates with the following tools:

UI5 CLI

Grunt CLI

abap-deploy CLI

SAP HANA Database Explorer

Allows you to access and inspect SAP HANA run-time objects. The extension includes a command that opens the SAP
HANA Database Explorer in a new browser tab.

Java Tools

This is custom documentation. For more information, please visit the SAP Help Portal 47
2/6/2024
Allows you to develop, test, and run Java applications. Includes debugging capabilities and enhanced code editors.

MTA Tools

Allows you to perform operations such as build, deployment, and validation on multitarget applications. The following
tools are installed as part of the extension:

Cloud Foundry environment CLI

Cloud Foundry environment deployment plugin

Cloud MTA Build Tool

MTA module runner (VS Code extension)

See MTA Tools.

SAP Fiori Tools

Allows you to simplify the development of SAP Fiori elements applications by providing extensions that can help you
create applications, visualize navigation, automatically generate code, and more. The following extensions are installed:

Fiori elements Yeoman Generator

Application Modeler

Guided Development

Service Modeler

XML Annotation Language Server

See SAP Fiori Tools.

Startup Server

Allows you to leverage a trigger and perform an action.

SAPUI5 Layout Editor & Extensibility

Allows you to visually develop your XML view and extend an existing SAPUI5 application that resides in the SAPUI5 ABAP
repository.

See Working with the Layout Editor and Extend SAPUI5 Applications.

SAP HANA Native Application


Build and deploy native SAP HANA applications or analytical models. This dev space contains a comprehensive set of editors to
support the creation of database artifacts (calculation views, tables, SQLScript procedures, and more), as well as tools to
enable an end-to-end development ow from project creation to the deployment to the SAP BTP.

See Working with SAP Business Application Studio.

 Note
SAP Business Application Studio needs to connect to the SAP HANA Cloud instance where you want to deploy your
application’s database artifacts. By default, SAP HANA Cloud accepts all connections from allowed IP addresses in SAP BTP,
for example, in the same region and infrastructure where SAP HANA was provisioned.

This is custom documentation. For more information, please visit the SAP Help Portal 48
2/6/2024
If you are working on an Azure account or you are trying to connect an SAP HANA instance from a different region, you must
con gure SAP HANA Cloud to allow connections from the IP address hosting SAP Business Application Studio for your Cloud
region and the underlying platform.

To learn how to change the SAP HANA Cloud allowed connections, see Change Allowed Connections.

To nd out your SAP Business Application Studio IP address, see SAP Business Application Studio Availability.

The SAP HANA Native Application scenario contains the following prede ned extensions:

Basic Tools

Allows you to optimize your web development work ow. The extension includes capabilities such as a code editor, le
management capabilities, split view and window management, preferences and settings.

SAP HANA Calculation View Editor

Allows you to edit and manage SAP HANA calculation views. The extension includes the SAP HANA calculation view
editor, the synonym editor, and the analytical privilege editor.

See SAP HANA Cloud Modeling Guide for SAP Business Application Studio.

SAP HANA Database Explorer

Allows you to access and inspect SAP HANA run-time objects. The extension includes a command that opens the SAP
HANA Database Explorer in a new browser tab.

See SAP HANA Database Explorer.

SAP HANA Tools

Allows you to develop native SAP HANA applications. The extension includes tools such as enhanced graphical and text-
based editors, project generators, and productivity tools.

See SAP HANA Cloud Developer Guide.

MTA Tools

Allows you to perform operations such as build, deployment, and validation on multitarget applications. The following
tools will be installed as part of the extension:

Cloud Foundry environment CLI

Cloud Foundry environment deployment plugin

Cloud MTA Build Tool

MTA module runner (VS Code extension)

See MTA Tools.

SAP HANA Smart Data Integration Tools

Allows you to do data federation, replication and transformation in SAP HANA. The extension includes graphical editors
such as Flowgraph, Replication Task and File Format editors.

See Modeling Guide for SAP Web IDE and SAP Business Application Studio

Startup Server

Allows you to leverage a trigger and perform an action.

This is custom documentation. For more information, please visit the SAP Help Portal 49
2/6/2024

SAP Mobile Application


The Mobile Development Kit (MDK) lets you customize, deploy, and manage your customized iOS and Android apps in the cloud.

See, Mobile Development Kit.

The SAP Mobile Application scenario contains the following prede ned extensions:

Basic Tools

Allows you to optimize your web development work ow. The extension includes capabilities such as a code editor, le
management capabilities, split view and window management, preferences and settings.

Mobile Services App Development Tools

Mobile Services App Development Tools enable developers to build end to end mobile applications. From modeling and
generating OData services, creating mobile native apps from metadata with MDK to building content for SAP Mobile
Cards.

HTML5 Runner

Allows you to locally run HTML5 applications. Includes the HTML5 application runner and run con gurations.

See Create Run Con gurations for HTML5 Applications.

Java Tools

Allows you to develop and run Java applications. Includes debugging capabilities and enhanced code editors.

MTA Tools

Allows you to perform operations such as build, deployment, and validation on multitarget applications. The following
tools are installed as part of the extension:

Cloud Foundry environment CLI

Cloud Foundry environment deployment plugin

Cloud MTA Build Tool

MTA module runner (VS Code extension)

See MTA Tools.

Startup Server

Allows you to leverage a trigger and perform an action.

Additional Extensions
You can extend and enrich your development environment with tools and capabilities based on your needs.

Each dev space contains a group of extensions that enhance its existing functionality. Some extensions are prede ned by each
development scenario, and others can be manually enabled based on your speci c development needs.

The extensions may be used to add speci c tools or to add an additional scenario to the dev space.

The following list shows a selection of our most used additional extensions.

This is custom documentation. For more information, please visit the SAP Help Portal 50
2/6/2024

 Note
To learn more about the prede ned extensions, see Dev Space Types.

Scenario Extensions

Extension Description

Development Tools for SAP Build Work Zone Allows you to build UI Integration cards, which are user interface
elements that present new means to provide application
information to the end user in a uni ed way. The business
information is represented compactly and allows interaction on it
being executed. This editor allows users to create new cards or
build cards from available samples, edit card properties, and
preview the changes. Finally, users can bundle and deploy the
cards into different systems.
See SAP Build Work Zone, advanced edition Developer Guide.

HTML5 Application Template Allows you to create an HTML5 application, using a template
wizard.

See Developing an HTML5 Application for Cloud Foundry.

HTML5 Runner Allows you to locally run HTML5 applications. Includes the HTML5
application runner and run con gurations.

See Create Run Con gurations for HTML5 Applications.

SAP Business Application Studio Extension Development Allows you to use create, deploy, and manage your own SAP
Business Application Studio extensions. You can then include these
extensions in your SAP Business Application Studio environment.

The SAP Business Application Studio Extension Management CLI


tool will be installed as part of the extension.

Work ow Module Allows you to create work ow applications and process templates
with SAP Work ow Management.
See SAP Work ow Management.

Tool Extensions

Extension Description

CDS Graphical Modeler Allows you to design SAP core data service models in SAP Cloud
Business Application development projects.

The extension includes the CDS Editor, which provides capabilities


for SAP business developers to visually design SAP CDS models.
Models include artifacts, such as entities, types, unstructured
types, enums, arrayed types, events, associations and
compositions, and projects and services, which accelerate SAP
Cloud Business Application development.

See Design CDS Models Using SAP Business Application Studio.

Docker Image Builder Allows you to build docker images. It supports build, login, and
push commands.

 Note
The image is not persistent.

This is custom documentation. For more information, please visit the SAP Help Portal 51
2/6/2024

Extension Description

Headless Testing Framework Allows you to run cross-platform end-to-end tests on a UI5
application, with selectors compatible to OPA5.
See Using BAS with wdi5 .

Java Tools Allows you to develop, test, and run Java applications. Includes
debugging capabilities and enhanced code editors.

Launchpad Module Allows you to add a launchpad to your multitarget application.


See Basic Development Flow in SAP Business Application Studio.

Python Tools Allows you to improve your Python coding experience. This
extension includes IntelliSense, formatting, linting, and debugging
support for Python les and Jupyter notebooks.

SAP HANA Tools Allows you to develop native SAP HANA applications. The
extension includes tools such as enhanced graphical and text-
based editors, project generators, and productivity tools. See SAP
HANA Cloud Developer Guide.

SAP HANA XS Advanced Tools Allows you to develop native SAP HANA XS Advanced applications.
The extension includes productivity tools for SAP HANA XS
Advanced. See SAP HANA Developer Guide for XS Advanced Model
(SAP Business App Studio).

SAPUI5 Adaptation Project Allows you to extend SAP Fiori applications in SAP Business
Application Studio.

See Extending an SAP Fiori Application.

SAPUI5 Layout Editor & Extensibility Allows you to visually develop your XML view and extend an
existing SAPUI5 application that resides in the SAPUI5 ABAP
repository.
See Working with the Layout Editor and Extend SAPUI5
Applications.

Extending SAP Business Application Studio


Enrich the IDE with additional features and capabilities to make your development more efficient.

 Note
This feature is not available in the China (Shanghai) region.

The SAP Business Application Studio extension framework allows you to add new project and module templates to ease project
creation. You can enrich the IDE with tools that will help you develop faster and more efficiently, such as code assist, static code
analysis, and code formatting. Likewise, you can integrate your IDE with external services and systems.

The extension framework allows you to extend SAP Business Application Studio in 2 different ways:

Extend a speci c dev space with VS Code extensions and Yeoman generators.

Search the Open VSX Registry for additional VS Code extensions to install directly on your dev space.

See Explore and Install VS Code Extensions.

Search and install open source generators to add the most suitable templates for your wizards.

See Explore and Install Generators.

This is custom documentation. For more information, please visit the SAP Help Portal 52
2/6/2024
Create your own SAP Business Application Studio extension.

Package VS Code extensions and Yeoman generators into an SAP Business Application Studio extension and then
deploy it to the subaccount in which your team is working. All the team members can then enable the extension
from the Dev Space Manager.

See Create and Deploy an SAP Business Application Studio Extension.

Explore and Install VS Code Extensions


You can install VS Code extensions from the Open VSX Registry to get additional tools to support the development activities
in your dev space.

 Note
SAP provides you with a mechanism to access third-party sites to view and download open-source, 3rd party, or its own tools,
libraries, or software components (“Extensions”) to dev spaces in SAP Business Application Studio. Using this mechanism,
you can view and install VS Code Extensions from the Open VSX Registry at your own risk.

SAP does not certify or endorse any of the third-party sites or Extensions, and they are not part of SAP Business Application
Studio.

You must ensure that you have and maintain all the necessary rights to use these Extensions.

You are responsible for all aspects of the Extensions, including maintenance, management, security, and support. SAP
Business Application Studio does not support the auto-update feature for these extensions.

You will assume all responsibility for any negative effects caused by or relating to the Extensions.

SAP may elect, in its sole discretion, to disable any dev space that includes Extensions that cause system malfunction or that
SAP reasonably believes may cause harm to SAP systems.

To install an extension:

1. Click (Extensions) from the activity bar or navigate to View Extensions from the menu.

2. The rst time you open this view, a disclaimer is displayed. Click OK to open the Extensions view. To read it again later,
click Show Disclaimer.

The Extensions view includes the following sections:

Search box - Explore the extensions in the Open VSX Registry . You can see the relevant extensions together
with their short descriptions. Double-clicking on an extension opens the extension page with the full details. To
clear the search results, click .

Dev Space - Installed - Shows the list of extensions you have installed in your dev space. You can uninstall
extensions from here.

3. Use the Search box to nd the extension you want, and click Install.

To uninstall an extension:

1. Search for the extension using the Search box or in the Dev Space - Installed section.

2. Click Uninstall from the Manage button context menu.

This is custom documentation. For more information, please visit the SAP Help Portal 53
2/6/2024
To update an extension:

1. Search for the extension using the Search box or in the Dev Space - Installed section.

2. Click Uninstall from the Manage button context menu.

3. Click Install.

Explore and Install Generators


Use external open source generators to add the most suitable templates for your wizards.

 Note
SAP provides you with a mechanism to access third-party sites to view and download open-source, 3rd party, or its own tools,
libraries, or software components (“Extensions”) to dev spaces in SAP Business Application Studio.

Using this mechanism, you can view and install Yeoman Generators from the public npm registry at your own risk.

SAP does not certify or endorse any of the third-party sites or Extensions, and they are not part of SAP Business Application
Studio. You must ensure that you have and maintain all the necessary rights to use these Extensions. You are responsible for
all aspects of the Extensions, including maintenance, management, security, and support. You will assume all responsibility
for any negative effects caused by or relating to the Extensions.

SAP may elect, in its sole discretion, to disable any dev space that includes Extensions that cause system malfunction or that
SAP reasonably believes may cause harm to SAP systems.

1. Click Explore and Install Generators from the top of the Template wizard or enter Explore and Install
Generators in the command palette.

The Explore and Install Generators tool opens in a new tab.

2. The rst time you access the tool, a disclaimer is displayed. Click OK to continue.

The generators from the npm registry are displayed.

3. In the Search for Generators eld, enter the desired template type (for example, SAP Fiori or SAP HANA).

4. Continue searching until you nd the relevant generator.

5. Click Install. The generator is added to your machine and can now be selected from the Template Wizard.

Create and Deploy an SAP Business Application Studio Extension


Create an SAP Business Application Studio extension that includes VS Code extensions and Yeoman generators and deploy it to
your subaccount.

Prerequisites

You must have the Extension deployer role. See Manage Authorizations.

You must enable the SAP Business Application Studio Extension Development additional extension in your dev space.
See Working in the Dev Space Manager.

To create an SAP Business Application Studio extension:

This is custom documentation. For more information, please visit the SAP Help Portal 54
2/6/2024
1. In your workspace, create an extension de nition le called extension.json with the following content.

 Note
Make sure to replace the placeholders in the le with the relevant information.

 Note
Make sure you only install secured artifacts with your custom SAP Business Application Studio extension.

The extension de nition le includes two main parts:

The extension metadata

The list of components that are part of the extension: VS Code extensions, Yeoman generators

 Note
You must include at least one of these components in the le.

 Sample Code

{
"apiVersion": "1",
"name": "<technical name>",
"namespace": "ext-<subdomain - where <subdomain> is the subdomain of the subaccount of th
"about": {
"description": "<description>",
"author": "<author>",
"tagline": "<the extension name displayed in the dev space manager>",
"thumbnail": "<thumbnail - The thumbnail must be a base64 encoded SVG>"
},
"version": "<version>",
"yeomanPackages": [
{
"name": "<package name>",
"versionRange": "<package version>"
}
],
"vscodeExtensions": [
{
"source": "url",
"uri": "<the url to the .vsix file>"
}
]
}

2. Open a terminal and run the following command to deploy the extension to the subaccount:

wex deploy

3. Go to the Dev Space Manager to verify that the SAP Business Application Studio extension you created is visible as an
additional extension. All developers working on the subaccount to which you deployed can enable this extension from
their Dev Space Manager.

This is custom documentation. For more information, please visit the SAP Help Portal 55
2/6/2024
To delete the extension:

1. Open a terminal and run the following command:

wex delete -x <namespace>/<ext-name>

 Note
Deletion of an extension is only possible if the extension is not being used by any dev space.

Working in SAP Business Application Studio


SAP Business Application Studio provides the features needed for the entire life cycle of your application, from the moment you
create the project until it is ready to be deployed.

Get Started
Get started with SAP Business Application Studio.
Explore Services Using the Service Center
The Service Center provides a central entry point to explore services from various service providers.
Create a Project
You can create a project from scratch using the project wizard, you can clone a project, or you can import an already
existing project to your workspace.
Develop
SAP Business Application Studio provides you with the tools you require for making your development experience more
efficient and productive.
Test and Run
Once you have nished coding, you can test and run your application.
Build and Deploy
Use our dedicated tools to build and deploy your application.
Develop an App Using Different Subaccounts
You can develop your application with different subaccounts. You use one subaccount to create and run your application
in SAP Business Application Studio. You use the other subaccount, in a different region, to deploy your application to
Cloud Foundry.
Access SAP Business Application Studio from VS Code
Connect securely to SAP Business Application Studio dev spaces directly from a local Visual Studio Code desktop
application.

Get Started
Get started with SAP Business Application Studio.

This section describes the steps to take when you open your dev space for the rst time.

Get Started Page


The Get Started page provides you contextual links useful to users at the beginning of their development cycle.
Accessing On Premise Systems
You can access SAP ABAP or other on-premise systems using a built-in Web Proxy.

This is custom documentation. For more information, please visit the SAP Help Portal 56
2/6/2024

Get Started Page


The Get Started page provides you contextual links useful to users at the beginning of their development cycle.

The Get Started page is displayed when you open your dev space or enter Get Started in the command palette.

It includes the following sections:

Quick access to common activities that are relevant for your dev space

Quick access to the projects in the dev space.

Sample applications relevant for your dev space

Important links to documentation and help tools.

Accessing On Premise Systems


You can access SAP ABAP or other on-premise systems using a built-in Web Proxy.

Your dev space includes a built-in Web Proxy (http://localhost:8887) that allows you access to on-premise systems. It is
already con gured with the HTTP_PROXY and the HTTPS_PROXY environment variables.

The proxy requires destination con guration to your on-premise system from your Cloud Foundry subaccount.

For more information, see Connecting to External Systems.

This is custom documentation. For more information, please visit the SAP Help Portal 57
2/6/2024

De ning On Premise Systems for the Web Proxy


1. Your administrator must create a destination and con gure the Cloud Connector so that as a developer, you can access
on-premise systems.

2. To update your dev space with a destination created after your dev space was started, open your dev space terminal and
execute the following command:

curl http://localhost:8887/reload

This will trigger an immediate update of your on-premise destinations used by the dev space Web Proxy.

3. Use the same URL that's in the destination from your dev space. The proxy will pass your request through the
destination.

Using Git On Premise Repositories


You can work with on-premise Git repositories once an appropriate destination has been created in your subaccount. Make sure
to use the exact same host and port as de ned in the destination URL property.

For more information, see Connecting to a Corporate Git Repository.

Using NPM Modules from On Premise Repositories


You can use npm modules from an on-premise npm repository or an on-premise Git repository.

Use standard npm registry con gurations to set the repository URL.

For example:

npm config set @<scope>:registry <URL>

Make sure an appropriate destination has been created in your subaccount and that you are using the exact same host and
port as de ned in the destination URL property.

Using Java Modules from On Premise Repositories


You can use Java modules as dependencies to your Java projects from an on-premise Maven repository.

Edit the standard Maven settings le (open le /home/user/.m2/settings.xml) to add the repository URL.

For example:

<repositories>
. . .
<repository>
<id>corporate.repository</id>
<url>PUT YOUR FULL REPOSITORY URL HERE</url>
</repository>
. . .
<\repositories>

Make sure an appropriate destination has been created in your subaccount and that you are using the exact same host and
port as de ned in the destination URL property.

This is custom documentation. For more information, please visit the SAP Help Portal 58
2/6/2024

Explore Services Using the Service Center


The Service Center provides a central entry point to explore services from various service providers.

You can use the services as data sources in your application and you can trigger application development from the Service
Center.

To explore services, click (Service Center) from the activity bar or navigate to View Open View from the menu, and

enter Service Center in the input eld.

The Service Center opens with the various service providers displayed, including the SAP System Service Provider, the SAP
Business Accelerator Hub Service Provider, the API Business Hub Enterprise Service Provider, and the Uni ed Customer
Landscape Service Provider.

You can hide or display each service provider in the le explorer. Right-click Service Center or click the ellipsis next to Service
Center and select or clear the service provider.

SAP System Service Provider


The SAP System service provider includes systems from your SAP Business Application Studio subaccount. You can use the
services as data sources in your application or for application development.

Login occurs automatically, using the SAP Business Application Studio user credentials.

Explore SAP System Services


1. Click the arrow to display the SAP Business Application Studio subaccount's destinations ( ).

2. Click the system ( ) to see the system properties, including the name, description, URL, authentication type, and
status.

There are different types of systems displayed using the SAP Business Application Studio subaccount's destinations:

ABAP Service Catalog

The destination points to the ABAP system directly. The system shows its service catalogs with a list of services
(V2 and V4, for example). To see the list of services, click the system and log in with your user credentials, if
needed.

If the service catalog is available and connected ( ), you can search for services within it. Click the search icon (

) and select the relevant service from the command palette.

Service Host

The destination points to a host. To log in, enter the service path and your credentials, if needed, and click
CONNECT.

Service URL

The destination points directly to the service.

Cloud for Customer Catalog

The destination points to the SAP Cloud for Customer system directly. The system shows its service catalog with
a list of services (V2). To see the list of services, click the system and log in with your user credentials, if needed.

This is custom documentation. For more information, please visit the SAP Help Portal 59
2/6/2024
If the service catalog is available and connected ( ), you can search for services within it. Click the search icon (

) and select the relevant service from the command palette.

SAP Business One

The destination points to the SAP Business One system directly. Adding this system enables you to create an SAP
BTP application consuming an SAP Business One service.

 Note
Only No Authentication or Basic Authentication types are supported.

You must use SAP Business One 10.0 Feature Package (FP) 2305 to enable adding a system.

For more information about SAP Business One and the catalog that exposes a list of services, see Service Layer
API Reference and What's New in SAP Business One 10.0, version for SAP HANA.

If you maintain credentials in the destination con guration of the account, login can occur automatically. If a system is
available, there's a dot next to the icon ( ).

If you don't maintain the credentials in the destination con guration of the account, you need to log in manually to open
the system information.

3. Click the arrow to display the list of services.

4. Click a service ( ) to see its properties, including the service name, URL, and status.

If a service is available, there's a dot next to the icon ( ).

5. Click an entity to see the service details, including entity data and live data:

a. You can see the entity's metadata, details, and live data from the Entities tab. This helps you choose an entity for
your application.

 Note
The live data only displays:

Up to 20 rows of data

Data for simple data types

You can also search for an entity.

b. You can see details about the system and service from the Properties tab.

6. You can click View Diagram to see the service entities, their properties, and the relationships between the entities in a
new tab.

Service Actions for Development


Create a Project from a Service

1. Click Create Project.

The template wizard displays the projects that you can create from a service. For example, an HTML5 project or an SAP
Fiori application. See Create an HTML5 Project or SAP Fiori Elements for more information.

2. Use the template wizard to create the relevant project.

Add an External Service to an SAP Fiori Project

You can add a service to an empty SAP Fiori project or to an SAP Fiori project that doesn't have a service:

This is custom documentation. For more information, please visit the SAP Help Portal 60
2/6/2024
1. Click Add to SAP Fiori.

If you only have one empty project:

The service is added and is displayed in the External Resources section of the storyboard.

The .service.metadata le is added to the project folder in the le explorer.

You can then add a UI and integrate the service.

If the SAP Fiori project already had a UI, the added service is integrated into the UI.

If you have more than one empty SAP Fiori project, you must select the project where you want to add the service.

Add an External Service to a CAP Project

You can select a service from the Service Center and add it as an external service to a CAP Node project:

1. Open a service and click Add to CAP.

2. If prompted, select the target CAP Node project to add the external service to.

3. (Optional) You can generate a sample service and select the relevant entities.

a. Select Yes to add a sample service.

b. Select the entities that you want to add.

 Note
Sample service generation is only available for a project created in the Full Stack Cloud Application dev space. It's not
available for a project created in the Full-Stack Application Using Productivity Tools dev space.

4. Click Add.

You added the external service to the CAP project. The following changes happen:

The <service_name>.xml and <service_name>.cds les appear in the srv external folder of the
project.

A service section appears in the package.json le of the CAP project, which refers to the srv external
<service_name>.xml le. This le has the metadata of the service:

"<service_name>": {
"kind": "odata",
"model": "srv/external/<service_name>"
"credentials": {
"destination": "<service_name>"
}
}

If you added a sample service with the relevant entities, the <service_name>.cds and the
<service_name>.js les appear in the srv external folder of the CAP project.

The external service is added to the storyboard, under External Resources.

Add a System
You can add a new system to your SAP Business Application Studio subaccount:

This is custom documentation. For more information, please visit the SAP Help Portal 61
2/6/2024

 Note
If your account isn't a trial account, make sure that the Business_Application_Studio_Administrator role is assigned
to you in the cockpit. See Manage Authorizations and Roles.

If you're adding a system based on an ABAP Service Catalog, the following prerequisites apply:

For SAP S/4HANA on-premise, SAP ERP, or another on-premise ABAP, make sure that the Cloud Connector is
set up. See this blog post (under the Create a Data Source (Destination) heading in the Service Catalog
section).

For SAP S/4HANA Cloud or the SAP BTP ABAP environment, which both use SAML Bearer Assertion
authentication, see Create a Destination to Connect to SAP Business Application Studio.

1. Click the relevant button to add a system:

If you are adding a system for the rst time, click Add System.

If you already have a system, hover over the subaccount and click (Add system).

A new tab opens.

2. Enter the system name and URL and select the system type, proxy, authentication method, and product, if needed.

 Note
You can select Basic Authentication and enter the username and password for your system. This con guration
enables you to view the system information without needing to log in each time.

3. Click Add.

SAP Business Accelerator Hub Service Provider


The SAP Business Accelerator Hub (formerly known as the SAP API Business Hub) service provider includes SAP Business
Accelerator Hub products, packages, and services. You can use the services as data sources in your application or for application
development.

 Note
The Service Center only shows SAP Business Accelerator Hub products and packages with OData services.

Explore SAP Business Accelerator Hub Services


1. From the Service Center, click the arrow to display the SAP Business Accelerator Hub products:

SAP S/4HANA Cloud, SAP S/4HANA, SAP SuccessFactors, SAP Customer Experience, and SAP Business Technology
Platform

2. Click the arrow next to the product ( ) to display the packages.

To explore events, see Explore SAP S/4HANA or SAP S/4HANA Cloud Events for the Full Stack Cloud Application dev
space and Explore SAP S/4HANA or SAP S/4HANA Cloud Events for the Full-Stack Application Using Productivity Tools
dev space.

If the package is available and connected ( ), you can search for services within it. Click the search icon ( ) and
select the relevant service from the command palette.

3. Click the arrow next to the package ( ) to display the services (APIs).

4. Click a service ( ) and log in with your SAP Business Accelerator Hub credentials, if needed.

This is custom documentation. For more information, please visit the SAP Help Portal 62
2/6/2024

 Note
You must log in with your SAP Business Accelerator Hub credentials one time at the beginning of your session.

After you log in to a service, there's a dot next to the icon ( ).

The service editor displays the service's properties, including the service name, protocol, status, and product.

You can navigate to the API package by clicking the link with the package name.

You can also navigate to the service in the SAP Business Accelerator Hub by clicking the service name. From the SAP
Business Accelerator Hub, you can click Try Out to test the API in the sandbox environment.

5. Click an entity to see the service details, including entity data and live data:

a. You can see the entity's metadata, details, and live data from the Entities tab. This helps you choose an entity for
your application.

 Note
The live data only displays:

Up to 20 rows of data

Data for simple data types

You can also search for an entity.

b. You can see details about the service from the Properties tab.

6. You can click View Diagram to see the service entities, their properties, and the relationships between the entities in a
new tab.

Service Actions for Development

Create a Project from a Service

1. Click Create Project.

The template wizard displays the projects that you can create from a service. For example, an HTML5 project or an SAP
Fiori application. See Create an HTML5 Project or SAP Fiori Elements for more information.

2. Use the template wizard to create the relevant project.

 Note
To run your project with the SAP Business Accelerator Hub sandbox, see the prerequisites in Developing an HTML5
Application for Cloud Foundry.

Add an External Service to an SAP Fiori Project

You can add a service to an empty SAP Fiori project or to an SAP Fiori project that doesn't have a service:

1. Click Add to SAP Fiori.

If you only have one empty project:

The service is added and is displayed in the External Resources section of the storyboard.

The .service.metadata le is added to the project folder in the le explorer.

You can then add a UI and integrate the service.

If the SAP Fiori project already had a UI, the added service is integrated into the UI.
This is custom documentation. For more information, please visit the SAP Help Portal 63
2/6/2024
If you have more than one empty SAP Fiori project, you must select the project where you want to add the service.

Add an External Service to a CAP Project

You can select a service from the Service Center and add it as an external service to a CAP Node project:

1. Open a service and click Add to CAP.

2. If prompted, select the target CAP Node project to add the external service to.

3. (Optional) You can generate a sample service and select the relevant entities.

a. Select Yes to add a sample service.

b. Select the entities that you want to add.

 Note
Sample service generation is only available for a project created in the Full Stack Cloud Application dev space. It's not
available for a project created in the Full-Stack Application Using Productivity Tools dev space.

4. Click Add.

You added the external service to the CAP project. The following changes happen:

The <service_name>.xml and <service_name>.cds les appear in the srv external folder of the
project.

A service section appears in the package.json le of the CAP project, which refers to the srv external
<service_name>.xml le. This le has the metadata of the service:

"<service_name>": {
"kind": "odata",
"model": "srv/external/<service_name>"
"credentials": {
"destination": "<service_name>"
}
}

If you added a sample service with the relevant entities, the <service_name>.cds and the
<service_name>.js les appear in the srv external folder of the CAP project.

The external service is added to the storyboard, under External Resources.

Add SAP S/4HANA or SAP S/4HANA Cloud Events

To add SAP S/4HANA or SAP S/4HANA Cloud events for consumption to your project, see Adding SAP S/4HANA or SAP
S/4HANA Cloud Events to Your Project for the Full Stack Cloud Application dev space and Add SAP S/4HANA or SAP S/4HANA
Cloud Events for the Full-Stack Application Using Productivity Tools dev space.

API Business Hub Enterprise Service Provider


The API business hub enterprise service provider offers products and services that are published in the API business hub
enterprise. You can use the services as data sources in your application or for application development.

Prerequisite

This is custom documentation. For more information, please visit the SAP Help Portal 64
2/6/2024
You created a service instance in the API business hub enterprise. See Creating a Service Instance in the API Management, API
business hub enterprise.

Add a System
You can add a new system, referring to the API business hub enterprise instance, from the SAP BTP cockpit in the SAP Business
Application Studio subaccount. This destination will be used to register new developers to API business hub enterprise and to
subscribe them to products.

1. Create a destination in your SAP Business Application Studio subaccount from the cockpit with the following elds:

Property Value

Name Provide a name for the system.

Type HTTP

URL Use the url value from the service key of the API business hub
enterprise instance.

You can nd the service key for the service instance that you
created (in the Prerequisite) in the SAP BTP cockpit, under the
API Management, API Business Hub Enterprise service.

Proxy Type Internet

Authentication OAuth2ClientCredentials

Client ID Use the clientId value from the service key of the API
business hub enterprise instance.

Client Secret Use the clientSecret value from the service key of the API
business hub enterprise instance.

Token Service URL Use the tokenUrl value from the service key of the API
business hub enterprise instance.

2. In the Additional Properties section, con gure the following:

Property Value

HTML5.DynamicDestination true

WebIDEEnabled true

WebIDEUsage apihub_enterprise

This is custom documentation. For more information, please visit the SAP Help Portal 65
2/6/2024

Property Value

apiBusinessHubEnterpriseURL Adding this property is optional.


This property enables navigation from the Service Center to the API business hub
enterprise.

Use the following format:

<subscribed subaccount name>.<devportal_url>.cfapps.<region>.hana.ondemand.com

Replace the placeholders with the following information:

Property Value

subscribed Use the rst part of the tokenUrl from the destination system of API
subaccount business hub enterprise.
name
For example, if the URL is
https://abcd123trial.authentication.eu10.hana.ondemand.com/oauth/token

Use abcd123trial for the subscribed subaccount name.

devportal_url For trial, use integrationsuitetrial-devportal

For production, use apibhubenterprise

region Find it in the tokenUrl.

For example, if the tokenUrl is


https://abcd123trial.authentication.eu10.hana.ondemand.com/oauth/token

The region is eu10.

Explore API Business Hub Enterprise Services

 Note
The Service Center only shows API business hub enterprise systems and products with OData services.

1. From the Service Center, click the arrow to display the API business hub enterprise systems.

Each system points to an API business hub enterprise instance.

2. Click the arrow next to the system ( ) to display the products within it.

Multiple APIs are grouped into a product.

If the product is available and connected ( ), you can search for services within it. Click the search icon ( ) and
select the relevant service from the command palette.

3. Click the arrow next to the products ( ) to display the services (APIs).

If the product is available, there's a dot next to the icon ( ).

4. Click a service ( ) to see its properties, including the service name, protocol, and status.

To see the service details, you must be onboarded to the API business hub enterprise and subscribed to the selected
product:

If you aren't onboarded to the API business hub enterprise, enter your rst name, last name, and subscription
name and click Subscribe.

This is custom documentation. For more information, please visit the SAP Help Portal 66
2/6/2024
You're now subscribed to the product and all services associated with it.

If you're onboarded to the API business hub enterprise, but you aren't subscribed to the product, enter a
subscription name and click Subscribe.

You can now access the service.

After you're subscribed to the selected product, you'll see the following information:

Subscription details

This section includes a link to the product in the API business hub enterprise, the subscription name with a link to
the subscription in the API business hub enterprise, and the subscription date.

Service properties

This section includes the service name, protocol, and status.

If a service is available, there's a dot next to the icon ( ).

 Note
If a service is unavailable and the target endpoint of the service requires authentication, make sure that the
target endpoint is con gured to be authenticated via Basic Authentication. See the "Con gure API
Management to Use the Basic Authentication Policy" section in this blog post .

It is recommended to use the verify API key policy to ensure secure access to the service. This policy is added
in the PreFlow of the ProxyEndpoint of the corresponding API proxy.

5. Click an entity to see the service details, including entity data and live data:

a. You can see the entity's metadata, details, and live data from the Entities tab. This helps you choose an entity for
your application.

 Note
The live data only displays:

Up to 20 rows of data

Data for simple data types

You can also search for an entity.

b. You can see details about the service from the Properties tab.

6. You can click View Diagram to see the service entities, their properties, and the relationships between the entities in a
new tab.

Service Actions for Development


If the SAP Business Application Studio Administrator role is assigned to you, after creating a project or adding a data model, the
destination to the selected product subscription is generated in the SAP BTP cockpit. The destination enables you to preview
live data and run your deployed application. The destination includes information about the product subscription, including the
subscription's API key and the subscription's ID.

If you don’t have the SAP Business Application Studio Administrator role, the destination isn't generated with your subscription.

Create a Project from a Service

1. Click Create Project.

This is custom documentation. For more information, please visit the SAP Help Portal 67
2/6/2024
The template wizard displays the projects that you can create from a service. For example, an HTML5 project or an SAP
Fiori application. See Create an HTML5 Project or SAP Fiori Elements for more information.

2. Use the template wizard to create the relevant project.

 Note
If the deployed application to Cloud Foundry fails to bring data from the service, make sure that the Assign Message policy is
used in the PreFlow of the ProxyEndpoint of the API proxy.

We use the Assign Message policy to override the HTTP request Accept-Encoding header:

<!-- This policy can be used to create or modify the standard HTTP request and response messages
<AssignMessage async="false" continueOnError="false" enabled="true" xmlns='http://www.sap.com/api

<!-- Sets a new value to the existing parameter -->


<Set>
<Headers>
<Header name="Accept-Encoding">identity</Header>
</Headers>
</Set>
<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
<AssignTo createNew="false" type="request"></AssignTo>
</AssignMessage>

Add an External Service to an SAP Fiori Project

You can add a service to an empty SAP Fiori project or to an SAP Fiori project that doesn't have a service:

1. Click Add to SAP Fiori.

If you only have one empty project:

The service is added and is displayed in the External Resources section of the storyboard.

The .service.metadata le is added to the project folder in the le explorer.

You can then add a UI and integrate the service.

If the SAP Fiori project already had a UI, the added service is integrated into the UI.

If you have more than one empty SAP Fiori project, you must select the project where you want to add the service.

Add an External Service to a CAP Project

You can select a service from the Service Center and add it as an external service to a CAP Node project:

1. Open a service and click Add to CAP.

2. If prompted, select the target CAP Node project to add the external service to.

3. (Optional) You can generate a sample service and select the relevant entities.

a. Select Yes to add a sample service.

b. Select the entities that you want to add.

 Note
This is custom documentation. For more information, please visit the SAP Help Portal 68
2/6/2024
Sample service generation is only available for a project created in the Full Stack Cloud Application dev space. It's not
available for a project created in the Full-Stack Application Using Productivity Tools dev space.

4. Click Add.

You added the external service to the CAP project. The following changes happen:

The <service_name>.xml and <service_name>.cds les appear in the srv external folder of the
project.

A service section appears in the package.json le of the CAP project, which refers to the srv external
<service_name>.xml le. This le has the metadata of the service:

"<service_name>": {
"kind": "odata",
"model": "srv/external/<service_name>"
"credentials": {
"destination": "<service_name>"
}
}

If you added a sample service with the relevant entities, the <service_name>.cds and the
<service_name>.js les appear in the srv external folder of the CAP project.

The external service is added to the storyboard, under External Resources.

Uni ed Customer Landscape Service Provider


The Uni ed Customer Landscape service provider includes packages and services from registered SAP S/4HANA Cloud systems
in SAP BTP. You can use the services as data sources in your application or for application development.

Prerequisites

Your administrator registered an SAP S/4HANA Cloud system in an SAP BTP global account.

See Enabling System Landscape for SAP Business Application Studio.

Your administrator created a Developing with SAP Business Application Studio formation type in the SAP BTP cockpit to
assign the SAP S/4HANA Cloud system to an SAP Business Application Studio subaccount.

You created a destination in your SAP Business Application Studio subaccount for each consumption bundle from the
SAP BTP cockpit with the following elds:

Property Value

Name Provide a name of your choice.

Type HTTP

URL Enter the URL of the the SAP S/4HANA Cloud target system.
This value is displayed in the System Landscape System
Details URL eld in the SAP BTP cockpit.

 Note
You must be a global account administrator to see the
System Landscape.

This is custom documentation. For more information, please visit the SAP Help Portal 69
2/6/2024

Property Value

Proxy Type Internet

Authentication Select the authentication based on your SAP S/4HANA Cloud


system inbound communication settings.

In the Additional Properties section, you con gured the following:

Property Value

HTML5.DynamicDestination true

WebIDEEnabled true

x-system-type SAP S/4HANA Cloud

This value is displayed in the System Landscape System


Details System Type eld in the SAP BTP cockpit.

x-correlation-id sap.s4:communicationScenario:SAP_COM_<XXXX>

Replace the number based on the relevant com_scenario for


the destination.

This value is displayed in the System Landscape System


Details Consumption Bundles Correlation IDs column
in the SAP BTP cockpit.

x-system-id Enter the name of the system ID.


This value is displayed in the System Landscape System
Details System ID eld in the SAP BTP cockpit.

Explore Uni ed Customer Landscape Services


1. Click the arrow to display the available systems ( ) for the account.

To explore events, see Explore SAP S/4HANA or SAP S/4HANA Cloud Events for the Full Stack Cloud Application dev
space and Explore SAP S/4HANA or SAP S/4HANA Cloud Events for the Full-Stack Application Using Productivity Tools
dev space.

2. Click the arrow to display the packages ( ) under a system.

If the package is available and connected ( ), you can search for services within it. Click the search icon ( ) and
select the relevant service from the command palette.

3. Click the arrow to display the services under a package.

4. Click a service ( ) to see its properties, including the service name, protocol, version, URL, and status.

In the Connectivity Information, you can see the consumption bundle name, ID, and correlation ID. If there is a
destination, you can select it and see its name and authentication.

If a service is available, there's a dot next to the icon ( ).

5. Click an entity to see the service details, including entity data and live data:

a. You can see the entity's metadata, details, and live data from the Entities tab. This helps you choose an entity for
your application.

 Note

This is custom documentation. For more information, please visit the SAP Help Portal 70
2/6/2024
The live data only displays:

Up to 20 rows of data

Data for simple data types

You can also search for an entity.

b. You can see details about the service from the Properties tab.

6. You can click View Diagram to see the service entities, their properties, and the relationships between the entities in a
new tab.

Service Actions for Development


Create a Project from a Service

1. Click Create Project.

The template wizard displays the projects that you can create from a service. For example, an HTML5 project or an SAP
Fiori application. See Create an HTML5 Project or SAP Fiori Elements for more information.

2. Use the template wizard to create the relevant project.

Add an External Service to an SAP Fiori Project

You can add a service to an empty SAP Fiori project or to an SAP Fiori project that doesn't have a service:

1. Click Add to SAP Fiori.

If you only have one empty project:

The service is added and is displayed in the External Resources section of the storyboard.

The .service.metadata le is added to the project folder in the le explorer.

You can then add a UI and integrate the service.

If the SAP Fiori project already had a UI, the added service is integrated into the UI.

If you have more than one empty SAP Fiori project, you must select the project where you want to add the service.

Add an External Service to a CAP Project

You can select a service from the Service Center and add it as an external service to a CAP Node project:

1. Open a service and click Add to CAP.

2. If prompted, select the target CAP Node project to add the external service to.

3. (Optional) You can generate a sample service and select the relevant entities.

a. Select Yes to add a sample service.

b. Select the entities that you want to add.

 Note
Sample service generation is only available for a project created in the Full Stack Cloud Application dev space. It's not
available for a project created in the Full-Stack Application Using Productivity Tools dev space.

4. Click Add.

This is custom documentation. For more information, please visit the SAP Help Portal 71
2/6/2024
You added the external service to the CAP project. The following changes happen:

The <service_name>.xml and <service_name>.cds les appear in the srv external folder of the
project.

A service section appears in the package.json le of the CAP project, which refers to the srv external
<service_name>.xml le. This le has the metadata of the service:

"<service_name>": {
"kind": "odata",
"model": "srv/external/<service_name>"
"credentials": {
"destination": "<service_name>"
}
}

If you added a sample service with the relevant entities, the <service_name>.cds and the
<service_name>.js les appear in the srv external folder of the CAP project.

The external service is added to the storyboard, under External Resources.

Add SAP S/4HANA or SAP S/4HANA Cloud Events

To add SAP S/4HANA or SAP S/4HANA Cloud events for consumption to your project, see Adding SAP S/4HANA or SAP
S/4HANA Cloud Events to Your Project for the Full Stack Cloud Application dev space and Add SAP S/4HANA or SAP S/4HANA
Cloud Events for the Full-Stack Application Using Productivity Tools dev space.

Create a Project
You can create a project from scratch using the project wizard, you can clone a project, or you can import an already existing
project to your workspace.

 Note
It is recommended to always connect your projects to a Git repository for long-term persistency. See Connect to Your Git
Source Control System.

Creating a Project Using the Wizard


You can create projects based on your development scenario and the extensions installed in the dev space using
prede ned templates.
Creating a Project from the Terminal
You can create projects based on your development scenario and the extensions installed in the dev space using the
terminal.
Cloning Repositories
Add an existing project to your local workspace by cloning its repository from Git.
Importing Projects
Import projects from your local le system to SAP Business Application Studio.
Project Visibility in SAP Business Application Studio
Projects are displayed in the le explorer within a workspace or as stand-alone folders.
Template Wizard
SAP Business Application Studio allows you to use any type of Yeoman generator including project and module
generators.

This is custom documentation. For more information, please visit the SAP Help Portal 72
2/6/2024

Creating a Project Using the Wizard


You can create projects based on your development scenario and the extensions installed in the dev space using prede ned
templates.

1. Open the wizard in one of the following ways:

From the menu, navigate to File New Project from Template .

Select Start from template from the Get Started page.

Enter New Project in the command palette and select SAP Business Application Studio: New Project from
Template.

The Project Wizard opens showing the project templates that are relevant based on the dev space and additional
extensions that you selected.

 Note
When you create a project using a template, you become the code owner and as such, you are responsible for any
updates or xes that must be performed for it. We recommend you follow the industry best practice of using
automated vulnerability scanning in the CI/CD pipeline to avoid supply chain and other cyber-attacks.

2. Follow the wizard steps and provide the required information. You can move between steps using Back and Next or by
clicking the steps from the wizard tree.

The wizard displays error noti cations on the eld level and on the step level.

The project is added to your dev space in a new workspace or as part or a multi-root workspace depending on the
Workspace preferences that you de ned.

The wizard generates the project including the relevant folder structure, artifacts, and resources.

Creating a Project from the Terminal


You can create projects based on your development scenario and the extensions installed in the dev space using the terminal.

1. To open the terminal, navigate to Terminal New Terminal from the menu.

2. Enter yo in the terminal.

3. Select the relevant project type from the list, such as Fiori Project or Basic Multitarget Application.

4. Answer the questions according to the type of application that you want to create.

Related Information
Terminal

Cloning Repositories
Add an existing project to your local workspace by cloning its repository from Git.

Use the Terminal to Clone a Repository


1. Open a terminal.

This is custom documentation. For more information, please visit the SAP Help Portal 73
2/6/2024
2. Change the current working directory to the location where you want the cloned directory.

3. Enter git clone, and then paste your URL.

For example:

 Sample Code

$ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY

Use the Command Palette to Clone a Repository


1. Open the Command Palette.

2. Enter Git: Clone in the input eld and press Enter.

3. Enter the repository URL and press Enter.

4. Select the folder into which you want to clone the repository and click Select Repository Location.

5. If prompted, enter your credentials in the input eld.

Importing Projects
Import projects from your local le system to SAP Business Application Studio.

If you have an SAP Web IDE project or a project you worked on in another IDE, you can save it as a ZIP or a TAR le and import it
to SAP Business Application Studio.

1. Make sure there is an open workspace in your dev space. If there is no open workspace:

a. Click Open Folder.

b. Select projects from the list provided in the command palette.

c. Click OK.

2. From the Get Started page, click Import, or select SAP Business Application Studio: Import Project from the command
palette.

3. Select the desired ZIP or TAR le.

4. Click Open.

The project is added to your dev space in a new workspace or as part or a multi-root workspace depending on the Workspace
preferences that you de ned.

Project Visibility in SAP Business Application Studio


Projects are displayed in the le explorer within a workspace or as stand-alone folders.

A workspace is an entity containing your project's settings, debug con gurations, and task con gurations.

We recommend you work in an environment where projects reside in a multi-root workspace.

In SAP Business Application Studio, a workspace is created for you as part of the project creation wizard. If a workspace is
already open, new projects are added to it by default.

This is custom documentation. For more information, please visit the SAP Help Portal 74
2/6/2024
Working in a multi-root workspace environment means that you can group projects that are saved in different locations or even
in different workspaces. All project les are visible in the le explorer under the same workspace.

You also have the option to open a project as a stand-alone folder, and not belonging to a workspace.

1. From the menu, navigate to File Open Folder... .

2. Select the desired project and click Open. The project opens as the root folder in the le explorer.

Reopening a Workspace
If you already have a workspace in which you want to create your project, click Open Workspace in the le explorer or from the
menu, navigate to File Open Workspace from File... and select the desired workspace le.

Changing the Default Settings


This is custom documentation. For more information, please visit the SAP Help Portal 75
2/6/2024
If you do not want your projects to be opened in a workspace by default, you can change the settings.

1. From the menu, navigate to File Preferences Settings .

2. From the Settings page, select Application Wizard.

3. Under Workspace, select the preferred default behavior from the dropdown list.

Template Wizard
SAP Business Application Studio allows you to use any type of Yeoman generator including project and module generators.

 Note
When you create a project using a template, you become the code owner and as such, you are responsible for any updates or
xes that must be performed for it. We recommend you follow the industry best practice of using automated vulnerability
scanning in the CI/CD pipeline to avoid supply chain and other cyber-attacks.

1. Enter Open Template Wizard in the command palette.

The Template wizard opens showing all the Yeoman generators that are installed in your machine.

2. Follow the wizard steps and provide the required information. You can move between steps using Back and Next or by
clicking the steps from the wizard tree.

The wizard displays error noti cations on the eld level as well as on the step level.

The artifact is added to your dev space in a new workspace or as part or a multi-root workspace depending on the
Workspace preferences that you de ned.

If you do not nd a wizard that suits your development needs, you can search for more wizards using the Explore and Install
Generators tool.

Develop
SAP Business Application Studio provides you with the tools you require for making your development experience more efficient
and productive.

Guide Center
This tool shows you how to execute common development tasks for speci c SAP scenarios.
Explorer
Use the project explorer to browse the contents of your current workspace.
Storyboard
The Storyboard allows you to develop applications using graphical editors and wizards.
Git Source Control
SAP Business Application Studio enables you to connect and interact with the Git source control system, letting you
connect and interact with remote Git repositories.
Terminal
Opening the integrated terminal allows you to access the underlying system. The terminal is a convenient tool because
you don't need to switch windows or change the state of an existing terminal to perform a quick command-line task.
Layout Editor

This is custom documentation. For more information, please visit the SAP Help Portal 76
2/6/2024
Display the content of an XML view in the layout editor to see it in a way that closely corresponds to how it will appear in
your nished application.
Command Palette
The command palette provides access to all the IDE functionality including shortcuts for the most common operations.
Runtime Version Management
SAP Business Application Studio uses asdf to allow you to select which runtime versions to install and use for developing
your application.
Problems View
The Problems view displays the coding errors and warnings of all open les in a list. When you click an item from the list,
the problematic piece of code is highlighted in the editor.
Search
There are different Search capabilities in SAP Business Application Studio.

Guide Center
This tool shows you how to execute common development tasks for speci c SAP scenarios.

The Guide Center tool provides guidance to perform development tasks based on the best practices de ned by SAP experts.

The tool presents a set of guides per development scenario. Different guides are displayed depending on the dev space type you
selected and the extensions you enabled for it.

Each guide contains a list of steps you have to perform to complete the development task.

Steps contain detailed instructions as well as the option to trigger an action, such as opening the relevant tool required to
perform the task in a new tab. For example, you can open the snippet tool to add code into your project, open the Project
Creation wizard to create an SAP application, or open documentation in a separate browser window.

To use the Guide Center tool:

1. Open the command palette and enter Guide Center. The Guide Center tool opens showing the list of guides available for
your dev space.

2. Open each step within the relevant guide and follow the instructions.

Explorer
Use the project explorer to browse the contents of your current workspace.

Project Explorer
The project explorer displays application components in a logical view, which simpli es browsing of the contents of your
application.

It gives you a bird's-eye view of the components involved in your application at any point in time.

Open the project explorer from the activity bar.

This is custom documentation. For more information, please visit the SAP Help Portal 77
2/6/2024

Outline
The Outline view displays a symbol tree of the currently active editor. This view is useful for understanding the structure of a le
or for navigating to a speci c element in a le.

You can click on an element in the Outline view to open that element in the editor tab.

To open the Outline view, select Explorer: Focus on Outline View from the command palette.

The Outline view opens on the side of the IDE, within the Explorer view.

This is custom documentation. For more information, please visit the SAP Help Portal 78
2/6/2024

Quick Access
The Quick Access view allows you to open the most used funtions with one click.

Storyboard
The Storyboard allows you to develop applications using graphical editors and wizards.

From the Storyboard you can trigger the graphical editors as well as other tools required to develop your application.

The Storyboard provides a graphical view of an application's data models, external data models, services, and UI front ends of
the application, as well as the connections between them. This allows for a quick understanding of the application’s structure
and components.

Depending on the dev space type you select, the storyboard in your dev space will have different features.

This is custom documentation. For more information, please visit the SAP Help Portal 79
2/6/2024
The storyboard is available in the SAP Fiori, Full-Stack Application Using Productivity Tools, and Full Stack Cloud Application dev
spaces.

Git Source Control


SAP Business Application Studio enables you to connect and interact with the Git source control system, letting you connect
and interact with remote Git repositories.

Prerequisite

Before you can work with the Git view, you or your administrator must establish a connection to your corporate Git
system. See Connect to Your Git Source Control System.

Ask your administrator which is the recommended authentication method for your company.

You can perform all your Git tasks using the terminal, but SAP Business Application Studio allows you to use the the
SIMPLIFIED GIT view or the SOURCE CONTROL view, if you prefer. See Using the Simpli ed Git View and Using the Advanced
Git View.

Work ow
Using Git is easy. The basic work ow is as follows:

1. Clone: Clone a repository from a remote Git source control system. All the information about the repository is copied,
and a local master branch is created and is visible in your workspace. If the remote repository has several branches, you
can create additional local branches based on those remote branches.

2. Develop: Once you have the code, you can develop – add les, delete les, modify les. Your changes are visible. When
you are ready, you can stage your changes and commit them.

3. Fetch and Merge/Rebase: (Optional) Before sending back your changes to the remote repository, you can fetch all the
changes made by others. Then you can merge or rebase the changes into your changes to make sure there are no
con icts. If there are con icts, you can adjust your code.

4. Push: Add your changes to the remote repository.

Using the Simpli ed Git View


Use the SIMPLIFIED GIT view to perform Git operations and manage Git repositories in SAP Business Application Studio.

To open the SIMPLIFIED GIT view, click from the activity bar.

Connect to a Remote Git Repository


Connect to a remote Git repository to enable contributions from other developers and to track changes in your project.
Commit Changes in the Simpli ed Git View
In the SIMPLIFIED GIT view, you can add the current changes to the last commit.
Pull Changes in the Simpli ed Git View
In the SIMPLIFIED GIT view, you can pull changes to download objects and references from the remote repository into
your local repository, and then merge the changes into your project.
Resolve Con icts in the Simpli ed Git View

This is custom documentation. For more information, please visit the SAP Help Portal 80
2/6/2024
Merge operations can fail because of con icts between the current branch and the branch from which you choose to
incorporate the changes. You can resolve merge con icts using the SIMPLIFIED GIT view.
Clone a Repository in the Simpli ed Git View
Clone a repository using the SIMPLIFIED GIT view.
Perform Actions in the Pending Changes Section
You can discard all selected changes, individually discard or ignore each pending change, or you can open an updated le
in the PENDING CHANGES section.
Create a Branch in the Simpli ed Git View
Create a new branch using the SIMPLIFIED GIT view and publish it to the remote repository.

Connect to a Remote Git Repository


Connect to a remote Git repository to enable contributions from other developers and to track changes in your project.

1. Click from the activity bar to open the SIMPLIFIED GIT view.

If you haven’t created a project, click Create Project to create one from a template. See Creating a Project Using the
Wizard.

2. Click Add Remote Repository.

3. When prompted, add the URL for the remote repository where your local repository will be pushed.

4. Enter your Git username and password (or token).

5. Choose whether to save your Git credentials for future use.

Commit Changes in the Simpli ed Git View


In the SIMPLIFIED GIT view, you can add the current changes to the last commit.

You can see a list of all changes in the PENDING CHANGES section.

For example, if you make a change to the project from the terminal, the change is automatically detected and appears in the
PENDING CHANGES section.

To add your changes to the remote Git repository, perform the following steps:

1. In the PENDING CHANGES section, select the les with changes that you want to include in the commit.

2. Enter a message describing your changes and click Commit & Sync.

This is custom documentation. For more information, please visit the SAP Help Portal 81
2/6/2024

Pull Changes in the Simpli ed Git View


In the SIMPLIFIED GIT view, you can pull changes to download objects and references from the remote repository into your
local repository, and then merge the changes into your project.

You can see a list of all changes in the PENDING CHANGES section.

Click Pull to pull the changes made in the remote repository to your project.

This is custom documentation. For more information, please visit the SAP Help Portal 82
2/6/2024

Resolve Con icts in the Simpli ed Git View


Merge operations can fail because of con icts between the current branch and the branch from which you choose to
incorporate the changes. You can resolve merge con icts using the SIMPLIFIED GIT view.

1. When there are con icts, the MERGE FILES section is displayed.

2. Click one of les to resolve the con ict.

A split view is displayed.

This is custom documentation. For more information, please visit the SAP Help Portal 83
2/6/2024

3. Choose one of the following options to resolve the merge con ict:

Accept Current Change: Apply the selected line of change from the current branch.

Accept Incoming Change: Apply the selected line of change from the remote branch.

Ignore: Ignore the selected line of change.

Complete Merge: Open the SOURCE CONTROL view to complete the merge. Only choose this option if you want
to use the SOURCE CONTROL view.

4. Enter a message describing your changes and click Commit & Sync to complete the con ict resolution and sync your
changes to the remote repository.

Clone a Repository in the Simpli ed Git View


Clone a repository using the SIMPLIFIED GIT view.

1. Click (Clone Repository).

2. Enter the URL of the remote repository that you want to clone.

3. Select the folder where you want to clone the repository.

4. Click Open to open the cloned repository in SAP Business Application Studio.

You can also choose to open the repository in a new window or add it to a workspace.

Perform Actions in the Pending Changes Section

This is custom documentation. For more information, please visit the SAP Help Portal 84
2/6/2024
You can discard all selected changes, individually discard or ignore each pending change, or you can open an updated le in the
PENDING CHANGES section.

Discard Changes
Discarding removes changes from the active branch.

In the PENDING CHANGES section, discard the relevant changes:

To discard the selected changes, hover over the PENDING CHANGES section title and click .

To discard changes for an individual le, hover over the le containing the changes you want to discard and click .

Ignore Pending Changes Individually


Click (Add to .gitignore) to ignore pending changes individually.

Open Updated File

Click (Open File) to open an updated le.

Create a Branch in the Simpli ed Git View


This is custom documentation. For more information, please visit the SAP Help Portal 85
2/6/2024
Create a new branch using the SIMPLIFIED GIT view and publish it to the remote repository.

1. In the Branch section, open the dropdown list and select + Add New Branch.

2. Enter a name for the new branch.

3. Select one the following options:

main: Create a branch of the main directory on the local repository

origin/main: Create a branch of the main directory on the remote repository

The new branch is added to the dropdown list in the Branch section.

4. Select Publish Branch to sync the new branch with the remote repository.

Using the Advanced Git View


General overview of the advanced Git view, the SOURCE CONTROL view, in SAP Business Application Studio.

SAP Business Application Studio provides a graphical user interface for executing Git commands and managing your source
control and versioning. You can also manually perform other Git commands from the terminal. This view contains all the options
for Git source control.

Source Control View

To open the SOURCE CONTROL view, click from the activity bar.

This is custom documentation. For more information, please visit the SAP Help Portal 86
2/6/2024

The SOURCE CONTROL view is divided into the following sections:

SOURCE CONTROL view menu

Click to toggle between list and tree views.

Click (or press <Ctrl> + <Enter> ) to commit the changes.

Click to refresh the Git pane.

Click to view the Git history.

Click to see more available actions. See Git Commands

Message section

Enter a description for the commit.

Staged Changes section

Shows the les that will be included in the next commit.

Hover over the section title to see additional actions.

Click to unstage all les in the section.

Hover over the les in this section to see additional actions:

Click to unstage the changes in the le.

Click to open the le.

Changes section

Shows the les that contain changes.

This is custom documentation. For more information, please visit the SAP Help Portal 87
2/6/2024

Hover over the section title to see additional actions.

Click to discard all changes.

Click to stage all changes.

Hover over the les in this section to see additional actions:

Click to discard the changes in the le.

Click to open the le.

Click to stage the changes in the le.

Amend section.

Click Amend at the bottom of the pane to make changes to a commit.

Git Status Bar


At the bottom-left corner of SAP Business Application Studio, you can nd indicators describing the status of your Git
repository. They show the current branch, dirty indicators, and the number of ahead and behind changes of the current branch.

The dirty indicators are as follows:

*: You have unstaged changes in your branch.

+: You have staged changes in your branch, but no unstaged changes.

!: You have con icting changes in your branch.

Clicking on the branch name, opens the command palette showing additional Git commands.

There is also a Synchronize Changes action in the status bar, next to the branch indicator, if the currently checked-out branch
has an upstream branch con gured. Clicking Synchronize Changes opens the command palette showing additional Git
commands that can be applied to the branch.

Branches
You can create and check out branches directly within the IDE by using the Git: Checkout command in the command palette.

To create a new branch:

1. Click on the active branch name in the status bar. The command palette opens.

2. Enter a name for the new branch. A new branch is created and checked out.

Gutter Indicators
If you open a folder that is a Git repository and begin making changes, annotations are added to the gutter and to the overview
ruler.

This is custom documentation. For more information, please visit the SAP Help Portal 88
2/6/2024
A red triangle indicates where lines have been deleted.

A green bar indicates new added lines.

A blue bar indicates modi ed lines.

Connecting an Existing Project to Git


You can add an existing project to Git.

1. In the Project Explorer, select your project.

2. Click from the activity bar to open the Git view.

3. Click to initialize the local repository.

4. Click in the Changes section to add the les in your new local repository. This stages them for the rst commit.

5. Click (or press <Ctrl> + <Enter> ) to commit the les that you've staged in your local repository.

6. When prompted, provide a commit message. Your project is now connected to your local Git repository.

Adding a Project to Git Remote

1. Click from the activity bar to open the Git view.

2. Click to see more available actions.

3. Select Remote Add Remote .

4. When prompted, add the URL for the remote repository where your local repository will be pushed.

5. Push the changes in your local repository to the remote Git repository. See Push Changes.

Understanding the UI
SAP Business Application Studio provides a graphical user interface for executing Git commands and managing your source
control and versioning.

Understanding the UI
The Git view consists of three major sections. The top section is for authoring the commit messages. It also provides access to a
couple of basic Git commands.

This is custom documentation. For more information, please visit the SAP Help Portal 89
2/6/2024
After this, you nd the commit section, which lists the changed les by their name and separates them in two groups:

Staged Changes - A list of the les that have been staged. Click to open the selected le, or to unstage it.

Changes - Files listed under the Changes section contain unstaged changes. Each le name is followed by a path to its
parent directory and an indicator describing the status of the change.

Click to open the selected le, to stage the le, or to refresh it.

The les can be in any of the following statuses:

A - A new le that has been staged.

U - An unstaged le. An unstaged change can be reverted by clicking on the Discard Changes action next to the le
location.

M - A modi ed le. Double-clicking on a modi ed le will open it in a diff editor. The read-only editor in the rst section
shows the state from the index. The second section of the editor re ects the state of the working tree, and it lets you to
further modify the le.

C - A copied le (if blue) or a con icted le (if red).

D - A deleted le.

At the bottom of the Git view you can see the last commit section, where a description of the most recent commit is displayed.

After staging the desired les and specifying the commit message, the changes can be committed to the repository. After a
successful commit, the Last Commit section is automatically updated.

Git Commands
SAP Business Application Studio supports Git commands from the Git view and from the command palette.

Commit (Amend) Changes


Enables you to add the current changes to the last commit.
Commit (Signed Off) Changes
Enables you to save your changes to the local repository. Sign-off is a line at the end of the commit message that
certi es who is the author of the commit.
Fetch Changes
Fetching enables you to download objects and references from a remote repository into your local repository. You can
then merge or rebase the changes into your project.
Merge Changes
You can incorporate all the changes from one branch into another in a single commit.
Pull Changes
Pulling is the same as fetching and merging. Pulling enables you to download objects and references from the remote
repository into your local repository, and then merge the changes into your project.

This is custom documentation. For more information, please visit the SAP Help Portal 90
2/6/2024
Push Changes
The Push option incorporates all unsynced committed changes into the remote branch of the currently checked-out local
branch.
Discard Changes
Discarding removes all changes from the active branch. For example, discarding a new le removes it from the branch.
Stage and Unstage Changes
You can add or remove all the changes in the Changes section with one click.
Git Stash
Use Stash to record the current state to the working directory and then go back to a clean working directory. Your local
changes are saved and the directory reverts to match the HEAD commit.
View Diffs
Compare different versions of a le.

Commit (Amend) Changes


Enables you to add the current changes to the last commit.

You can combine staged changes with the previous commit instead of creating an entirely new commit. It can also be used to
simply edit the previous commit message without changing it.

1. From the SOURCE CONTROL view menu, click More Actions.

2. Select Commit (Amend).

Commit (Signed Off) Changes


Enables you to save your changes to the local repository. Sign-off is a line at the end of the commit message that certi es who
is the author of the commit.

1. From the SOURCE CONTROL view menu, click More Actions.

2. Select Commit (Signed Off). The commit message is sent including the signature of the committer.

Fetch Changes
Fetching enables you to download objects and references from a remote repository into your local repository. You can then
merge or rebase the changes into your project.

1. From the SOURCE CONTROL view menu, click More Actions.

2. Select Fetch.... The command palette is displayed.

3. From the list, select the remote Git repository from which you want to fetch the changes.

This is custom documentation. For more information, please visit the SAP Help Portal 91
2/6/2024

Merge Changes
You can incorporate all the changes from one branch into another in a single commit.

To merge a branch into another:

1. From the SOURCE CONTROL view menu, click More Actions.

2. Select Merge.... The command palette opens.

3. Select the branch you want to merge into the currently active branch.

Dealing with Merge Con icts


Merge operations can fail because of con icts between the current branch and the branch you choose from which to
incorporate the changes. To see which les have merge con icts, navigate to the console or the explorer:

The console displays a list of all les with merge con icts.

The explorer displays "!" next to any les with con icts.

When you access a le with con icts, the con icts and the options for resolving them are displayed in the le.

Choose from the following options to resolve the merge con ict:

1. Accept Current Change: Apply only the changes from the current branch.

2. Accept Incoming Change: Apply only the changes from the target branch.

3. Accept Both Changes: Merge both changes (the rst change from the current branch and the second change from the
target branch).

4. Compare changes: View the differences (current and target) in a split window.

This is custom documentation. For more information, please visit the SAP Help Portal 92
2/6/2024

Pull Changes
Pulling is the same as fetching and merging. Pulling enables you to download objects and references from the remote
repository into your local repository, and then merge the changes into your project.

Pull
1. From the SOURCE CONTROL view menu, click More Actions.

2. Select Pull.

The changes are fetched from the speci c branch and merged into your local checked-out branch.

Pull From
This feature has the same functionality as Pull, but in this case, when you select the action, the command palette is displayed
and you can de ne the repository from which you want to pull the changes.

1. From the SOURCE CONTROL: GIT menu, click More Actions.

2. Select Pull from. The command palette is displayed.

3. Select the the repository from which you want to pull the changes.

Push Changes
The Push option incorporates all unsynced committed changes into the remote branch of the currently checked-out local
branch.

The number of unsynced committed changes is displayed next to the repository name. All tags created within the open
repository are pushed.

 Note
It is recommended to pull changes before pushing changes. This action ensures that your local copy is synced with the
remote repository.

If a team member pushed to the remote repository and you push changes before syncing, you may encounter some issues,
including head annotations or merge con icts.

Push
1. From the SOURCE CONTROL view menu, click More Actions.

2. Select Push.

Push to

This is custom documentation. For more information, please visit the SAP Help Portal 93
2/6/2024
1. From the SOURCE CONTROL menu, click More Actions.

2. Select Push to. The command palette is displayed.

3. Select the target remote repository branch to which you want to push.

Discard Changes
Discarding removes all changes from the active branch. For example, discarding a new le removes it from the branch.

Move your mouse over the le containing the changes you want to discard and click Discard Changes.

 Note
Only unstaged les can be discarded.

Stage and Unstage Changes


You can add or remove all the changes in the Changes section with one click.

Click Stage All Changes to adds all changed les to the list of changes that will be included in the next commit.

Click Unstage All Changes to remove all changed les from the next commit.

Git Stash
Use Stash to record the current state to the working directory and then go back to a clean working directory. Your local changes
are saved and the directory reverts to match the HEAD commit.

Pop Stash
Removes a single entry from the stash list and applies it on top of the current working tree state. This is the inverse operation
of stash push.

If there are con icts, the entry is not removed from the stash list. You need to resolve the con icts and perform stash drop
manually afterwards.

Pop Latest Stash


Removes the latest entry from the stash list and applies it on top of the current working tree state.

Apply Stash
Takes a single entry from the stash list and applies it on top of the current working tree state. This functionality is like Pop Stash,
but without removing the entry from the stash list.

Apply Latest Stash


This is custom documentation. For more information, please visit the SAP Help Portal 94
2/6/2024
Takes the latest entry from the stash list and applies it on top of the current working tree state.

Drop Stash
Removes a single stash entry from the list of stash entries.

View Diffs
Compare different versions of a le.

View Changes in Local Repository


Clicking a modi ed le opens a diff viewer. This viewer is split into two sections. The rst section is a read-only editor showing
the index state. The second section is an editor for the working-tree state.

View Changes in Different Branches


1. Select a modi ed le from the task explorer.

2. From the command palette, enter Git Diff: Compare With.

3. Select the branch to which you want to compare the currently active branch.

A diff viewer is displayed. The rst section is a read-only editor showing the current branch, and the second section shows the
le in the selected branch.

Setting Up Git to Work with Gerrit


Gerrit is a web-based software code review tool for reviewing, approving, or rejecting changes to the source code developed by
your colleagues. Gerrit works as an intermediate environment for source control between the local environment and the
remote Git repository.

Prerequisite
You con gured the required Cloud Connector and destination in your account.

This is custom documentation. For more information, please visit the SAP Help Portal 95
2/6/2024

Procedure
1. Enable Gerrit:

a. Navigate to File Preferences Settings .

b. From the list of preferences, under Extensions, click Sapbas.

c. Under Gerrit: Enabled, select the Whether gerrit is enabled checkbox.

d. Under Gerrit: Con guration, click Add Item and add the required properties (hookPath, protocol, and hostname)
and their values, which can be obtained from your organization's Gerrit administrator.

This is the con guration for SAP WDF Gerrit system:

2. Clone your project. See Cloning Repositories.

3. Perform your change and create a commit. See Commit (Amend) Changes.

4. From the SOURCE CONTROL view menu, click More Actions.

5. Select Push to Gerrit.

Related Information
This is custom documentation. For more information, please visit the SAP Help Portal 96
2/6/2024
Cloud Connector
Install the cloud connector
Con gure Systems in Cloud Connector

Providing Authentication to Git


You can use Basic or OAuth to authenticate your Git user.

Providing Basic Authentication


SAP Business Application Studio supports basic authentication, which means you must provide your username and password to
access your Git provider.

 Note
SSH is not available for on-premise Git installations.

To work with the Git view in SAP Business Application Studio, you need to store or cache credentials. Once you have enabled one
of these methods, you will not have to enter your credentials every time you use Git.

 Note
Doing this requires you to entrust your credentials to SAP and to a third party.

Cache credentials in memory for a short period of time. See Git Credential Cache .

Store credentials inde nitely in a le on your dev space. See Git Credential Store .

If it's supported, it's recommended to use a Personal Access Token (PAT) instead of a password.

For example, you can create a PAT in GitHub following these instructions. Other Git providers will have different ways of creating
PATs.

 Note
PATs are an alternative to using passwords for authentication to Git, and as such, they should be frequently renewed.

Providing OAuth Authentication to GitHub


In SAP Business Application Studio, when connecting to GitHub, a popup appears with an veri cation code you can use to set up
OAuth authentication.

1. When the popup with the code appears, click Copy the code and open GitHub. A new tab with GitHub opens.

2. Log in to GitHub, and paste the code obtained before.

3. Authorize the code.

4. Back in SAP Business Application Studio, select if you want to save your user authentication per session or per dev
space.

 Note
You can con gure these settings for your user authentication in the Preferences page:

This is custom documentation. For more information, please visit the SAP Help Portal 97
2/6/2024
sapbas.git.github.oauth: Enables or disables OAuth authentication for Github.com .

sapbas.git.github.enterprise.oauth: If your administrator has not con gured a destination for your
subaccount, you can de ne a host/client ID.

Terminal
Opening the integrated terminal allows you to access the underlying system. The terminal is a convenient tool because you
don't need to switch windows or change the state of an existing terminal to perform a quick command-line task.

You can create multiple terminals open to different locations and easily navigate between them.

With access to the terminal, you can use any tool that is pre-installed on your dev space, such as maven and npm. You can install
additional tools, including global npm packages and other CLIs, using npm install. You can execute commands from the
command line, create new projects or modules, build applications, and deploy applications from the terminal.

From the menu, navigate to Terminal New Terminal to open the terminal.

To open the terminal at a speci c directory, right-click the desired le in the File Explorer, and select Open in Integrated
Terminal.

Related Information
Create an SAPUI5 App from the Command Line

Layout Editor
Display the content of an XML view in the layout editor to see it in a way that closely corresponds to how it will appear in your
nished application.

 Note
This is custom documentation. For more information, please visit the SAP Help Portal 98
2/6/2024
The layout editor is not supported in the Safari browser.

Layout Editor Landscape


The layout editor consists of a canvas in the center, and two panes on either side. On one side, you will nd the Controls and
Outline tabs, while on the other side, you will nd the Properties pane.

Toolbar
The layout editor toolbar allows you to:

Change the device format of the canvas to smartphone, tablet, or desktop view.

Expand and collapse the panes to the sides of the canvas.

One side includes the Controls and Outline tabs.

The other side includes the Properties pane.

Undo and redo actions.

Controls Tab
You can expand or collapse each section by clicking the arrow on each section header. You can also search for controls by
entering the control name in the search eld at the top of the Controls tab. The relevant sections expand to display the controls

This is custom documentation. For more information, please visit the SAP Help Portal 99
2/6/2024
that match the search criteria.

 Note
Make sure to delete the search criteria if you want to expand other sections.

You can drag and drop controls from the Controls tab onto the canvas. For more information, see Add Controls from the
Controls Tab.

You can nd the list of available controls in SAPUI5 Controls Supported in the Layout Editor.

Outline Tab
Controls that are selected on the Outline tab are automatically selected on the canvas and vice versa.

You can use the Outline tab to see the hierarchy of controls on the canvas. In addition, you can add and remove controls from
the canvas using the Outline tab.

For more information, see Add Controls from the Outline Tab.

This is custom documentation. For more information, please visit the SAP Help Portal 100
2/6/2024

Canvas
The canvas in the middle of the layout editor area provides a graphical display of the selected XML view.

Click a control on the canvas to select it. To select a parent control, hold Ctrl and click. You can keep clicking until you reach the
highest control in the hierarchy and then the focus will return to the original control. Click outside the canvas to undo the
selection.

This is custom documentation. For more information, please visit the SAP Help Portal 101
2/6/2024

Properties Pane

On the side of the canvas is a pane that displays the following:

Properties Pane
The Properties pane shows the properties of the control that is currently selected in the canvas and allows you to modify its
property values. The most commonly used properties for each control are displayed at the top of the list. The icon next to
each property opens the Data Binding dialog box.

For more information, see Binding Data, Bind Data to a Simple Control, and Bind Data to an Aggregate-Type Control.

This is custom documentation. For more information, please visit the SAP Help Portal 102
2/6/2024

 Note
Deprecated properties or aggregations are marked with the label deprecated (also in the Outline tab). For more
information, see SAP Library for User Interface Add-On 1.0 for SAP NetWeaver on SAP Help Portal at
http://help.sap.com/nw-uiaddon. Under Application Help, open SAP Library, and search for deprecation.

Related Information
Working with the Layout Editor

This is custom documentation. For more information, please visit the SAP Help Portal 103
2/6/2024
SAPUI5 Controls Supported in the Layout Editor

Working with the Layout Editor


An overview of the steps required to edit a project using the layout editor.

Prerequisites
You have created or imported an SAP Fiori project using the SAP Fiori Application template.

To create a project using this template:

1. Enter New Project in the command palette and select SAP Business Application Studio: New Project from Template.
The Project Wizard opens showing the project templates that are relevant based on the dev space and additional
extensions that you selected.

2. Select the SAP Fiori application tile, and click Start.

3. Select the Basic template, and click Next.

4. Follow the wizard steps and provide the required information.

In the view folder of this project, you can edit the following views:

App.view.xml

View1.view.xml

Procedure
1. From the context menu of the XML view, choose Open With... and select the Layout Editor from the command palette.

2. Edit the views of your application as follows:

Add controls to your view using the drag and drop functionality.

Delete controls from your view.

Rearrange controls in your view using the drag and drop functionality.

Use the keyboard to navigate within the canvas. Double-click on a control to move the selection to its parent.

Bind controls in the layout editor to elements from the OData service.

Add Controls from the Outline Tab


You can add controls to the canvas from the Outline tab.

Procedure
1. On the Outline tab, select a control to which you want to add another control.

2. At the top of the Outline tab, click , then in the popup menu, select the control you want to add.

The control is added on the Outline tab and appears on the canvas.

 Note

This is custom documentation. For more information, please visit the SAP Help Portal 104
2/6/2024
The information bar at the top of the canvas shows you where you are about to drop the control.

Related Information
Delete Controls from the Outline Tab
SAPUI5 Controls Supported in the Layout Editor

Delete Controls from the Outline Tab


You can remove controls from the Outline tab.

Procedure
1. On the Outline tab, select a control that you want to delete.

2. At the top of the Outline tab, click .

The control is removed from the view.

Related Information
Add Controls from the Outline Tab
SAPUI5 Controls Supported in the Layout Editor

Add Controls from the Controls Tab


Add controls to the canvas by using drag and drop functionality.

Select the control that you want to add to the canvas from the Controls tab in the rst section of the layout editor area and
drag it to the drop target on the canvas. A tooltip displays the drop targets as you drag the control around the canvas.

Example
If you want to add an HBox layout with a Button control to your view, do the following:

1. Choose the Controls tab.

2. Open the Layout section by clicking the arrow next to the section title.

3. Select the HBox control and drag it to the canvas. Drop it at the position where you want it to appear.

4. Open the Action section by clicking the arrow next to the section title.

5. Select the Button control and drag it to the canvas.

6. Drop the Button control onto the HBox layout.

Keyboard Support
Use the keyboard to move selected controls or navigate within the view that you opened with the layout editor.

Selecting Controls

This is custom documentation. For more information, please visit the SAP Help Portal 105
2/6/2024
If you selected a control in the canvas of the layout editor, you can move the selection using the arrow keys:

UP ARROW : moves the selection to the parent of the selected control

DOWN ARROW : moves the selection to the child of the selected control

LEFT ARROW : moves the selection to the control that is up/to the right of the selected control (within the same
aggregation)

RIGHT ARROW : moves the selection to the control that is down/to the left of the selected control (within the same
aggregation)

CTRL + click: moves the selection to the parent of the selected control

Moving Selected Controls


If you have selected a control in the canvas of the layout editor, you can change its position within the aggregation:

SHIFT + LEFT ARROW : moves the control up/to the right

SHIFT + RIGHT ARROW : moves the control down/to the left

Changing the Drop Target


When you drag and drop a control from the palette to the canvas or from one position within the canvas to another, you can use
the keyboard to de ne the drop position of the dragged control:

Use SHIFT or ALT to de ne the drop position of the dragged control within an aggregation:

SHIFT : moves the drop position up/to the right

ALT : moves the drop position down/to the left

Binding Data
In the layout editor, you can bind properties of controls or control aggregations to an artifact in the OData service.

Prerequisites
You have de ned a data set for the view that you are working on, by doing one of the following:

If you are opening a view that has no data set de ned for it, the Data Binding dialog box opens, where you can de ne a
data set.

Select the view, and de ne the data set from the dropdown list.

 Caution
If you change the data set that is de ned for the current view, the existing data bindings might become invalid.

Overview
The following types of bindings are possible:

Properties of controls

Aggregations of controls

 Note
This is custom documentation. For more information, please visit the SAP Help Portal 106
2/6/2024
To bind properties of models that are not OData models, you must work from the source code les and not from the layout
editor. Alternatively, if you do not want to work with the source les in the XML editor, you can enter free text for properties
in the Properties pane.

 Note
If your application does not consume an OData service, you can add the OData Service component to it.

Related Information
SAPUI5 API Reference

De ne Entity Set
Before you can bind data to a control, you need to de ne an entity set.

Prerequisites
You have created a project in the layout editor. For more information, see Working with the Layout Editor.

You have dragged a control from the Controls pane to the canvas. For more information, see Add Controls from the
Controls Tab.

Procedure
1. In the canvas, select the control for which you want to de ne an entity set.

2. In the Properties pane, click the icon.

The Select Entity Set dialog box opens.

3. Select and con gure one of the entity sets for your control.

 Note
Most users should use either of the rst two entity sets listed here.

Use ancestor's entity set.

De ne dummy entity set for the selected control.

 Restriction
The "dummy" entity set is only for advanced users.

De ne entity set and set the selected control as template.

4. Click Bind.

Bind Data to a Simple Control


You can bind data to a simple control.

Procedure

This is custom documentation. For more information, please visit the SAP Help Portal 107
2/6/2024
1. On the canvas, select the desired control for which you want to de ne data binding.

2. In the Properties pane on the side of the canvas, do one of the following:

Click next to the property to which you want to bind data, and then do the following in the Data Binding
dialog box:

a. In the Data Fields list, double-click one or more data elds that you want to add to the expression.

The data elds are automatically concatenated to the string in the Expression box.

b. Click Bind or rst manually edit the expression string and then click Bind.

In the Properties pane, for a eld or dropdown list, manually enter the required expression within curly brackets
{...} according to the data set that you selected.

Bind Data to an Aggregate-Type Control


You can bind data to an aggregate-type control, which creates a template.

Prerequisites
You have de ned an entity set. For more information, see De ne Entity Set.

Procedure
1. In the canvas or on the Outline tab to the side of the canvas, choose an aggregate-type control that you want to turn into
a template, such as a List Item control.

2. In the Properties pane to the side of the canvas, from the Select Entity Set dialog box, select De ne entity set and set
the selected control as template., and click Bind.

This control becomes a template.

3. In the Con rmation Needed dialog box, con rm the removal of any existing controls on the same level by clicking OK.

Results
The template item is now marked Template in the Outline tab.

Bind to the i18n Model


You can bind a control property to the i18n model or create a new i18n entry.

Procedure
1. On the canvas, select the desired control for which you want to de ne i18n model binding.

2. In the Properties pane to the side of the canvas, do one of the following:

Click next to the property to which you want to bind data, and then do the following in the dialog box that
appears:

a. From the drop down list, select i18n, double-click one or more entries that you want to add to the
expression.

The entries are automatically concatenated to the string in the Expression box.

This is custom documentation. For more information, please visit the SAP Help Portal 108
2/6/2024
b. Click Bind or rst manually edit the expression string and then click Bind.

In the Properties pane, for a eld or dropdown list, manually enter the required expression within curly brackets
{...}.

Click + to add a new i18n entry.

Bind to a Label Annotation


You can bind a control property to a label annotation.

Context
You can bind a control property to a label annotation that resides in the OData metadata le. Other annotation les are not
supported.

Procedure
1. On the canvas, select the desired control for which you want to de ne a label annotation binding.

2. In the Properties pane to the side of the canvas, do one of the following:

Click next to the property to which you want to bind data, and then do the following in the dialog box that
appears:

a. From the dropdown list, select Labels, double-click one or more annotation that you want to add to the
expression.

The annotations are automatically concatenated to the string in the Expression box.

b. Click Bind or rst manually edit the expression string and then click Bind.

In the Properties pane, for a eld or dropdown list, manually enter the required expression within curly brackets
{...}.

SAPUI5 Controls Supported in the Layout Editor


Provides a list of SAPUI5 controls that are supported in the layout editor.

Controls Tab
The following SAPUI5 controls can be dragged and dropped from the Controls tab onto the canvas.

 Note
The controls on the Controls tab are also available from the Outline tab. For more information, see Add Controls from the
Outline Tab.

 Note
For more information about SAPUI5 controls, see UI development toolkit for HTML5 - Demo Kit.

SAPUI5 Controls Available on the Controls Tab

SAPUI5 Control Name Description

This is custom documentation. For more information, please visit the SAP Help Portal 109
2/6/2024

SAPUI5 Control Name Description

Action List Items Button that is used to re actions when pressed.

sap.m.ActionListItem

Action Select Provides a list of prede ned items that allows end users to choose options and
additionally trigger some actions.
sap.m.ActionSelect

Add Bookmark Button Button that is displayed in the application footer. Clicking the button opens a dialog
box that allows the user to save the app state, so that the app can be launched in this
sap.ushell.ui.footerbar.AddBookmarkButton
state directly from the launchpad.

Analytic Map Renders a map based on a GeoJSON source.

sap.ui.vbm.AnalyticMap

App The root element of an SAPUI5 mobile application. It inherits from the NavContainer
control and thus provides its navigation capabilities. App provides certain header tags
sap.m.App
to the HTML page that are relevant for mobile apps.

Bar Centers a control like a title while having other controls on its left and right.

sap.m.Bar

Breadcrumbs Enables users to navigate between items by providing a list of links to previous steps
sap.m.Breadcrumbs in the user's navigation path. The last three steps can be accessed as links directly,
while the remaining links prior to them are available in a drop-down menu.

Busy Indicator Provides methods to show or hide a waiting animation that covers the whole page and
blocks user interaction.
sap.ui.core.BusyIndicator

Button Allows users to trigger actions.

sap.m.Button

Calendar Basic calendar that is used for DatePickers.

sap.ui.uni ed.Calendar

Calendar Legend Legend for the Calendar control. Displays special date colors with their
corresponding description.
sap.ui.uni ed.CalendarLegend

CalendarLegendItem Item to be displayed in a CalendarLegend.

sap.ui.uni ed.CalendarLegendItem

Carousel Navigates through a list of controls by swiping right or left.

sap.m.Carousel

Check Box Allows the user to select one or multiple items from a list.

sap.m.CheckBox

Component Container Container that embeds a UIComponent in a control tree.

sap.ui.core.ComponentContainer

Control Con guration Can be used to add additional con guration for lter elds in the SmartFilterBar
control, in order to overwrite the default settings from the OData metadata. For
sap.ui.comp.smart lterbar.ControlCon guration
instance, it is possible to change the label, index or control type of a lter eld.

Column Allows de nition of column-speci c properties that are applied when rendering a List
control.
sap.m.Column

This is custom documentation. For more information, please visit the SAP Help Portal 110
2/6/2024

SAPUI5 Control Name Description

Column List Item Used with cell aggregation to create rows for the sap.m.Table control.

sap.m.ColumnListItem

Combo Box Combines a dropdown list with items and a text input eld with a button allowing the
user to either type a value directly or choose from a list of prede ned items.
sap.m.ComboBox

Custom Data Contains a single key/value pair of custom data attached to an Element.

sap.ui.core.CustomData

Custom List Item With content aggregation, can be used to customize standard list items that are not
provided by SAPUI5. ListItem type is applied to CustomListItem as well.
sap.m.CustomListItem

 Note
Content aggregation allows any control. Complex responsive layout controls (such
as Table and Form) should not be aggregated as content.

Custom Tile Displays application-speci c content in the Tile control.

sap.m.CustomTile

Date Picker Date input control with a calendar used as a date picker.

sap.m.DatePicker

Detail Page An sap.m.semantic.ShareMenuPage control that supports certain semantic


buttons that have default semantic-speci c properties and are eligible for content
sap.m.semantic.DetailPage
aggregation.

Display List Item Used to represent a label and a value.

sap.m.DisplayListItem

DraftIndicator A draft indicator is sap.m.Label.


sap.m.DraftIndicator

Feed Input Allows the user to enter text for a new feed entry and then post it.

sap.m.FeedInput

Feed List Item Provides a set of properties for text, sender information, and time stamp.

sap.m.FeedListItem

Filter Group Item Represents a lter belonging to a group other than basic.

sap.ui.comp. lterbar.FilterGroupItem

Filter Item Represents a lter belonging to the basic group.

sap.ui.comp. lterbar.FilterItem

Flex Item Data Holds layout data for a FlexBox / HBox / VBox.

sap.m.FlexItemData

Flex Box Builds the container for a exible box layout.

sap.m.FlexBox

Form Structured into FormContainer controls, each of which consists of FormElement


controls.
sap.ui.layout.form.Form

This is custom documentation. For more information, please visit the SAP Help Portal 111
2/6/2024

SAPUI5 Control Name Description

Form Container Group inside a Form.

sap.ui.layout.form.FormContainer

Form Element Row in a FormContainer control.

sap.ui.layout.form.FormElement

Fullscreen Page An sap.m.semantic.ShareMenuPage control that supports certain semantic


buttons that have default semantic-speci c properties and are eligible for content
sap.m.semantic.FullscreenPage
aggregation.

Generic Tile Displays header, subheader, and a customizable main area in a tile format.

sap.m.GenericTile

Geo Map A map control that allows the user to position multiple visual objects on top of a map.

sap.ui.vbm.GeoMap

Grid Layout that positions its child controls in a 12-column ow layout.

sap.ui.layout.Grid

Grid Container Data The GridLayout-speci c layout data for FormContainers.

sap.ui.layout.form.GridContainerData

Grid Data Grid layout data.

sap.ui.layout.GridData

Grid Element Data The GridLayout-speci c layout data for FormElement elds.

sap.ui.layout.form.GridElementData

Group Groups are used to group group elements.

sap.ui.comp.smartform.Group

Group Con guration Can be used to add additional con gurations for groups in the SmartFilterBar. A group
in the SmartFilterBar is a group of lter elds in the advanced search.
sap.ui.comp.smart lterbar.GroupCon guration

GroupElement A combination of one label and different controls associated to this label.

sap.ui.comp.smartform.GroupElement

Group Header List Item Used to display the title of a group and act as a separator between groups in
sap.m.List and sap.m.Table.
sap.m.GroupHeaderListItem

HBox Builds the container for a horizontal exible box layout.

sap.m.HBox

Horizontal Layout Provides support for horizontal alignment of controls.

sap.ui.layout.HorizontalLayout

Icon Uses an embedded font instead of a pixel image.

sap.ui.core.Icon

Icon Tab Bar Represents a collection of tabs with associated content.

sap.m.IconTabBar

This is custom documentation. For more information, please visit the SAP Help Portal 112
2/6/2024

SAPUI5 Control Name Description

Icon Tab Filter Represents a selectable item inside an Icon Tab Bar control.

sap.m.IconTabFilter

Icon Tab Header Displays a number of Icon Tab Filter and Icon Tab Separator controls.

sap.m.IconTabHeader

Icon Tab Separator Icon used to separate two Icon Tab Filter controls.

sap.m.IconTabSeparator

Image Wrapper around the IMG tag.

sap.m.Image

Input Allows users to input data.

sap.m.Input

Input List Item List item used for a label and an input eld.

sap.m.InputListItem

Invisible Text Used to bring hidden texts to the UI for screen reader support.

sap.ui.core.InvisibleText

Item Control base type.

sap.ui.core.Item

Label Used in SAPUI5 mobile applications to provide label text for other controls.

sap.m.Label

Layout Data A layout data base type.

sap.ui.core.LayoutData

Link Used to trigger actions or to navigate to other applications or web pages.

sap.m.Link

List Provides a container for all types of list items.

sap.m.List

List Item Used in lists or list-like controls, such as DropdownBox.

sap.ui.core.ListItem

Master Page An sap.m.semantic.SemanticPage control that supports certain semantic


buttons that have default semantic-speci c properties and are eligible for content
sap.m.semantic.MasterPage
aggregation.

Message Strip Allows the embedding of application-related messages in the application.

sap.m.MessageStrip

Nav Container Handles hierarchical navigation between Page controls or other fullscreen controls.

sap.m.NavContainer

Object Attribute Displays a text eld that can be normal or active.

sap.m.ObjectAttribute

This is custom documentation. For more information, please visit the SAP Help Portal 113
2/6/2024

SAPUI5 Control Name Description

Object Header Allows the user to easily identify a special object.

sap.m.ObjectHeader

Object Identi er Display control that allows the user to easily identify a speci c object.

sap.m.ObjectIdenti er

Object List Item Display control that provides summary information about an object as an item in a list.

sap.m.ObjectListItem

Object Number Displays number and number unit properties for an object.

sap.m.ObjectNumber

Object Status Status information that can be either text with a value state, or an icon.

sap.m.ObjectStatus

Over ow Toolbar Container based on sap.m.Toolbar that provides over ow when its content does not
t in the visible area.
sap.m.Over owToolbar

Over ow Toolbar Button Represents an sap.m.Button that shows its text only when in the over ow area of an
sap.m.Over owToolbar.
sap.m.Over owToolbarButton

Page Basic container for a mobile application screen.

sap.m.Page

Paging Button Allows users to navigate between items and entities.

sap.m.PagingButton

Pane Container An abstraction of Splitter.

sap.ui.layout.PaneContainer Could be used as an aggregation of ResponsiveSplitter or other


PaneContainers.

Panel Container for controls that has a header and content.

sap.m.Panel

Progress Indicator Shows the progress of a process in a graphical way.

sap.m.ProgressIndicator

Pull To Refresh Triggers the refresh event.

sap.m.PullToRefresh

Radio Button Control similar to CheckBox, but it allows the user to choose only one of a prede ned
set of options.
sap.m.RadioButton

Radio Button Group Used as a wrapper for a group of sap.m.RadioButton controls, which then can be
used as a single UI element.
sap.m.RadioButtonGroup

Rating Indicator Used to rate content.

sap.m.RatingIndicator

Responsive Flow Layout Data This is a LayoutData element that can be added to a control if this control is used
within a ResponsiveFlowLayout.
sap.ui.layout.ResponsiveFlowLayoutData

This is custom documentation. For more information, please visit the SAP Help Portal 114
2/6/2024

SAPUI5 Control Name Description

Search Field Allows users to input a search string.

sap.m.SearchField

Segmented Button Horizontal control made of multiple buttons, which can display a title or an image.

sap.m.SegmentedButton

Segmented Button Item Used for creating buttons for the sap.m.SegmentedButton. It is derived from the
sap.ui.core.Item.
sap.m.SegmentedButtonItem

Select Provides a list of items that allows the user to select an item.

sap.m.Select

Select List Displays a list of items that allows the user to select an item.

sap.m.SelectList

Semantic Page An enhanced sap.f.DynamicPage, that contains controls with semantic-speci c


meaning.
sap.f.semantic.SemanticPage

Semantic Page An enhanced sap.m.Page control that can contain controls with semantic meaning.
Content speci ed in sap.m.semantic.SemanticPage semantic control
sap.m.semantic.SemanticPage
aggregations are automatically positioned in dedicated sections of the footer or the
header of the page, depending on the control's semantics.

Share Menu Page An sap.m.semantic.SemanticPage control that supports a Share menu in the
footer.
sap.m.semantic.ShareMenuPage

Shell Can be used as root element of applications. It can contain an App or a SplitApp
control. The Shell provides some overarching functionality for the overall application
sap.m.Shell
and takes care of visual adaptation, such as a frame around the App, on desktop
browser platforms.

Simple Form Provides an API for creating simple forms. Inside a SimpleForm control, a Form
control is created along with its FormContainers control and FormElements
sap.ui.layout.form.SimpleForm
control, but the complexity in the API is removed.

Slider User interface control that allows the user to adjust values within a speci ed numerical
range.
sap.m.Slider

Smart Chart Creates a chart based on OData metadata and the con guration speci ed. The
entitySet property must be speci ed to use the control. This property is used to
sap.ui.comp.smartchart.SmartChart
fetch elds from OData metadata, from which the chart UI will be generated. It can also
be used to fetch the actual chart data.

Based on the chartType property, this control will render the corresponding chart.

 Note
Most of the attributes are not dynamic and cannot be changed once the control has
been initialized.

Smart Field A wrapper for other controls. It interprets OData metadata to determine the control that
has to be instantiated. The OData entity is derived from the control's binding context.
sap.ui.comp.smart eld.SmartField
The OData entity's property that is changed or displayed with the control is derived
from the control's value property.

This is custom documentation. For more information, please visit the SAP Help Portal 115
2/6/2024

SAPUI5 Control Name Description

Smart Filter Bar The SmartFilterBar control uses the OData metadata of an entity in order to create
a FilterBar.
sap.ui.comp.smart lterbar.SmartFilterBar
Whether a eld is visible on the FilterBar, supports type-ahead and value help, for
example, is automatically determined. When you use control con gurations and group
con gurations it is possible to con gure the FilterBar and adapt it according to
your needs.

Smart Form Renders a form (sap.ui.layout.form.Form). When used with the SmartField
control the label is taken from the metadata annotation sap:label if not speci ed
sap.ui.comp.smartform.SmartForm
directly.

Smart Link The SmartLink control uses a semantic object to display NavigationPopover for
further navigation steps.
sap.ui.comp.navpopover.SmartLink

 Note
Navigation targets are determined using CrossApplicationNavigation of the
uni ed shell service.

Smart Table Creates a table based on OData metadata and the con guration speci ed. The
entitySet attribute must be speci ed to use the control. This attribute is used to fetch
sap.ui.comp.smarttable.SmartTable
elds from OData metadata, from which columns will be generated; it can also be used
to fetch the actual table data.

Based on the tableType property, this control will render a standard, analytical, tree, or
responsive table.

Split Pane A container of a single control in a responsive splitter. Could be used as an aggregation
of a PaneContainer.
sap.ui.layout.SplitPane

Splitter Layout Data Holds layout data for the splitter contents. Allowed size values are numeric values
ending in "px" and "%" and the special case "auto". (The CSS value "auto" is used
sap.ui.layout.SplitterLayoutData
internally to recalculate the size of the content dynamically and is not directly set as
style property.)

Standard List Item List item that provides the most common use cases, such as image, title, and
description.
sap.m.StandardListItem

Standard Tile Displayed in the Tile container.

sap.m.StandardTile

Switch User interface control on mobile devices that is used for switching between binary
states.
sap.m.Switch

Table Provides a set of sophisticated and convenient functions for responsive table design.

sap.m.Table

Text Used for embedding longer text paragraphs that need text wrapping into your
application.
sap.m.Text

Text Area Allows multiline text input.

sap.m.TextArea

Tile Container Container that arranges same-size tiles on carousel pages.

sap.m.TileContainer

This is custom documentation. For more information, please visit the SAP Help Portal 116
2/6/2024

SAPUI5 Control Name Description

Tile Content This control is used within the GenericTile control.

sap.m.TileContent

Title Used to aggregate other controls.

sap.ui.core.Title

Time Picker A single- eld input control that enables the users to ll time related input elds.

sap.m.TimePicker

Toggle Button Control that toggles between pressed and normal state.

sap.m.ToggleButton

Toolbar Horizontal container that is usually used to display buttons, labels, selects, and other
input controls.
sap.m.Toolbar

Toolbar Layout Data De nes layout data for the sap.m.Toolbar items.

sap.m.ToolbarLayoutData
 Note
ToolbarLayoutData should not be used together with
sap.m.ToolbarSpacer.

Toolbar Separator Creates a visual separator between toolbar items.

sap.m.ToolbarSeparator

Toolbar Spacer Adds horizontal space between toolbar items.

sap.m.ToolbarSpacer

Upload Collection Allows users to upload single or multiple les.

sap.m.UploadCollection

Upload Collection Item Provides information about uploaded les.

sap.m.UploadCollectionItem

Variant Layout Data Allows to add multiple LayoutData to one control in case that an easy switch of layouts
(e.g. in a Form) is needed.
sap.ui.core.VariantLayoutData

VBox Builds the container for a vertical exible box layout.

sap.m.VBox

Vertical Layout Layout in which the content controls are rendered one below the other.

sap.ui.layout.VerticalLayout

XML View A View de ned using (P)XML and HTML markup.

sap.ui.core.mvc.XMLView

Outline Tab
The SAPUI5 controls listed here are available only from the Outline tab in the layout editor.

 Note
This is custom documentation. For more information, please visit the SAP Help Portal 117
2/6/2024
For more information about SAPUI5 controls, see UI development toolkit for HTML5 - Demo Kit.

SAPUI5 Controls Available on the Outline Tab

SAPUI5 Control Name Description

sap.m.semantic.AddAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.m.semantic.CancelAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.f.semantic.CloseAction A semantic-speci c button, eligible for the closeAction aggregation


of the sap.f.semantic.SemanticPage to be placed in its
title.

sap.f.semantic.CopyAction A semantic-speci c button, eligible for the copyAction aggregation


of the sap.f.semantic.SemanticPage to be placed in its
title.

sap.f.semantic.DeleteAction A semantic-speci c button, eligible for the deleteAction


aggregation of the sap.f.semantic.SemanticPage to be
placed in its title.

sap.f.semantic.DiscussInJamAction A semantic-speci c button, eligible for the discussInJamAction


aggregation of the sap.f.semantic.SemanticPage to be
placed in the share menu within its title.

sap.m.semantic.DiscussInJamAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage.

sap.f.semantic.EditAction A semantic-speci c button, eligible for the editAction aggregation


of the sap.f.semantic.SemanticPage to be placed in its
title.

sap.m.semantic.EditAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.f.semantic.ExitFullScreenAction A semantic-speci c button, eligible for the exitFullScreenAction


aggregation of the sap.f.semantic.SemanticPage to be
placed in its title.

sap.f.semantic.FavoriteAction A semantic-speci c button, eligible for the favoriteAction


aggregation of the sap.f.semantic.SemanticPage to be
placed in its title.

sap.m.semantic.FavoriteAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.m.semantic.FilterAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.m.semantic.FilterSelect A sap.m.Select control enhanced with styling according to the


semantics of a common "Filter" action.

A FilterSelect cannot be used independently but only as


aggregation content of a sap.m.semantic.SemanticPage.

This is custom documentation. For more information, please visit the SAP Help Portal 118
2/6/2024

SAPUI5 Control Name Description

sap.f.semantic.FlagAction A semantic-speci c button, eligible for the agAction aggregation


of the sap.f.semantic.SemanticPage to be placed in its
title.

sap.m.semantic.FlagAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.f.semantic.FooterMainAction A semantic-speci c button, eligible for the footerMainAction


aggregation of the sap.f.semantic.SemanticPage to be
placed in its footer.

sap.m.semantic.ForwardAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.f.semantic.FullScreenAction A semantic-speci c button, eligible for the fullScreenAction


aggregation of the sap.f.semantic.SemanticPage to be
placed in its title.

sap.m.semantic.GroupAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.m.semantic.GroupSelect A sap.m.Select control enhanced with styling according to the


semantics of a common "Group" acton.

A GroupSelect cannot be used independently but only as


aggregation content of a sap.m.semantic.SemanticPage.

sap.m.semantic.MainAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.f.semantic.MessagesIndicator A semantic-speci c button, eligible for the messagesIndicator


aggregation of the sap.f.semantic.SemanticPage to be
placed in its footer.

sap.m.semantic.MessagesIndicator Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.m.semantic.MultiSelectAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.f.semantic.NegativeAction A semantic-speci c button, eligible for the negativeAction


aggregation of the sap.f.semantic.SemanticPage to be
placed in its footer.

sap.m.semantic.NegativeAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.m.semantic.OpenInAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.f.semantic.PositiveAction A semantic-speci c button, eligible for the positiveAction


aggregation of the sap.f.semantic.SemanticPage to be
placed in its footer.

This is custom documentation. For more information, please visit the SAP Help Portal 119
2/6/2024

SAPUI5 Control Name Description

sap.m.semantic.PositiveAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.f.semantic.PrintAction A semantic-speci c button, eligible for the printAction aggregation


of the sap.f.semantic.SemanticPage to be placed in the
share menu within its title.

sap.m.semantic.PrintAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.m.semantic.SaveAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.f.semantic.SendEmailAction A semantic-speci c button, eligible for the sendEmailAction


aggregation of the sap.f.semantic.SemanticPage to be
placed in the share menu within its title.

sap.m.semantic.SendEmailAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.f.semantic.SendMessageAction A semantic-speci c button, eligible for the sendMessageAction


aggregation of the sap.f.semantic.SemanticPage to be
placed in the share menu within its title.

sap.m.semantic.SendMessageAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage.

sap.f.semantic.ShareInJamAction A semantic-speci c button, eligible for the shareInJamAction


aggregation of the sap.f.semantic.SemanticPage to be
placed in the share menu within its title.

sap.m.semantic.ShareInJamAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.m.semantic.SortAction Has default semantic-speci c properties and is eligible to be


included in the aggregation content of an
sap.m.semantic.SemanticPage control.

sap.f.semantic.TitleMainAction A semantic-speci c button, eligible for the titleMainAction


aggregation of the sap.f.semantic.SemanticPage to be
placed in its title.

sap.m.Title Used for header texts and title.

sap.m.Token Renders a token containing text and an optional Delete icon.

sap.m.Tokenizer Displays multiple tokens.

sap.suite.ui.commons.BusinessCard Allows displaying of business card information, including an image,


rst title (either URL link or text), second title, and multiple text
lines.

sap.suite.ui.commons.ComparisonChart Displays a comparison chart.

sap.suite.ui.commons.ComparisonData Comparison tile value holder.

This is custom documentation. For more information, please visit the SAP Help Portal 120
2/6/2024

SAPUI5 Control Name Description

sap.suite.ui.commons.CountingNavigationItem Extends the sap.ui.ux3.NavigationItem control. This


control displays the number of items in a corresponding content
area. It also provides a rich tooltip that appears and disappears
after a certain delay.

sap.suite.ui.commons.DateRangeScroller Provides a method to scroll through a series of time periods, each


of which is represented by a start date and an end date, known as
the date range.

sap.suite.ui.commons.DateRangeSliderInternal Provides the user with a RangeSlider control that is optimized


for use with dates.

sap.suite.ui.commons.DeltaMicroChart Displays a delta of two values as a chart.

sap.suite.ui.commons.DynamicContainer Displays multiple GenericTile controls as changing slides.

sap.suite.ui.commons.FacetOverview Used in UnifiedThingInspector to display a preview of facet


content.

sap.suite.ui.commons.GenericTile Tile control that displays a title, description, and customizable


main area.

sap.suite.ui.commons.HarveyBallMicroChart Chart that shows a comparative part to a total.

sap.suite.ui.commons.HarveyBallMicroChartItem Con guration of a slice on a pie chart.

sap.suite.ui.commons.HeaderCell Contains four cells (West, North, East, South). It can display one or
more controls in different layouts. Each aggregation must contain
only one instance of HeaderCellItem.

sap.suite.ui.commons.HeaderCellItem Object that contains an instance of a control and information about


its height. It should be used inside
sap.suite.ui.commons.HeaderCell.

sap.suite.ui.commons.HeaderContainer Container that provides a horizontal layout. On mobile devices, it


provides a horizontal scroll. On desktops, it provides scroll left and
scroll right buttons. This control supports keyboard navigation. You
can use left and right arrow keys to navigate through the inner
content. The Home key puts focus on the rst control and the
End key puts focus on the last control. Use the Enter key or
Spacebar key to choose the control.

sap.suite.ui.commons.JamContent Displays SAP Jam content text, subheader, and numeric value in a
tile.

sap.suite.ui.commons.KpiTile Used in UnifiedThingInspector to display object-related


KPIs in a factsheet.

sap.suite.ui.commons.NewsContent Displays news content text and subheader in a tile.

sap.suite.ui.commons.NoteTaker Allows creation and storage of notes for further reference.

sap.suite.ui.commons.NoteTakerCard Allows storage of NoteTaker card header and body text.

sap.suite.ui.commons.NoteTakerFeeder Allows entering quick notes and note cards.

sap.suite.ui.commons.NumericContent Numeric content to be used in a tile or other place where it is


needed to show numeric values with semantic colors and
deviations.

sap.suite.ui.commons.TileContent Serves as a universal container for different types of content and


footer.

This is custom documentation. For more information, please visit the SAP Help Portal 121
2/6/2024

SAPUI5 Control Name Description

sap.ui.commons.ApplicationHeader Located at the top of an application page and consists of four


areas.

sap.ui.commons.Button Allows users to trigger actions such as save or print. For the button
UI, you can de ne text or an icon, or both.

sap.ui.commons.CheckBox Provides a box that can be agged and has a label. A checkbox can
either stand alone, or be in a group with other checkboxes.

sap.ui.commons.ColorPicker Allows the user to choose a color. The color can be de ned using
HEX, RGB, or HSV values, or a CSS colorname.

sap.ui.commons.FileUploader Framework that generates an input eld and a button with the text
Browse....

sap.ui.commons.MenuBar Represents a user interface area that is the entry point for menus
with their menu items.

sap.ui.commons.MenuButton Common button control that opens a menu when chosen by the
user. The control provides an API for con guring the docking
position of the menu.

sap.ui.commons.Paginator Provides navigation between pages within a list of numbered


pages.

sap.ui.commons.Panel Represents a container with scroll functionality that can be used for
text and controls.

sap.ui.commons.PasswordField Text eld with masked characters that borrows its properties and
methods from the TextField control.

sap.ui.commons.ProgressIndicator Shows the progress of a process in a graphical way.

sap.ui.commons.RadioButton Consists of a round element and descriptive text.

sap.ui.commons.RangeSlider Interactive control that is displayed either as a horizontal or vertical


line with two pointers and units of measurement.

sap.ui.commons.RatingIndicator Allows the user to rate a certain topic.

sap.ui.commons.SegmentedButton Provides a group of buttons.

sap.ui.commons.Slider Interactive control that is displayed either as a horizontal or vertical


line with a pointer and units of measurement.

sap.ui.commons.Splitter Allows splitting the screen into two areas.

sap.ui.commons.TextArea Control for entering or displaying multiple rows of text.

sap.ui.commons.TextField Renders an input eld for text input.

sap.ui.commons.Toolbar Horizontal row of items where in many cases the single toolbar
items are buttons that contain icons.

sap.ui.commons.Tree Simple tree for displaying an item in a hierarchical way.

sap.ui.commons.TreeNode Tree node element.

sap.ui.layout.FixFlex Builds the container for a layout with a xed and a exible part.

sap.ui.layout.form.FormLayout Base layout used to render a Form control.

sap.ui.layout.form.GridLayout Renders a Form control using an HTML table-based grid.

This is custom documentation. For more information, please visit the SAP Help Portal 122
2/6/2024

SAPUI5 Control Name Description

sap.ui.layout.form.ResponsiveGridLayout Renders a Form control using a responsive grid.

sap.ui.layout.form.ResponsiveLayout Renders a Form control with a responsive layout.

sap.ui.layout.ResponsiveSplitter A responsive splitter which divides the application into several


areas.

sap.ui.uni ed.Currency Text view that displays currency values and aligns them at the
separator.

sap.ui.uni ed.FileUploader Framework that generates an input eld and a button with the text
Browse ....

sap.ui.uni ed.FileUploaderParameter Represents a parameter for the FileUploader, which is rendered


as a hidden input eld.

sap.ui.uni ed.Menu Interactive element that provides a choice of different actions to


the user.

sap.ui.uni ed.MenuItem Standard item used inside a menu. Represents an action that can
be selected by a user in the menu or that can be used as a
submenu that organizes the actions hierarchically.

sap.ui.uni ed.ShellOverlay Opened in front of an sap.ui.unified.Shell control.

sap.ui.uni ed.SplitContainer Provides a main content and a secondary content area.

sap.ui.ux3.ExactArea Consists of two sections: a toolbar and a content area where


arbitrary controls can be added.

sap.ui.ux3.FeedChunk Unit that is embedded, standalone or multiple, into a Feed control.

sap.ui.ux3.Feeder Lean common feed, or a comment feed, with a text commit


function.

sap.uxap.ObjectPageHeader Static part of an Object page header.

sap.uxap.ObjectPageHeaderContent Dynamic part of an Object page header.

Command Palette
The command palette provides access to all the IDE functionality including shortcuts for the most common operations.

To open the command palette, navigate to View Command Palette... from the menu or press F1 (Windows/Linux) or
Command + Shift + P (Mac).

This will open an input eld at the top of the IDE allowing you to enter a command. Content assist then allows you to nd
commands quickly.

Some commands will lead you into a minimal text-based wizard, allowing you to enter additional parameters.

This is custom documentation. For more information, please visit the SAP Help Portal 123
2/6/2024

Runtime Version Management


SAP Business Application Studio uses asdf to allow you to select which runtime versions to install and use for developing your
application.

By default, SAP Business Application Studio de nes only one Java and Node.js version that is officially supported. The default
installed versions, are the Long Term Support (LTS) versions for Node.js and Java. You can check the currently installed version
in your dev space, using the following command in the terminal:

For Java: java -version

For Node.js: node --version

You can manually install and select a different version.

Install a Runtime Version


1. From the command palette, select Runtime: Install,

2. Select Node.js or Java as the runtime you want to install.

3. Select the runtime version you want to install

The new version will be available on your dev space and persisted using your allocated storage. Installing the version does not
change the default version used.

 Note

asdf can be also used from the SAP Business Application Studio terminal to install additional versions. See the All
Commands topic in the asdf documentation.

If you installed a Java version using the SAP Business Application Studio terminal, it is recommended to run the
Runtime: Add Proxy Certi cate to Java command via the command palette to allow connectivity to on-premise Java
repositories during the maven build.

Set a Default Runtime Version

This is custom documentation. For more information, please visit the SAP Help Portal 124
2/6/2024
1. From the command palette, select Runtime: Set default.

2. Select Node.js or Java as the runtime,

3. Select the runtime version you want to set as default.

Your selection will be persisted on your dev space and applies to all workspaces.

Problems View
The Problems view displays the coding errors and warnings of all open les in a list. When you click an item from the list, the
problematic piece of code is highlighted in the editor.

From the menu, navigate to View Problems to open the Problems view.

Search
There are different Search capabilities in SAP Business Application Studio.

You can perform a search from the Search view or from the Find widget in the editor.

To open the Search view, navigate to View Search from the menu.

This is custom documentation. For more information, please visit the SAP Help Portal 125
2/6/2024

To open the Find widget within a le, press Ctrl+F.

Find and Replace

You can nd text and replace in the currently opened le. The search results will be highlighted in the editor, overview ruler, and
minimap.

If there is more than one matched result in the current opened le, you can press Enter and Shift+Enter to navigate to next
or previous result when the nd input box is focused.

When the Find Widget is open, it will automatically populate the selected text in the editor into the nd input box. If the
selection is empty, the word under the cursor will be inserted into the input box instead.

Find In Selection

By default, the nd operations are run on the entire le in the editor. It can also be run on selected text. You can turn this
feature on by clicking the hamburger icon on the Find Widget.

This is custom documentation. For more information, please visit the SAP Help Portal 126
2/6/2024
Multiline support

You can search text in multiple lines by pasting it into the Find input box. Pressing Ctrl+Enter inserts a new line in the input
box.

Resize Find Widget

You can drag the left sash of the Find Widget to enlarge it. You can also double-click the left sash to maximize it or shrink it to its
default size.

Search across les

You can search over all les in the currently opened folder. Press Ctrl+Shift+F and enter your search term. Search results
are grouped into les containing the search term, with an indication of the hits in each le and its location. Expand a le to see a
preview of all of the hits within that le. Then single-click on one of the hits to view it in the editor.

Advanced search options

In the input box below the search box, you can enter patterns to include or exclude from the search.

If you enter a word, a search will be performed on every folder and le with the name of the word you entered in the workspace.

If you enter ./ before the word, that will match the folder name at the top level of your workspace.

Use an exclamation mark ! to exclude those patterns from the search.

Use a comma , to separate multiple patterns.

Paths must use forward slashes.

You can also use glob syntax:

* to match one or more characters in a path segment

? to match on one character in a path segment

** to match any number of path segments, including none

{} to group conditions (for example {**/*.html,**/*.txt} matches all HTML and text les)

[] to declare a range of characters to match

Some folders are excluded by default to reduce the number of search results that you are not interested in (for example,
node_modules). Open settings to change these rules.

Also note the Use Exclude Settings and Ignore Files toggle button in the les to exclude box. The toggle determines whether to
exclude les that are ignored by your .gitignore les and/or matched by your files.exclude and search.exclude
settings.

From the Explorer, you can right-click on a folder and select Find in Folder to search inside a folder only.

Search and replace

You can search and replace across les. Expand the Search input eld to display the Replace one.

This is custom documentation. For more information, please visit the SAP Help Portal 127
2/6/2024

When you enter text into the Replace input eld, you will see a diff display of the pending changes. You can replace across all
les from the Replace input eld, replace all in one le or replace a single change.

Advanced Search and Replace Options

In addition to search and replace with plain text, there are also advanced search options:

Match Case

Match Whole Word

Regular Expression

Include Ignored Files

Test and Run


Once you have nished coding, you can test and run your application.

Creating Run Con gurations


Create run con gurations that de ne how your project or unit test is executed.
Running Applications in Incognito Mode
Running an application in Incognito mode allows you to test it with different users.
Application Preview Settings
Each application runs on a speci c port. If you want to open a new browser tab with your running application, use the
Ports: Preview command.
Cloud Foundry Tools
Connect and perform actions on the Cloud Foundry environment.
Debugging
SAP Business Application Studio has built-in debugging support for the Node.js runtime and can debug JavaScript,
TypeScript, or any other language that gets transpiled to JavaScript.

Creating Run Con gurations


Create run con gurations that de ne how your project or unit test is executed.

SAP Business Application Studio provides default run con gurations for your projects. You can create and con gure additional
run con gurations that de ne how your project or unit test is executed. You can also create a new run con guration by
duplicating an existing run con guration and then editing it.

Clicking (Run and Debug) from the header provides one of the following options:

If there is a default run con guration that's created during project creation, this con guration runs.

This is custom documentation. For more information, please visit the SAP Help Portal 128
2/6/2024
If you add a new con guration and run it, this con guration runs.

If you add multiple con gurations, the last con guration that you ran runs.

If you have run con gurations from multiple projects, you can choose which con guration to run.

Related Information
Creating Run Con gurations for Java Modules

SAP Fiori tools- Create a New Run Con guration in SAP Business Application Studio

Creating Run Con gurations for CAP Java Modules

Creating Run Con gurations for CAP Node Applications

Creating Run Con gurations for Java Modules


Create new run con gurations to run a Java module for a multitarget application.

Run a Java module on the local Apache Tomcat server and allow binding the module's required resources to speci c Cloud
Foundry services.

Prerequisites

Your project must include an mta.yaml le that points to the Java module.

The Java module's pom.xml le must include the following de nition: packagingType= war.

Add a New Con guration

1. Click from the activity bar to open the Run Con gurations view.

2. Click + (Create Con guration).

3. Select the Java module as the runnable object.

A new con guration is added to your launch.json le.

 Note
Any manual change performed to the launch.json le is re ected in the con guration tree.

Bind Dependencies
In the Run Con gurations view, you can see the resources that are de ned in the MTA descriptor. You can bind or unbind these
resources to a speci c Cloud Foundry service instance.

 Note
The following Cloud Foundry service types are supported for binding:

hana ( managed-hana isn't supported)

PSA-based SAP HANA

This is custom documentation. For more information, please visit the SAP Help Portal 129
2/6/2024
HaaS (if con gured as "Available for all IPs")

xsuaa

destination

connectivity

auditlog

application-logs

To bind the resource:

1. Open the Run Con gurations view.

2. Select the desired con guration.

3. Select the desired resource.

4. Click (bind).

If not already logged in, you're prompted to log in to Cloud Foundry.

A list of all available services that match your resource type are displayed in the command palette.

5. Select the desired service.

The resource is bound to the service.

This updates the resource's con guration les. See the Advanced Options section to see the changes made to the con guration
les.

If you're binding to an SAP HANA service, a new connection called '<my_service_instance name>' is added to the
SQLTools view where your tables and data are displayed.

Unbinding the resource removes all of the changes made to the con guration les.

To unbind the resource:

1. Open the Run Con gurations view.

2. Select the desired con guration.

3. Select the desired resource.

4. Click (unbind).

Run a Con guration


1. If you bound your service to a service that requires Chisel to run:

This is custom documentation. For more information, please visit the SAP Help Portal 130
2/6/2024
a. In the command palette, enter Tasks and select Tasks: Run Task.

b. Select openChiselTunnelFor-<service name>.

 Note
If Chisel is already running in the same port and space, skip this step.

2. Select the desired run con guration.

3. Click (Run) to run the project.

Prelaunch and dependent tasks are run.

The Debug Console opens.

4. Click Open in New Tab to view the UI in a new tab.

5. If you need to stop a con guration that is already running, you can do so from the Run and Debug view.

 Note
For more information about the tasks triggered by the run con guration, see the Advanced Options section.

Stopping a con guration from the Run and Debug view doesn't stop any running tasks.

Edit a Run Con guration


1. Right-click a relevant run con guration to do the following:

Con gure Environment - Open the environment le to view the binding con guration.

Rename - Provide a new name for the selected run con guration.

Show in File - Open the JSON le containing the set of con guration properties, with the name highlighted.

Delete - Delete the set of con guration properties from the JSON le.

Delete a Run Con guration


1. Right-click a run relevant con guration and choose Delete.

 Note
If you delete the launch con guration, it's removed from the launch.json le but the tasks remain.

Advanced Options
In addition to the launch.json le that is created as part of the new con guration, the following les are added or updated
when creating a run con guration:

Environment con guration le

A new environment le is created. After the resource is bound to a service, the le is populated with all the environment
variables required to connect to Cloud Foundry.

The environment con guration le is referenced from your Launch con guration.

This is custom documentation. For more information, please visit the SAP Help Portal 131
2/6/2024

New tasks in the tasks.json le

The following tasks are added to the tasks.json le:

A technical generic task. This is the con guration's prelaunch task.

This task enables you to de ne additional tasks to run before starting the con guration (using the dependsOn
property).

A task that triggers the Apache Tomcat server running with the context of the application resources.

A build task that triggers the mvn clean install command.

Tomcat runtime con guration directory

When you create a new con guration, a new Tomcat runtime con guration directory is created containing the following
con guration les:

ROOT.xml (user/.tomcat/<configuration_name>/Catalina/localhost)

For example, /home/user/.tomcat/bookshop-srv-1/conf/Catalina/localhost

server.xml (user/.tomcat/<configuration_name>/conf)

For example, /home/user/.tomcat/bookshop-srv-1/conf

 Note
By default, Tomcat runs on port 8080. If you want to run multiple con gurations at the same time, you need to
con gure a different port for the additional Tomcat in the server.xml le. In addition, you need to change the
default ports 8009 and 8005 de ned in this le to other ports to avoid collision.

You also need to de ne a debug port (that isn't the default 8000), both in the 'run-tomcat' task in the
tasks.json le, and in the matching launch con guration in the launch.json le, which are all associated with
This is custom documentation. For more information, please visit the SAP Help Portal 132
2/6/2024
the same run con guration.

You can modify the content of this directory to con gure Tomcat as desired for this run con guration. For example, you
can add libraries to be used at runtime or change ports. For more information, see Apache Tomcat .

Binding Process
Not all of the services that you want to bind to are publicly exposed. Therefore, we must use a secure tunnel to access them
from Cloud Foundry.

When binding to one of these services, we use chisel to open a secure channel to your Cloud Foundry space.

A new task is created within the binding step to run chisel. Run this task before running the con guration.

The environment con guration le is updated with the chisel and the selected service parameters.

The Tomcat con guration les are updated according to the chosen service.

Running Applications in Incognito Mode


Running an application in Incognito mode allows you to test it with different users.

To run an application in Incognito mode:

1. Run the application from SAP Business Application Studio. The application opens in a new window.

2. Copy the URL from the opened application window. For example, https://port4004-workspaces-ws-
ln78g.region10.int.applicationstudio.cloud.sap/

3. Open a new window in Incognito mode.

4. Manually enter a URL using the following format: <SAP Business Application Studio URL with no path>/login?e=
<application URL from step 2>.

For example, https://bas-extensions.region10cf.int.applicationstudio.cloud.sap/login?


e=https://port4004-workspaces-ws-ln78g.region10.int.applicationstudio.cloud.sap/

5. Login using your SAP Business Application Studio user credentials.

6. If the application requires authentication, provide the application user you want to use for testing.

Application Preview Settings


Each application runs on a speci c port. If you want to open a new browser tab with your running application, use the Ports:
Preview command.

Previewing Ports
1. Enter the Ports: Preview command in the command palette.

A list of all the exposed applications is displayed.

2. Click the relevant application.

The exposed application opens in a new tab.


This is custom documentation. For more information, please visit the SAP Help Portal 133
2/6/2024

Con guring Port Noti cation Settings


You can de ne which ports should omit a noti cation when an application is being run.

1. In SAP Business Application Studio, click to open the Settings view.

2. Search for Ports.

3. From the list of preferences, select Ports.

4. Under Exclude Expose Noti cations click Edit in settings.json.

5. Specify the port or range of ports for which you do not want to show a noti cation.

6. Save your changes.

Cloud Foundry Tools


Connect and perform actions on the Cloud Foundry environment.

You can access the Cloud Foundry tools by opening the command palette and entering CF. You can also create a list of pre-
de ned targets using the CLOUD FOUNDRY: TARGETS view.

Login to Cloud Foundry


You must be logged in to Cloud Foundry to use the Cloud Foundry Tools.

1. In the command palette, select CF: Login to Cloud Foundry. The Cloud Foundry Sign In and Targets page opens.

2. Select the type of authentication method you prefer.

See Connecting to Cloud Foundry Using Identity Providers.

3. Depending on the method you selected, enter your username and Cloud Foundry password or your temporary SSO
authentication code.

4. Select the organization to which you want to connect.

5. Select the desired space within the organization.

Click on the status bar to change the target.

Select Cloud Foundry Target


1. Select the organization to which you want to connect.

2. Select the desired space within the organization.

3. Click Apply.

Set Org and Space


You can change the organization and space you de ned when logging into Cloud Foundry.

1. In the command palette, select CF: Select a space from your allowed spaces. The Cloud Foundry Sign In
and Targets page opens.

This is custom documentation. For more information, please visit the SAP Help Portal 134
2/6/2024
2. Select the organization to which you want to connect.

3. Select the desired space within the organization.

Create a New Service Instance


Create service instance in your current Cloud Foundry org and space. You can later consume this service for your development
needs.

1. In the command palette, select CF: Create a service instance.

2. Provide a service instance name. The name must be unique, if you enter an already existing name, the creation fails.

3. Select a Cloud Foundry service.

4. Select the service plan that best ts your service instance.

5. Optional: Provide additional parameters for the service instance. You can also press Enter to enter an empty
parameter.

 Note
You can create a service instance in the CLOUD FOUNDRY: TARGETS view. The CLOUD FOUNDRY: TARGETS view opens.

1. Click from the activity bar.

2. Click (Create a service instance) next to the Services folder under the active target.

Create a User-Provided Service Instance


With a user-provided service instance, you can use services that are not available in the marketplace.

1. From the activity bar, click . The CLOUD FOUNDRY: TARGETS view opens.

2. Click next to the Services node under the active target.

3. In the command center, provide a service instance name. The name must be unique, if you enter an already existing
name, the creation fails.

4. Select a Cloud Foundry service.

5. Select the service plan that best ts your service instance.

6. Optional: Provide additional parameters for the service instance. You can also press Enter to enter an empty
parameter.

Bind a Service to a Locally Run Application


1. In the command palette, select CF: Bind a service to a locally run application.

This is custom documentation. For more information, please visit the SAP Help Portal 135
2/6/2024
2. Select the folder where the .env le will be created. This le contains the information for connecting to the Cloud
Foundry service.

3. Click OK.

4. Select the service instance to which you want to bind.

 Note
You can also bind a service to an application using the CLOUD FOUNDRY: TARGETS view by right-clicking on the desired
service and clicking Bind a service to a locally run application.

Create a New Cloud Foundry Target


You can create a list of frequently used Cloud Foundry targets. You can then move from one target to the next with only one
click.

1. From the activity bar, click . The CLOUD FOUNDRY: TARGETS view opens.

2. Click (Create a Cloud Foundry target)

3. Click Create New in the command center. The target is based on the current org and space to which you are connected.

4. Provide a name for the target.

You can change the current target in three different ways:

Log in to Cloud Foundry using a different endpoint.

Select a different organization and space within the current endpoint.

Select a different space within the current organization.

Once you have set up your targets, you can de ne which one will be the active target by clicking (Set Cloud Foundry Target)
by the desired target name.

Reload the Targets Tree


If the target tree is not showing updated information, you can manually trigger a reload to refresh the view.

1. In the command palette, select CF: Reload Targets Tree.

Connecting to Cloud Foundry Using Identity Providers


Connect to Cloud Foundry using the UI or the command line.

The manner in which you can connect to Cloud Foundry depends on the identity provider (IdP) you use.

This is custom documentation. For more information, please visit the SAP Help Portal 136
2/6/2024

Comparison Between the Different Identity Providers for Cloud Foundry Login in
SAP Business Application Studio

SAP ID Service Custom IdP Corporate IdP

SAP Business Application Supported Not supported Not supported


Studio UI-based login with
username and password

SAP Business Application Supported Supported Supported


Studio UI-based SSO login

SAP Business Application Supported Supported Supported


Studio CLI-based login

CLI-based login example Reference Reference Reference

cf login cf login --origin cf login --sso


<origin>

Authorization ow OAuth Resource Owner OAuth Resource Owner OAuth Authorization Code Grant
Password Password (browser ow) + One-Time
Passcode

For more information, see this blog .

Debugging
SAP Business Application Studio has built-in debugging support for the Node.js runtime and can debug JavaScript, TypeScript,
or any other language that gets transpiled to JavaScript.

Debugging a File
To debug a node.js le:

1. Open the Run and Debug view.

This is custom documentation. For more information, please visit the SAP Help Portal 137
2/6/2024

2. Open the dropdown list to select the relevant con guration.

A list of con guration options is displayed.

3. Select Node.js. A launch con guration le (launch.json) is created automatically. You can con gure and save
debugging setup details in this le.

This le contains 3 con gurations:

Launch Program

Create JavaScript Debug Terminal

Run Current File

4. To add a new con guration to an existing launch.json, from the dropdown list, select Add Con guration.

5. From the dropdown list, select Run Current File or Launch Program (which provides you the option to skip node internal
les).

You can run your con guration through the command palette, by ltering on Debug: Start Debugging.

 Note
Note that the attributes available in launch con gurations vary from debugger to debugger.

Debugging Modes
There are two core debugging modes, Launch and Attach.

This is custom documentation. For more information, please visit the SAP Help Portal 138
2/6/2024
The debugger can launch a program in debug mode, or it can attach to an already running program in debug mode.

You can trigger these modes from the command palette: Debug: Attach to Node Process

Breakpoints
Breakpoints can be toggled by clicking on the editor margin or using F9 on the current line.

You can also use the BREAKPOINTS section.

Click to add a function breakpoint.

Click to deactivate a breakpoint.

Click to remove all breakpoints.

Build and Deploy


Use our dedicated tools to build and deploy your application.

Use the SAP Business Application Studio development tools for working with multitarget applications. See MTA Development.

You can also nd documentation for scenario-speci c deployment options.

If you want to deploy an SAP Fiori application, see Deploy an Application.

If you want to deploy an SAP HANA application, see Maintaining the Multitarget Application Development & Deployment
Descriptors.

Task Explorer
You can create, modify, and run tasks for speci c SAP scenarios.

 Note
This feature is only available when the dev space extensions provide scenario-speci c tasks.

The Task Explorer allows you to create and edit scenario-speci c tasks using a dedicated user interface. You can store your
con gurations and reuse them.

1. From the left sidebar, click to open the Task Explorer view.

2. Click +.

This is custom documentation. For more information, please visit the SAP Help Portal 139
2/6/2024

The Create Task page is displayed showing only tasks that are relevant to the projects in your workspace.

Tasks are grouped according to the user intent.

3. Click Con gure. The task is created in the tasks.json le and is visible in the Task Explorer view.

4. Right-click on a task to edit its properties or to delete it if necessary.

5. Save your changes.

6. Run the task by clicking the Run icon next to the task in the Task Explorer

or by clicking the button at the top corner of the Edit Task view.

Related Information
Building and Deploying Multitarget Applications

MTA Development
Learn how to use the SAP Business Application Studio development tools for working with multitarget applications.

MTA Tools
The MTA Tools allow you to perform operations such as build, deploy, and validation on multitarget applications.

The MTA Tools are provided as an extension to SAP Business Application Studio and contains the following:

Cloud Foundry CLI


The Cloud Foundry Command Line Interface provides commands to deploy and manage CF services and applications.

For more information, see Using the Cloud Foundry Command Line Interface .

Cloud MTA Build Tool

This is custom documentation. For more information, please visit the SAP Help Portal 140
2/6/2024
The Cloud MTA Build Tool is a standalone command-line tool that builds a deployment-ready multitarget application (MTA)
archive .mtar le from the artifacts of an MTA project according to the project’s MTA development descriptor (mta.yaml le),
or from the module build artifacts according to the MTA deployment descriptor (mtad.yaml le).

For more information, see the Cloud MTA Build Tool user guide.

Cloud Foundry CLI MTA Plugin


A CLI plugin for Multitarget Application (MTA) operations in Cloud Foundry.

For more information, see the documentation .

Cloud Foundry Targets Plugin


This plugin facilitates the use of multiple API targets with the Cloud Foundry CLI.

For more information, see the documentation .

Cloud Foundry CLI Copy Env Plugin


A Cloud Foundry CLI plugin to export application VCAP_SERVICES and VCAP_APPLICATION onto the local machine.

For more information, see the documentation .

generator-basic-multitarget-application
The generator-basic-multitarget-application is a Yeoman generator for creating a basic (empty) multitarget
application.

cf-cli-service-info-plugin
The cf-cli-service-info-plugin is a Cloud Foundry plugin which enables the following:

Provides service key details.

Provides service credentials.

Calculates a VCAP_SERVICES json, compatible with how Cloud Foundry binds services to apps and persists to le.

Chisel
Chisel is a fast TCP tunnel, transported over HTTP, secured via SSH.

For more information, see the documentation .

MTA Editor
The visual MTA editor allows you to edit the MTA descriptor (the mta.yaml le located in the root project folder) using tables
and forms instead of the text-based code editor.

The multitarget application (MTA) descriptor contains the metadata of all entities comprising an application or used by it during
deployment or runtime, and the dependencies between them.

This is custom documentation. For more information, please visit the SAP Help Portal 141
2/6/2024
The MTA descriptor is automatically generated when an application project is created from scratch, and it is updated when the
project properties change or when a module is added or removed. However, not all the necessary information can be generated
automatically. You need to maintain the descriptor manually to de ne resources, properties, and dependencies, as well as ll in
missing information.

The MTA descriptor is written in the YAML format, which has strict syntax requirements. You can edit the descriptor in the text-
based code editor, but we recommend you use the visual MTA editor. The visual MTA editor allows you to easily navigate
between the objects in the mta.yaml le and helps you avoid dealing with the complex and sensitive syntax of YAML les.

To open the visual MTA Editor:

1. Right-click the desired mta.yaml le.

2. Choose Open With MTA Editor .

 Note
The visual MTA editor removes comments and formats the le. If you want to add comments, use the code editor. To open
the code editor, double-click on the desired mta.yaml le or right-click the le and choose Open With Code Editor .

If you edit the le with the code editor, it is important to use spaces rather than tabs for indentation.

Related Information
The Multi-Target Application Model
SAP Business Application Studio Multitarget Application (MTA) development toolkit

Building and Deploying Multitarget Applications


Build and deploy multitarget applications to SAP Cloud Foundry.

Building Multitarget Applications


Prerequisites

Your dev space must contain a multitarget application.

There are several ways for building multitarget applications in SAP Business Application Studio:

From the context menu.

1. Right-click on the mta.yaml le.

2. Choose Build MTA Project.

From the command palette.

1. Enter MTA.

2. Choose Build MTA Project.

3. Select the desired mta.yaml le.

 Note
If there’s only one mta.yaml available, the build starts automatically.

This is custom documentation. For more information, please visit the SAP Help Portal 142
2/6/2024

From the Task Explorer.

1. From the activity bar, click to open the Task Explorer view.

2. Click + (Create Task).

3. Click Build.

4. Select the MTA project descriptor of the project you want to build.

5. Click Con gure to edit the build con guration parameters.

6. Save your changes.

Use the Task Explorer to change the default MTA Build options, for example, to change the default location of the MTA
archive or to provide an MTA extension for the build. In the Task Explorer, you can save this build con guration for later
use.

From the CLI. See Cloud MTA Build Tool .

The terminal opens showing the output of the build. Once the build is complete, a folder named mta_archives is added to the
project that contains the relevant MTA archive (MTAR le).

 Note
If you changed the default con gurations using the Task Explorer, the output will correspond to the speci ed build
parameters.

Deploying Multitarget Applications


Prerequisites

You must be logged on to a Cloud Foundry organization and space. See Cloud Foundry Tools.

You must have permissions to deploy to your Cloud Foundry space.

Your dev space must contain a multitarget application.

Your project must contain an MTA archive (MTAR) le.

There are several ways for deploying multitarget applications to SAP Cloud Foundry:

From the context menu.

1. Right-click on the relevant MTAR le.

2. Choose Deploy MTA Archive.

3. If relevant, select the MTA extension that you want to deploy from the command palette.

From the command palette.

1. Enter MTA.

2. Choose Deploy MTA Archive.

3. Select the desired MTAR le.

 Note
If there’s only one MTAR le available, the deployment starts automatically.
This is custom documentation. For more information, please visit the SAP Help Portal 143
2/6/2024

From the Task Explorer.

1. From the activity bar, click to open the Task Explorer view.

2. Click + (Create Task).

3. Click Deploy.

4. Select the MTA archive of the project you want to build.

5. Click Con gure to edit deployment con guration parameters.

6. Save your changes.

Use the Task Explorer to change the default MTA deploy options. In the Task Explorer, you can save this con guration for
later use.

From the CLI. See Deploy Commands .

The terminal opens showing the output of the deploy process.

Continuous Integration and Delivery


SAP Continuous Integration and Delivery lets you con gure and run prede ned continuous integration and delivery (CI/CD)
pipelines that automatically build, test, and deploy your code changes to speed up your development and delivery cycles.

Prerequisites
Perform the following con guration steps to use SAP Continuous Integration and Delivery in SAP Business Application Studio:

1. You must subscribe to the Continuous Integration & Delivery service, assign the required roles and permissions, add the
relevant service plan, and add the relevant instance.

See Initial Setup in the SAP Continuous Integration and Delivery documentation or run the Get Started with SAP
Business Application Studio booster to automate these steps. See Initial Setup in the Developing Business Applications
Using Productivity Tools documentation.

2. In the SAP BTP cockpit, make sure to check that you have the following:

A subscription to SAP Business Application Studio and Continuous Integration & Delivery.

An instance for SAP Continuous Integration and Delivery.

If you ran the booster, the instance name is default_cicd-service. If you completed the manual steps, the instance
name is the name that you chose.

See Enabling the API Usage.

3. Open a dev space in SAP Business Application Studio.

4. Open a project in the terminal.

5. Enter the following command to get the space GUID:

cf space dev --guid

6. Open the Continuous Integration & Delivery service from the SAP BTP cockpit.

This is custom documentation. For more information, please visit the SAP Help Portal 144
2/6/2024

7. In SAP Continuous Integration and Delivery, click (Settings).

8. Click (Add space to allow list), enter the space GUID that you obtained in Step 5, and click OK.

9. Click Save.

10. In the SAP BTP cockpit, navigate to Connectivity Destinations .

11. Click New Destination.

12. Click the Service Instance tab and create a destination with the following con gurations:

Property Value

Service Instance <the instance created earlier>

Name cicd-backend

Additional Property HTML5.DynamicDestination true

13. Click Next.

14. Leave the default values, but change Authentication to OAuth2UserTokenExchange and click Save.

15. Create a new dev space or restart your existing dev space to use the SAP Continuous Integration and Delivery service.

Procedure
The CI/CD view in SAP Business Application Studio, allows you to see all jobs con gured for the current project, as long as the
project is connected to a Git repository.

You can create a job for your project using a CI/CD pipeline.

1. From the menu, navigate to View Command Palette .

2. Search for Guide Center: Create a CI/CD Job. Select the guide and follow the instructions.

Each job is con gured using a config.yaml le in the project Git repository.

The CI/CD view shows the latest build triggered by the user. To see all builds, open the SAP Continuous Integration and Delivery
service. See SAP Continuous Integration and Delivery to learn about this service. You can see the build details for each job, such
as the creation date and status.

Once a new build is triggered, the view is updated with the latest build.

From the job’s context menu, you can:

See the build steps and logs.

Click View Build Log to open.

Manually trigger a build.

Click Trigger a Build. The best practice is to use Git webhooks to automatically trigger a build with each build action.
Nevertheless, you can manually trigger a build without pushing changes to Git.

Open the code editor.

Click Edit to open the config.yaml le in the code editor.

This is custom documentation. For more information, please visit the SAP Help Portal 145
2/6/2024
Delete the job.

Click Delete to remove the job from the SAP Continuous Integration and Delivery service and the con guration le is
deleted from the repository. This affects all users working in the repository.

From the CI/CD JOBS view menu bar, you can click (Settings) to open the Settings page, or + to add a new job.

Develop an App Using Different Subaccounts


You can develop your application with different subaccounts. You use one subaccount to create and run your application in SAP
Business Application Studio. You use the other subaccount, in a different region, to deploy your application to Cloud Foundry.

This scenario is useful in the following situations:

You're using a single development subaccount to develop many target accounts.

Your development account isn't in the same region as your target account.

Develop an app with two subaccounts as follows:

1. From your global account in the SAP BTP cockpit, create two subaccounts in two different regions. See Create a
Subaccount [Feature Set B].

One subaccount is for the design time environment and the other is for the runtime environment.

2. Complete the following steps in the design time subaccount:

a. Add the relevant SAP Business Application Studio service plan. See Con gure Entitlements and Quotas from Your
Subaccount.

b. Subscribe to SAP Business Application Studio.

3. Navigate to the Overview page of your runtime subaccount and click Enable Cloud Foundry. This enables you to deploy
the application to Cloud Foundry. See Create Orgs.

4. If you're using an external data source (outside SAP BTP) for your application, create the same destination, with the
same name, in both subaccounts. See Create HTTP Destinations and Add a System.

5. Log in to Cloud Foundry. Make sure to update the Cloud Foundry endpoint with the region of the runtime subaccount (for
example, change https://api.cf.us10.hana.ondemand.com to
https://api.cf.eu10.hana.ondemand.com).

6. Create a Project in the design time subaccount. Make sure to connect to the relevant destination during data source and
service selection.

7. Test your application by creating a run con guration. Make sure to bind the relevant destination.

8. Build and deploy your application.

Your application uses the runtime subaccount to deploy to Cloud Foundry.

Access SAP Business Application Studio from VS Code


Connect securely to SAP Business Application Studio dev spaces directly from a local Visual Studio Code desktop application.

Prerequisites

This is custom documentation. For more information, please visit the SAP Help Portal 146
2/6/2024
To ensure the best functionality, make sure you are always working (locally) on the latest officially released version of VS Code
and that you regularly update the SAP Business Application Studio toolkit extension to the latest version.

The remote connection to SAP Business Application Studio allows you to:

Work in your SAP Business Application Studio tailored dev spaces directly from your local VS Code installation, including
the tools and con gurations that are not available on your local OS.

Connect to your different centrally managed SAP environments (for example, API Business Hub Enterprise, subaccount
destinations, etc.) via theSAP Business Application Studio Service Center.

Develop directly on SAP BTP.

Separate your development environment to avoid impacting your local machine con guration.

Access an existing dev space from multiple machines or locations.

Access multiple dev spaces from one VS Code desktop installation.

Debug an application running somewhere else, such as a customer site or in the cloud.

Use the extensions available in the VS Code marketplace.

 Caution
If you install third-party extensions while using a remote connection to SAP Business Application Studio, the third
party may be able to access your data from the dev space.

Allows easy access through a hosted secure environment, available anywhere, anytime.

Getting Started
1. Install the Remote Access for SAP Business Application Studio extension from the Visual Studio marketplace .

2. Click in the VS Code activity bar to open the SAP Business Application Studio view.

Adding Landscapes
1. In the SAP Business Application Studio view, click Connect Landscape to add the landscape you want to access.

2. In the command palette, enter your landscape URL.

This is custom documentation. For more information, please visit the SAP Help Portal 147
2/6/2024
To add another landscape:

1. Click in the view's title bar.

2. In the command palette, enter the additional landscape URL.

All the landscapes you connect to and their respective dev spaces are displayed in the SAP Business Application Studio view.

Connecting to the Landscapes


1. Select the landscape to which you want to log in.

2. Click .

3. When prompted, allow the extension to log in using SAP Business Application Studio.

4. Click Open to allow access to the SAP Business Application Studio landscape in VS Code.

5. If you are not already logged in, provide your SAP credentials when prompted.

6. Click Open VS Code to start working on your SAP Business Application Studio dev spaces in VS Code.

Disconnecting from the Landscapes

1. From the action bar, click .

2. Select BAS Access Token (Business Application Studio).

3. Click Sign Out.

Managing Dev Spaces


The SAP Business Application Studio view contains all the landscapes you added. You can access all the dev spaces in the
landscapes to which you are connected.

Start a dev space by hovering over the dev space name and clicking Play.

A dot appears on the dev space's icon once the status changes to STARTED.

Stop a dev space by hovering over the dev space name and clicking Stop.

Open a dev space by hovering over the dev space name and clicking .

This is custom documentation. For more information, please visit the SAP Help Portal 148
2/6/2024

 Note
You can only have 2 dev spaces running at a time.

The dev space opens in a new tab.

Working with a Trial Account


Get a trial account to experience SAP Business Application Studio for free.

Trial accounts are intended for personal exploration, and not for production use or team development. They allow restricted use
of the services. To learn more about the difference between enterprise and trial accounts, see Enterprise versus Trial Accounts.

 Note
SAP Business Application Studio is available on Trial in the Singapore, Frankfurt, and US East (VA) regions.

If you do not have a subaccount in these regions, you need to create a new subaccount with the following settings:

Provider Supported Regions

Amazon Web Services (AWS) Europe (Frankfurt) or US East (VA)

 Note
There is no support for new trial accounts in the Europe
(Frankfurt) region. Trial accounts created before October 2021 will
still be supported.

This is custom documentation. For more information, please visit the SAP Help Portal 149
2/6/2024

Provider Supported Regions

Microsoft Azure Singapore

Getting Started with a Trial Account


Set up your trial system to develop applications using SAP Business Application Studio.
Trial Account Restrictions
There are additional restrictions that apply to SAP Business Application Studio trial accounts.
Creating a New Subaccount
Your trial account comes with a default subaccount that contains all the relevant roles and authorizations. You can
create additional subaccounts, if needed.

Getting Started with a Trial Account


Set up your trial system to develop applications using SAP Business Application Studio.

1. Sign up for an SAP BTP trial account. See Get a Free Trial Account.

 Note
An SAP BTP trial account is free of charge. However, every trial user gets one trial account only.

Your trial account contains a subaccount called trial that is automatically created and already subscribed to SAP
Business Application Studio.

Any other subaccount that you create requires a manual subscription. See Creating a New Subaccount.

2. Open the SAP BTP trial cockpit.

3. From the Quick Tool Access section, click SAP Business Application Studio.

SAP Business Application Studio opens.

4. Click Create Dev Space to begin working.

Trial Account Restrictions

This is custom documentation. For more information, please visit the SAP Help Portal 150
2/6/2024
There are additional restrictions that apply to SAP Business Application Studio trial accounts.

In addition to the regular SAP Business Application Studio restrictions, when using a trial account the following restrictions also
apply:

A user can only have up to 2 dev spaces.

A user can only have 1 dev space in the RUNNING state at a time.

The session times out after one hour of inactivity.

The maximum size limit of a dev space is 4 GB.

Dev spaces that have not been in the RUNNING state for 30 consecutive days will be deleted.

Creating a New Subaccount


Your trial account comes with a default subaccount that contains all the relevant roles and authorizations. You can create
additional subaccounts, if needed.

1. From the SAP BTP cockpit, click Enter your Trial Account.

2. Click New Subaccount.

3. Fill in the required elds and click Create.

4. Open your new subaccount.

5. From the navigation area, click Entitlements.

This is custom documentation. For more information, please visit the SAP Help Portal 151
2/6/2024

6. Click Con gure Entitlements.

7. Click Add Service Plans.

8. Search for Studio.

9. Select SAP Business Application Studio and, under Available Plans, select trial (Application).

10. Click Add 1 Service Plan.

11. Click Save.

This is custom documentation. For more information, please visit the SAP Help Portal 152
2/6/2024

12. From the navigation area, click Service Marketplace.

13. Search for Studio.

14. Select SAP Business Application Studio and click Create.

15. From the New Instance or Subscription dialog box, leave the default selections and click Create.

16. Click View Subscription to see the details of your new subaccount.

17. Click Go to Application.

Restrictions
When using SAP Business Application Studio, there are user restrictions on computing resources and project components to
ensure optimal performance.

SAP Business Application Studio computing resources (CPU, memory, storage) are limited and optimized for serving standard
SAP application development use-cases.

To ensure an optimal performance and developer experience, the following restrictions must be maintained:

A user can create up to 10 dev spaces.

A user can only have up to two running dev spaces.

A user can have disk space of up to 10 GB per dev space.

A user can only have up to 50 projects stored on their dev space.

A user can only have up to 20 projects or MTA modules open in their workspace.

A user can only have up to 1000 Java classes (comprising up to 27,000 code lines) on a single project compilation.

A user can only have up to 1000 SAP HANA database artifacts on a single project compilation.

If your resource usage is close to any of these restrictions, the system performance may be impacted.

If the restrictions are surpassed, performance can't be assured by the SAP Business Application Studio product license.

 Note
We recommend you connect to the data center that is closer to your physical location to ensure best performance. See SAP
Business Application Studio Availability

Troubleshooting
Explore the Guided Answers for troubleshooting issues in SAP Business Application Studio.

This is custom documentation. For more information, please visit the SAP Help Portal 153
2/6/2024
You can nd solutions for common troubleshooting issues in SAP Business Application Studio in our Guided Answers .

You can also access the Guided Answers directly from SAP Business Application Studio by searching for Guided Answers in
the command palette.

Contact SAP Support


We suggest you report an incident or error through the SAP Support Portal.

1. Create a new incident. See Getting Support.

Select the relevant component from the list:

Component Description

CA-BAS SAP Business Application Studio issues.

CA-BAS-BLD-HTML5 HTML5 module build - SAP Business Application Studio

CA-BAS-BLD-MTA Build MTA applications - SAP Business Application Studio

CA-BAS-DPL-ABAP Deploy to ABAP - SAP Business Application Studio

CA-BAS-DPL-MTA Deploy MTA applications - SAP Business Application Studio

CA-BAS-RUN- Run HTML5 Module - SAP Business Application Studio


HTML5

CA-BAS-RUN-CFG Run Con gurations view - SAP Business Application Studio

CA-BAS-RUN-CAP Run CAP application - SAP Business Application Studio

CA-BAS-TPL-FIORI SAP Fiori project template - SAP Business Application Studio

CA-BAS-TPL-MTA MTA templates - SAP Business Application Studio

CA-BAS-WS-MNG Dev space Manager - SAP Business Application Studio

CA-BAS-WS-CTRL Dev Space Controller - SAP Business Application Studio

CA-BAS-EDT-HTML5 Fiori development (code assist, validations, i18n) - SAP Business Application Studio

CA-BAS-EDT-W5G Layout Editor (WYSIWYG) - SAP Business Application Studio

CA-BAS-EDT-JAVA JAVA tools - SAP Business Application Studio

CA-BAS-EDT-MTA MTA descriptor (mta.yaml) editor

CA-BAS-CNSM Consume SAP Services - SAP Business Application Studio

CA-BAS-BSC Basic Tools (npm, GIT) - SAP Business Application Studio

CA-BAS-CF Cloud Foundry Tools command palette - SAP Business Application Studio

CA-BAS-WIZ Yeoman-UI generator - SAP Business Application Studio

CA-BAS-FLO File system, logging, Operator Clusters - SAP Business Application Studio

CA-BAS-MON Monitoring - SAP Business Application Studio

CA-BAS-AUT Login, roles, authentication, authorizations - SAP Business Application Studio

CA-BAS-WEX Extension management - SAP Business Application Studio

This is custom documentation. For more information, please visit the SAP Help Portal 154
2/6/2024

Component Description

CA-BAS-HAN-DPL HANA Explorer for SAP Business Application Studio

 Note
Contact the Customer Interaction Center (CIC) in order to ask for a speed-up to your request. You will nd additional
information in SAP Note 560499 .

We invite you to participate in the SAP Product Support Accreditation Program. This program will show you how you can
work best with Product Support to get faster, easier closure to your incidents. For additional information see the SAP KBA
2911278 .

Administrator Guide
This guide describes the administrator tasks of subscription, management of authorizations and roles, connecting to external
systems and selecting the application plans, amongst others.

Set Up SAP Business Application Studio


Here's a checklist for setting up your system so you can develop applications using SAP Business Application Studio.
Subscribe to SAP Business Application Studio
Before you can work in SAP Business Application Studio, the account administrator must subscribe the subaccount to
the SAP Business Application Studio application.
Application Plans
SAP Business Application Studio provides two types of application plans in SAP BTP enterprise accounts: free and
standard-edition.
Manage Authorizations and Roles
The subaccount administrator can assign the user a role for developing with SAP Business Application Studio or for
managing data.
Connecting to External Systems
To connect any on-premise system from SAP Business Application Studio, you must create a destination. Additionally,
some business cases will also require a destination to perform OData service exploration and to select an OData service
for creating and viewing applications.
Connect to Your Git Source Control System
SAP Business Application Studio allows you to connect to public and corporate repositories.
Export and Download Personal Data from Speci c Users
You can export and download personal data from speci c users from your workspace.
Restart a Dev Space
You can change the state of a dev space to Running.
Delete Personal Data
You can delete personal data stored in your workspace.
SAP Business Application Studio Availability
You can nd the regions where SAP Business Application Studio is available and the relevant IP addresses.

Set Up SAP Business Application Studio


Here's a checklist for setting up your system so you can develop applications using SAP Business Application Studio.

 Note
This is custom documentation. For more information, please visit the SAP Help Portal 155
2/6/2024
If you are working in a trial account, follow the procedure in Getting Started with a Trial Account.

Prerequisites
You have an SAP BTP global account. See Getting a Global Account.

Procedure

Step Description Additional Information

1. Create a subaccount in your Create a subaccount in the SAP BTP, Cloud Foundry Create a Subaccount
global account. environment.

Select a region according to the


guidelines in the SAP Business
Application Studio Availability topic.

2. Con gure the SAP Business Assign the SAP Business Application Studio application to Con gure Entitlements and
Application Studio entitlement in your subaccount by adding its relevant service plan. Quotas for Subaccounts
your global account.
Application Plans
Relevant for Feature Set B accounts
only.

To check if your global account


belongs to Feature Set A or Feature
Set B, see Cloud Management Tools
— Feature Set Overview.

3. Subscribe to SAP Business You need to subscribe to the SAP Business Application Subscribe to SAP Business
Application Studio. Studio application from your subaccount. Application Studio

4. Grant user permissions. Assign the Manage Authorizations and Roles


Business_Application_Studio_Developer role to
developers so that they can work with SAP Business
Application Studio.

5. OPTIONAL: Enable identity If you de ne a custom identity provider for your Federation Attribute Settings of Any
provider (IdP)-based subaccount, be sure to con gure the assertion-based Identity Provider
authentication for SAP Business attributes mapping for this IdP.
Application Studio applications
(optional).

6. OPTIONAL: Connect to your Git SAP Business Application Studio allows you to connect to Connect to Your Git Source Control
source control system. public and corporate Git repositories. System

7. OPTIONAL: Create spaces. You can create and delete spaces in a Cloud Foundry Create Spaces
organization using the SAP BTP cockpit or the console
Relevant for developers who want to client (Cloud Foundry command-line interface).
work in Cloud Foundry runtime.
We recommend at least 1 space for a development team
working on the same project (that is, 1 space per project).

For staging/test and production organizations, 1 space is


sufficient.

This is custom documentation. For more information, please visit the SAP Help Portal 156
2/6/2024

Step Description Additional Information

8. OPTIONAL: Assign members to Enable your developers to work with your SAP BTP, Cloud Managing Members
your Cloud Foundry organizations Foundry environments.
and spaces.
Your developers need to be assigned to the space
Relevant for developers developing developer role to be able to use the space from SAP
Cloud Foundry applications. Business Application Studio.

Subscribe to SAP Business Application Studio


Before you can work in SAP Business Application Studio, the account administrator must subscribe the subaccount to the SAP
Business Application Studio application.

Prerequisites
If your global account uses the subscription-based commercial model, then you must have bought a SaaS license for SAP
Business Application Studio. See Pricing and Packaging . You can also contact us on SAP BTP or via an SAP sales
representative.

You've created a subaccount in Cloud Foundry. See Create a Subaccount.

You're an administrator of the subaccount.

Procedure
1. Open your global account in the cockpit.

2. Go to your subaccount.

3. In the navigation area, choose Services Service Marketplace .

You can see a list of the applications to which your global account is entitled in the Cloud Foundry environment.

 Note
The Instances and Subscriptions page displays all subscriptions and instances in your subaccount.

4. Search for Studio. The SAP Business Application Studio tile appears.

 Note
If you don't see the SAP Business Application Studio tile in the results, make sure that there's an entitlement for SAP
Business Application Studio in your subaccount. See Con gure Entitlements and Quotas for Subaccounts.

5. Click the application name to open its Overview page.

6. Click Create.

7. From the New Instance or Subscription dialog box, select the relevant application plan. For information on the difference
between the plans, see Application Plans.

8. Click Create.

9. From the Creation in Progress dialog box, click View Subscription.

10. Grant user permissions to work with SAP Business Application Studio. See Manage Authorizations and Roles.

This is custom documentation. For more information, please visit the SAP Help Portal 157
2/6/2024
11. From the SAP Business Application Studio Overview page in the cockpit, click Go to Application.

 Note
To remove a subscribed application, go to the Instances and Subscriptions page, click the ellipsis at the end of the
subscription row, and then click Delete. This action deletes all data related to the application in the respective subaccount.

Application Plans
SAP Business Application Studio provides two types of application plans in SAP BTP enterprise accounts: free and standard-
edition.

You select the plan when subscribing to the application. See Subscribe to SAP Business Application Studio.

The type of plan you choose determines pricing, conditions of use, and resources. Learn about the plan details in the SAP
Discovery Center .

Both plans provide preinstalled runtimes and tools tailored for developing key scenarios such as: SAP S/4HANA extensions, full
stack business applications, SAP Fiori applications, and more. However, the free plan contains some restrictions. See Free Plan
Restrictions.

Each subaccount has only 1 subscription. If you selected the free plan and want to upgrade to the paid standard-edition plan, you
can do so as described in Upgrading to the Standard-Edition Plan.

You can use different plans in separate subaccounts.

Free Plan Restrictions

 Note
Only community support is available for free service plans and these are not subject to SLAs. Use of free tier service plans
are subject to additional terms and conditions as provided in the SAP Business Technology Platform Supplement .

A user can only have up to 2 dev spaces.

A user can only have 1 dev space in the RUNNING state at a time.

When working in the Full-Stack Application Using Productivity Tools dev space, a user can deploy a maximum of 2 times.

The maximum size limit of a dev space is 4 GB.

Upgrading to the Standard-Edition Plan


To upgrade the application subscription from the free plan to the standard-edition plan:

This is custom documentation. For more information, please visit the SAP Help Portal 158
2/6/2024
1. Open your global account in the cockpit.

2. Go to your subaccount.

3. In the navigation area, choose Instances and Subscriptions.

A list of the applications to which your subaccount is subscribed in the Cloud Foundry environment is displayed.

4. Search for SAP Business Application Studio.

5. Select the ellipsis at the end of the subscription row, and from the menu, click Update.

6. In the wizard that opens, select standard-edition plan and click Update Subscription.

 Note
If you don't see the standard-edition plan in the list, make sure that there's an entitlement for SAP Business
Application Studio in your subaccount. See Con gure Entitlements and Quotas for Subaccounts.

 Note

The content of the existing dev spaces is not affected by the update.

No changes are made to the user permissions.

The free tier restrictions are not applied anymore.

Restart your dev space to see the extended disk space.

Related Information
Onboarding to the Free Plan

Manage Authorizations and Roles


The subaccount administrator can assign the user a role for developing with SAP Business Application Studio or for managing
data.

Role collections are user-related authorizations that restrict access to resources and services based on de ned user
permissions. They consist of individual roles. The roles are based on role templates. For SAP Business Application Studio there
are three relevant role templates available: Developer role, Extension Deployer role, and Administrator role:

To allow development using SAP Business Application Studio, you must assign the Developer role to the developer.

The Developer role allows developers to develop applications using SAP Business Application Studio.

To allow administrator operations using SAP Business Application Studio, you must assign the Administrator role to the
user.

This is custom documentation. For more information, please visit the SAP Help Portal 159
2/6/2024
The Administrator role allows administrators to manage (export and delete) user data and to restart a user's dev space.
See Export and Download Personal Data from Speci c Users, Delete Personal Data, and Restart a Dev Space.

 Note
It is recommended to limit the number of administrators with full management permissions.

To allow a developer to create an SAP Business Application Studio extension, you must assign the Extension Deployer
role to the user.

The Developer and Administrator role collections together with their corresponding role templates are created automatically
when you subscribe to SAP Business Application Studio.

 Note
If you want to perform both administrator and developer tasks, you must have both roles assigned.

Prerequisites
Your subaccount is subscribed to SAP Business Application Studio. See Subscribe to SAP Business Application Studio.

You must be a subaccount administrator to assign roles.

You're using a SAML 2.0 standard compliant identity provider. See Trust and Federation with SAML 2.0 Identity
Providers.

If you live in the China (Shanghai) region, you must create a new role collection before assigning permissions. See
Manage Role Collections.

Assigning Permissions
You can assign permissions as follows:

1. In the SAP BTP cockpit, navigate to your subaccount.

2. From the Navigation area, choose Security Role Collections .

3. Select an existing role collection:

Select a role collection that was created automatically when you subscribed to SAP Business Application Studio.

If you live in the China (Shanghai) region, select a role collection that you created, as described in the
Prerequisites.

4. Click Edit.

5. Enter the email address of the user who you want to give permissions to in the ID eld.

6. Select the relevant identity provider, for example, Default Identity provider.

7. Enter the email address of the user who you want to give permissions to in the E-Mail eld.

8. Click Save.

To assign permissions to groups, follow the instructions in the Map Role Collections to User Groups topic.

If you want to create a different set of roles, see Manage Role Collections.

Manage Role Collections


You can create a new role collection with a different set of roles or you can update an existing role collection.

This is custom documentation. For more information, please visit the SAP Help Portal 160
2/6/2024
To create a different set of roles or update a role collection, perform the following steps:

1. In the SAP BTP cockpit, navigate to your subaccount.

2. From the Navigation area, choose Security Role Collections .

3. Select an existing role collection or click Create, provide a name, click Create, and select the new role collection.

4. Click Edit.

5. Open the Role Name dialog box to add a new role.

a. From the Role Template dropdown list, select the relevant role:

Select Business_Application_Studio_Developer to create a role collection for developers.

Select Business_Application_Studio_Extension_Deployer to create a role collection for


developers who can deploy extensions.

Select Business_Application_Studio_Administrator to create a role collection for


administrators.

b. From the Application Identi er dropdown list, select <region<IAAS_#>>-app-studio!t<generated-uaa-


number>.

For example, jp20-app-studio!t333*

c. Select the Role Name from the table and click Add.

6. Click Save.

Connecting to External Systems


To connect any on-premise system from SAP Business Application Studio, you must create a destination. Additionally, some
business cases will also require a destination to perform OData service exploration and to select an OData service for creating
and viewing applications.

Context
SAP Business Application Studio dev spaces include a built-in web proxy that allows you access to on premise systems (such as
ABAP systems, Git on-premise, npm on-premise, etc.)

 Note
Always protect your access to an external system, including a Private Artifact Repository manager, an on-premise system, or
a trusted system.

The proxy requires destination con guration to your on-premise system from your Cloud Foundry subaccount.

HTTP requests including the host and port provided with this destination URL made from the dev space using the proxy, will be
transferred through this destination.

You can create a destination that points to your system, either from the Service Center or from the SAP BTP cockpit.

Procedure
Create a Destination from the Service Center for OData Services

This is custom documentation. For more information, please visit the SAP Help Portal 161
2/6/2024
See Add a System to add a destination from the Service Center with all the required properties.

Create a Destination from the SAP BTP Cockpit

1. Open the SAP BTP cockpit in the Cloud Foundry environment and go to the subaccount that is subscribed to SAP
Business Application Studio.

2. Create a destination with the system endpoint URL. For more information, see Create HTTP Destinations.

3. Add the following additional properties to the created destination:

Property Value

WebIDEEnabled true

HTML5.DynamicDestination true

4. Set the WebIDEUsage property for your destination type:

Destination Type Properties

ABAP System WebIDEUsage value: odata_abap,dev_abap

odata_abap:

For exploring ABAP service catalogs

dev_abap:

For deploying to the SAPUI5 ABAP Repository and developing


extension projects.

SAP Cloud for Customer WebIDEUsage value: odata_c4c

Used to explore SAP Cloud for Customer catalogs.

Service URL WebIDEUsage value: odata_gen

For an absolute URL, you can use the full URL option
(WebIDEAdditionalData property and full_url as the value). For
a service host, the relative URL should be added upon login.

SAP Business Accelerator Hub WebIDEUsage value: apihub_sandbox

5. Choose Save.

6. If you are using an ABAP system from the SAP BTP, ABAP environment or SAP S/4HANA Cloud, make sure to follow the
required integration steps for setting up the communication between the system and SAP Business Application Studio:

SAP S/4HANA Cloud, public edition: Integrating SAP Business Application Studio

SAP BTP, ABAP environment: Setup of UI Development in SAP Business Application Studio

7. If you are using an on-premise system, con gure the Cloud Connector so that your system is correctly exposed. See
Cloud Connector.

If you don't have any Cloud Connector to use, you can set up a Cloud Connector on your local machine/VM.

 Note
In the Access Control tab of the Cloud Connector, grant access to all relevant URL paths (Resources) to access the
system (for Access Policy, select the Path and all sub-paths option).

For example: /sap/opu/odata, /sap/bc/adt, /sap/bc/ui2/app_index/, and /sap/bc/ui5_ui5.

This is custom documentation. For more information, please visit the SAP Help Portal 162
2/6/2024
8. Once the destination has been created, SAP Business Application Studio developers can use it in their dev spaces. See
Accessing On Premise Systems.

 Note
If you cannot access the on-premise system and there is an allowlist in your network, make sure you allowed BAS
inbound IPs as described in SAP Business Application Studio Availability.

Connect to Your Git Source Control System


SAP Business Application Studio allows you to connect to public and corporate repositories.

Context
You can connect to whichever repository you want using the supported authentication methods.

Your account may be connected to both a public and a corporate repository.

Connecting to a Corporate Git Repository


As an administrator, you can work with on-premise Git repositories once an appropriate destination has been created in
your subaccount or OAuth has been enabled.
Connecting to a Public Git Repository
Using SAP Business Application Studio, you can connect to all public git services, such as GitHub, GitLab, and BitBucket.
Connecting to a Public Git Server that Requires a Certi cate
You can manage the connectivity to a public Git server that requires a client certi cate.

Connecting to a Corporate Git Repository


As an administrator, you can work with on-premise Git repositories once an appropriate destination has been created in your
subaccount or OAuth has been enabled.

Connecting to Git
Make sure to use the same host and port as de ned in the destination URL property.

 Note
The corporate Git connectivity supports only secure HTTPS connections. HTTP, SSH, and other protocols are not supported.

1. Install and con gure a Cloud Connector. For more information, see Cloud Connector.

2. Con gure the Cloud Connector to open a channel to your Git system. Follow the instructions as described in Con gure
Access Control. Use the following settings:

Field Value

Back-end Type Non-SAP System

Protocol HTTPS

Internal Host / Port Enter the internal host and port for your Git system.

This is custom documentation. For more information, please visit the SAP Help Portal 163
2/6/2024

Field Value

Host / Port Enter a virtual host and port for your Git system. You can use the same host and port
as for the virtual host and port.

Principal Type None

For the system you just added, specify the resources to enable, using the following settings:

Field Value

Enabled Checked

URL Path /

Access Policy Path and all sub-paths

3. Upload your organization's Git server certi cate to the cloud connector (if your Git server is using certi cate-based
authentication).

4. If you de ned a custom identity provider, make sure that you have con gured the assertion-based attributes mapping for
this identity provider. For more information, see Con gure Trust to the SAML Identity Provider.

5. De ne your corporate Git destination.

a. In the SAP BTP cockpit, select Connectivity Destinations .

b. Select New Destination.

c. In the Destination Con guration section, set the Proxy Type to OnPremise.

d. In the Additional Properties section, con gure the following:

Property Value

WebIDEEnabled true

HTML5.DynamicDestination true

HTML5.Timeout 60000

(Optional property)

 Note
To start consuming the new con gurations, users can either restart their dev space or reload the destinations into the dev
space. See Accessing On Premise Systems.

Enabling OAuth in GitHub Enterprise

This is custom documentation. For more information, please visit the SAP Help Portal 164
2/6/2024
1. Create an OAuth app as described in the GitHub documentation . Make sure to click Enable Device Flow when creating
the app since OAuth app will use the device ow to identify and authorize users.

2. Once the app is created, from the General tab of the application, copy the Client ID number.

3. Add the GitHubEnterpriseClientID as an additional property to the GitHub Enterprise destination, where the
value is the Client ID number you copied before.

Using Git
Learn how to use Git in the SAP Business Application Studio Developer Guide. See Git Source Control.

Connecting to a Public Git Repository


Using SAP Business Application Studio, you can connect to all public git services, such as GitHub, GitLab, and BitBucket.

Providing Authentication
SAP Business Application Studio supports the following authentication methods. Once you have enabled one of these methods,
you will not have to enter your credentials every time you use Git.

Basic authentication - Access your Git provider using your username and password.

To work with the Git view in SAP Business Application Studio, you need to store or cache credentials.

 Note
Doing this requires you to entrust your credentials to SAP and to a third party.

Cache credentials in memory for a short period of time. See Git Credential Cache .

Store credentials inde nitely in a le on your dev space. See Git Credential Store .

You can use a Personal Access Token (PAT) instead of a password.

For example, you can create a PAT in GitHub following these instructions. Other Git providers will have different ways of
creating PATs.

SSH - SSH (Secure Shell) keys are used for managing networks, operating systems, and con gurations. The ssh
command provides a secure encrypted connection between two hosts over a network.

Connecting to Git
In SAP Business Application Studio, public Git works out-of-the-box.

You can start by cloning a project to your local workspace. See Cloning Repositories.

Using Git
Learn how to use Git in the SAP Business Application Studio Developer Guide. See Git Source Control.

Connecting to a Public Git Server that Requires a Certi cate

This is custom documentation. For more information, please visit the SAP Help Portal 165
2/6/2024
You can manage the connectivity to a public Git server that requires a client certi cate.

Context

 Note
The Git connectivity supports only secure HTTPS connections. HTTP, SSH and other protocols are not supported.

Procedure
1. In the SAP BTP cockpit, select Connectivity Destinations .

2. Select New Destination.

3. In the Destination Con guration section, do the following:

a. Set Proxy Type to Internet.

b. Set Authentication to ClientCerti cateAuthentication.

c. Upload the client certi cate in the Key Store Location eld.

d. Enter your Key Store Password.

4. In the Additional Properties section, con gure the following:

Property Value

WebIDEEnabled true

WebIDEUsage git

WebIDEAdditionalData git_host_<Git host name>

The Git host name must be entered as it appears in the URL. For example, if the URL is
https://git.acme.corp:443, the host name would be git.acme.corp.

So you would enter in the eld: git_host_git.acme.corp

5. Select the Use default JDK truststore checkbox.

Next Steps
Test your new Git system by cloning a repository (see Cloning Repositories) or by initializing a local repository, setting the
remote repository, fetching and pushing to the remote repository.

Export and Download Personal Data from Speci c Users


You can export and download personal data from speci c users from your workspace.

This is custom documentation. For more information, please visit the SAP Help Portal 166
2/6/2024
1. In your browser, get a list of all workspaces contained in a speci c subaccount:

https://<sap-business-application-studio-url>/ws-manager/api/v1/workspace?all=true

2. Enter your administrator credentials in the login page.

3. From the list provided, identify the dev space you want to export (for example by searching for the username property).

4. Copy the baseUrl property under the runtime section in the dev space you want to export.

This URL is the <runtime-url> parameter used in the request in Step 6.

5. Make sure the dev space you want to export is in the Running state. If not, restart the dev space before exporting the
data. See Restart a Dev Space.

6. Use the following request to export data:

https://<sap-business-application-studio-url>/login?e=<runtime-url>/wsmaintain/export

Restart a Dev Space


You can change the state of a dev space to Running.

Prerequisites

Install a REST API tool such as Postman.

1. In your browser, get a list of all workspaces in a speci c subaccount:

https://<sap-business-application-studio-url>/ws-manager/api/v1/workspace?all=true

2. Enter your administrator credentials in the login page.

3. From the list provided, identify the dev space you want to wake up (for example by searching for the username property).

4. Copy the id property under the config section. This ID is the <ws-id> parameter used in the request in the last step.

5. Copy the displayname property under the labels section. This display name is the <display-name> parameter
used in the request in the last step.

6. Open a new tab in the browser and fetch your JWT token by sending the following request:

GET https://<sap-business-application-studio-url>/jwt

7. Copy the JWT value from the response.

8. In the REST API tool, send a PUT HTTP request to the following API:

PUT https://<sap-business-application-studio-url>/ws-manager/api/v1/workspace/<ws-id>?all=true

Request Header:
X-Approuter-Authorization: Bearer <JWT_Token>

Request Body:
{"suspended":false, "WorkspaceDisplayName":"<display-name>"}

 Note
If you're performing actions on your own workspace, you don't need to include the ?all=true parameter.

This is custom documentation. For more information, please visit the SAP Help Portal 167
2/6/2024

Delete Personal Data


You can delete personal data stored in your workspace.

Prerequisites

Install a REST API tool such as Postman.

1. In your browser, get a list of all workspaces in a speci c subaccount:

https://<sap-business-application-studio-url>/ws-manager/api/v1/workspace?all=true

2. Enter your administrator credentials in the login page.

3. From the list provided, identify the dev space you want to delete (for example by searching for the username property).

4. Copy the id property under the config section. This ID is the <ws-id> parameter used in the request in the last step.

5. (Optional) If you want to export the data before deleting the dev space, the dev space must be in the Running state. If
the dev space isn’t in the Running state, restart the dev space to export the data. See Restart a Dev Space.

6. Open a new tab in the browser and fetch your JWT token by sending the following request:

https://<sap-business-application-studio-url>/jwt

7. Copy the JWT value from the response.

8. In the REST API tool, send a DELETE HTTP request to the following API:

DELETE https://<sap-business-application-studio-url>/ws-manager/api/v1/workspace/<ws-id>?all=t

Request Header:
X-Approuter-Authorization: Bearer <JWT_Token>

 Note
If you're performing actions on your own workspace, you don't need to include the ?all=true parameter.

SAP Business Application Studio Availability


You can nd the regions where SAP Business Application Studio is available and the relevant IP addresses.

Outbound IP Address
Use an SAP Business Application Studio outbound IP address when connecting from SAP Business Application Studio to an
outside service.

For example, you can use an outbound IP address for connecting SAP Business Application Studio to an SAP S/4HANA service
or an ABAP Cloud System service.

 Note
We recommend you connect to the data center that is closer to your physical location to ensure best performance.

This is custom documentation. For more information, please visit the SAP Help Portal 168
2/6/2024

Region IaaS Provider Technical Key SAP Business Application


Studio

Outbound IP*

Europe (Frankfurt) AWS eu10 18.158.7.155

 Note 18.192.47.220
There is no support for new
18.194.253.116
trial accounts in this region.
Trial accounts created 3.65.235.145
before October 2021 will still
be supported. 3.68.253.57

18.193.62.167

Europe (Frankfurt) AWS eu10-trial 18.192.169.180

18.193.190.210

18.193.190.236

Europe (Frankfurt) AWS eu11 18.185.27.129

3.122.202.117

3.65.47.134

18.157.69.102

3.126.1.137

3.69.188.52

Europe (Frankfurt) AWS eu12 18.158.167.104

18.158.197.80

18.198.185.172

18.158.167.239

18.192.41.236

3.68.62.167

US East (Virginia) AWS us10 3.218.32.143

34.195.235.17

35.171.105.85

107.23.185.214

18.235.6.188

34.202.247.115

US East (Virginia) AWS us10-trial 100.25.71.121

34.198.58.151

54.172.162.6

This is custom documentation. For more information, please visit the SAP Help Portal 169
2/6/2024

Region IaaS Provider Technical Key SAP Business Application


Studio

Outbound IP*

Australia (Sydney) AWS ap10 3.105.48.137

3.106.19.99

3.24.68.98

13.237.126.245

54.66.136.70

54.66.49.132

Singapore AWS ap11 13.251.235.126

54.255.46.77

54.255.68.69

18.142.61.29

3.1.255.127

54.179.99.46

Seoul AWS ap12 3.35.61.218

3.36.186.108

52.78.62.199

15.165.92.14

3.37.142.13

52.78.126.220

Canada (Montreal) AWS ca10 3.96.106.101

3.96.253.248

99.79.177.154

3.96.12.36

3.98.118.119

35.183.248.246

Brazil (Sao Paulo) AWS br10 18.230.114.154

54.232.168.1

54.232.48.50

54.207.137.216

54.94.190.187

54.94.95.72

This is custom documentation. For more information, please visit the SAP Help Portal 170
2/6/2024

Region IaaS Provider Technical Key SAP Business Application


Studio

Outbound IP*

Japan (Tokyo) AWS jp10 52.198.200.83

52.68.68.77

54.64.113.216

13.113.231.142

35.76.193.116

35.76.58.2

Europe (Netherlands) Azure eu20 20.50.59.1

20.224.162.71

20.229.178.62

20.50.59.78

20.224.162.58

20.229.177.44

US West (Washington) Azure us20 20.57.129.173

20.120.161.236

20.120.251.74

20.57.129.190

20.120.161.89

20.83.210.217

US East (Virginia) Azure us21 20.62.163.90

20.51.200.101

20.84.71.145

20.62.163.97

20.51.200.148

20.115.81.15

Japan (Tokyo) Azure jp20 20.78.56.84

20.78.11.2

20.63.136.151

20.78.56.93

20.78.38.95

20.243.33.146

This is custom documentation. For more information, please visit the SAP Help Portal 171
2/6/2024

Region IaaS Provider Technical Key SAP Business Application


Studio

Outbound IP*

Australia (Sydney) Azure ap20 20.92.248.254

20.213.11.195

20.92.224.221

20.92.249.110

20.213.10.89

20.92.224.182

Singapore Azure ap21 20.195.27.211

20.24.48.158

20.195.8.76

20.195.28.39

20.24.49.140

20.195.8.101

Singapore Azure ap21-trial 20.191.152.199

20.198.217.56

20.212.240.110

20.191.152.225

20.198.218.33

20.212.177.39

Switzerland North Azure ch20 20.208.136.62

51.107.1.253

51.103.220.138

20.208.138.3

51.107.5.175

51.103.222.158

US Central (Iowa) Google Cloud us30 35.202.248.207

34.133.218.253

*NAT IPs (egress, IPs for requests from an SAP Business Application Studio dev space)

Inbound IP Address
If your corporate network is protected by a corporate proxy or rewall, extend your allowlist to enable connections from the
corporate network to your dev spaces in SAP Business Application Studio, in both HTTP and WebSocket protocols.

For example, when connecting to a service on your corporate SAP system, which is located within your corporate network, you
might need to maintain the SAP Business Application Studio connectivity service host in your rewall.

This is custom documentation. For more information, please visit the SAP Help Portal 172
2/6/2024
Use the host listed in the Connectivity Service Host column of the following table, according to your region.

The Cloud Connector should also be connected to this service host.

If your network restriction also requires explicit IPs, use the IPs listed in the Inbound IP column of the following table, according
to your region.

Region IaaS Technical SAP Business Application Studio SAP Business Application Studio
Provider Key
Connectivity Service Host Inbound IP

Europe AWS eu10 https://connectivity.eu10.applicationstudio.cloud.sap 18.159.70.155


(Frankfurt)
18.159.232.22

18.156.27.245

18.193.62.167

52.58.227.227

3.66.10.126

Europe AWS eu11 https://connectivity.eu11.applicationstudio.cloud.sap 18.158.123.221


(Frankfurt)
18.193.170.223

18.157.124.219

35.156.170.248

3.64.94.185

3.68.127.205

Europe AWS eu12 https://connectivity.eu12.applicationstudio.cloud.sap 3.124.78.26


(Frankfurt)
3.64.186.38

35.157.83.247

18.198.238.190

3.66.52.233

3.126.7.208

Europe AWS cry10cf.int https://connectivity.cry10cf.int.applicationstudio.cloud.sap 18.192.167.232


(Frankfurt)
18.198.211.102

18.196.140.56

18.193.50.247

18.156.62.37

3.68.133.153

US East AWS us10 https://connectivity.us10.applicationstudio.cloud.sap 100.24.163.249


(Virginia)
54.243.145.188

18.210.189.221

44.193.236.153

3.91.126.136

34.236.221.171

This is custom documentation. For more information, please visit the SAP Help Portal 173
2/6/2024

Region IaaS Technical SAP Business Application Studio SAP Business Application Studio
Provider Key
Connectivity Service Host Inbound IP

Australia AWS ap10 https://connectivity.ap10.applicationstudio.cloud.sap 13.238.41.41


(Sydney)
54.153.190.7

52.63.88.22

54.252.50.184

3.105.22.230

13.210.109.84

Singapore AWS ap11 https://connectivity.ap11.applicationstudio.cloud.sap 18.139.207.29

52.220.86.30

13.213.240.205

54.169.224.233

13.213.216.104

13.213.186.249

Seoul AWS ap12 https://connectivity.ap12.applicationstudio.cloud.sap 54.180.46.250

3.34.92.76

3.37.239.157

3.37.8.79

3.36.229.98

3.37.237.182

Canada AWS ca10 https://connectivity.ca10.applicationstudio.cloud.sap 3.98.238.174


(Montreal)
52.60.170.25

3.97.151.56

3.97.151.215

35.183.175.160

3.98.191.85

Brazil (Sao AWS br10 https://connectivity.br10.applicationstudio.cloud.sap 54.207.235.96


Paulo)
54.94.84.199

54.94.12.100

54.94.88.250

18.230.90.202

54.232.23.35

This is custom documentation. For more information, please visit the SAP Help Portal 174
2/6/2024

Region IaaS Technical SAP Business Application Studio SAP Business Application Studio
Provider Key
Connectivity Service Host Inbound IP

Japan AWS jp10 https://connectivity.jp10.applicationstudio.cloud.sap 54.95.29.60


(Tokyo)
18.180.77.231

18.181.101.86

35.74.156.52

35.75.212.58

175.41.212.190

Europe AWS eu10-trial https://connectivity.eu10cf.trial.applicationstudio.cloud.sap


 Note
(Frankfurt)
SAP Business Application Studio
support static inbound IPs for tria

To determine the inbound IP addres


steps:

US East AWS us10-trial https://connectivity.us10cf.trial.applicationstudio.cloud.sap 1. Open the command promp


(Virginia)
2. Enter the following comman

$ nslookup <connecti

 Note
The inbound IPs may change over
Singapore Azure ap21-trial https://connectivity.ap21cf.trial.applicationstudio.cloud.sap
trouble connecting from an outsid
Business Application Studio, perf
previous note to determine the ne

Europe Azure eu20 https://connectivity.eu20.applicationstudio.cloud.sap 20.76.191.246


(Netherlands)
20.93.214.159

US West Azure us20 https://connectivity.us20.applicationstudio.cloud.sap 20.109.144.108


(Washington)
20.109.145.6

US East Azure us21 https://connectivity.us21.applicationstudio.cloud.sap 20.81.5.143


(Virginia)
20.81.5.181

Japan Azure jp20 https://connectivity.jp20.applicationstudio.cloud.sap 20.89.185.253


(Tokyo)
20.89.185.115

Australia Azure ap20 https://connectivity.ap20.applicationstudio.cloud.sap 20.193.1.52


(Sydney)
20.193.0.203

Singapore Azure ap21 https://connectivity.ap21.applicationstudio.cloud.sap 20.198.213.162

20.198.212.10

Switzerland Azure ch20 https://connectivity.ch20.applicationstudio.cloud.sap 20.250.123.150


North
4.226.16.64

US Central Google us30 https://connectivity.us30.applicationstudio.cloud.sap 34.68.195.45


(Iowa) Cloud
34.123.168.153

This is custom documentation. For more information, please visit the SAP Help Portal 175
2/6/2024

Security Guide
This guide contains the security elements for SAP Business Application Studio.

It includes information on the following:

Architectural Overview
Standards and Best Practices
Encryption with a Customer-Controlled Encryption Key
SAP Business Application Studio supports using a customer-controlled encryption key (CCEK) to encrypt les and
folders.
Malware Scan in Dev Spaces
SAP Business Application Studio scans the user les within the dev spaces for malware.
Security Recommendations and Considerations
The following sections present an overview of security recommendations and considerations for SAP Business
Application Studio developers and administrators.

Architectural Overview

SAP Business Application Studio is part of SAP BTP and the SAP Multi-cloud offering (AWS, Azure, Alibaba, etc.).

Developers (end users) use a web browser to access their own dev space, personal, restricted, and tailored. The dev space is a
Developer Virtual Appliance which includes everything a developer requires: development environment, technology stacks,
tools, security and connectivity instruments, developed source code, and applications.

SAP Business Application Studio is based on the SAP Cloud Foundry Business Application Pattern to provide Multi-tenant
Software-as-a-Service (SaaS).

The Identity and Access Management (IAM) is based on SAP Cloud Foundry Authorization and Trust Management. Once the
developers pass the authorization process, they are granted access with appropriate scopes to the dev space.

This is custom documentation. For more information, please visit the SAP Help Portal 176
2/6/2024
The developers can access different services (outside of SAP BTP), from the dev space based on the SAP Cloud Foundry
destination they created. The SAP Cloud Connector is used, in addition, to provide a secured access to the on-premise
landscape.

Related Information
SAP Cloud Foundry Business Application Pattern
Authorization and Trust Management
SAP Cloud Foundry destinations
SAP Cloud Connector
Manage Authorizations from SAP BTP cockpit
Connecting to External Systems
How the Connectivity Proxy Works

Standards and Best Practices


SAP Business Application Studio implements security standards and best practices to guarantee secured solution.

For example:

Enforce authentication and authorization

Encrypt communication

Prevent untrusted input

Audit

Encryption with a Customer-Controlled Encryption Key


SAP Business Application Studio supports using a customer-controlled encryption key (CCEK) to encrypt les and folders.

CCEK functionality is enabled by default for all dev spaces that were created from September 18, 2022 and onwards:

For all les and folders in your dev space, located under /home/user, the data is persisted in the physical storage in
encrypted form. Access to the les and folders requires the CCEK key to be enabled in the SAP Data Custodian Key
Management Service (KMS), which is the default case.

If you opt to disable the managed keys, then dev spaces in your tenant won’t be able to start and new dev spaces can’t
be created. As long as the managed keys are disabled, the les will not be accessible in SAP Business Application Studio.
You can still delete a dev space while the managed keys are disabled. Existing dev spaces will be reachable again when
you enable the managed keys.

Malware Scan in Dev Spaces


SAP Business Application Studio scans the user les within the dev spaces for malware.

The scan is triggered every 10 minutes for dev spaces in Running state.

If malware is detected, a noti cation is displayed and the user can delete the le or ignore the message.

This is custom documentation. For more information, please visit the SAP Help Portal 177
2/6/2024
In addition, a corresponding entry is written to the audit log of the subaccount from which the user logged in, specifying the le,
dev space, and user name where the malware was found.

Related Information
Audit Log Viewer for the Cloud Foundry Environment
Viewing Audit Logs

Security Recommendations and Considerations


The following sections present an overview of security recommendations and considerations for SAP Business Application
Studio developers and administrators.

Security Recommendations
The following security recommendations are included in the list of SAP BTP security recommendations.

Summary Recommendation

Limit the number of administrators with full management BTP-BAS-0001


permissions.

Security Considerations
Decisions you make when using SAP Business Application Studio can have an impact on the security of your applications. The
information provided is meant to help you decide.

Summary More Information

Use caution when installing third-party extensions while using a See Access SAP Business Application Studio from VS Code.
remote connection to SAP Business Application Studio.

When connecting to corporate Git source control systems, use PATs See Connecting to a Corporate Git Repository.
whenever possible.

Always protect your access to an external system. See Connecting to External Systems.

Make sure you only install secured artifacts with your custom SAP See Create and Deploy an SAP Business Application Studio
Business Application Studio extension. Extension.

This is custom documentation. For more information, please visit the SAP Help Portal 178

You might also like