5/28/25, 12:24 PM

SAP Build Code

Generated on: 2025-05-28 [Link] GMT+0000

SAP Build Code | Production

Public

Original content: [Link]

US&state=PRODUCTION&version=SHIP

Warning

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

For more information, please visit [Link]

This is custom documentation. For more information, please visit SAP Help Portal. 1
 5/28/25, 12:24 PM

What is SAP Build Code

SAP Build Code offers an AI-powered cloud development environment specifically tailored for SAP Cloud Application Programming
Model (CAP), SAP Fiori, mobile, and SAPUI5 developers.

By seamlessly integrating coding, testing, and application management, it streamlines the application development process on
SAP BTP. SAP Build Code combines SAP Business Application Studio with the most essential services and SDKs on SAP BTP.

With the integration of Joule, the innovative AI copilot of SAP, SAP Build Code enables automatic generation of application code,
data models, services, and sample data. Using SAP Build Code ensures adherence to the best practices and guidance outlined in
the SAP BTP Developer's Guide.

SAP Build Code Components

SAP Build Code is composed of several SAP services. These services facilitate application development for all key extension use
cases in SAP environments.

SAP Build Code Services

Service Description

SAP Business Application SAP Business Application Studio is a powerful and modern development environment, tailored for
Studio efficient development of business applications for the Intelligent Enterprise. Available as a cloud service,
it provides developers a desktop-like experience similar to market leading IDEs, while accelerating time-
to-market with high-productivity development tools such as wizards and templates, graphical editors,
quick deployment, and more.

Transport Management SAP Cloud Transport Management service lets you manage software deliverables between accounts of
different environments (such as Cloud Foundry, ABAP, and Neo), by transporting them across various
runtimes. This includes application artifacts as well as their respective application-specific content.

This is custom documentation. For more information, please visit SAP Help Portal. 2
 5/28/25, 12:24 PM

Service Description

SAP Continuous Integration SAP Continuous Integration and Delivery lets you configure and run predefined continuous integration
and Delivery and delivery (CI/CD) pipelines that automatically build, test, and deploy your code changes to speed up
your development and delivery cycles.

SAP Document Management Onboard and offboard your repositories to the Document Management Service.
– Applications

SAP Document Management Document Management Service, Repository Option lets you securely store your enterprise content in a
- Repository meaningful way using folder hierarchies.

SAP Mobile Services SAP Mobile Services is an open-standards based cloud platform that enables mobile application
development, configuration, and management.

SAP Business Technology The SAP BTP, Cloud Foundry runtime lets you develop polyglot cloud-native applications and run them on
Platform, Cloud Foundry the SAP BTP Cloud Foundry environment.
runtime

SAP Alert Notification Receive notifications about SAP Business Technology Platform (SAP BTP) events to your preferred
service for BTP communication channel or monitoring tool.

CP Cloud Logging SAP Cloud Logging service is an instance-based observability service that builds upon OpenSearch to
store, visualize, and analyze application logs, metrics, and traces from SAP BTP Cloud Foundry, Kyma,
Kubernetes and other runtime environments.

 Note
In SAP Build Code, the Cloud Logging service is available for evaluation purposes only.

Application Autoscaler Automatically scale your applications to meet their dynamic resource needs.
Service

These services are included in the overall SAP Business Technology Platform contract:

Feature Flag Service Control the rollout of new features.

SAP Build Work Zone, Simplify access to applications by establishing a central entry point.
foundation

Destination Retrieve and store technical information about the target resource (destination) that you want to connect
with your application to a remote service or a system

Connectivity Service Enable SAP BTP applications to access remote services that run on the Internet or on-premise.

SAP Authorization and Trust Manage user authorizations and trust to identity providers. Identity providers are the user base for
Management applications.

SaaS Provisioning Service The SaaS Provisioning service allows application providers to register multitenant applications and
services in the Cloud Foundry environment in SAP Business Technology Platform.

HTML5 Applications Develop and run HTML5 applications in a cloud environment.

Event Broker This service supports SAP's strategic event-driven architecture initiative to create a well-defined, easily
consumable and extensible ecosystem for exchanging SAP business events.

What's New for SAP Build Code

Learn about the new and updated features in the SAP Build Code services.
This is custom documentation. For more information, please visit SAP Help Portal. 3
 5/28/25, 12:24 PM

Integration with SAP Build

SAP Build Code is one of the components of SAP Build.

SAP Build enables anyone, no matter what is their skill level, to create and augment enterprise applications, process automation,
and business sites with drag-and-drop simplicity.

Component More Information

SAP Build Apps SAP Build Apps is a low-code development platform to create apps
for the Web and native mobile use. Business users can build
enterprise-grade apps without writing a single line of code.
Professional developers can reduce coding effort in the creation of
complex data models and business logic.

For more info, see What Is SAP Build Apps?.

SAP Build Code SAP Build Code offers an AI-powered cloud development
environment specifically tailored for SAP Cloud Application
Programming Model (CAP), SAP Fiori, mobile, and SAPUI5
developers. SAP Build Code streamlines the application
development process on SAP BTP, and it combines SAP Business
Application Studio with the most essential services and SDKs on
SAP BTP.

For more information, see What is SAP Build Code.

SAP Build Process Automation SAP Build Process Automation is a citizen developer solution to
adapt, improve, and innovate business processes with no-code
workflow management and robotic process automation
capabilities. For example, creating forms-based workflows and
automating repetitive tasks within existing process flows.

For more information, see What Is SAP Build Process Automation?.

SAP Build Work Zone Using SAP Build Work Zone, you can create business sites that
serve as a unified point of access to SAP, custom-built, and third
party applications and extensions, both on the cloud and on
premise.
This is custom documentation. For more information, please visit SAP Help Portal. 4
 5/28/25, 12:24 PM

Component More Information

After creating a business app, you can deploy it to your subaccount

in SAP Build Work Zone and integrate it into a business site to make
it available for users.

For more information, see What Is SAP Build Work Zone, advanced
edition?.

Initial Setup
Perform these preparatory steps to set up your system for creating your business applications in SAP Build Code.

Prerequisites

You have created a global account in the SAP BTP cockpit. See Getting a Global Account.

Subscribe to SAP Build Code

 Tip
The correct way to subscribe to SAP Build Code is using the booster and not the manual setup.

 Note
If you already have a subscription to one or more of the services included in SAP Build Code and you would like to upgrade to
the SAP Build Code plan, see Changing Service Plans.

1. Access your global account in the SAP BTP cockpit and choose Boosters from the navigation pane.

2. Search for the Get started with SAP Build Code booster.

 Note
There is a booster for each of the SAP Build Code service plans. Make sure to select the one relevant to the plan you
want to work in.

 Note
To see if SAP Build Code is available in your region, search for SAP Build Code in the Discovery Center .

3. Open the booster to see the overview, components, and additional resources.

4. Choose Start.

The booster wizard guides you through the process of enabling the tools, configuring entitlements, and assigning members
on the SAP BTP cockpit.

 Note
The Get started with SAP Build Code booster does not set up an SAP HANA Cloud database instance automatically.
You need to manually create an instance. See Create an SAP HANA Database Instance Using SAP HANA Cloud Central.

The booster checks for required authorizations, compatible providers, and regions.

This is custom documentation. For more information, please visit SAP Help Portal. 5
 5/28/25, 12:24 PM
5. Make sure that you comply with all the prerequisites, and choose Next.

6. In the Select Scenario step, select the Create Subaccount radio button.

7. In the Configure Subaccount step, select the necessary entitlements for the different services and provide information for
the required fields. See Configure Entitlements and Quotas for Subaccounts.

 Note
The booster will create an entitlement to the Cloud Logging service but it will not create an instance. An instance will
automatically be created the first time you deploy an application.

 Note
The Cloud Logging service is included only for development purposes in SAP Build Code. If you want to use a productive
version of the service, delete this service from the list in the SAP Build Code booster, and subscribe to it separately
without using the build-code plan. See Cloud Logging .

 Note
Make sure to provide a meaningful name for the subaccount. For example, build-procode-dev-fullstack.

8. In the Add Users step, select the custom Identity Authentication service tenant configured for your account for both the
platform users and for the applications.

 Note
If you select a different identity provider, some services will not work as expected.

9. Enter the details of additional users who will work on your development project and assign them to the relevant roles.

Administrators will be assigned to the org manager and space manager roles, and to the
Build_Code_Administrator and Subaccount Administrator role collections.

Developers will be assigned to the space developer role and to the Build_Code_Developer and Subaccount
Viewer role collections.

10. Choose Finish.

11. After running the booster, on the popup window, choose Navigate to Subaccount.

12. From the navigation pane, select Services Instances and Subscriptions .

13. Under the Subscriptions tile, choose SAP Build Code.

The SAP Build lobby appears.

 Note
If you already have a subscription to one or more of the services included in SAP Build Code and you would like to upgrade to
the SAP Build Code plan, see Changing Service Plans.

Accessing SAP Build Code

1. From the subaccount's navigation pane, select Services Instances and Subscriptions .

2. Under the Subscriptions tile, choose SAP Build Code.

The SAP Build lobby appears.

This is custom documentation. For more information, please visit SAP Help Portal. 6
 5/28/25, 12:24 PM

Development
With SAP Build Code, you can develop business applications following the best practices and guidance outlined in the SAP BTP
Developer's Guide.

Prerequisites
Make sure your administrator has set up your system with the required roles and entitlements as described in Initial Setup.

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.

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 finished 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.

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 or consume events and functions in your application from the Service Center. You can
also create a new service based on a business object.

To explore services, navigate to the Service Center using one of the following options:

Click (Service Center) from the activity bar.

Navigate to View Open View from the menu, and enter Service Center in the input field.

Click + in the External Resources section of the storyboard.

The Service Center opens in the context of your project.

This is custom documentation. For more information, please visit SAP Help Portal. 7
 5/28/25, 12:24 PM
From the Service Center, you can explore different resource types, such as a service, event, business object, or function.

You can select a provider from the Select a Provider dropdown list. The following service providers are available:

SAP System Service Provider

SAP Business Accelerator Hub Service Provider

Developer Hub Service Provider

Unified Customer Landscape 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. If you don't maintain the credentials in the
destination configuration of the account, you need to log in manually to open the system information.

Explore SAP System Services

1. Use the Service radio button in the Service Center to filter for the relevant providers.

2. From the Select a Provider dropdown list, select SAP System.

3. The Service Center displays a list of catalogs and a separate list of single services.

 Note
If a system is connected, there's a dot next to the icon ( ) and you can click it to see the services that it contains.

Use the search field ( ) to filter the list.

The Catalog of Services list contains the following types of systems:

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 catalog and log in with your user
credentials, if needed.

Cloud for Customer Catalog

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

The Services list displays the following types of systems:

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.

SAP Business One

This is custom documentation. For more information, please visit SAP Help Portal. 8
 5/28/25, 12:24 PM
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.

4. Click a catalog ( ) to open it and display the list of services, or click a service ( ) to see its properties, including the
name, description, authentication type, status, and URL.

5. Click an entity to see the service details. You can see the entity's metadata, details, and live data in the Entities tab. This
helps you choose an entity for your application.

 Note
The live data only displays up to 20 rows of data for simple data types.

You can also search for an entity.

You can see details about the system and service in 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.

Explore SAP System Business Objects and ABAP CDS Views

 Note
This feature is only available in an SAP Fiori project.

If you don't find the correct UI service for your project, you can explore business objects or CDS views and their properties in SAP
S/4HANA Public Cloud and then generate an OData V4 service from an ABAP business object or CDS view. The service enables
you to develop an SAP Fiori application based on your own custom UI service and deploy it to SAP BTP or SAP S/4 HANA Cloud.

Prerequisites:

To explore business objects and CDS views, make sure you have performed the following steps:

You must use SAP S/4HANA Cloud or ABAP Cloud only and connect with SAMLAssertion authentication to SAP BTP.

See Integrating SAP Business Application Studio and Creating a Destination for Cross-Subaccount Communication.

You must connect to the SAP S/4HANA Development Tenant (usually Client 80).

You must have a business user in SAP S/4HANA with the BR_DEVELOPER business role.

You created an SAP Fiori project. See Create a Project.

Explore an ABAP Business Object or an ABAP CDS View

1. Under External Resources in the storyboard, click +.

2. Use the Business Object/CDS radio button to filter for the relevant entries.

3. Click a system from the list to connect to the system.

Lists of business objects and CDS views are displayed.

This is custom documentation. For more information, please visit SAP Help Portal. 9
 5/28/25, 12:24 PM
4. Click a business object or CDS view from the list to see its entities and properties.

The list of properties is also displayed for each entity.

5. Click the Add to SAP Fiori Project button.

 Note
If the business object or CDS view isn't optimized for UI creation, a notification will be displayed.

Add the Custom UI Service to the Project

1. Follow the UI Service Generator wizard steps, provide the required information, and click Finish.

The UI OData service is generated from the business object or CDS view and is published in the V4 service catalog.

See UI Service Generation for more information.

2. Navigate to the storyboard.

The new UI service is displayed under External Resources and is also available in the Service Center.

Create a UI Application

1. Under UI Applications in the storyboard, click +.

2. Follow the SAP Fiori generator wizard steps, provide the required information, and click Finish.

See Generating an Application for more information.

The new UI application is displayed under UI Applications in the storyboard.

3. Run the application to preview it.

Explore SAP System Functions

 Note
This feature is only available in a Full-Stack Application Using Productivity Tools project.

A Remote Function Call (RFC) is the standard SAP interface for communication between SAP systems. RFC calls a function to be
executed in a remote system.

You can add an RFC to a Full-Stack Application Using Productivity Tools project and then explore functions in the Service Center.

Prerequisites:

You can only explore systems that are configured with the Remote Function Call (RFC) type of authentication protocol.

Create and maintain systems with the Type RFC in the Destination Configuration of the SAP BTP cockpit. See RFC
Destinations.

In addition to any other RFC calls that you use in your app, you must maintain the Cloud Connector for RFC with the
following function names set up:

DOCU_GET

RFC_FUNCTION_SEARCH

RFC_METADATA_GET

See Initial Configuration (RFC) and Configure Access Control (RFC).

This is custom documentation. For more information, please visit SAP Help Portal. 10
 5/28/25, 12:24 PM
The following Additional Properties are required for the RFC destination:

[Link]

[Link]

[Link]

Only manual credential entry (CONFIGURED_USER) for the Authorization Type is supported when you log in to the
system from the Service Center.

You created a Full-Stack Application Using Productivity Tools project. See Create a Project.

Procedure:

1. If the storyboard doesn't open automatically, open it.

2. In the storyboard, under External Resources, click +.

3. In the Service Center, use the Function radio button.

Systems that fit the prerequisites are displayed.

4. Click on the desired system and log in with your username and password, if needed.

A list of functions is displayed.

Classic APIs are delivered by SAP, are stable, will not change, and are therefore recommended. See this blog about
Classic APIs.

5. Choose the desired API to open it.

The import parameters, export parameters, tables, and general information for the function are available in the Service
Center editor.

6. Click the Add to Project button.

 Note
If you have several projects in your workspace, you will be prompted to select a project.

7. To preview, you must create a user in the Repository-Based Shipment Channel (RBSC). See Viewing Licenses and
Repository Endpoints.

8. When adding a function to the project for the first time, you need to enter your RBSC credentials and click Add. This will
enable you to run the function later.

See Managing Technical Users in Repository-Based Shipment Channel.

If you need to set up or change your RBSC credentials, select CDS: Configure RBSC for @sap/cds-rfc library from the
command palette and follow the prompts.

 Note
RBSC credentials are stored in the project's .npmrc file. The .npmrc file will be added to the .gitignore file. You will
be prompted for credentials only one time per project. If you manually remove the RBSC credentials from the .npmrc
file, you will be prompted to enter the credentials again.

The function is added to the project and the following changes occur:

The npmrc file is updated with your RBSC credentials, enabling access to the RFC library. The RFC library is added
as a dependency to the project. See SAP Cloud Application Programming Model- RFC Integration .

This is custom documentation. For more information, please visit SAP Help Portal. 11
 5/28/25, 12:24 PM
Under the srv>external resource folder, the function is translated to a cds file.

The run configuration for running the external resource is updated automatically.

 Note
When adding a function to a project, you may be prompted to approve the copying of your system login
credentials. You can agree, disagree, or choose not to decide at that moment. Your decision can be changed later
in the Service Center settings. Upon approval, credentials from the Service Center will be copied to the project
for running locally.

The function is displayed in the External Resources section of the storyboard.

The [Link] file is updated with the destination:

"<YourDestination>": {
"kind": "rfc",
"model": "srv/external/<YourDestination>",
"[production]": {
"credentials": {
"destination": "<YourDestination>"
}
}
}

Service Actions for Development

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. From the Service Center, open a service and click the Add to SAP Fiori Project button.

 Note
If your dev space does not have a project, click Create Project and follow the wizard.

The service will be added to the new project.

If you only have one empty project:

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

The .[Link] file is added to the project folder in the file 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. From the Service Center, open a service and click the Add to CAP Project button.

This is custom documentation. For more information, please visit SAP Help Portal. 12
 5/28/25, 12:24 PM

 Note
If your dev space does not have a project, click Create Project and follow the wizard.

The service will be added to the new project.

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

3. (Optional) If you are using a Full Stack Cloud Application project, 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 files appear in the srv external folder of the
project.

A service section appears in the [Link] file of the CAP project, which refers to the srv external
<service_name>.xml file. This file has the metadata of the service:

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

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

A run configuration is generated.

Add an External Service to a Java Project

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

1. From the Project Overview, click on the External Resources row to add an external resource to the project.

The Service Center opens.

2. Click on an OData service to open it and click the Add to Project button.

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

The external service is added under the srv external folder.

You can also see the new service in the Project Overview.

The [Link] configuration file is updated for the productive profile and for the local preview, and
includes the new service and its destination.

This is custom documentation. For more information, please visit SAP Help Portal. 13
 5/28/25, 12:24 PM
A Maven dependency named cds-feature-remote-odata, which is required to enable Remote Services for
OData V2 or V4 APIs in the application, is added to the project's [Link] file.

For more information about what is configured by the Service Center when adding the service to your project, see
Configuring Remote Services .

Once the service has been added to the project, you can do the following:

Continue modeling your service. See Project Overview.

Implement a custom handler and consume your external service. See Consuming Remote Services .

Test your project. See Creating Run Configurations for CAP Java Applications.

For more information, see CAP Service SDK for Java .

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

 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. Next to the Systems search field, click to add a system.

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 configuration 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, services, and events. 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 that contain OData services.

Explore SAP Business Accelerator Hub Services

1. Use the Service or Event radio button in the Service Center to filter for the relevant providers.

This is custom documentation. For more information, please visit SAP Help Portal. 14
 5/28/25, 12:24 PM
For more information about exploring 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. From the Select a Provider dropdown list, select SAP Business Accelerator Hub.

3. The following products are available in the Select Product dropdown list:

SAP S/4HANA Cloud

SAP S/4HANA

SAP SuccessFactors

SAP Customer Experience

SAP Business Technology Platform

Select a product to display its packages.

4. Click the package to display the services (APIs).

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

 Note
You must log in with your SAP Business Accelerator Hub credentials once 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.

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

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

 Note
The live data only displays up to 20 rows of data for simple data types.

You can also search for an entity.

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

7. 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

 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. From the Service Center, open a service and click the Add to SAP Fiori Project button.

This is custom documentation. For more information, please visit SAP Help Portal. 15
 5/28/25, 12:24 PM

 Note
If your dev space does not have a project, click Create Project and follow the wizard.

The service will be added to the new project.

If you only have one empty project:

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

The .[Link] file is added to the project folder in the file 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. From the Service Center, open a service and click Add to CAP Project .

 Note
If your dev space does not have a project, click Create Project and follow the wizard.

The service will be added to the new project.

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

3. (Optional) If you are using a Full Stack Cloud Application project, 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 files appear in the srv external folder of the
project.

A service section appears in the [Link] file of the CAP project, which refers to the srv external
<service_name>.xml file. This file has the metadata of the service:

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

This is custom documentation. For more information, please visit SAP Help Portal. 16
 5/28/25, 12:24 PM
}
}

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

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

Add an External Service to a Java Project

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

1. From the Project Overview, click on the External Resources row to add an external resource to the project.

The Service Center opens.

2. Click on an OData service to open it and click the Add to Project button.

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

The external service is added under the srv external folder.

You can also see the new service in the Project Overview.

The [Link] configuration file is updated for the productive profile and for the local preview, and
includes the new service and its destination.

A Maven dependency named cds-feature-remote-odata, which is required to enable Remote Services for
OData V2 or V4 APIs in the application, is added to the project's [Link] file.

For more information about what is configured by the Service Center when adding the service to your project, see
Configuring Remote Services .

Once the service has been added to the project, you can do the following:

Continue modeling your service. See Project Overview.

Implement a custom handler and consume your external service. See Consuming Remote Services .

Test your project. See Creating Run Configurations for CAP Java Applications.

For more information, see CAP Service SDK for Java .

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.

Developer Hub Service Provider

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

Prerequisite

You created a service instance in the Developer Hub. See Creating a Service Instance in the API Management, Developer Hub.

This is custom documentation. For more information, please visit SAP Help Portal. 17
 5/28/25, 12:24 PM

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

 Note
To add a system, you must meet these criteria:

You're assigned the Business_Application_Studio_Administrator role in the cockpit. See Manage Authorizations and
Roles.

You're connected to a space with a subscription to the Developer Hub.

1. 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.

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

3. Click Add.

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

Property Value

Name Provide a name for the system.

Type HTTP

URL Use the url value from the service key of the Developer Hub
instance.

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

Proxy Type Internet

Authentication OAuth2ClientCredentials

Client ID Use the clientId value from the service key of the Developer
Hub instance.

Client Secret Use the clientSecret value from the service key of the
Developer Hub instance.

Token Service URL Use the tokenUrl value from the service key of the Developer
Hub instance.

5. In the Additional Properties section, configure the following:

This is custom documentation. For more information, please visit SAP Help Portal. 18
 5/28/25, 12:24 PM

Property Value

[Link] true

WebIDEEnabled true

WebIDEUsage apihub_enterprise

apiBusinessHubEnterpriseURL Adding this property is optional.

This property enables navigation from the Service Center to the Developer Hub.

Use the following format:

<subscribed subaccount name>.<devportal_url>.cfapps.<region>.[Link]

Replace the placeholders with the following information:

Property Value

subscribed Use the first part of the tokenUrl from the destination system of the
subaccount Developer Hub.
name
For example, if the URL is
[Link]

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

[Link]

The region is eu10.

Explore Developer Hub Services

 Note
The Service Center only shows Developer Hub systems and products with OData services.

1. If it's not already selected, use the Service radio button in the Service Center to filter for the relevant providers.

2. From the Select a Provider dropdown list, select Developer Hub.

Each system points to a Developer Hub instance.

3. Select a system from the dropdown list to display the products within it.

There are 2 types of products:

SAP S/4HANA Cloud Products

These products are created from the SAP S/4HANA Cloud business system, which has been connected to the
Developer Hub.

To see the list of products, the following prerequisites apply:

This is custom documentation. For more information, please visit SAP Help Portal. 19
 5/28/25, 12:24 PM
a. The Global Account Administrator registered the SAP S/4HANA Cloud system in the SAP BTP cockpit and
linked it to the Integration Suite. See How to discover APIs from business systems in Developer Hub.

b. You have created products from the SAP S/4HANA Cloud system in the Developer Hub. See Create Products
from Business Systems.

Custom Products

You must be onboarded to the Developer Hub and subscribed to access the service details for these products.

Multiple APIs are grouped into a product.

If the product is available and connected ( ), you can search for services within it.

4. Click a product ( ) to display the services (APIs).

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

SAP S/4HANA Cloud Products

You can see the Entity Details, Service Properties, and Connectivity Information, which lets you connect to the live data of
the service, if there is a matching destination. The destination is copied from the target system in the Developer Hub to the
SAP Business Application Studio account whenever you fetch live data or when you add a service to the project.

 Note
You must have an SAP Business Application Studio Administrator role to create a new destination while fetching
live date or adding a service to a project.

Only destinations created with BasicAuthentication are supported.

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

Custom Products

To see the service details, you must be onboarded to the Developer Hub and subscribed to the selected product:

If you aren't onboarded to the Developer Hub, enter your first name, last name, and subscription name and click
Subscribe.

You're now subscribed to the product and all services associated with it.

If you're onboarded to the Developer Hub, 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 Developer Hub, the subscription name with a link to the
subscription in the Developer Hub, and the subscription date.

Service properties

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

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

 Note

This is custom documentation. For more information, please visit SAP Help Portal. 20
 5/28/25, 12:24 PM
If a service is unavailable and the target endpoint of the service requires authentication, make sure that the
target endpoint is configured to be authenticated via Basic Authentication. See the "Configure API Management
to Use the Basic Authentication Policy" section in this blog post .

We recommend using 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.

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

a. You can see the Entity Details and Live Data in the Entities tab. This helps you choose an entity for your application.

 Note
The Live Data only displays up to 20 rows of data for simple data types.

You can also search for an entity.

b. You can see Service Properties in the Properties tab.

7. You can click View Diagram from the Entities tab 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 an external service,
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. For Custom Products, 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.

 Note
For Custom Products only: If the deployed application to Cloud Foundry fails to bring data from the service, make sure that in
the Developer Hub, 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='[Link]

<!-- 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. From the Service Center, open a service and click the Add to SAP Fiori Project button.

This is custom documentation. For more information, please visit SAP Help Portal. 21
 5/28/25, 12:24 PM

 Note
If your dev space does not have a project, click Create Project and follow the wizard.

The service will be added to the new project.

If you only have one empty project:

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

The .[Link] file is added to the project folder in the file 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. From the Service Center, open a service and click the Add to CAP Project button.

 Note
If your dev space does not have a project, click Create Project and follow the wizard.

The service will be added to the new project.

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

3. (Optional) If you are using a Full Stack Cloud Application project, 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 files appear in the srv external folder of the
project.

A service section appears in the [Link] file of the CAP project, which refers to the srv external
<service_name>.cds file. This file has the metadata of the service:

"<service_name>": {
"kind": "odata",
"model": "srv/external/<service_name>"
"[production]": {
"credentials": {
"destination": "<service_name>",

This is custom documentation. For more information, please visit SAP Help Portal. 22
 5/28/25, 12:24 PM
"path": "<service_path>"
}
},
"csrf": true,
"csrfInBatch": true
}

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

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

Add an External Service to a Java Project

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

1. From the Project Overview, click on the External Resources row to add an external resource to the project.

The Service Center opens.

2. Click on an OData service to open it and click the Add to Project button.

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

The external service is added under the srv external folder.

You can also see the new service in the Project Overview.

The [Link] configuration file is updated for the productive profile and for the local preview, and
includes the new service and its destination.

A Maven dependency named cds-feature-remote-odata, which is required to enable Remote Services for
OData V2 or V4 APIs in the application, is added to the project's [Link] file.

For more information about what is configured by the Service Center when adding the service to your project, see
Configuring Remote Services .

Once the service has been added to the project, you can do the following:

Continue modeling your service. See Project Overview.

Implement a custom handler and consume your external service. See Consuming Remote Services .

Test your project. See Creating Run Configurations for CAP Java Applications.

For more information, see CAP Service SDK for Java .

Unified Customer Landscape Service Provider

The Unified 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.

This is custom documentation. For more information, please visit SAP Help Portal. 23
 5/28/25, 12:24 PM
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 fields:

Property Value

Name Provide a name of your choice.

Type HTTP

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

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

Proxy Type Internet

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

system inbound communication settings.

In the Additional Properties section, you configured the following:

Property Value

[Link] true

WebIDEEnabled true

x-system-type SAP S/4HANA Cloud

This value is displayed in the System Landscape System

Details System Type field 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 field in the SAP BTP cockpit.

Explore Unified Customer Landscape Services

1. Use the Service or Event radio button in the Service Center to filter for the relevant providers.

This is custom documentation. For more information, please visit SAP Help Portal. 24
 5/28/25, 12:24 PM
For more information, 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. From the Select a Provider dropdown list, select Unified Customer Landscape.

3. Select a system to display its packages ( ) under a system.

If the package is available and connected ( ), you can search for services within it.

4. Click a package to display its services.

5. Click a service ( ) to display 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 connected, there's a dot next to the icon ( ).

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

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

 Note
The live data only displays up to 20 rows of data for simple data types.

You can also search for an entity.

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

7. 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

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. From the Service Center, open a service and click the Add to SAP Fiori Project button.

 Note
If your dev space does not have a project, click Create Project and follow the wizard.

The service will be added to the new project.

If you only have one empty project:

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

The .[Link] file is added to the project folder in the file 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

This is custom documentation. For more information, please visit SAP Help Portal. 25
 5/28/25, 12:24 PM
You can select a service from the Service Center and add it as an external service to a CAP Node project:

1. From the Service Center, open a service and click the Add to CAP Project button.

 Note
If your dev space does not have a project, click Create Project and follow the wizard.

The service will be added to the new project.

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

3. (Optional) If you are using a Full Stack Cloud Application project, 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 files appear in the srv external folder of the
project.

A service section appears in the [Link] file of the CAP project, which refers to the srv external
<service_name>.xml file. This file 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 files appear in the srv external folder of the CAP project.

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

Add an External Service to a Java Project

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

1. From the Project Overview, click on the External Resources row to add an external resource to the project.

The Service Center opens.

2. Click on an OData service to open it and click the Add to Project button.

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

The external service is added under the srv external folder.

This is custom documentation. For more information, please visit SAP Help Portal. 26
 5/28/25, 12:24 PM
You can also see the new service in the Project Overview.

The [Link] configuration file is updated for the productive profile and for the local preview, and
includes the new service and its destination.

A Maven dependency named cds-feature-remote-odata, which is required to enable Remote Services for
OData V2 or V4 APIs in the application, is added to the project's [Link] file.

For more information about what is configured by the Service Center when adding the service to your project, see
Configuring Remote Services .

Once the service has been added to the project, you can do the following:

Continue modeling your service. See Project Overview.

Implement a custom handler and consume your external service. See Consuming Remote Services .

Test your project. See Creating Run Configurations for CAP Java Applications.

For more information, see CAP Service SDK for Java .

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.

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.
Creating a Project from the Lobby
You can create projects from the SAP Build lobby.
Creating a Project Using the Wizard
You can create projects based on your development scenario and the extensions installed in the dev space using predefined
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 file system to SAP Business Application Studio.
Project Visibility in SAP Business Application Studio
Projects are displayed in the file explorer within a workspace or as stand-alone folders.

This is custom documentation. For more information, please visit SAP Help Portal. 27
 5/28/25, 12:24 PM
Template Wizard
SAP Business Application Studio allows you to use any type of Yeoman generator including project and module generators.

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.

Accessing the Dev Space Manager

To open the Dev Space Manager, click the relevant link in the Quick Links section of the Get Started page.

You can also open the Dev Space Manager from the lobby.

1. Click the Product Switch icon ( ) on the upper-right corner of the lobby.

2. Select the Dev Space Manager tile.

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 files and settings, are available. If you want to
apply updates to extensions and bug fixes, 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 file 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

This is custom documentation. For more information, please visit SAP Help Portal. 28
 5/28/25, 12:24 PM
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 check mark from extensions you want to remove.

3. Click Save Changes.

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 file 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 file, 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 of disk space.

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 file 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 file:

tar xvzf <[Link]>

This is custom documentation. For more information, please visit SAP Help Portal. 29
 5/28/25, 12:24 PM

Creating a Project from the Lobby

You can create projects from the SAP Build lobby.

Prerequisites

Make sure your administrator has set up your system with the required roles and entitlements as described in Initial Setup.

Procedure
1. Navigate to the SAP Build lobby.

a. Access your subaccount in the SAP BTP cockpit.

b. From the navigation pane, under Services, click Instances and Subscriptions.

c. Under Subscriptions, click SAP Build Code.

2. Click Create to start the creation process.

3. Click the Build an Application tile.

4. Click the SAP Build Code tile.

5. Click the type of application you want to create.

Full-Stack application

SAP Mobile application

SAP Fiori application

6. Provide a name for your project and select the dev space where you want the project to reside. SAP Build Code
recommends the dev space it deems most suitable, but you can go to the Dev Space Manager to select or create a different
one. See Working in the Dev Space Manager.

7. Click Create. In the lobby, a message is displayed showing that your project has been created.

8. Click the project name. The project opens in the Storyboard of SAP Business Application Studio.

Related Information
SAP Build lobby documentation
This is custom documentation. For more information, please visit SAP Help Portal. 30
 5/28/25, 12:24 PM

Creating a Project Using the Wizard

You can create projects based on your development scenario and the extensions installed in the dev space using predefined
templates.

1. Open the wizard in one of the following ways:

From the menu, navigate to File New Project from Template .

Select New Project 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 fixes 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 notifications on the field 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 defined.

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 SAP Help Portal. 31
 5/28/25, 12:24 PM
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 [Link]

Use the Command Palette to Clone a Repository

1. Open the Command Palette.

2. Enter Git: Clone in the input field 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 field.

Importing Projects
Import projects from your local file 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 file 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 file.

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 defined.

Project Visibility in SAP Business Application Studio

Projects are displayed in the file explorer within a workspace or as stand-alone folders.

A workspace is an entity containing your project's settings, debug configurations, and task configurations.

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 SAP Help Portal. 32
 5/28/25, 12:24 PM
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 files are visible in the file 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 file explorer.

Reopening a Workspace

If you already have a workspace in which you want to create your project, click Open Workspace in the file explorer or from the
menu, navigate to File Open Workspace from File... and select the desired workspace file.

Changing the Default Settings

This is custom documentation. For more information, please visit SAP Help Portal. 33
 5/28/25, 12:24 PM
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
fixes 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 notifications on the field 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 defined.

If you do not find 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.

Generative AI-Powered Development

Joule, SAP's innovative AI copilot, enables you to generate data models, services, sample data for your project with simple
language descriptions, as well as an SAP Fiori UI based on your business requirements document. Joule can also update
the application logic and generate and run unit tests.
Guide Center
This tool shows you how to execute common development tasks for specific SAP scenarios.
Explorer
Use the project explorer to browse the contents of your current workspace.
Project Overview
Explore your project's components in a logical view, which simplifies browsing of the contents of your application.
Storyboard
The Storyboard allows you to develop applications using graphical editors and wizards.
Git Source Control

This is custom documentation. For more information, please visit SAP Help Portal. 34
 5/28/25, 12:24 PM
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
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 finished 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.
Outline View
The Outline view displays a symbol tree of the currently active editor. This view is useful for understanding the structure of
a file or for navigating to a specific element in a file.
Problems View
The Problems view displays the coding errors and warnings of all open files 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.

Generative AI-Powered Development

Joule, SAP's innovative AI copilot, enables you to generate data models, services, sample data for your project with simple
language descriptions, as well as an SAP Fiori UI based on your business requirements document. Joule can also update the
application logic and generate and run unit tests.

 Caution
Joule in SAP Business Application Studio improves accuracy by using your project's source code files as context. Therefore,
please ensure these files do not contain any personal data.

Joule Code Assistant

 Note

This feature will reduce your AI quota as it generates the code.

The code is generated using the information on the files in your workspace.

The code is generated using AI and can therefore contain errors and hallucinations, therefore it is important to always
review the code.

The Joule Code Assistant includes the following features:

Auto-complete

When writing code, press tab and the next line of code will be suggested. You can press tab again to accept the entire
line, or you can click Accept Word to accept each segment separately.

This is custom documentation. For more information, please visit SAP Help Portal. 35
 5/28/25, 12:24 PM

 Caution
For high risk sectors: Make sure you are familiar with the source code and that you validate the generated code.

To disable this feature:

1. Go to Manage Settings .

2. Search for Code Assistant.

3. Under the Joule Code Assistant: Tab To Enable Autocomplete section, deselect the Inline code suggestions as you
type checkbox.

Refactoring

1. Select a section of code.

2. Right-click and select Joule Code Assistant Refactor .

Your code will be reorganized and cleaned up to enhance its readability, maintainability, and performance without altering
its functionality.

This is custom documentation. For more information, please visit SAP Help Portal. 36
 5/28/25, 12:24 PM

Code explanation

1. Select a section of code.

2. Right-click and select Joule Code Assistant Add Comments .

Joule will provide an explanation of what the selected code does.

This is custom documentation. For more information, please visit SAP Help Portal. 37
 5/28/25, 12:24 PM

Your code will be reorganized and cleaned up to enhance its readability, maintainability, and performance without altering its
functionality.

Code Search
Enables semantic search for code within your workspace.

1. Open Joule ( ) from the activity bar.

2. At the bottom on the pane, select /code search Search the repository.

This is custom documentation. For more information, please visit SAP Help Portal. 38
 5/28/25, 12:24 PM

3. Use natural language to tell Joule what you are looking for.

This is custom documentation. For more information, please visit SAP Help Portal. 39
 5/28/25, 12:24 PM
4. The first time you perform a search, it may take some moments for the results to appear because the workspace content
needs to be indexed. Click Continue in the notification.

The results show the files relevant to your search criteria.

Now that the workspace has been indexed, the next time you perform a code search, Joule suggests prompts based on your
previous search. You can click on one of the suggested prompts or enter a new one manually.

SAP Business Application Studio indexes any new file added to the workspace.

To disable this feature:

1. Go to Manage Settings .

2. Search for Code Search.

3. Deselect the Code Search: Auto Indexing Enabled checkbox.

Joule Options for Full Stack Projects

Learn about the scenario-specific features for working in your Full Stack Application project using Joule.
Joule Options for UI5 Applications
Use Joule to accelerate and ease the development of freestyle UI5 applications.

Joule Options for Full Stack Projects

Learn about the scenario-specific features for working in your Full Stack Application project using Joule.

Prerequisite: You created a Full-Stack Application project and opened it in SAP Business Application Studio. See Create a Project.

Generate a Data Model or Service with Joule

1. Open Joule ( ) from the activity bar.

2. At the bottom of the Joule view, select one of the slash commands suggested and use natural language to describe your
use case.

This is custom documentation. For more information, please visit SAP Help Portal. 40
 5/28/25, 12:24 PM

This is custom documentation. For more information, please visit SAP Help Portal. 41
 5/28/25, 12:24 PM

3. Click the arrow to send the request.

4. Use the Accept button on bottom of the generated code block to apply the result to your project.

This is custom documentation. For more information, please visit SAP Help Portal. 42
 5/28/25, 12:24 PM

The new entities are displayed in the storyboard.

5. Click (Run and Debug) from the header to preview the project with the added data models, services, and sample data.

Edit your Project with Joule

From the storyboard you can edit your project's data models and services.

1. To open Joule from the storyboard, click the Joule icon in the data model or services tile. The Joule view opens on the
right.

This is custom documentation. For more information, please visit SAP Help Portal. 43
 5/28/25, 12:24 PM
2. Enter a prompt describing how to enhance the project and then click to send the request.

3. Click Accept to apply the result to your project.

The project is updated. You can see the changes reflected in the storyboard.

4. Click (Run and Debug) from the header to preview the project with the updated sample data.

Edit Sample Data with Joule

1. Open the Data Editor.

To open it from the storyboard, select an entity and click the Edit Sample Data icon.

To open it from Joule, click Open Data Editor, and then click an entity from the list.

This is custom documentation. For more information, please visit SAP Help Portal. 44
 5/28/25, 12:24 PM

2. Click Enhance in the top corner of the Data Editor.

Joule opens.

3. Enter a prompt describing how to enhance the existing sample data and then click to send the request. You are shown
the updated code and a summary of the changes.

This is custom documentation. For more information, please visit SAP Help Portal. 45
 5/28/25, 12:24 PM

4. Click Accept to apply the result to your project.

The content in the Data Editor is updated.

5. Click (Run and Debug) from the header to preview the project with the updated sample data.

Update the Application Logic with Joule

1. Follow steps 1-5 of Customize Service Behavior to add an application logic.

2. From the Application Logic Editor, click Open Code Editor Application Logic to navigate to the source code editor.

3. Enter a prompt and then click to send the request.

4. Click Accept to apply the result to your project.

The logic file content is updated.

5. Click (Run and Debug) from the header to preview the project with the updated application logic.

This is custom documentation. For more information, please visit SAP Help Portal. 46
 5/28/25, 12:24 PM

Generate and Run Unit Tests with Joule

1. From the Application Logic Editor, click Open Code Editor Unit Test .

2. Click Yes to enable the test environment.

3. Enter a prompt or leave the default prompt and then click to send the request.

4. Click Accept to apply the result to your project.

The unit test file content is updated.

5. Open the Generative AI-Powered Development guide, expand the Unit Testing Run Unit Test section, and click Run
Test.

All the required npm dependencies are installed and the unit test runs via `npm test`.

Joule Options for UI5 Applications

Use Joule to accelerate and ease the development of freestyle UI5 applications.

Create a Freestyle SAPUI5 Application with Joule

In the Joule view, you can use /ui5 slash commands to invoke tailored Joule functionalities or ask UI5-related questions.

For example, you can ask Joule to create a table for the project.

1. Open the controller or view that was created from the New Project template. This enables the /ui5 slash command
in Joule.

2. Enter a prompt requesting a table. For example: "/ui5 create a table in the main view that
displays the products of the northwind service. Provide data bindings to the
properties of this odata entity."

Joule displays the files that are considered important for executing the task and then suggests the code that should
be added to the [Link] file to include the table. It also provides an explanation of the code at the end of
the suggestion.

3. Accept the code.

4. Preview the application.

Use /ui5-typescript commands to migrate existing JavaScript-based UI5 applications to TypeScript. As soon as the
command is selected, a list of suggestions appears. For more information, see SAPUI5 Meets TypeScript: A Smooth
Migration Journey with Joule .

Use Joule to format the output or to add functionality to the application.

For example, you can ask Joule to format a parameter or add a column to a table. Likewise, you can ask Joule to add
application logic..

Guide Center
This tool shows you how to execute common development tasks for specific SAP scenarios.

The Guide Center tool provides guidance to perform development tasks based on the best practices defined by SAP experts.

This is custom documentation. For more information, please visit SAP Help Portal. 47
 5/28/25, 12:24 PM
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 simplifies 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 SAP Help Portal. 48
 5/28/25, 12:24 PM

Outline
The Outline view displays a symbol tree of the currently active editor. This view is useful for understanding the structure of a file or
for navigating to a specific element in a file.

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 SAP Help Portal. 49
 5/28/25, 12:24 PM

Quick Access
The Quick Access view allows you to open the most used funtions with one click.

Project Overview
Explore your project's components in a logical view, which simplifies browsing of the contents of your application.

 Note
This feature is currently available only in projects of type Full Stack.

All the sections contained in the Storyboard are represented in the Project Overview. Any changes made in the Project Overview
are reflected in the Storyboard and vice versa.

Opening the View

This is custom documentation. For more information, please visit SAP Help Portal. 50
 5/28/25, 12:24 PM

To open the Project Overview, click from the activity bar. A bird's-eye view of the components involved in your application is

displayed.

On the Project Overview title row:

Click to create a new project using a template.

Click to open an existing project.

Project Section
From the Project dropdown list, select the project that you want to see in the tree.

Click the ellipsis at the end of the row to see the available actions for the project.

 Note
Some options are only available if you are working in a Full-Stack Application Using Productivity Tools dev space.

Open Storyboard

Deploy Project

Configure Discovery by SAP Build. See Configure Discovery by SAP Build.

Enable Multitenancy. See Enabling Multitenancy.

Disable / Enable SAP Build Work Zone

Delete - Deletes the namespace together with any entities it may contain.

Data Models
Under Data Models, you can see the namespace and below it the data model entities.

Click on the Data Models row to create a new data model entity.

1. From the dropdown list, choose if you want to create the data model entity in a new or an existing namespace.

If new, provide a name for the namespace.

If existing, select the desired namespace from the list.

2. Click Create.

Click the ellipsis at the end of the row for the namespace or the entity to see the actions available for it.

Services
Under Services, you can see the service entities used in the project.

Click on the Services row to create a new service.

Click the ellipsis at the end of the row for the service or entity to see the actions available for it.

Analytical Models

Under Analytical Models, you can see the SAP HANA calculation views used in the project.

This is custom documentation. For more information, please visit SAP Help Portal. 51
 5/28/25, 12:24 PM
Click on the Analytical Models row to create a new calculation view.

Click the ellipsis at the end of the view row to see the actions available for it.

For more details, see Modeling Calculation Views.

User Interfaces

Under User Interfaces, you can see SAP Fiori or mobile applications used in the project.

Click on the User Interfaces row to create a new UI application. A generator opens based on the type of application
that you want to create.

Click the ellipsis at the end of the UI application row to see the actions available for it.

External Resources
Under External Resources, you can see the external services used in the project.

Click on the External Resources row to add an external resource to the project. The Service Center opens.

1. Follow the instructions in Explore Services Using the Service Center to add the external resource.

Click the ellipsis at the end of the resource's row to see the actions available for it.

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.

The storyboard is available in the SAP Fiori, Full-Stack Application Using Productivity Tools, SAP Mobile Application, 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.

Ask your administrator which is the recommended authentication method for your company. See Connect to Your Git
Source Control System.

This is custom documentation. For more information, please visit SAP Help Portal. 52
 5/28/25, 12:24 PM
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 Simplified Git View and Using the Advanced Git View.

Workflow
Using Git is easy. The basic workflow 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 files, delete files, modify files. 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 conflicts.
If there are conflicts, you can adjust your code.

4. Push: Add your changes to the remote repository.

Disclaimer
Dev space owners are responsible for maintaining any code cloned from source control systems. Open-source repositories are
maintained and supported according to their open-source licenses and documentation.

SAP Business Application Studio supports only specific versions of runtime tools (such as NPM and Java). If your code isn't
supported by the default dev space configurations, you can either use a different runtime version or contact the repository owner
to adjust the code.

Using the Simplified 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 Simplified Git View
In the SIMPLIFIED GIT view, you can add the current changes to the last commit.
Pull Changes in the Simplified 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 Conflicts in the Simplified Git View
Merge operations can fail because of conflicts between the current branch and the branch from which you choose to
incorporate the changes. You can resolve merge conflicts using the SIMPLIFIED GIT view.
Clone a Repository in the Simplified 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 file in
the PENDING CHANGES section.
Create a Branch in the Simplified Git View

This is custom documentation. For more information, please visit SAP Help Portal. 53
 5/28/25, 12:24 PM
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 Simplified 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 files 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 SAP Help Portal. 54
 5/28/25, 12:24 PM

Pull Changes in the Simplified 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.

Resolve Conflicts in the Simplified Git View

Merge operations can fail because of conflicts between the current branch and the branch from which you choose to incorporate
the changes. You can resolve merge conflicts using the SIMPLIFIED GIT view.

1. When there are conflicts, the MERGE FILES section is displayed.

This is custom documentation. For more information, please visit SAP Help Portal. 55
 5/28/25, 12:24 PM

2. Click one of files to resolve the conflict.

A split view is displayed.

3. Choose one of the following options to resolve the merge conflict:

Accept Current Change: Apply the selected line of change from the current branch.

This is custom documentation. For more information, please visit SAP Help Portal. 56
 5/28/25, 12:24 PM
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 conflict resolution and sync your
changes to the remote repository.

Clone a Repository in the Simplified 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

You can discard all selected changes, individually discard or ignore each pending change, or you can open an updated file 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 file, hover over the file containing the changes you want to discard and click .

This is custom documentation. For more information, please visit SAP Help Portal. 57
 5/28/25, 12:24 PM

Ignore Pending Changes Individually

Click (Add to .gitignore) to ignore pending changes individually.

Open Updated File

Click (Open File) to open an updated file.

Create a Branch in the Simplified Git View

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.

This is custom documentation. For more information, please visit SAP Help Portal. 58
 5/28/25, 12:24 PM

Using the Advanced Git View

General overview of the advanced Git view, the SOURCE CONTROL view, in SAP Business Application Studio.

 Note
SAP Business Application Studio opens with the Simplified Git view enabled by default. If you want to use the Advanced Git
view, right-click on the activity bar, deselect Simplified Git, and select Source Control.

This is custom documentation. For more information, please visit SAP Help Portal. 59
 5/28/25, 12:24 PM

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.

The SOURCE CONTROL view is divided into the following sections:

SOURCE CONTROL view menu

Click to toggle between list and tree views.

This is custom documentation. For more information, please visit SAP Help Portal. 60
 5/28/25, 12:24 PM
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 files that will be included in the next commit.

Hover over the section title to see additional actions.

Click to unstage all files in the section.

Hover over the files in this section to see additional actions:

Click to unstage the changes in the file.

Click to open the file.

Changes section

Shows the files that contain changes.

Hover over the section title to see additional actions.

Click to discard all changes.

Click to stage all changes.

Hover over the files in this section to see additional actions:

Click to discard the changes in the file.

Click to open the file.

Click to stage the changes in the file.

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 find 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.

This is custom documentation. For more information, please visit SAP Help Portal. 61
 5/28/25, 12:24 PM

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 conflicting 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 configured. 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.

A red triangle indicates where lines have been deleted.

A green bar indicates new added lines.

A blue bar indicates modified 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 files in your new local repository. This stages them for the first commit.

5. Click (or press <Ctrl> + <Enter> ) to commit the files that you've staged in your local repository.

This is custom documentation. For more information, please visit SAP Help Portal. 62
 5/28/25, 12:24 PM
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.

After this, you find the commit section, which lists the changed files by their name and separates them in two groups:

Staged Changes - A list of the files that have been staged. Click to open the selected file, or to unstage it.

Changes - Files listed under the Changes section contain unstaged changes. Each file name is followed by a path to its
parent directory and an indicator describing the status of the change.

Click to open the selected file, to stage the file, or to refresh it.

The files can be in any of the following statuses:

A - A new file that has been staged.

U - An unstaged file. An unstaged change can be reverted by clicking on the Discard Changes action next to the file
location.

M - A modified file. Double-clicking on a modified file will open it in a diff editor. The read-only editor in the first section
shows the state from the index. The second section of the editor reflects the state of the working tree, and it lets you to
This is custom documentation. For more information, please visit SAP Help Portal. 63
 5/28/25, 12:24 PM
further modify the file.

C - A copied file (if blue) or a conflicted file (if red).

D - A deleted file.

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 files 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 certifies
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.
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 file 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 file.

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.

This is custom documentation. For more information, please visit SAP Help Portal. 64
 5/28/25, 12:24 PM

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 certifies 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.

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 Conflicts

Merge operations can fail because of conflicts between the current branch and the branch you choose from which to incorporate
the changes. To see which files have merge conflicts, navigate to the console or the explorer:

The console displays a list of all files with merge conflicts.

This is custom documentation. For more information, please visit SAP Help Portal. 65
 5/28/25, 12:24 PM

The explorer displays "!" next to any files with conflicts.

When you access a file with conflicts, the conflicts and the options for resolving them are displayed in the file.

Choose from the following options to resolve the merge conflict:

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 first 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.

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 specific 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 define the repository from which you want to pull the changes.

This is custom documentation. For more information, please visit SAP Help Portal. 66
 5/28/25, 12:24 PM
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 conflicts.

Push

1. From the SOURCE CONTROL view menu, click More Actions.

2. Select Push.

Push to
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 file removes it from the branch.

Move your mouse over the file containing the changes you want to discard and click Discard Changes.

 Note
Only unstaged files can be discarded.

Stage and Unstage Changes

This is custom documentation. For more information, please visit SAP Help Portal. 67
 5/28/25, 12:24 PM
You can add or remove all the changes in the Changes section with one click.

Click Stage All Changes to adds all changed files to the list of changes that will be included in the next commit.

Click Unstage All Changes to remove all changed files 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 conflicts, the entry is not removed from the stash list. You need to resolve the conflicts 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

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 file.

View Changes in Local Repository

Clicking a modified file opens a diff viewer. This viewer is split into two sections. The first section is a read-only editor showing the
index state. The second section is an editor for the working-tree state.

This is custom documentation. For more information, please visit SAP Help Portal. 68
 5/28/25, 12:24 PM

View Changes in Different Branches

1. Select a modified file 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 first section is a read-only editor showing the current branch, and the second section shows the file
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 configured the required Cloud Connector and destination in your account.

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: Configuration, 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 configuration for SAP WDF Gerrit system:

This is custom documentation. For more information, please visit SAP Help Portal. 69
 5/28/25, 12:24 PM
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
Cloud Connector
Install the cloud connector
Configure 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
This is custom documentation. For more information, please visit SAP Help Portal. 70
 5/28/25, 12:24 PM
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 indefinitely in a file 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 verification 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 configure these settings for your user authentication in the Preferences page:

[Link]: Enables or disables OAuth authentication for [Link] .

[Link]: If your administrator has not configured a destination for your

subaccount, you can define 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

This is custom documentation. For more information, please visit SAP Help Portal. 71
 5/28/25, 12:24 PM
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 specific directory, right-click the desired file 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
finished application.

 Note
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 find the Controls and
Outline tabs, while on the other side, you will find 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.

This is custom documentation. For more information, please visit SAP Help Portal. 72
 5/28/25, 12:24 PM
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 field at the top of the Controls tab. The relevant sections expand to display the controls 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.

This is custom documentation. For more information, please visit SAP Help Portal. 73
 5/28/25, 12:24 PM

You can find 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 SAP Help Portal. 74
 5/28/25, 12:24 PM

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 SAP Help Portal. 75
 5/28/25, 12:24 PM

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 SAP Help Portal. 76
 5/28/25, 12:24 PM

 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 [Link]
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 SAP Help Portal. 77
 5/28/25, 12:24 PM
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:

[Link]

[Link]

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 SAP Help Portal. 78
 5/28/25, 12:24 PM
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 first 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 SAP Help Portal. 79
 5/28/25, 12:24 PM
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 define the drop position of the dragged control:

Use SHIFT or ALT to define 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 defined 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 defined for it, the Data Binding dialog box opens, where you can define a data
set.

Select the view, and define the data set from the dropdown list.

 Caution
If you change the data set that is defined 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 SAP Help Portal. 80
 5/28/25, 12:24 PM
To bind properties of models that are not OData models, you must work from the source code files and not from the layout
editor. Alternatively, if you do not want to work with the source files 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

Define Entity Set

Before you can bind data to a control, you need to define 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 define an entity set.

2. In the Properties pane, click the icon.

The Select Entity Set dialog box opens.

3. Select and configure one of the entity sets for your control.

 Note
Most users should use either of the first two entity sets listed here.

Use ancestor's entity set.

Define dummy entity set for the selected control.

 Restriction
The "dummy" entity set is only for advanced users.

Define 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 SAP Help Portal. 81
 5/28/25, 12:24 PM
1. On the canvas, select the desired control for which you want to define 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 fields that you want to add to the expression.

The data fields are automatically concatenated to the string in the Expression box.

b. Click Bind or first manually edit the expression string and then click Bind.

In the Properties pane, for a field 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 defined an entity set. For more information, see Define 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 Define entity set and set the
selected control as template., and click Bind.

This control becomes a template.

3. In the Confirmation Needed dialog box, confirm 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 define 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.

b. Click Bind or first manually edit the expression string and then click Bind.
This is custom documentation. For more information, please visit SAP Help Portal. 82
 5/28/25, 12:24 PM
In the Properties pane, for a field 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 file. Other annotation files are not
supported.

Procedure
1. On the canvas, select the desired control for which you want to define 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 first manually edit the expression string and then click Bind.

In the Properties pane, for a field 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

Action List Items Button that is used to fire actions when pressed.

[Link]

This is custom documentation. For more information, please visit SAP Help Portal. 83
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

Action Select Provides a list of predefined items that allows end users to choose options and
additionally trigger some actions.
[Link]

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
[Link]
state directly from the launchpad.

Analytic Map Renders a map based on a GeoJSON source.

[Link]

App The root element of an SAPUI5 mobile application. It inherits from the
NavContainer control and thus provides its navigation capabilities. App provides
[Link]
certain header tags 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.

[Link]

Breadcrumbs Enables users to navigate between items by providing a list of links to previous steps in
[Link] 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.
[Link]

Button Allows users to trigger actions.

[Link]

Calendar Basic calendar that is used for DatePickers.

[Link]

Calendar Legend Legend for the Calendar control. Displays special date colors with their
corresponding description.
[Link]

CalendarLegendItem Item to be displayed in a CalendarLegend.

[Link]

Carousel Navigates through a list of controls by swiping right or left.

[Link]

Check Box Allows the user to select one or multiple items from a list.

[Link]

Component Container Container that embeds a UIComponent in a control tree.

[Link]

Control Configuration Can be used to add additional configuration for filter fields in the SmartFilterBar
control, in order to overwrite the default settings from the OData metadata. For
[Link]
instance, it is possible to change the label, index or control type of a filter field.

Column Allows definition of column-specific properties that are applied when rendering a
List control.
[Link]

This is custom documentation. For more information, please visit SAP Help Portal. 84
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

Column List Item Used with cell aggregation to create rows for the [Link] control.

[Link]

Combo Box Combines a dropdown list with items and a text input field with a button allowing the
user to either type a value directly or choose from a list of predefined items.
[Link]

Custom Data Contains a single key/value pair of custom data attached to an Element.

[Link]

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.
[Link]

 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-specific content in the Tile control.

[Link]

Date Picker Date input control with a calendar used as a date picker.

[Link]

Detail Page An [Link] control that supports certain semantic

buttons that have default semantic-specific properties and are eligible for content
[Link]
aggregation.

Display List Item Used to represent a label and a value.

[Link]

DraftIndicator A draft indicator is [Link].

[Link]

Feed Input Allows the user to enter text for a new feed entry and then post it.

[Link]

Feed List Item Provides a set of properties for text, sender information, and time stamp.

[Link]

Filter Group Item Represents a filter belonging to a group other than basic.

[Link]

Filter Item Represents a filter belonging to the basic group.

[Link]

Flex Item Data Holds layout data for a FlexBox / HBox / VBox.

[Link]

Flex Box Builds the container for a flexible box layout.

[Link]

This is custom documentation. For more information, please visit SAP Help Portal. 85
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

Form Structured into FormContainer controls, each of which consists of FormElement

controls.
[Link]

Form Container Group inside a Form.

[Link]

Form Element Row in a FormContainer control.

[Link]

Fullscreen Page An [Link] control that supports certain semantic

buttons that have default semantic-specific properties and are eligible for content
[Link]
aggregation.

Generic Tile Displays header, subheader, and a customizable main area in a tile format.

[Link]

Geo Map A map control that allows the user to position multiple visual objects on top of a map.

[Link]

Grid Layout that positions its child controls in a 12-column flow layout.

[Link]

Grid Container Data The GridLayout-specific layout data for FormContainers.

[Link]

Grid Data Grid layout data.

[Link]

Grid Element Data The GridLayout-specific layout data for FormElement fields.

[Link]

Group Groups are used to group group elements.

[Link]

Group Configuration Can be used to add additional configurations for groups in the SmartFilterBar. A group
in the SmartFilterBar is a group of filter fields in the advanced search.
[Link]

GroupElement A combination of one label and different controls associated to this label.

[Link]

Group Header List Item Used to display the title of a group and act as a separator between groups in
[Link] and [Link].
[Link]

HBox Builds the container for a horizontal flexible box layout.

[Link]

Horizontal Layout Provides support for horizontal alignment of controls.

[Link]

This is custom documentation. For more information, please visit SAP Help Portal. 86
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

Icon Uses an embedded font instead of a pixel image.

[Link]

Icon Tab Bar Represents a collection of tabs with associated content.

[Link]

Icon Tab Filter Represents a selectable item inside an Icon Tab Bar control.

[Link]

Icon Tab Header Displays a number of Icon Tab Filter and Icon Tab Separator controls.

[Link]

Icon Tab Separator Icon used to separate two Icon Tab Filter controls.

[Link]

Image Wrapper around the IMG tag.

[Link]

Input Allows users to input data.

[Link]

Input List Item List item used for a label and an input field.

[Link]

Invisible Text Used to bring hidden texts to the UI for screen reader support.

[Link]

Item Control base type.

[Link]

Label Used in SAPUI5 mobile applications to provide label text for other controls.

[Link]

Layout Data A layout data base type.

[Link]

Link Used to trigger actions or to navigate to other applications or web pages.

[Link]

List Provides a container for all types of list items.

[Link]

List Item Used in lists or list-like controls, such as DropdownBox.

[Link]

Master Page An [Link] control that supports certain semantic

buttons that have default semantic-specific properties and are eligible for content
[Link]
aggregation.

This is custom documentation. For more information, please visit SAP Help Portal. 87
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

Message Strip Allows the embedding of application-related messages in the application.

[Link]

Nav Container Handles hierarchical navigation between Page controls or other fullscreen controls.

[Link]

Object Attribute Displays a text field that can be normal or active.

[Link]

Object Header Allows the user to easily identify a special object.

[Link]

Object Identifier Display control that allows the user to easily identify a specific object.

[Link]

Object List Item Display control that provides summary information about an object as an item in a list.

[Link]

Object Number Displays number and number unit properties for an object.

[Link]

Object Status Status information that can be either text with a value state, or an icon.

[Link]

Overflow Toolbar Container based on [Link] that provides overflow when its content does
not fit in the visible area.
[Link]

Overflow Toolbar Button Represents an [Link] that shows its text only when in the overflow area of an
[Link].
[Link]

Page Basic container for a mobile application screen.

[Link]

Paging Button Allows users to navigate between items and entities.

[Link]

Pane Container An abstraction of Splitter.

[Link] Could be used as an aggregation of ResponsiveSplitter or other

PaneContainers.

Panel Container for controls that has a header and content.

[Link]

Progress Indicator Shows the progress of a process in a graphical way.

[Link]

Pull To Refresh Triggers the refresh event.

[Link]

This is custom documentation. For more information, please visit SAP Help Portal. 88
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

Radio Button Control similar to CheckBox, but it allows the user to choose only one of a predefined
set of options.
[Link]

Radio Button Group Used as a wrapper for a group of [Link] controls, which then can be
used as a single UI element.
[Link]

Rating Indicator Used to rate content.

[Link]

Responsive Flow Layout Data This is a LayoutData element that can be added to a control if this control is used
within a ResponsiveFlowLayout.
[Link]

Search Field Allows users to input a search string.

[Link]

Segmented Button Horizontal control made of multiple buttons, which can display a title or an image.

[Link]

Segmented Button Item Used for creating buttons for the [Link]. It is derived from the
[Link].
[Link]

Select Provides a list of items that allows the user to select an item.

[Link]

Select List Displays a list of items that allows the user to select an item.

[Link]

Semantic Page An enhanced [Link], that contains controls with semantic-specific

meaning.
[Link]

Semantic Page An enhanced [Link] control that can contain controls with semantic meaning.
Content specified in [Link] semantic control
[Link]
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 [Link] control that supports a Share menu in the
footer.
[Link]

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
[Link]
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
[Link]
control, but the complexity in the API is removed.

Slider User interface control that allows the user to adjust values within a specified numerical
range.
[Link]

This is custom documentation. For more information, please visit SAP Help Portal. 89
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

Smart Chart Creates a chart based on OData metadata and the configuration specified. The
entitySet property must be specified to use the control. This property is used to
[Link]
fetch fields 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
[Link]
context. The OData entity's property that is changed or displayed with the control is
derived from the control's value property.

Smart Filter Bar The SmartFilterBar control uses the OData metadata of an entity in order to
create a FilterBar.
[Link]
Whether a field is visible on the FilterBar, supports type-ahead and value help, for
example, is automatically determined. When you use control configurations and group
configurations it is possible to configure the FilterBar and adapt it according to
your needs.

Smart Form Renders a form ([Link]). When used with the SmartField
control the label is taken from the metadata annotation sap:label if not specified
[Link]
directly.

Smart Link The SmartLink control uses a semantic object to display NavigationPopover for
further navigation steps.
[Link]

 Note
Navigation targets are determined using CrossApplicationNavigation of
the unified shell service.

Smart Table Creates a table based on OData metadata and the configuration specified. The
entitySet attribute must be specified to use the control. This attribute is used to fetch
[Link]
fields 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.
[Link]

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
[Link]
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.
[Link]

This is custom documentation. For more information, please visit SAP Help Portal. 90
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

Standard Tile Displayed in the Tile container.

[Link]

Switch User interface control on mobile devices that is used for switching between binary
states.
[Link]

Table Provides a set of sophisticated and convenient functions for responsive table design.

[Link]

Text Used for embedding longer text paragraphs that need text wrapping into your
application.
[Link]

Text Area Allows multiline text input.

[Link]

Tile Container Container that arranges same-size tiles on carousel pages.

[Link]

Tile Content This control is used within the GenericTile control.

[Link]

Title Used to aggregate other controls.

[Link]

Time Picker A single-field input control that enables the users to fill time related input fields.

[Link]

Toggle Button Control that toggles between pressed and normal state.

[Link]

Toolbar Horizontal container that is usually used to display buttons, labels, selects, and other
input controls.
[Link]

Toolbar Layout Data Defines layout data for the [Link] items.

[Link]
 Note
ToolbarLayoutData should not be used together with
[Link].

Toolbar Separator Creates a visual separator between toolbar items.

[Link]

Toolbar Spacer Adds horizontal space between toolbar items.

[Link]

Upload Collection Allows users to upload single or multiple files.

[Link]

This is custom documentation. For more information, please visit SAP Help Portal. 91
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

Upload Collection Item Provides information about uploaded files.

[Link]

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.
[Link]

VBox Builds the container for a vertical flexible box layout.

[Link]

Vertical Layout Layout in which the content controls are rendered one below the other.

[Link]

XML View A View defined using (P)XML and HTML markup.

[Link]

Outline Tab

The SAPUI5 controls listed here are available only from the Outline tab in the layout editor.

 Note
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

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] A semantic-specific button, eligible for the closeAction aggregation

of the [Link] to be placed in its title.

[Link] A semantic-specific button, eligible for the copyAction aggregation

of the [Link] to be placed in its title.

[Link] A semantic-specific button, eligible for the deleteAction

aggregation of the [Link] to be
placed in its title.

[Link] A semantic-specific button, eligible for the discussInJamAction

aggregation of the [Link] to be
placed in the share menu within its title.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link].

This is custom documentation. For more information, please visit SAP Help Portal. 92
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

[Link] A semantic-specific button, eligible for the editAction aggregation

of the [Link] to be placed in its title.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] A semantic-specific button, eligible for the exitFullScreenAction

aggregation of the [Link] to be
placed in its title.

[Link] A semantic-specific button, eligible for the favoriteAction

aggregation of the [Link] to be
placed in its title.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] A [Link] 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 [Link].

[Link] A semantic-specific button, eligible for the flagAction aggregation

of the [Link] to be placed in its title.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] A semantic-specific button, eligible for the footerMainAction

aggregation of the [Link] to be
placed in its footer.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] A semantic-specific button, eligible for the fullScreenAction

aggregation of the [Link] to be
placed in its title.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] A [Link] 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 [Link].

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
This is custom documentation. For more information, please visit SAP Help Portal. 93
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

[Link] control.

[Link] A semantic-specific button, eligible for the messagesIndicator

aggregation of the [Link] to be
placed in its footer.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] A semantic-specific button, eligible for the negativeAction

aggregation of the [Link] to be
placed in its footer.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] A semantic-specific button, eligible for the positiveAction

aggregation of the [Link] to be
placed in its footer.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] A semantic-specific button, eligible for the printAction aggregation

of the [Link] to be placed in the
share menu within its title.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] A semantic-specific button, eligible for the sendEmailAction

aggregation of the [Link] to be
placed in the share menu within its title.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] A semantic-specific button, eligible for the sendMessageAction

aggregation of the [Link] to be
placed in the share menu within its title.

This is custom documentation. For more information, please visit SAP Help Portal. 94
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link].

[Link] A semantic-specific button, eligible for the shareInJamAction

aggregation of the [Link] to be
placed in the share menu within its title.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] Has default semantic-specific properties and is eligible to be

included in the aggregation content of an
[Link] control.

[Link] A semantic-specific button, eligible for the titleMainAction

aggregation of the [Link] to be
placed in its title.

[Link] Used for header texts and title.

[Link] Renders a token containing text and an optional Delete icon.

[Link] Displays multiple tokens.

[Link] Allows displaying of business card information, including an image,

first title (either URL link or text), second title, and multiple text
lines.

[Link] Displays a comparison chart.

[Link] Comparison tile value holder.

[Link] Extends the [Link] 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.

[Link] 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.

[Link] Provides the user with a RangeSlider control that is optimized

for use with dates.

[Link] Displays a delta of two values as a chart.

[Link] Displays multiple GenericTile controls as changing slides.

[Link] Used in UnifiedThingInspector to display a preview of facet

content.

[Link] Tile control that displays a title, description, and customizable main
area.

[Link] Chart that shows a comparative part to a total.

[Link] Configuration of a slice on a pie chart.

This is custom documentation. For more information, please visit SAP Help Portal. 95
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

[Link] 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.

[Link] Object that contains an instance of a control and information about

its height. It should be used inside
[Link].

[Link] 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 first control and the
End key puts focus on the last control. Use the Enter key or
Spacebar key to choose the control.

[Link] Displays SAP Jam content text, subheader, and numeric value in a
tile.

[Link] Used in UnifiedThingInspector to display object-related KPIs

in a factsheet.

[Link] Displays news content text and subheader in a tile.

[Link] Allows creation and storage of notes for further reference.

[Link] Allows storage of NoteTaker card header and body text.

[Link] Allows entering quick notes and note cards.

[Link] Numeric content to be used in a tile or other place where it is

needed to show numeric values with semantic colors and
deviations.

[Link] Serves as a universal container for different types of content and

footer.

[Link] Located at the top of an application page and consists of four

areas.

[Link] Allows users to trigger actions such as save or print. For the button
UI, you can define text or an icon, or both.

[Link] Provides a box that can be flagged and has a label. A checkbox can
either stand alone, or be in a group with other checkboxes.

[Link] Allows the user to choose a color. The color can be defined using
HEX, RGB, or HSV values, or a CSS colorname.

[Link] Framework that generates an input field and a button with the text
Browse....

[Link] Represents a user interface area that is the entry point for menus
with their menu items.

[Link] Common button control that opens a menu when chosen by the
user. The control provides an API for configuring the docking
position of the menu.

This is custom documentation. For more information, please visit SAP Help Portal. 96
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

[Link] Provides navigation between pages within a list of numbered pages.

[Link] Represents a container with scroll functionality that can be used

for text and controls.

[Link] Text field with masked characters that borrows its properties and
methods from the TextField control.

[Link] Shows the progress of a process in a graphical way.

[Link] Consists of a round element and descriptive text.

[Link] Interactive control that is displayed either as a horizontal or vertical

line with two pointers and units of measurement.

[Link] Allows the user to rate a certain topic.

[Link] Provides a group of buttons.

[Link] Interactive control that is displayed either as a horizontal or vertical

line with a pointer and units of measurement.

[Link] Allows splitting the screen into two areas.

[Link] Control for entering or displaying multiple rows of text.

[Link] Renders an input field for text input.

[Link] Horizontal row of items where in many cases the single toolbar
items are buttons that contain icons.

[Link] Simple tree for displaying an item in a hierarchical way.

[Link] Tree node element.

[Link] Builds the container for a layout with a fixed and a flexible part.

[Link] Base layout used to render a Form control.

[Link] Renders a Form control using an HTML table-based grid.

[Link] Renders a Form control using a responsive grid.

[Link] Renders a Form control with a responsive layout.

[Link] A responsive splitter which divides the application into several

areas.

[Link] Text view that displays currency values and aligns them at the
separator.

[Link] Framework that generates an input field and a button with the text
Browse ....

[Link] Represents a parameter for the FileUploader, which is rendered

as a hidden input field.

[Link] Interactive element that provides a choice of different actions to

the user.

This is custom documentation. For more information, please visit SAP Help Portal. 97
 5/28/25, 12:24 PM

SAPUI5 Control Name Description

[Link] 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.

[Link] Opened in front of an [Link] control.

[Link] Provides a main content and a secondary content area.

[Link] Consists of two sections: a toolbar and a content area where

arbitrary controls can be added.

[Link] Unit that is embedded, standalone or multiple, into a Feed control.

[Link] Lean common feed, or a comment feed, with a text commit

function.

[Link] Static part of an Object page header.

[Link] 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 field at the top of the IDE allowing you to enter a command. Content assist then allows you to find
commands quickly.

Some commands will lead you into a minimal text-based wizard, allowing you to enter additional parameters.

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.

This is custom documentation. For more information, please visit SAP Help Portal. 98
 5/28/25, 12:24 PM
By default, SAP Business Application Studio defines only one Java, one [Link], and one Python version that is officially supported.
The default installed versions are the Long Term Support (LTS) versions. You can check the currently installed version in your dev
space, using the following command in the terminal:

For Java: java -version

For [Link]: node --version

For Python: python --version

You can manually install and select a different version.

Install a Runtime Version

1. From the command palette, select Runtime: Install,

2. Select 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 Certificate to Java command via the command palette to allow connectivity to on-premise Java
repositories during the maven build.

Set a Default Runtime Version

1. From the command palette, select Runtime: Set default.

2. Select 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.

Outline View
The Outline view displays a symbol tree of the currently active editor. This view is useful for understanding the structure of a file or
for navigating to a specific element in a file.

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 SAP Help Portal. 99
 5/28/25, 12:24 PM

Problems View
The Problems view displays the coding errors and warnings of all open files 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.

This is custom documentation. For more information, please visit SAP Help Portal. 100
 5/28/25, 12:24 PM

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.

To open the Find widget within a file, press Ctrl+F.

This is custom documentation. For more information, please visit SAP Help Portal. 101
 5/28/25, 12:24 PM
Find and Replace

You can find text and replace in the currently opened file. 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 file, you can press Enter and Shift+Enter to navigate to next or
previous result when the find input box is focused.

When the Find Widget is open, it will automatically populate the selected text in the editor into the find 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 find operations are run on the entire file 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.

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 files

You can search over all files in the currently opened folder. Press Ctrl+Shift+F and enter your search term. Search results are
grouped into files containing the search term, with an indication of the hits in each file and its location. Expand a file to see a
preview of all of the hits within that file. 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 file 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.

This is custom documentation. For more information, please visit SAP Help Portal. 102
 5/28/25, 12:24 PM
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 files)

[] 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 files to exclude box. The toggle determines whether to
exclude files that are ignored by your .gitignore files and/or matched by your [Link] and [Link]
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 files. Expand the Search input field to display the Replace one.

When you enter text into the Replace input field, you will see a diff display of the pending changes. You can replace across all files
from the Replace input field, replace all in one file 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

This is custom documentation. For more information, please visit SAP Help Portal. 103
 5/28/25, 12:24 PM
Once you have finished coding, you can test and run your application.

Creating Run Configurations

Create run configurations that define 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 specific 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 [Link] runtime and can debug JavaScript,
TypeScript, or any other language that gets transpiled to JavaScript.
Stopping a Process
An application may continue to run in the background even if the debugger or and the explorer show it has been stopped.

Creating Run Configurations

Create run configurations that define how your project or unit test is executed.

SAP Business Application Studio provides default run configurations for your projects. You can create and configure additional run
configurations that define how your project or unit test is executed. You can also create a new run configuration by duplicating an
existing run configuration and then editing it.

Clicking (Run and Debug) from the header provides one of the following options:

If there is a default run configuration that's created during project creation, this configuration runs.

If you add a new configuration and run it, this configuration runs.

If you add multiple configurations, the last configuration that you ran runs.

If you have run configurations from multiple projects, you can choose which configuration to run.

Related Information
SAP Fiori tools- Create a New Run Configuration in SAP Business Application Studio

Creating Run Configurations for CAP Java Modules

Creating Run Configurations for CAP Node Applications

Creating Run Configurations for Java Modules

Create new run configurations 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 specific Cloud Foundry
services.

Prerequisites

This is custom documentation. For more information, please visit SAP Help Portal. 104
 5/28/25, 12:24 PM
Your project must include an [Link] file that points to the Java module.

The Java module's [Link] file must include the following definition: packagingType= war.

Add a New Configuration

1. Click from the activity bar to open the Run Configurations view.

2. Click + (Create Configuration).

3. Select the Java module as the runnable object.

A new configuration is added to your [Link] file.

 Note
Any manual change performed to the [Link] file is reflected in the configuration tree.

Bind Dependencies

In the Run Configurations view, you can see the resources that are defined in the MTA descriptor. You can bind or unbind these
resources to a specific 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

HaaS (if configured as "Available for all IPs")

xsuaa

destination

connectivity

auditlog

application-logs

To bind the resource:

1. Open the Run Configurations view.

2. Select the desired configuration.

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.

This is custom documentation. For more information, please visit SAP Help Portal. 105
 5/28/25, 12:24 PM
5. Select the desired service.

The resource is bound to the service.

This updates the resource's configuration files. See the Advanced Options section to see the changes made to the configuration
files.

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 configuration files.

To unbind the resource:

1. Open the Run Configurations view.

2. Select the desired configuration.

3. Select the desired resource.

4. Click (unbind).

Run a Configuration
1. If you bound your service to a service that requires Chisel to run:

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 configuration.

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 configuration 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 configuration, see the Advanced Options section.

Stopping a configuration from the Run and Debug view doesn't stop any running tasks.

This is custom documentation. For more information, please visit SAP Help Portal. 106
 5/28/25, 12:24 PM

Edit a Run Configuration

1. Right-click a relevant run configuration to do the following:

Configure Environment - Open the environment file to view the binding configuration.

Rename - Provide a new name for the selected run configuration.

Show in File - Open the JSON file containing the set of configuration properties, with the name highlighted.

Delete - Delete the set of configuration properties from the JSON file.

Delete a Run Configuration

1. Right-click a run relevant configuration and choose Delete.

 Note
If you delete the launch configuration, it's removed from the [Link] file but the tasks remain.

Advanced Options

In addition to the [Link] file that is created as part of the new configuration, the following files are added or updated when
creating a run configuration:

Environment configuration file

A new environment file is created. After the resource is bound to a service, the file is populated with all the environment
variables required to connect to Cloud Foundry.

The environment configuration file is referenced from your Launch configuration.

New tasks in the [Link] file

The following tasks are added to the [Link] file:

A technical generic task. This is the configuration's prelaunch task.

This task enables you to define additional tasks to run before starting the configuration (using the dependsOn
property).
This is custom documentation. For more information, please visit SAP Help Portal. 107
 5/28/25, 12:24 PM

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 configuration directory

When you create a new configuration, a new Tomcat runtime configuration directory is created containing the following
configuration files:

[Link] (user/.tomcat/<configuration_name>/Catalina/localhost)

For example, /home/user/.tomcat/bookshop-srv-1/conf/Catalina/localhost

[Link] (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 configurations at the same time, you need to configure
a different port for the additional Tomcat in the [Link] file. In addition, you need to change the default ports
8009 and 8005 defined in this file to other ports to avoid collision.

You also need to define a debug port (that isn't the default 8000), both in the 'run-tomcat' task in the [Link]
file, and in the matching launch configuration in the [Link] file, which are all associated with the same run
configuration.

You can modify the content of this directory to configure Tomcat as desired for this run configuration. 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 configuration.

The environment configuration file is updated with the chisel and the selected service parameters.

The Tomcat configuration files 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:

This is custom documentation. For more information, please visit SAP Help Portal. 108
 5/28/25, 12:24 PM
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, [Link]
[Link]/

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, [Link]

e=[Link]

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 specific 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.

Configuring Port Notification Settings

You can define which ports should omit a notification 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 Notifications click Edit in [Link].

5. Specify the port or range of ports for which you do not want to show a notification.

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-defined
targets using the CLOUD FOUNDRY: TARGETS view.

This is custom documentation. For more information, please visit SAP Help Portal. 109
 5/28/25, 12:24 PM

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 defined 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.

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 fits 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. From the activity bar, click .

This is custom documentation. For more information, please visit SAP Help Portal. 110
 5/28/25, 12:24 PM
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 fits 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.

2. Select the folder where the .env file will be created. This file 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.

This is custom documentation. For more information, please visit SAP Help Portal. 111
 5/28/25, 12:24 PM
Select a different space within the current organization.

Once you have set up your targets, you can define 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.

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>

This is custom documentation. For more information, please visit SAP Help Portal. 112
 5/28/25, 12:24 PM

SAP ID Service Custom IdP Corporate IdP

Authorization flow OAuth Resource Owner OAuth Resource Owner OAuth Authorization Code
Password Password Grant (browser flow) + One-
Time Passcode

For more information, see this blog .

Debugging
SAP Business Application Studio has built-in debugging support for the [Link] runtime and can debug JavaScript, TypeScript, or
any other language that gets transpiled to JavaScript.

Debugging a File

To debug a [Link] file:

1. Open the Run and Debug view.

2. Open the dropdown list to select the relevant configuration.

A list of configuration options is displayed.

This is custom documentation. For more information, please visit SAP Help Portal. 113
 5/28/25, 12:24 PM
3. Select [Link]. A launch configuration file ([Link]) is created automatically. You can configure and save debugging
setup details in this file.

This file contains 3 configurations:

Launch Program

Create JavaScript Debug Terminal

Run Current File

4. To add a new configuration to an existing [Link], from the dropdown list, select Add Configuration.

5. From the dropdown list, select Run Current File or Launch Program (which provides you the option to skip node internal
files).

You can run your configuration through the command palette, by filtering on Debug: Start Debugging.

 Note
Note that the attributes available in launch configurations vary from debugger to debugger.

Debugging Modes

There are two core debugging modes, Launch and Attach.

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.

Stopping a Process
An application may continue to run in the background even if the debugger or and the explorer show it has been stopped.

If this happens, you will get a notification stating that the port is in use.

This is custom documentation. For more information, please visit SAP Help Portal. 114
 5/28/25, 12:24 PM
To correct this:

1. Open the command palette and select Ports: Stop the process running on the port.

2. Select the relevant port.

 Note
This action cannot be reversed. Make sure you select the correct port.

Build and Deploy

Use our dedicated tools to build and deploy your application.

Prerequisites

1. You've logged in to your Cloud Foundry account, see Login to Cloud Foundry.

2. To create an SAP HANA Cloud instance for seamless business application development and deployment:

You've added the SAP HANA Cloud, SAP HANA Schemas & HDI Containers entitlement to your subaccount. For
details on adding entitlements to your subaccount, see Configure Entitlements and Quotas from Your Subaccount
(you'll be directed to the SAP Business Technology Platform documentation).

You've created an SAP HANA Cloud database instance from SAP HANA Cloud Central.

For details on subscribing to SAP HANA Cloud Administration Tools and accessing SAP HANA Cloud Central, see
Subscribing to the SAP HANA Cloud Administration Tools (Multi-Environment) (you'll be directed to the SAP HANA
Cloud documentation).

For details on creating an SAP HANA Cloud database instance from SAP HANA Cloud Central using cf CLI, see
Using the Cloud Foundry Command Line interface (cf CLI) with SAP HANA Cloud (you'll be directed to the SAP
HANA Cloud documentation).

 Note
When using a trial account, use the default values for each step of the SAP HANA Database instance setup
wizard, except for the SAP HANA Database Advanced Settings step.

Set Allowed connections to Allow all IP addresses and select Review and Create.

For details on managing your SAP HANA Cloud instance, see Managing SAP HANA Database Instances (you'll be
directed to the SAP HANA Cloud documentation).

3. If you are subscribed to the Free or the Trial plan, make sure you also have the following:

You've added the SAP Build Work Zone, standard edition entitlement to your subaccount and
subscribed to SAP Build Work Zone, standard edition on Service Marketplace. For details, see Initial
Setup (you'll be directed to the SAP Build Work Zone documentation).

 Note
If you already have the entitlement and subscription for SAP Build Work Zone, advanced edition, you don't need
the subscription and entitlement for SAP Build Work Zone, standard edition.

You've assigned the Launchpad_Admin role collection to the user. For details on assigning role collections to users,
see Assigning Role Collections to Users or User Groups (you'll be directed to the SAP Business Technology Platform
This is custom documentation. For more information, please visit SAP Help Portal. 115
 5/28/25, 12:24 PM
documentation).

You've added the Cloud Foundry Runtime entitlements to your subaccount. For details on adding entitlements to
your subaccount, see Configure Entitlements and Quotas from Your Subaccount (you'll be directed to the SAP
Business Technology Platform documentation).

 Note
You can adjust the units of Cloud Foundry Runtime assigned to your subaccount depending on your business
requirements.

Deployment Options

Use the SAP Business Application Studio development tools for working with multitarget applications. See MTA Development.

You can also find documentation for scenario-specific 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 specific SAP scenarios.

 Note
This feature is only available when the dev space extensions provide scenario-specific tasks.

The Task Explorer allows you to create and edit scenario-specific tasks using a dedicated user interface. You can store your
configurations and reuse them.

1. From the left sidebar, click to open the Task Explorer view.

2. Click +.

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 Configure. The task is created in the [Link] file 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

This is custom documentation. For more information, please visit SAP Help Portal. 116
 5/28/25, 12:24 PM
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

The Cloud MTA Build Tool is a standalone command-line tool that builds a deployment-ready multitarget application (MTA) archive
.mtar file from the artifacts of an MTA project according to the project’s MTA development descriptor ([Link] file), or from
the module build artifacts according to the MTA deployment descriptor ([Link] file).

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 .

This is custom documentation. For more information, please visit SAP Help Portal. 117
 5/28/25, 12:24 PM

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 file.

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 [Link] file 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.

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 define resources, properties, and dependencies, as well as fill 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 [Link] file and helps you avoid dealing with the complex and sensitive syntax of YAML files.

To open the visual MTA Editor:

1. Right-click the desired [Link] file.

2. Choose Open With MTA Editor .

 Note

This is custom documentation. For more information, please visit SAP Help Portal. 118
 5/28/25, 12:24 PM
The visual MTA editor removes comments and formats the file. If you want to add comments, use the code editor. To open the
code editor, double-click on the desired [Link] file or right-click the file and choose Open With Code Editor .

If you edit the file 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 [Link] file.

2. Choose Build MTA Project.

From the command palette.

1. Enter MTA.

2. Choose Build MTA Project.

3. Select the desired [Link] file.

 Note
If there’s only one [Link] available, the build starts automatically.

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 Configure to edit the build configuration 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 configuration for later use.

This is custom documentation. For more information, please visit SAP Help Portal. 119
 5/28/25, 12:24 PM
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 file).

 Note
If you changed the default configurations using the Task Explorer, the output will correspond to the specified 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) file.

There are several ways for deploying multitarget applications to SAP Cloud Foundry:

From the context menu.

1. Right-click on the relevant MTAR file.

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 file.

 Note
If there’s only one MTAR file available, the deployment starts automatically.

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 Configure to edit deployment configuration parameters.

6. Save your changes.

Use the Task Explorer to change the default MTA deploy options. In the Task Explorer, you can save this configuration for
later use.

From the CLI. See Deploy Commands .

This is custom documentation. For more information, please visit SAP Help Portal. 120
 5/28/25, 12:24 PM
The terminal opens showing the output of the deploy process.

Continuous Integration and Delivery

Configure and run predefined continuous integration and delivery (CI/CD) pipelines that automatically build, test, and deploy your
code changes to speed up your development and delivery cycles without leaving SAP Business Application Studio.

Prerequisites

Make sure you have run the Get Started with SAP Build Code booster. See Initial Setup

Make sure your project is connected to a Git repository.

Set up the connection between the Git repository, the CI/CD service, and your SAP BTP target deployment environment as
described in the Configuration topic.

In the SAP BTP cockpit, navigate to Connectivity Destinations and make sure you have a destination for the CI/CD
service. If you subscribed to SAP Build Code not using the booster, you need to perform the configuration manually. See
Configure the Configure the SAP Continuous Integration and Delivery Service.

Working in the CI/CD View

The CI/CD view in SAP Business Application Studio, allows you to see all jobs configured 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.

From the CI/CD JOBS view menu bar, you can click (Settings) to open the Settings page, or + to add a new job.

1. Open SAP Business Application Studio.

2. From the menu, navigate to View Command Palette .

3. Search for Guide Center: Create a CI/CD Job. Select the guide and follow the instructions.

Each job is configured using a [Link] file 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 [Link] file in the code editor.

This is custom documentation. For more information, please visit SAP Help Portal. 121
 5/28/25, 12:24 PM
Delete the job.

Click Delete to remove the job from the SAP Continuous Integration and Delivery service and the configuration file is
deleted from the repository. This affects all users working in the repository.

Configure the SAP Continuous Integration and Delivery Service

Create and configure a destination for the CI/CD service.

Perform the following configuration steps to use SAP Continuous Integration and Delivery in SAP Build Code:

1. In the SAP BTP cockpit, navigate to Connectivity Destinations .

2. Click Create Destination.

3. In the Destination Configuration section, provide the following delatils:

Property Value

Name cicd-backend

Type HTTP

Description [Do not delete] SAP Continuous Integration

and Delivery

URL To find this value:

a. Navigate to the Instances and Subscriptions >

Instances section.

b. Search for the default_cicd-service instance,

and click View Credentials at the upper right corner of
the page.

The Credentials dialog box is displayed containing the required

values.

Proxy Type Internet

Authenticiation OAuth2JWTBearer

Client ID To find this value:

a. Navigate to the Instances and Subscriptions >

Instances section.

b. Search for the default_cicd-service instance,

and click View Credentials at the upper right corner of
the page.

The Credentials dialog box is displayed containing the required

values.

Token Serive URL Type Dedicated

Token Serive URL To find this value:

a. Navigate to the Instances and Subscriptions >

Instances section.

This is custom documentation. For more information, please visit SAP Help Portal. 122
 5/28/25, 12:24 PM

Property Value

b. Search for the default_cicd-service instance,

and click View Credentials at the upper right corner of
the page.

The Credentials dialog box is displayed containing the required

values.

Additional Property WebIDEEnabled true

Additional Property [Link] true

Use default JDK truststore Enabled

4. Click Save.

5. Go to Security Role Collections to make sure you have been assigned the following roles:

Business_Application_Studio_Developer

Business_Application_Studio_Administrator

CICD Service Developer

CICD Service Administrator

If you are missing any role, Follow the procedure below to assign it to your user:

 Note
You must be an administrator of your global account and subaccount on SAP BTP to assign roles.

a. In your subaccount in the SAP BTP cockpit, choose Security Trust Configuration .

b. Choose the name of your identity provider.

c. Enter the e-mail address of the user to which you want to assign a role collection.

d. Choose Show Assignments.

e. If the user is new to the subaccount, choose Add User in the Confirmation dialog.

f. Choose Assign Role Collection.

g. From the dropdown list, select the role you want to assign and confirm your choice with Assign Role Collection.

 Note
When you assign roles or remove role assignments, it can take up to 60 minutes for changes to take effect. Log off and
then log on again for changes to take effect immediately.

6. Refresh your browser for the changes to take effect.

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:

This is custom documentation. For more information, please visit SAP Help Portal. 123
 5/28/25, 12:24 PM
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.

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 Configure 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 [Link] to
[Link]

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 configuration. 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.

 Restriction
This extension works only on a host machine (for example, Windows, Mac, or Linux). It will not work from a remote machine
such as WSL or a remote container.

Prerequisites

Make sure you have installed the SAP Business Application Studio toolkit extension.

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 in the VS Code
marketplace.

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 configurations that are not available on your local OS.

This is custom documentation. For more information, please visit SAP Help Portal. 124
 5/28/25, 12:24 PM
Connect to your different centrally managed SAP environments (for example, Developer Hub, subaccount destinations,
etc.) via the SAP Business Application Studio Service Center.

Develop directly on SAP BTP.

Separate your development environment to avoid impacting your local machine configuration.

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 SAP Business Application Studio toolkit extension from the Visual Studio marketplace. This extension pack
will automatically install the Remote Access for SAP Business Application Studio extension as well.

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.

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.

This is custom documentation. For more information, please visit SAP Help Portal. 125
 5/28/25, 12:24 PM
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 .

 Note
You can only have 2 dev spaces running at a time.

The dev space opens in a new tab.

This is custom documentation. For more information, please visit SAP Help Portal. 126
 5/28/25, 12:24 PM

Working with a Trial Account

Get a trial account to experience SAP Build Code 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 Build Code is available on Trial in the US10 region.

There are restrictions that apply to SAP Build Code trial accounts. See Trial Plan Restrictions.

Initial Setup in the Trial Landscape

Perform these preparatory steps to set up your trial system for creating your business applications in SAP Build Code.

Initial Setup in the Trial Landscape

Perform these preparatory steps to set up your trial system for creating your business applications in SAP Build Code.

Prerequisites
You have an SAP BTP Trial account in the US10 region.

Subscribe to SAP Build Code

 Tip

This is custom documentation. For more information, please visit SAP Help Portal. 127
 5/28/25, 12:24 PM
The correct way to subscribe to SAP Build Code is using the booster and not the manual setup.

1. Access your global account in the SAP BTP cockpit and click Go To Your Trial Account.

2. Choose Boosters from the navigation pane.

3. Search for the Get started with SAP Build Code booster.

4. Open the booster to see the overview, components, and additional resources, and click Start .

The booster checks for required authorizations, compatible providers, and regions.

 Note
The Get started with SAP Build Code booster does not set up an SAP HANA Cloud database instance automatically.
You need to manually create an instance. See Create an SAP HANA Database Instance Using SAP HANA Cloud Central.

5. After running the booster, on the popup window, choose Navigate to Subaccount.

6. From the navigation pane, select Services Instances and Subscriptions .

7. Under the Subscriptions tile, choose SAP Build Code.

The SAP Build lobby appears.

Accessing SAP Build Code

1. From the subaccount's navigation pane, select Services Instances and Subscriptions .

2. Under the Subscriptions tile, choose SAP Build Code.

The SAP Build lobby appears.

Administration
Learn about the tasks for setting up your system to develop applications using SAP Build Code.

Service Plans
SAP Build Code provides 3 types of application plans in SAP BTP enterprise accounts: standard, free, and trial.
Manage Authorizations and Roles
The subaccount administrator can assign the user a role for developing with SAP Build Code or for managing data.
Regional Availability
Get an overview of the regional availability of SAP Build Code and AI Core provider.

Service Plans
SAP Build Code provides 3 types of application plans in SAP BTP enterprise accounts: standard, free, and trial.

When setting up SAP Build Code, select the booster for the plan you want to use.

All plans provide tools tailored for developing key scenarios such as: SAP S/4HANA extensions, full stack business applications,
SAP Fiori applications, and more.

This is custom documentation. For more information, please visit SAP Help Portal. 128
 5/28/25, 12:24 PM
Use the standard plan for productive development with pre-configured SAP services. It includes preinstalled runtimes.

Use the free plan for evaluation purposes. Restrictions apply to the development environments. Only community support is
available for free tier service plans and these are not subject to SLAs.

Use a trial account for evaluation purposes for a 3-month period. Restrictions apply to the development environments.
Only community support is available for trial service plans and these are not subject to SLAs.

Different restrictions apply for each of these plans:

Standard Plan Restrictions

Free Plan Restrictions

Trial Plan Restrictions

Changing Service Plans

Learn about the options for moving to different service plans.

Select your current service plan and your target service plan so learn about your options.

For detailed information on the supported migration scenarios, please refer to the following table:

Service Current Plan Target Plan Explanation

SAP Business free build-code-free In the cockpit, go to your subaccount

Application Studio and run the Get Started with SAP Build
Code (Free Plan) booster. See Initial
Setup.

SAP Business free build-code Follow the instructions in the Upgrading

Application Studio your service to the build-code plan
section.

SAP Business standard-edition build-code-free This scenario is not supported.

Application Studio

SAP Business standard-edition build-code Follow the instructions in the Upgrading

Application Studio your service to the build-code plan
section.

SAP Business build-code-free build-code Follow the instructions in the Upgrading

Application Studio from the Free to the Standard Plan
section.

SAP Business build-code-free free Follow the instructions in the Changing

Application Studio to a Different Plan section.

 Note
This will remove the following:

Lobby

Joule features

All the dev spaces and their

content

This is custom documentation. For more information, please visit SAP Help Portal. 129
 5/28/25, 12:24 PM

Service Current Plan Target Plan Explanation

SAP Business build-code standard-edition Follow the instructions in the Changing

Application Studio to a Different Plan section.

SAP Mobile Services free build-code Follow the instructions in the Upgrading
your service to the build-code plan
section.

SAP Mobile Services resources build-code Follow the instructions in the Upgrading
your service to the build-code plan
section.

SAP Mobile Services standard (deprecated build-code Follow the instructions in the Upgrading
plan) your service to the build-code plan
section.

SAP Mobile Services b2c (deprecated plan) build-code Follow the instructions in the Upgrading
your service to the build-code plan
section.

SAP Mobile Services build-code standard (deprecated plan) Changing the service plan to a
deprecated plan is not recommended.

SAP Mobile Services build-code resources Follow the instructions in the Upgrading
your service to the build-code plan
section.

SAP Mobile Services build-code free This scenario is not supported.

SAP Document free standard Follow the instructions in the Upgrading

Management Service, your service to the build-code plan
Integration Option section.

SAP Document standard build-code Follow the instructions in the Upgrading

Management Service, your service to the build-code plan
Integration Option section.

SAP Document build-code standard Follow the instructions in the Changing

Management Service, to a Different Plan section.
Integration Option

SAP Document standard free This scenario is not supported.

Management Service,
Integration Option

SAP Document build-code free This scenario is not supported.

Management Service,
Integration Option

SAP Document standard build-code Follow the instructions in the Upgrading

Management Service, your service to the build-code plan
Application Option section.

SAP Document build-code standard Follow the instructions in the Changing

Management Service, to a Different Plan section.
Application Option

SAP Cloud Transport free build-code Follow the instructions in Updating the
Management service Service Plan in the SAP Cloud Transport
Management Service documentation.

This is custom documentation. For more information, please visit SAP Help Portal. 130
 5/28/25, 12:24 PM

Service Current Plan Target Plan Explanation

SAP Cloud Transport standard build-code Follow the instructions in Updating the
Management service Service Plan in the SAP Cloud Transport
Management Service documentation.

Upgrading your service to the build-code plan

Prerequisites

Make sure you have a subscription to SAP Build Code.

1. In the navigation area, choose Service Marketplace.

2. Search for Build Code.

3. Under Application Plans, click the 3 dots in the line for the standard plan, and click Create.

Procedure

1. Open your global account in the cockpit.

2. Go to your subaccount.

3. In the navigation area, choose Entitlements.

4. Click Edit.

5. Click Add Service Plans.

6. Search for your service, and under Available Plans select build-code (Application).

This is custom documentation. For more information, please visit SAP Help Portal. 131
 5/28/25, 12:24 PM
7. Click Add 1 Service Plan.

8. 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.

9. Search for your service.

10. Select the ellipsis at the end of the subscription row, and from the menu, click Update.

11. In the wizard that opens, select the build-code plan, and click Update Subscription.

Upgrading from the Free to the Standard Plan

1. In the SAP BTP cockpit, navigate to the subaccount containing the SAP Build Code subscription.

2. If you have Cloud Foundry, under the Cloud Foundry Environment section, click Disable Cloud Foundry.

 Caution
Doing this will delete all the spaces in the subaccount.

3. Navigate back to the global account, and run the Get Started with SAP Build Code booster. See Initial Setup.

This is custom documentation. For more information, please visit SAP Help Portal. 132
 5/28/25, 12:24 PM

Changing to a Different Plan

1. Open your global account in the cockpit.

2. Go to your subaccount.

3. In the navigation area, choose Entitlements.

4. Click Edit.

5. Click Add Service Plans.

6. Search for your service, and under Available Plans select the plan to which you want to move.

Manage Authorizations and Roles

The subaccount administrator can assign the user a role for developing with SAP Build Code or for managing data.

Role collections are user-related authorizations that restrict access to resources and services based on defined user permissions.
They consist of individual roles. The roles are based on role templates. For SAP Build Code, there are 2 relevant role templates
available: Build Code Administrator and Build Code Developer.

To allow development using SAP Build Code, you must assign the Build Code Developer role to the developer.

To allow administrator operations such as exporting and deleting user data using SAP Build Code, you must assign the
Build Code Administrator role to the user.

 Note
It is recommended to limit the number of administrators with full management permissions.

This is custom documentation. For more information, please visit SAP Help Portal. 133
 5/28/25, 12:24 PM
The Developer and Administrator role collections together with their corresponding role templates are created automatically when
you subscribe to SAP Build Code.

 Note
If you want to perform both administrator and developer tasks, you must have both roles assigned.

Prerequisites
Your subaccount must be subscribed to SAP Build Code.

You must be a subaccount administrator to assign roles.

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 a role collection that was created automatically when you subscribed to SAP Build Code.

4. Click Edit.

5. Enter the email address of the user who you want to give permissions to in the ID field.

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 field.

8. Click Save.

To assign permissions to groups, follow the instructions in the Map Role Collections to User Groups topic.

Regional Availability
Get an overview of the regional availability of SAP Build Code and AI Core provider.

SAP Build Code links to the service subscription in the SAP BTP cockpit. It operates in the same region and is hosted by the same
IaaS provider as your subaccounts on SAP BTP. However, the AI Core service, which is essential for Generative AI-powered
development Generative AI-Powered Development capabilities, is only available in some SAP BTP regions. As a result, you might
need to cross-consume AI Core from a different IaaS provider or region.

Regional Availability of SAP Build Code

BAS IaaS BAS Consumer BAS Consumer AI Core Provider AI Core Provider AI Core IaaS Planned
Provider Region Region Region Name Region Region Name Provider Availability

Microsoft Azure ap10 Australia ap10 Australia Amazon Web Available

(Sydney) (Sydney) Services

Amazon Web ap11 Singapore ap10 Singapore Amazon Web Available

Services Services

Google Cloud ap30 Australia ap30 Australia Google Cloud Available

Platform (Sydney) (Sydney) Platform

Microsoft Azure br20 Brazil (Sao br10 Brazil - Sao Amazon Web 03.2025
Paulo) Paulo Services

This is custom documentation. For more information, please visit SAP Help Portal. 134
 5/28/25, 12:24 PM

BAS IaaS BAS Consumer BAS Consumer AI Core Provider AI Core Provider AI Core IaaS Planned
Provider Region Region Region Name Region Region Name Provider Availability

Amazon Web ca10 Canada us21 US East Microsoft Azure 03.2025

Services (Montreal)

Amazon Web eu10 Europe eu10 Europe Amazon Web Available

Services (Frankfurt) (Frankfurt) Services

Microsoft Azure eu20 Europe eu20 Europe Microsoft Azure Available

(Netherlands) (Netherlands)

Google Cloud eu30 Europe eu30 Europe Google Cloud Available

Platform (Frankfurt) (Frankfurt) Platform

Amazon Web jp10 Japan (Tokyo) jp10 Japan (Tokyo) Amazon Web Available
Services Services

Microsoft Azure jp20 Japan (Tokyo) jp10 Japan (Tokyo) Amazon Web 03.2025
Services

Amazon Web us10 US East (N. us10 US East (N. Amazon Web Available
Services Virginia) Virginia) Services

Microsoft Azure us20 US West us10 US East (N. Amazon Web 02.2025
(Washington) Virginia) Services

Microsoft Azure us21 US East us21 US East Microsoft Azure Available

Google Cloud us30 US Central us30 US East (N. Google Cloud Available
Platform (Iowa) Virginia) Platform

Security
Learn about the security mechanisms in place for the different services composing SAP Build Code.

The following links lead to the security information for each of the SAP Build Code services:

SAP Business Application Studio, Standard Edition

SAP Cloud Transport Management

SAP Continuous Integration and Delivery

SAP Document Management – Applications

SAP Document Management - Repository

SAP Mobile Services

SAP Business Technology Platform, Cloud Foundry runtime

Alert Notification

CP Cloud Logging - Standard Plan

Event Broker

Feature Flag Service

This is custom documentation. For more information, please visit SAP Help Portal. 135
 5/28/25, 12:24 PM
SAP Build Work Zone foundation

Destination

Connectivity Service

SAP Authorization and Trust Management

SaaS Provisioning Service

HTML5 Applications

Application Autoscaler Service

Data Protection and Privacy

SAP Build Code stores anonymized user IDs for billing purposes only.

This anonymized information will be deleted once it is no longer required for billing or quota purposes.

This is custom documentation. For more information, please visit SAP Help Portal. 136