6/11/25, 2:39 PM

SAP Business Technology Platform

Generated on: 2025-06-11 14:39:27 GMT+0000

SAP Business Technology Platform (SAP BTP) | Cloud

Public

Original content: https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b?locale=en-

US&state=PRODUCTION&version=Cloud

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 https://help.sap.com/docs/disclaimer.

This is custom documentation. For more information, please visit SAP Help Portal. 1
 6/11/25, 2:39 PM

Getting Started
Once you're familiar with the basic concepts of SAP BTP, you can start your first workflows or check out further resources that
help you get started quickly.

Onboarding Guides
The SAP BTP Administrator's Guide helps you plan your development projects on SAP BTP from onboarding to SAP Cloud Identity
Services, through setting up the correct organizational structure, to creating an account and security model, to developing and
operating applications.

The SAP BTP Developer’s Guide helps you define the correct methodologies and tools for your development project.

Getting Started Workflows

Learn how to get a global account and get started with a trial or an enterprise account on SAP BTP. A trial account lets you try out
SAP BTP for free, and within an enterprise account, you can use so-called free tier service plans for free. See Trial Accounts and
Free Tier.

Depending on your use case, follow the appropriate workflow:

Getting a Global Account

Getting Started in the Cloud Foundry Environment

Getting Started in the ABAP Environment

Getting Started in the Kyma Environment

Additional Resources
The SAP Developer Center provides further resources to get you started:

SAP Discovery Center

SAP BTP in SAP Developer Center

Start Developing on SAP BTP Tutorials

Related Information
SAP BTP Administrator's Guide
SAP BTP Developer's Guide
Access the Cockpit

Development
Develop and run business applications on SAP Business Technology Platform (SAP BTP) using our cloud application programming
model, APIs, services, tools, and capabilities.

This is custom documentation. For more information, please visit SAP Help Portal. 2
 6/11/25, 2:39 PM
SAP BTP supports multiple environments. It features a number of tools and programming languages that increase your flexibility
and freedom when developing applications. You can choose the environment that best suits your use cases and skill set and get to
work. You also have the possibility to integrate applications you’ve built with other solutions by SAP.

Environment options

Cloud Foundry Kyma ABAP

Benefits Simplified developer Take full advantage of the ABAP programming language
experience for business advanced features and rich
Fast prototyping with ABAP
application development ecosystem of Kubernetes
RESTful Programming Model
Large choice of programming Free choice of programming (RAP)
languages languages and models
Integrated development
(containerized deployments)
Intuitive “code-to-container” lifecycle
packaging and deployment, Combines microservices and
Reuse existing on-prem ABAP
managed by the platform serverless functions
assets
Platform-managed application Built-in, managed service mesh
security patching and updates based on Istio, and other cloud-
native open-source modules to
Automatic application routing,
reduce the development effort
load balancing, health checks,
and multilevel self-healing Built-in, managed event mesh

Support for CAP – an Managed infrastructure: day-2

opinionated business app operations, security patches,
development framework and updates

Full administrator access

Refined horizontal and vertical

automatic scalability

Dedicated application runtime

Zero downtime infrastructure

setup by default

Support for CAP – an

opinionated business app
development framework

Support for on-premise

connectivity

Additional Comparison: SAP BTP, Kyma Runtime Comparison: SAP BTP, Kyma Runtime Development in the ABAP
Information and SAP BTP, Cloud Foundry Runtime and SAP BTP, Cloud Foundry Runtime Environment

Shared
No infrastructure vendor lock-in
Benefits
Build scalable multitenancy business applications (SaaS)

Out-of-the-box consumption of SAP and hyperscaler services

Built on industry standards and open technology

Good For Managed build-on approach Open build-on approach User-centric process
extensions
Enterprise-grade business Enterprise-grade applications
applications and services Robust, transactional cloud
Cloud-native development of
applications
apps and services

This is custom documentation. For more information, please visit SAP Help Portal. 3
 6/11/25, 2:39 PM

Cloud Foundry Kyma ABAP

Cloud-native web applications Low latency infra-services Migrating and adapting add-
and services communication ons to the cloud

Scalable, microservice-based Reduced infrastructure Reusing existing on-premise

applications management effort ABAP code

Small to medium extensions Highly scalable, microservice- Enabling ABAP developers to

built with CAP/low-code based applications go to the cloud
tooling
Applications built with CAP

Skills Any major programming Kubernetes knowledge Ability to write modern ABAP
languages code
Docker
SAP Fiori/UI5 and SAP HANA Core data services
NodeJS or Python for
serverless functions SAP Fiori/UI5 and SAP HANA

Any major programming

language

SAP Fiori/UI5 and SAP HANA

We provide detailed information about developing, configuring, and deploying your applications depending on your preferred
environment and development approach.

Development in the Cloud Foundry Environment

Learn more about developing applications on the SAP BTP, Cloud Foundry environment.
Development in the ABAP Environment
Learn more about developing applications in the ABAP environment.
Development in the Kyma Environment
Learn more about developing applications in SAP BTP, Kyma runtime.

Related Information
SAP BTP Administrator's Guide
Developing with the SAP Cloud Application Programming Model
Consuming Services in SAP BTP

Extensions
The extension capabilities of SAP Business Technology Platform (SAP BTP) enables developers to implement loosely coupled
extension applications securely, thus implementing additional workflows or modules on top of the existing SAP cloud solution they
already have.

Unified Customer Landscape

The Unified Customer Landscape service provides capabilities for automated extensibility and integration of SAP and third-party
systems.

All standard SAP solutions are offered with customizing capabilities. Additionally, customers often have their own requirements for
innovative or industry-specific extensions and the extension capabilities of SAP BTP can help them build, deploy, and operate their
new functionality.

This is custom documentation. For more information, please visit SAP Help Portal. 4
 6/11/25, 2:39 PM
You can extend standard SAP solutions without disrupting their performance and core processes. When building extension
applications, you can also benefit from the automation of the integration between the cloud platform and the extended SAP
solutions.

You can also benefit from an automated integration between SAP systems or between SAP systems and a specific service in SAP
BTP.

Using the Unified Customer Landscape service, you can maintain your customer landscape. The frontend representation of this
service is the System Landscape page in the SAP BTP cockpit. The dedicated SAP S/4HANA Cloud Extensibility and SAP
SuccessFactors Extensibility services are also part of the Unified Customer Landscape capabilities. See Maintaining Unified
Customer Landscape.

To get a full list of terms related to the extensibility and integration concepts in the Unified Customer Landscape area, see
Extensibility and Integration Concepts.

Registering and Deregistering Systems

To connect a system with a global account in SAP BTP, you need to have the system listed in the System page.

Adding, Registering and Deregistering Systems

Integrating SAP Solutions

You can integrate several systems and services as part of the common business scenario. To do that, you create a formation in the
SAP BTP cockpit that includes all systems that the scenario requires. Every formation has a type related to its purpose. Using
formations is a standard way to enable the communication between systems.

See Integrating SAP Solutions.

Extending SAP Solutions

The extension capabilities of SAP BTP provide a standard way for extending SAP solutions and developing event-driven extensions
and applications. This framework includes:

Simplified, standardized and unified extensibility and configuration for the SAP solutions.

Central catalog per customer for all connected SAP systems where data such as APIs, events, credentials and other is
stored. You can benefit from business services and actionable events across end-to-end business processes.

You have the following options to extend your SAP solution using the SAP SuccessFactors Extensibility or SAP S/4HANA Cloud
Extensibility services:

Extensions with automated configurations in the Cloud Foundry runtime: applicable for SAP S/4HANA Cloud, SAP
Marketing Cloud, and SAP SuccessFactors.

Extensions with automated configurations in the Kyma runtime: applicable for SAP S/4HANA Cloud, SAP Marketing Cloud,
SAP SuccessFactors, SAP Cloud for Customer, SAP Commerce Cloud, and SAP Field Service Management.

If you have to group the systems of different SAP solutions in the same business case, you can set up the connectivity between all
these systems and a global account in SAP BTP in a single formation in the SAP BTP cockpit. See Automating Integrations Using
Formations.

See Extending SAP Solutions.

This is custom documentation. For more information, please visit SAP Help Portal. 5
 6/11/25, 2:39 PM

Troubleshooting
If you encounter a problem when extending an SAP S/4HANA Cloud or an SAP SuccessFactors system, go through the following
troubleshooting information first:

Troubleshooting for SAP S/4HANA Cloud Extensibility Service

Troubleshooting for SAP SuccessFactors Extensibility Service

Related Information
SAP BTP Developer's Guide: Extending Existing SAP Solutions Using SAP BTP

Maintaining Unified Customer Landscape

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

Unified Customer Landscape is a service that offers customer landscape management capabilities. The frontend representation of
this service is the System Landscape page in the SAP BTP cockpit. The dedicated SAP S/4HANA Cloud Extensibility and SAP
SuccessFactors Extensibility services are also part of the Unified Customer Landscape capabilities.

Customer Landscape Discovery

The System Landscape page of the SAP BTP cockpit gives you a visual overview of your SAP and third-party systems associated
with the given global account or a subaccount. There are different ways to add systems in the Systems Systems page:
manually or automatically. If a system of your solution is associated with your global account or through a subscription in SAP BTP
cockpit associated with a given subaccount, it will appear in the list automatically. Otherwise, you have to add your system
manually. Systems are added to the list in one of the following ways:

Auto-Discovered

An auto-discovered system is a system (associated with the given global account) that has been discovered and added
automatically to the list based on information of the existing system landscape. Any SAP system of the supported system
types that is associated with the same customer ID, with which your global account in SAP BTP is associated, will be added
automatically in the system landscape list.

Subaccount/<my-subaccount>

Specifies that the system has been added through a subscription in SAP BTP cockpit associated with a given subaccount.
The subscription has been discovered and added automatically through the subaccount.

Manually-Added

Specifies that the system has been added to the list manually by the global account administrator, using the Add System
button and completing the wizard. The system has been associated with the global account in SAP BTP.

See Adding, Registering and Deregistering Systems.

Integration and Extensibility

This is custom documentation. For more information, please visit SAP Help Portal. 6
 6/11/25, 2:39 PM
Unified Customer Landscape also helps you integrate and extend your SAP S/4HANA Cloud, SAP Ariba, SAP SuccessFactors, and
other SAP and third-party systems in one single experience.

In the SAP BTP cockpit, you get a comprehensive overview of all your systems associated with your customer ID. These systems
can be registered or auto discovered. They are conveniently listed as a record in the Systems list. Moreover, Unified Customer
Landscape lets you integrate one or more systems in a common business case by including these systems in a formation.

See:

Automating Integrations Using Formations

Extending SAP S/4HANA Cloud in the Cloud Foundry and Kyma Environment

Extending SAP Marketing Cloud in the Cloud Foundry and Kyma Environment

Extending SAP SuccessFactors in the Cloud Foundry and Kyma Environment

Extending SAP Customer Experience Products in the Kyma Environment

Extensibility and Integration Concepts

When implementing your extensibility scenario, there are a couple of concepts you need to understand to be able to benefit from
the functionality that SAP BTP offers.

Systems

A system is a specific instance of an SAP or third-party solution that is manually added or auto discovered and is listed in the
System Landscape Systems page in the SAP BTP cockpit.

When you want to add functionality to your SAP or third-party solution, you start by developing an extension application and
deploying it in SAP BTP. Then, to allow the application to access the SAP or third-party solution, you add the system of this solution
to the Systems page of the SAP BTP cockpit. If the system is one of the following types, you also have to register it using a
registration token:

SAP S/4HANA Cloud

SAP Marketing Cloud

SAP SuccessFactors

System Details

Status

The registration process can have the following status values:

No status

The system has been added as a record to the list. You can get a registration token for it. However, the registration process
on the corresponding solution's system side has not been performed or completed yet.

Registered

The registration token has been used and the automated registration process has been completed successfully. Now, the
system can be used in extensibility business scenarios.

Error while Registering

This is custom documentation. For more information, please visit SAP Help Portal. 7
 6/11/25, 2:39 PM
The registration has failed.

Deregistering

A deregistration process has started. As a result, the connectivity between the system and SAP BTP is disabled and
extension scenarios cannot be established. The system remains in the system landscape list and you can register it again
later on.

Error while Deregistering

The deregistration has failed.

Removing

A system removal process has started in the SAP BTP cockpit. You can remove a system from the list only when this
system:

Hasn't been registered yet

Has been deregistered first

Has been manually added

Then, you can remove the system from the Systems list completely. To register the system again, first, you must add it to
the list anew, and then, initiate the registration procedure.

Error while Removing

The system removal has failed.

Consumption Bundles, APIs, and Events

Consumption bundles group logically APIs and events intended for communication with the SAP or third-party system. This
grouping means that the consumption of the APIs or the events can happen by using the same set of credentials later on. When
you register a system, you can also preview the number and the content of consumption bundles that are exposed for
communication with the given system.

After you add your third-party systems, you can specify the set of APIs and events in consumption bundles. A consumption bundle
organizes a set of related APIs and events into a single group for consumption purposes and expresses information about how the
APIs and events that it contains can be accessed. All APIs and events that are part of the same consumption bundle need to be
accessible through the same set of credentials. You add the consumption bundles in System Details of the respective third-party
system.

You can explore the consumption bundles, the APIs, and the events configured for your system in System Details. To do that, go to
the respective tab: Consumption Bundles, APIs, or Events.

URL

You can use the URL as an entry point to the corresponding system. Optionally, you can use it to identify duplicate systems added
to the list.

Discovery Mechanisms

There are different ways to add systems to the Systems page in the SAP BTP cockpit: manually or automatically. If a system of
your solution is associated with your global account or through a subscription in SAP BTP cockpit associated with a given
subaccount, it will appear in the list automatically. Otherwise, you have to add your system manually. Systems are added to the list
in one of the following ways:

Auto-Discovered

This is custom documentation. For more information, please visit SAP Help Portal. 8
 6/11/25, 2:39 PM
An auto-discovered system is a system (associated with the given global account) that has been discovered and added
automatically to the list based on information of the existing system landscape. Any SAP system of the supported system types
that is associated with the same customer ID, with which your global account in SAP BTP is associated, will be added
automatically in the system landscape list.

 Note
If a given SAP system is missing on the Systems page, it may be associated with a different customer ID on the SAP BTP global
account you are working in. In this case, you need to add the system manually, and then, register it.

Subaccount/<my-subaccount>

Specifies that the system has been added through a subscription in SAP BTP cockpit associated with a given subaccount. The
subscription has been discovered and added automatically through the subaccount.

Manually-Added

Specifies that the system has been added to the list manually by the global account administrator, using the Add System button
and completing the wizard. The system has been associated with the global account in SAP BTP.

Business Type

When you have an auto-discovered SAP system, you can find information in the respective system details whether this system is
used for test or production purposes for example. This information is loaded automatically and is presented in the Business Type
field.

Actions

These are the things you can do with a system:

Adding

Adding a system to the list in the Systems page is just the first step of the system registration process. When you have only added
a system, the system is not yet registered in the global account in SAP BTP. It appears in the system landscape list as a record with
empty (or initialized) status. That is, the required configuration on the system side has not been performed, and therefore, the
newly added system cannot exchange or expose its technical details, metadata, APIs, or events. Only when the registration process
is complete and the system is registered with SAP BTP, it can exchange the relevant information and enable the extension
scenario.

Registering

When registering an SAP system of type SAP SuccessFactors, SAP S/4HANA Cloud, SAP Marketing Cloud and SAP systems from
the SAP Customer Experience portfolio, the required configuration on the system side has been performed, and therefore, the
newly added system can exchange or expose its technical details, metadata, APIs, or events. Only when the registration process is
complete and the system is registered with SAP BTP, it can exchange the relevant information and enable the extension or
integration scenario.

The registration of the newly added systems is based on a registration token. The token is used for the pairing of the system and
the corresponding global account. After you add a system, you can get the token in the SAP BTP cockpit. Then, you can use it to
configure the integration on the corresponding system side. By using the registration token on the system side and registering the
system, the system administrator allows the integration of the system with SAP BTP.

The system gets a Registered status, only when a token is issued and the registration is complete on the corresponding system
side. In general, the Registered status means that the communication between the system and SAP BTP has been established.
However, depending on the system and its requirements, additional configuration might be needed for the enablement of a fully

This is custom documentation. For more information, please visit SAP Help Portal. 9
 6/11/25, 2:39 PM
functional extension scenario. The additional configuration, depending on the system type, is outlined in the corresponding
documents listed in the Related Information section. See Adding, Registering and Deregistering Systems.

For system types different than SAP SuccessFactors, SAP S/4HANA Cloud, SAP Marketing Cloud and SAP systems from the SAP
Customer Experience portfolio, when adding a system in the Systems page, this system is registered directly but no status is
displayed.

Refreshing

To ensure you have all your auto-discovered systems listed in the Systems page, choose Refresh. Refreshing the Systems list pulls
all the systems and it might take some time.

Specifics When Registering SAP S/4HANA Cloud Systems

When you register an SAP S/4HANA Cloud system, you can automate some of the required configuration steps at a later point
using communication scenario groups. The communication scenario groups are entities that are part of the registration token that
you use to register your SAP S/4HANA Cloud systems and are associated with one or more communication scenarios in SAP
S/4HANA Cloud.

For example, you can use the Event Mesh communication scenario group when you get the registration token for the SAP
S/4HANA Cloud system. This allows the automatic enablement of the communication scenario SAP_COM_0892 after the
corresponding system is added to the formation of type Eventing Between SAP Cloud Systems.

You can configure the communication scenario groups when registering an SAP S/4HANA Cloud system in the SAP BTP cockpit, in
System Landscape Systems . See Register an SAP S/4HANA Cloud System in a Global Account in SAP BTP.

Merging

You have added your SAP systems manually at a given point in time and you have registered them. Then, you notice that you have
the exact same systems in the list in the Systems page only this time they are auto-discovered and are not registered. To avoid
duplicates and streamline the list of systems, you can merge the auto-discovered SAP systems with your manually added systems.
The logic automatically detects duplicates based on their URL and system type. Note that you can only merge auto-discovered
SAP systems without assigned status in a target system that has already been registered. That is, you cannot merge registered
auto-discovered systems. See Mergе SAP Systems.

Deregistering

Deregistering a system means that the connectivity between this system and the global account is disabled and extension
scenarios cannot be established. You can deregister a system from the Actions column, or from the System Details page that you
access when selecting the system from the System list. See Deregister or Removе a System.

Removing

Removing a system means that this system is no longer part of the system landscape list. To remove a system from the list, first
you have to deregister it. You can remove a system from the Actions column, or from the System Details page that you access
when selecting the system from the System list. See Deregister or Removе a System.

You can see the discovery mechanism and access all the actions related to the systems listed in the SAP BTP cockpit, in System
Landscape Systems . See Adding, Registering and Deregistering Systems.

Formations
A formation is a logical grouping of SAP or third-party systems that can be extended in a business scenario. Formations allow you
to combine SAP or third-party solution systems and a subaccount in SAP BTP to simplify the connectivity setup and to provide a

This is custom documentation. For more information, please visit SAP Help Portal. 10
 6/11/25, 2:39 PM
unified view of all components required for the implementation of your extension scenario. To create a fully functional formation,
you can use a two-step wizard. At the first step, you specify a custom formation name and assign a subaccount to it. At the second
step, you can include an SAP or third-party solution system in the formation. You do this configuration once and you can change it
anytime.

Extension business cases often involve extending several SAP or third-party solutions at a time. For example, for a given business
case you might need to extend the functionality or the UI as follows:

An SAP SuccessFactors system, and an SAP S/4HANA Cloud system. First, you need to configure the connectivity of each
of these systems to Cloud Foundry, Kyma, or both environments. Extension applications of both solutions are part of the
same business need.

An SAP Commerce Cloud system, and an SAP S/4HANA Cloud system. Again, you first configure the connectivity of each
of these systems to the Kyma environment.

A single system of the supported SAP or third-party solutions.

SAP or third-party systems that expose event data, which can be shared and exchanged with the systems included in the
formation.

When creating a formation in the System Landscape Formations page in the SAP BTP cockpit, you include the systems of
the different SAP or third-party solutions you want to extend. If your business case features more than one system, you can use
the corresponding button to include additional systems in the formation. You can start the dialog as many times and add systems
to your formation as you want.

Systems Details in a Formation

Consumption Bundle APIs

A consumption bundle can group logically a set of APIs for communication with the SAP or third-party system.

Consumption Bundle Events

A consumption bundle can group logically a set of events for communication with the SAP or third-party system.

Types

The formation type defines the use case. Therefore, depending on the use case, you have different formation types. To a get a list of
the available formation types, see Integrating SAP Solutions.

Formation Status

A formation can have the following status values:

Ready

The formation has been added as a record to the list and all registered systems are included successfully.

Draft

Not all the systems were included when creating the formation. Include all the missing systems and choose Finalize
Formation.

Action Required

The formation has been created but you cannot use it productively yet.

This is custom documentation. For more information, please visit SAP Help Portal. 11
 6/11/25, 2:39 PM
Based on the formation type and the subaccount that you specified, it might require an SAP BTP, Kyma environment
instance or an SAP Business Application Studio subscription. Although the SAP BTP cockpit allows you to create such a
formation, to enable and make use of it, you must also create the respective instance or subscription.

Synchronizing

Systems that are included in the formation are currently synchronizing in the background.

Error

An error occurred while some of the systems that are included in the formation were synchronizing in the background.

Actions

Creating Formations

Create a logical grouping of the systems that you want to extend.

Including/Excluding Systems in a Formation

Include additional systems to a given formation or exclude already included systems from a formation.

If your business case features more than one system, you can include additional systems in the formation. You can include as
many systems as you want to your formation.

Resynchronizing Systems in a Formation

When you include systems in a formation, these systems are synchronized in the background. If an error occurs, you can
resynchronize these systems to restart the synchronization process. To do that, choose Resynchronize for the particular
formation. You will have this action available only for formations that are in status Error.

Reseting and Resynchronizing Systems in a Formation

If you want to reconfigure the systems in a formation from scratch without excluding them, you have to choose Reset and
Resynchronize. You will have this action available only for formations that have Ready status and their formation type is Side-by-
Side Extensibility with Kyma.

Finalizing a Formation

You can finalize a formation that is in Draft state which means that not all the required systems were included when creating the
formation. When you include all the missing systems, choose Finalize Formation.

Deleting Formations

Detach the systems, unassign the subaccount, and delete the formation at one go.

When you start a formation deletion process, first the systems are excluded from the formation, then, the subaccount is
unassigned, and last, the formation is deleted from the list completely.

You can create and configure formations in the SAP BTP cockpit, in System Landscape Formations . See Automating
Integrations Using Formations.

Adding, Registering and Deregistering Systems

This is custom documentation. For more information, please visit SAP Help Portal. 12
 6/11/25, 2:39 PM
To connect an SAP system with a global account in SAP BTP, you need to register the system. You can also add and work with a
third-party systems.

Prerequisites
You are a global account administrator, or you are a system landscape administrator of the global account where you want
to register your SAP system. See Working with Role Collections.

Before adding your system, make sure it's not already auto-discovered and listed automatically in the System Landscape
Systems page.

Registering SAP Systems

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

For some system types, such as SAP SuccessFactors, SAP S/4HANA Cloud, SAP Marketing Cloud and SAP systems from the SAP
Customer Experience portfolio, adding a system to the list in the Systems page is just the first step of the system registration
process. When you have only added a system, the system is not yet registered in the SAP BTP global account. That is, the required
configuration on the system side has not been performed, and therefore, the newly added system cannot exchange or expose its
technical details, metadata, APIs, or events. Only when the registration process is complete and the system is registered with SAP
BTP, it can exchange the relevant information and enable the extension scenario.

If your system is associated with the given global account, this system is discovered and added automatically to the Systems page
based on information of the existing system landscape. Any SAP system that is associated with the same customer ID, with which
your global account in SAP BTP is associated, will be auto-discovered.

 Note
If a given SAP system is missing on the Systems page, it may be associated with a different customer ID on the SAP BTP global
account you are working in. In this case, you need to add the system manually, and then, register it.

 Note
You cannot migrate the registered SAP systems between global accounts.

If you want to start using another global account, you will have to register your SAP systems again.

For systems of type SAP SuccessFactors, SAP S/4HANA Cloud, SAP Marketing Cloud and SAP systems from the SAP Customer
Experience portfolio, the registration of the newly added systems is based on a registration token. The registration token is used
for the pairing of the system and the corresponding global account. After you add a system, you can get the token in the SAP BTP
cockpit. Then, you can use it to configure the integration on the corresponding system side. By using the registration token on the
system side and registering the system, the system administrator allows the integration of the system with SAP BTP.

When you add an SAP system of type SAP SuccessFactors, SAP S/4HANA Cloud, SAP Marketing Cloud and SAP systems from the
SAP Customer Experience portfolio, it appears in the system landscape list as a record with empty (or initialized) status. The
system gets a Registered status, only when a token is issued and the registration is complete on the corresponding system side. In
general, the Registered status means that the communication between the system and SAP BTP has been established. However,
depending on the system and its requirements, additional configuration might be needed for the enablement of a fully functional
extension scenario. The additional configuration, depending on the system type, is outlined in the corresponding documents listed
in the Related Information section.

This is custom documentation. For more information, please visit SAP Help Portal. 13
 6/11/25, 2:39 PM

 Note
When registering SAP systems of the same type, you can have up to 1000 tokens per global account ready to be used. Tokens
that are already used to register an SAP system are not included in this number.

This means that you cannot have more than 1000 systems in the Systems list of the same type with an empty status and
generated token that is not used yet.

For system types different than SAP SuccessFactors, SAP S/4HANA Cloud, SAP Marketing Cloud and SAP systems from the SAP
Customer Experience portfolio, when adding a system in the Systems page, this system is registered directly but no status is
displayed.

The registration process has the following states displayed in the cockpit:

No status displayed in the Status column - the registration token for an SAP system of type SAP SuccessFactors, SAP
S/4HANA Cloud, SAP Marketing Cloud or SAP systems from the SAP Customer Experience portfolio has been created but
the registration on the respective SAP system side has not been performed or completed yet. For systems with type other
than SAP SuccessFactors, SAP S/4HANA Cloud, SAP Marketing Cloud and SAP systems from the SAP Customer
Experience portfolio are registered when added to the Systems page but no status has been displayed. Only systems that
require a registration token to be registered have the status Registered when this token has been used.

Registered - the registration token for systems of type SAP SuccessFactors, SAP S/4HANA Cloud, SAP Marketing Cloud
and SAP systems from the SAP Customer Experience portfolio has been used and the automated registration process has
been successfully completed. The systems of these types can be assigned to a formation on the Formations page in the
cockpit. All other system types are registered without a registration token and can be assigned to a formation.

Error while Registering - the registration has failed.

 Note
If a system is in status Error while Registering, delete it and register it again.

If the registration error persists, report a case in one of the following components depending on the system type:

SAP SuccessFactors - BC-NEO-EXT-SF

SAP S/4HANA Cloud - BC-NEO-EXT-S4C

All other system types - BC-CP-MP

 Note
When registering a system or creating a formation, the data you provide in the given input fields is not encrypted with your
customer managed key. The data you enter is only encrypted at rest.

Procedure

1. In the cockpit, navigate to your global account, and then choose System Landscape Systems .

2. On the Systems page, choose Add System.

 Note
Before adding your system, make sure it's not already auto-discovered and listed automatically in the Systems page.
Some of the SAP systems have additional configurations described in dedicated procedures. See:

Register an SAP S/4HANA Cloud System in a Global Account in SAP BTP

This is custom documentation. For more information, please visit SAP Help Portal. 14
 6/11/25, 2:39 PM
Register an SAP Marketing Cloud System in a Global Account in SAP BTP

Register an SAP SuccessFactors System in a Global Account in SAP BTP

Register an SAP Customer Experience System

3. In the Add System wizard:

a. In the Type dropdown list, select the system type.

b. Enter a name for the system you want to register.

 Note
Use only printable ASCII characters.

 Tip
We recommend that you indicate the type of the system when specifying the system name. For example,
<mysystem>-commerce-cloud. This helps you identify the system type when assigning systems to a
formation.

c. Choose Add.

d. For systems of type SAP SuccessFactors, SAP S/4HANA Cloud, SAP Marketing Cloud and SAP systems from the
SAP Customer Experience portfolio, choose Get Token.

A registration token is generated for this system.

Systems of type different than SAP SuccessFactors, SAP S/4HANA Cloud and SAP systems from the SAP Customer
Experience portfolio don't need a registration token, they are automatically registered when added to the Systems
page. Their status is empty but you can consider them as registered.

e. Copy the registration token. You need the token to complete the integration on the respective SAP solution system
side.

f. Close the wizard.

Result

The system has been added as a record to the list on the Systems page in the SAP BTP cockpit. For systems of type SAP
SuccessFactors, SAP S/4HANA Cloud and SAP systems from the SAP Customer Experience portfolio, a registration token for
connecting the corresponding SAP solution with the global account in SAP BTP has been generated. Systems of type other than
SAP SuccessFactors, SAP S/4HANA Cloud and SAP systems from the SAP Customer Experience portfolio, are automatically
registrated, no additional configurations are required.

 Note
Registration tokens have different validity periods that depend on the system type. For more information about token expiry,
see the corresponding documentation at the Related Links section.

Next Steps

For SAP systems of type SAP SuccessFactors, SAP S/4HANA Cloud, SAP Marketing Cloud and SAP systems from the SAP
Customer Experience portfolio, use the registration token to complete the registration on the respective SAP system side.
See:

Trigger the Registration in the SAP S/4HANA Cloud Tenant

This is custom documentation. For more information, please visit SAP Help Portal. 15
 6/11/25, 2:39 PM
Trigger the Registration in the SAP Marketing Cloud Tenant

Register an SAP SuccessFactors System in a Global Account in SAP BTP

Register an SAP Customer Experience System

You can assign the system to a formation on the Formations page, as follows:

SAP systems of type SAP Commerce Cloud, SAP Cloud for Customer, and SAP Field Service Management can be
assigned to a formation directly before the integration is complete on the respective SAP Customer Experience
system side. However, to enable the API access, you first need to complete the integration.

For systems of type SAP S/4HANA Cloud, SAP Marketing Cloud and SAP SuccessFactors, you first need to
configure the integration on the respective SAP system side.

For systems of type other than SAP S/4HANA Cloud, SAP Marketing Cloud and SAP SuccessFactors and SAP
systems from the SAP Customer Experience portfolio, after adding these systems in the Systems list, you can
directly include them in a formation.

See Automating Integrations Using Formations.

If you no longer need it, you can deregister or remove the system depending on its status. See Deregister or Removе a
System.

Registering Third-Party Systems

You add a third-party system to the list in the System Landscape Systems page. At this point you provide all the required
details for this system: its type, provider, URL, and system ID. For third-party systems, this completes the registration process and
you have your third-party system registered with SAP BTP. Even though the third-party system is registered directly, no status is
displayed.

See Register a Third-Party System.

Deregistering Systems
Deregistering an SAP or third-party system means that the connectivity between this system and the global account is disabled
and extension scenarios cannot be established, while removing a system means that this system is no longer part of the system
landscape list. You can deregister or remove a system from the Actions column, or from the System Details page that you access
when selecting the system from the system landscape list.

See Deregister or Removе a System.

Merging Systems

If you have already added these systems manually at a given point in time and you have registered them, the auto-discovered
systems might create duplicate entries in the list. To avoid duplicates and streamline the list of systems, you can merge
automatically the auto-discovered SAP systems with your manually added systems.

See Mergе SAP Systems.

Related Information
Extending SAP S/4HANA Cloud in the Cloud Foundry and Kyma Environment
Extending SAP Marketing Cloud in the Cloud Foundry and Kyma Environment
Extending SAP SuccessFactors in the Cloud Foundry and Kyma Environment

This is custom documentation. For more information, please visit SAP Help Portal. 16
 6/11/25, 2:39 PM
Extending SAP Customer Experience Products in the Kyma Environment
Register an SAP Integrated Business Planning System in a Global Account in SAP BTP
Register a System of Type SAP BTP Application
Register a Third-Party System

Register an SAP S/4HANA Cloud System in a Global Account in

SAP BTP
To connect an SAP S/4HANA Cloud Public Edition system with a global account in SAP BTP, you need to register the system in the
corresponding global account.

Prerequisites
See Adding, Registering and Deregistering Systems.

You are an administrator of the global account where you want to register your SAP S/4HANA Cloud system.

To configure the integration on the SAP S/4HANA Cloud system side, you need to be an administrator of the SAP S/4HANA
Cloud tenant.

Context

 Note
This documentation refers to SAP S/4HANA Cloud Public Edition. See Introduction to the Universe of SAP S/4HANA Cloud
Public Edition.

The registration process is based on a registration token that is used for the pairing of the SAP S/4HANA Cloud system and the
corresponding global account. You create the token in the global account, and then the tenant administrator of the respective SAP
S/4HANA Cloud system uses the token to start the automated registration process on the SAP S/4HANA Cloud system side.

 Note
When registering SAP S/4HANA Cloud systems, you can have up to 1000 tokens per global account ready to be used. Tokens
that are already used to register an SAP S/4HANA Cloud system are not included in this number.

This means that you cannot have more than 1000 systems in the Systems page of type SAP S/4HANA Cloud with an empty
status and generated token that is not used yet.

 Note
You cannot migrate the registered SAP S/4HANA Cloud systems between global accounts.

If you want to start using another global account, you will have to register your SAP S/4HANA Cloud systems again.

The registration process has the following states displayed in the cockpit:

No status displayed in the Status column - the registration token for an SAP system has been created but the registration
on the respective SAP solution system side has not been performed or completed.

Registered - the registration token has been used and the automated registration process has been successfully
completed. The system can be assigned to a formation on the Formations page in the cockpit.

This is custom documentation. For more information, please visit SAP Help Portal. 17
 6/11/25, 2:39 PM
Error while Registering - the registration has failed. Remove the system and then add it to the Systems list and try to
register it again.

Deregistering - а deregistration process has started in the SAP BTP cockpit. As a result, the connection between the SAP
solution system and the global account in SAP BTP is removed. The system remains in the list and you can register it again
later on.

Once a system is registered, you can deregister it only after removing it from all entitlement configurations and formations
it takes part in.

 Note
You will not be able to deregister a system if its status is one of the following:

Error while Registering

Deregistering

Error while Deregistering - the deregistration has failed. Try to deregister the system again. If the problem persists, report a
case in the BC-NEO-EXT-S4C component.

Removing - a system removal process has started in the SAP BTP cockpit. As a result, the link between the SAP solution
and SAP BTP is destroyed and the system is removed from the list. To register the system again, first you must add it to the
list anew, and then initiate the registration procedure.

Once a system is registered, you can only remove it if you first deregister it.

 Note
You will not be able to remove a system if its status is one of the following:

Registered

You first need to deregister the system.

Deregistering

Error while Deregistering

Try to deregister the system again.

Error while Removing - the system removal has failed. Try to removе the system again. If the problem persists, report a
case in the BC-NEO-EXT-S4C component.

 Note
When registering a system or creating a formation, the data you provide in the given input fields is not encrypted with your
customer managed key. The data you enter is only encrypted at rest.

Procedure
1. In the cockpit, navigate to your global account, and then choose System Landscape Systems .

2. Check if your SAP S/4HANA Cloud system has been auto-discovered and is already in the Systems page. If yes, then
continue with step 3.e. and get the registration token.

 Note

This is custom documentation. For more information, please visit SAP Help Portal. 18
 6/11/25, 2:39 PM
If your SAP S/4HANA Cloud system is auto-discovered and you still add it manually and then finish the registration
process with the manually added system, you can merge the two entries. See Mergе SAP Systems.

3. On the Systems page, choose Add System.

a. In the Type dropdown list, select SAP S/4HANA Cloud.

b. Enter a name for the system you want to register.

 Note
Use only printable ASCII characters.

 Tip
We recommend that you indicate the type of the system when specifying the system name. For example,
<mysystem>-S/4HANA-cloud. This helps you identify the system type when assigning systems to a
formation.

c. Choose Add.

d. In the Communication Scenario Groups dropdown menu, select one of the following options:

All Communication Scenarios: to create any of the communication scenarios in SAP S/4HANA Cloud.

Eventing Between SAP Cloud Systems: to allow the automatic enablement of the SAP_COM_0892
communication scenario in SAP S/4HANA Cloud.

Integration with SAP Ariba Buying: to allow the automatic enablement of the SAP_COM_0545 and
SAP_COM_0A00 communication scenarios in SAP S/4HANA Cloud.

Integration with SAP Start: to allow the automatic enablement of the SAP_COM_0647 communication
scenario in SAP S/4HANA Cloud.

e. Choose Get Token.

The system generates the registration token.

f. Copy the registration token and send it to the tenant administrator for the respective SAP S/4HANA Cloud system.
You need it for configuring the integration on the extended SAP S/4HANA Cloud system side.

You can also get the registration token later, once the system appears in the list on the Systems page.

The registration token is valid for 7 days after it has been generated. When a token is not used within its validity
period, it is no longer valid and cannot be used for registering an SAP S/4HANA Cloud system. If the validity of the
token expires before you use it to configure the integration on the SAP S/4HANA Cloud system side and complete
the registration, you need to get a new token. You can then copy it and use it to complete the registration.

 Note
A registration token can be used only once, for registering a single SAP S/4HANA Cloud system.

g. Close the wizard.

The SAP S/4HANA Cloud system appears in the list of systems on the Systems page. Its Status field is empty
because the registration process is not yet completed.

4. Start the automated registration process on the SAP S/4HANA Cloud system side. To do so, proceed as described in as
described in Trigger the Registration in the SAP S/4HANA Cloud Tenant.

 Note
You can register a system with the same name only once per global account. Once you have started a registration
process for a system with a specified name you can no longer register a system with the same name and connect it with

This is custom documentation. For more information, please visit SAP Help Portal. 19
 6/11/25, 2:39 PM
the same global account.

5. Check the status of the registration process. To do so, in the cockpit navigate to your global account, and on the Systems
page, check if the status of the SAP S/4HANA Cloud system has changed to Registered.

If you are already on the Systems page, refresh the page to check if the status has changed.

Next Steps

Trigger the Registration in the SAP S/4HANA Cloud Tenant

Related Information
Adding, Registering and Deregistering Systems
Deregister or Removе a System

Trigger the Registration in the SAP S/4HANA Cloud Tenant

Use this procedure to trigger the registration process for an SAP S/4HANA Cloud system that you want to pair with your global
account in SAP BTP.

Prerequisites

You are an SAP S/4HANA Cloud tenant administrator.

Procedure
1. Log on to the SAP S/4HANA Cloud tenant, go to Home, Communication Management tab and then choose the Maintain
Extensions on SAP BTP tile.

2. In the Maintain Extensions on SAP BTP screen, in the Extensions section, choose New.

3. In the Integration Token field, enter the content of the registration token from the SAP BTP cockpit.

4. Choose Save. A new entry in the table appears with status Enabling.

5. After the integration has finished successfully, you can refresh the table.

The status of the integration should have changed to Enabled.

Register an SAP Marketing Cloud System in a Global Account in

SAP BTP
To connect an SAP Marketing Cloud system with a global account in SAP BTP, you need to register the system in the
corresponding global account.

Prerequisites

See Adding, Registering and Deregistering Systems

You are an administrator of the global account where you want to register your SAP Marketing Cloud system.

To configure the integration on the SAP Marketing Cloud system side, you need to be an administrator of the SAP
Marketing Cloud tenant.

This is custom documentation. For more information, please visit SAP Help Portal. 20
 6/11/25, 2:39 PM

Context
The registration process is based on a registration token that is used for the pairing of the SAP Marketing Cloud system and the
corresponding global account. You create the token in the global account, and then the tenant administrator of the respective SAP
Marketing Cloud system uses the token to start the automated registration process on the SAP Marketing Cloud system side.

 Note
When registering SAP Marketing Cloud systems, you can have up to 1000 tokens per global account ready to be used. Tokens
that are already used to register an SAP Marketing Cloud system are not included in this number.

This means that you cannot have more than 1000 systems in the Systems page of type SAP Marketing Cloud with an empty
status and generated token that is not used yet.

The registration process has the following states displayed in the cockpit:

No status displayed in the Status column - the registration token for an SAP system has been created but the registration
on the respective SAP solution system side has not been performed or completed.

Registered - the registration token has been used and the automated registration process has been successfully
completed. The system can be assigned to a formation on the Formations page in the cockpit.

Error while Registering - the registration has failed. Remove the system and then add it to the Systems list and try to
register it again

Deregistering - а deregistration process has started in the SAP BTP cockpit. As a result, the connection between the SAP
solution system and the global account in SAP BTP is removed. The system remains in the list and you can register it again
later on.

Once a system is registered, you can deregister it only after removing it from all entitlement configurations and formations
it takes part in.

 Note
You will not be able to deregister a system if its status is one of the following:

Error while Registering

Deregistering

Error while Deregistering - the deregistration has failed. Try to deregister the system again. If the problem persists, report a
case in the BC-NEO-EXT-S4C component..

Removing - a system removal process has started in the SAP BTP cockpit. As a result, the link between the SAP solution
and SAP BTP is destroyed and the system is removed from the list. To register the system again, first you must add it to the
list anew, and then initiate the registration procedure.

Once a system is registered, you can only remove it if you first deregister it.

 Note
You will not be able to remove a system if its status is one of the following:

Registered

You first need to deregister the system.

Deregistering

This is custom documentation. For more information, please visit SAP Help Portal. 21
 6/11/25, 2:39 PM
Error while Deregistering

Error while Removing - the system removal has failed. Try to remove the system again. If the problem persists, report a
case in the BC-NEO-EXT-S4C component.

 Note
When registering a system or creating a formation, the data you provide in the given input fields is not encrypted with your
customer managed key. The data you enter is only encrypted at rest.

 Note
You cannot migrate the registered SAP Marketing Cloud systems between global accounts.

If you want to start using another global account, you will have to register your SAP Marketing Cloud systems again.

Procedure
1. In the cockpit, navigate to your global account, and then choose System Landscape Systems .

2. On the Systems page, choose Add System.

a. In the Type dropdown list, select SAP Marketing Cloud.

b. Enter a name for the system you want to register.

 Note
Use only printable ASCII characters.

 Tip
We recommend that you indicate the type of the system when specifying the system name. For example,
<mysystem>-S/4HANA-cloud. This helps you identify the system type when assigning systems to a
formation.

c. Choose Add.

d. In the Communication Scenario Groups dropdown menu, select All Communication Scenarios to create any of the
communication scenarios in SAP Marketing Cloud.

e. Choose Get Token.

The system generates the registration token.

f. Copy the registration token and send it to the tenant administrator for the respective SAP Marketing Cloud system.
You need it for configuring the integration on the extended SAP Marketing Cloud system side.

You can also get the registration token later, once the system appears in the list on the Systems page.

The registration token is valid for 7 days after it has been generated. When a token is not used within its validity
period, it is no longer valid and cannot be used for registering an SAP Marketing Cloud system. If the validity of the
token expires before you use it to configure the integration on the SAP Marketing Cloud system side and complete
the registration, you need to get a new token. You can then copy it and use it to complete the registration.

 Note
A registration token can be used only once, for registering a single SAP Marketing Cloud system.

g. Close the wizard.

This is custom documentation. For more information, please visit SAP Help Portal. 22
 6/11/25, 2:39 PM
The SAP Marketing Cloud system appears in the list of systems on the Systems page. Its Status field is empty
because the registration process is not yet completed.

3. Start the automated registration process on the SAP Marketing Cloud system side. To do so, proceed as described in as
described in Trigger the Registration in the SAP Marketing Cloud Tenant.

 Note
You can register a system with the same name only once per global account. Once you have started a registration
process for a system with a specified name you can no longer register a system with the same name and connect it with
the same global account.

4. Check the status of the registration process. To do so, in the cockpit navigate to your global account, and on the Systems
page, check if the status of the SAP Marketing Cloud system has changed to Registered.

If you are already on the Systems page, refresh the page to check if the status has changed.

Next Steps
Trigger the Registration in the SAP Marketing Cloud Tenant

Related Information
Adding, Registering and Deregistering Systems
Deregister or Removе a System

Trigger the Registration in the SAP Marketing Cloud Tenant

Use this procedure to trigger the registration process for an SAP Marketing Cloud system that you want to pair with your global
account in SAP BTP.

Prerequisites
You are an SAP Marketing Cloud tenant administrator.

Procedure
1. Log on to the SAP Marketing Cloud tenant, go to Home, Communication Management tab and then choose the Maintain
Extensions on SAP BTP tile.

2. In the Maintain Extensions on SAP BTP screen, in the Extensions section, choose New.

3. In the Integration Token field, enter the content of the registration token from the SAP BTP cockpit.

4. Choose Save. A new entry in the table appears with status Enabling.

5. After the integration has finished successfully, you can refresh the table.

The status of the integration should have changed to Enabled.

Register an SAP Integrated Business Planning System in a Global

Account in SAP BTP
To connect an SAP Integrated Business Planning system with a global account in SAP BTP, you need to register the system in the
corresponding global account.

This is custom documentation. For more information, please visit SAP Help Portal. 23
 6/11/25, 2:39 PM

Prerequisites

See Adding, Registering and Deregistering Systems

You are an administrator of the global account where you want to register your SAP Integrated Business Planning system.

To configure the integration on the SAP Integrated Business Planning system side, you need to be an administrator of the
SAP Integrated Business Planning tenant.

Context

The registration process is based on a registration token that is used for the pairing of the SAP Integrated Business Planning
system and the corresponding global account. You create the token in the global account, and then the tenant administrator of the
respective SAP Integrated Business Planning system uses the token to start the automated registration process on the SAP
Integrated Business Planning system side.

 Note
When registering SAP Integrated Business Planning systems, you can have up to 1000 tokens per global account ready to be
used. Tokens that are already used to register an SAP Integrated Business Planning system are not included in this number.

This means that you cannot have more than 1000 systems in the Systems page of type SAP Integrated Business Planning with
an empty status and generated token that is not used yet.

The registration process has the following states displayed in the cockpit:

No status displayed in the Status column - the registration token for an SAP system has been created but the registration
on the respective SAP solution system side has not been performed or completed.

Registered - the registration token has been used and the automated registration process has been successfully
completed. The system can be assigned to a formation on the Formations page in the cockpit.

Error while Registering - the registration has failed. Remove the system and then add it to the Systems list and try to
register it again

Deregistering - а deregistration process has started in the SAP BTP cockpit. As a result, the connection between the SAP
solution system and the global account in SAP BTP is removed. The system remains in the list and you can register it again
later on.

Once a system is registered, you can deregister it only after removing it from all entitlement configurations and formations
it takes part in.

 Note
You will not be able to deregister a system if its status is one of the following:

Error while Registering

Deregistering

Error while Deregistering - the deregistration has failed. Try to deregister the system again. If the problem persists, report a
case in the BC-NEO-EXT-S4C component..

Removing - a system removal process has started in the SAP BTP cockpit. As a result, the link between the SAP solution
and SAP BTP is destroyed and the system is removed from the list. To register the system again, first you must add it to the
list anew, and then initiate the registration procedure.

Once a system is registered, you can only remove it if you first deregister it.
This is custom documentation. For more information, please visit SAP Help Portal. 24
 6/11/25, 2:39 PM

 Note
You will not be able to remove a system if its status is one of the following:

Registered

You first need to deregister the system.

Deregistering

Error while Deregistering

Error while Removing - the system removal has failed. Try to remove the system again. If the problem persists, report a
case in the BC-NEO-EXT-S4C component.

 Note
When registering a system or creating a formation, the data you provide in the given input fields is not encrypted with your
customer managed key. The data you enter is only encrypted at rest.

 Note
You cannot migrate the registered SAP Integrated Business Planning systems between global accounts.

If you want to start using another global account, you will have to register your SAP Integrated Business Planning systems
again.

Procedure
1. In the cockpit, navigate to your global account, and then choose System Landscape Systems .

2. On the Systems page, choose Add System.

a. In the Type dropdown list, select SAP Integrated Business Planning.

b. Enter a name for the system you want to register.

 Note
Use only printable ASCII characters.

 Tip
We recommend that you indicate the type of the system when specifying the system name. For example,
<mysystem>-S/4HANA-cloud. This helps you identify the system type when assigning systems to a
formation.

c. Choose Add.

d. In the Communication Scenario Groups dropdown menu, select All Communication Scenarios to create any of the
communication scenarios in SAP Integrated Business Planning.

e. Choose Get Token.

The system generates the registration token.

f. Copy the registration token and send it to the tenant administrator for the respective SAP Integrated Business
Planning system. You need it for configuring the integration on the extended SAP Integrated Business Planning
system side.

You can also get the registration token later, once the system appears in the list on the Systems page.

This is custom documentation. For more information, please visit SAP Help Portal. 25
 6/11/25, 2:39 PM
The registration token is valid for 7 days after it has been generated. When a token is not used within its validity
period, it is no longer valid and cannot be used for registering an SAP Integrated Business Planning system. If the
validity of the token expires before you use it to configure the integration on the SAP Integrated Business Planning
system side and complete the registration, you need to get a new token. You can then copy it and use it to complete
the registration.

 Note
A registration token can be used only once, for registering a single SAP Integrated Business Planning system.

g. Close the wizard.

The SAP Integrated Business Planning system appears in the list of systems on the Systems page. Its Status field is
empty because the registration process is not yet completed.

3. Start the automated registration process on the SAP Integrated Business Planning system side. To do so, proceed as
described in as described in Trigger the Registration in the SAP Integrated Business Planning Tenant.

 Note
You can register a system with the same name only once per global account. Once you have started a registration
process for a system with a specified name you can no longer register a system with the same name and connect it with
the same global account.

4. Check the status of the registration process. To do so, in the cockpit navigate to your global account, and on the Systems
page, check if the status of the SAP Integrated Business Planning system has changed to Registered.

If you are already on the Systems page, refresh the page to check if the status has changed.

Next Steps

Trigger the Registration in the SAP Integrated Business Planning Tenant

Trigger the Registration in the SAP Integrated Business Planning

Tenant
Use this procedure to trigger the registration process for an SAP Integrated Business Planning system that you want to pair with
your global account in SAP BTP.

Prerequisites

You are an SAP Integrated Business Planning tenant administrator.

Procedure
1. Log on to the SAP Integrated Business Planning tenant, go to Home, Communication Management tab and then choose
the Maintain Extensions on SAP BTP tile.

2. In the Maintain Extensions on SAP BTP screen, in the Extensions section, choose New.

3. In the Integration Token field, enter the content of the registration token from the SAP BTP cockpit.

4. Choose Save. A new entry in the table appears with status Enabling.

5. After the integration has finished successfully, you can refresh the table.

The status of the integration should have changed to Enabled.

This is custom documentation. For more information, please visit SAP Help Portal. 26
 6/11/25, 2:39 PM

Register an SAP SuccessFactors System in a Global Account in

SAP BTP
To connect an SAP SuccessFactors system with a global account in SAP BTP, you need to register the system in the corresponding
global account.

Prerequisites

See Adding, Registering and Deregistering Systems.

You are an administrator of the global account where you want to register your SAP SuccessFactors system.

You have a dedicated SAP SuccessFactors company instance.

You have a user with permissions to access Extension Center in SAP SuccessFactors Admin Center that include:

Admin Access to MDF OData API permission from the Metadata Framework category

Create Integration with SAP BTP permission from the Manage Extensions on SAP BTP category

To assign these permissions to your user, you might need the help of an administrator.

To get a user with the respective permissions, follow these steps:

1. Make sure you have an access to the SAP SuccessFactors Admin Center. See Permission to Access Admin Center.

2. Add your user to an already existing group or create a new dedicated group and add your user. See Creating
Dynamic Permission Groups.

3. Use an already existing role or create a new dedicated role. See Creating Permission Roles.

4. Assign the respective permissions to your role. See Assigning Permissions to a Role.

5. Add your role to the dedicated group. See Assigning Roles to Groups.

6. To fully activate the permissions, log out and log in again to the SAP SuccessFactors company instance.

Context
The registration process is based on a registration token that is used for the pairing of the SAP SuccessFactors company and the
corresponding global account in SAP BTP. You create the token in the global account, and then start the automated registration
process on the SAP SuccessFactors company side using this token.

 Note
When registering SAP SuccessFactors systems, you can have up to 1000 tokens per global account ready to be used. Tokens
that are already used to register an SAP SuccessFactors system are not included in this number.

This means that you cannot have more than 1000 systems in the Systems list of type SAP SuccessFactors with an empty
status and generated token that is not used yet.

The registration process has the following states displayed in the cockpit:

No status displayed in the Status column - the registration token for an SAP system has been created but the registration
on the respective SAP solution system side has not been performed or completed.

Registered - the registration token has been used and the automated registration process has been successfully
completed. The system can be assigned to a formation on the Formations page in the cockpit.

This is custom documentation. For more information, please visit SAP Help Portal. 27
 6/11/25, 2:39 PM
Error while Registering - the registration has failed. Remove the system and then add it to the Systems list and try to
register it again

Deregistering - а deregistration process has started in the SAP BTP cockpit. As a result, the connection between the SAP
solution system and the global account in SAP BTP is removed. The system remains in the list and you can register it again
later on.

Once a system is registered, you can deregister it only after removing it from all entitlement configurations and formations
it takes part in.

Error while Deregistering - the deregistration has failed. Try to deregister the system again. If the problem persists, report a
case in the BC-NEO-EXT-SF component.

Removing - a system removal process has started in the SAP BTP cockpit. As a result, the link between the SAP solution
and SAP BTP is destroyed and the system is removed from the list. To register the system again, first you must add it to the
list anew, and then initiate the registration procedure.

Once a system is registered, you can only remove it if you first deregister it.

 Note
You will not be able to remove a system if its status is one of the following:

Registered

You first need to deregister the system.

Deregistering

Error while Deregistering

Try to deregister the system again.

Error while Removing - the system removal has failed. Try to remove the system again. If the problem persists, report a
case in the BC-NEO-EXT-SF component.

 Note
When registering a system or creating a formation, the data you provide in the given input fields is not encrypted with your
customer managed key. The data you enter is only encrypted at rest.

Procedure
1. In the SAP BTP cockpit, navigate to your global account, and then choose System Landscape Systems .

2. On the Systems page, choose Add System.

a. In the Type dropdown list, select SAP SuccessFactors.

b. Enter a name for the system you want to register.

 Note
Use only printable ASCII characters.

 Tip
We recommend that you indicate the type of the system when specifying the system name. For example,
<mysystem>-SuccessFactors. This helps you identify the system type when assigning systems to a
formation.

This is custom documentation. For more information, please visit SAP Help Portal. 28
 6/11/25, 2:39 PM
c. Choose Add.

d. Choose Get Token.

The system generates the registration token.

e. Copy the registration token and send it to the tenant administrator for the respective SAP SuccessFactors system.
You need it for configuring the integration on the extended SAP SuccessFactors system side.

You can also get the registration token later, once the system appears in the list on the Systems page.

The registration token is valid for 7 days after it has been generated. When a token is not used within its validity
period, it is no longer valid and cannot be used for registering an SAP SuccessFactors system. If the validity of the
token expires before you use it to configure the integration on the SAP SuccessFactors system side and complete
the registration, you need to get a new token. You can then copy it and use it to complete the registration.

 Note
A token can be used only once, for registering a single SAP SuccessFactors system.

f. Close the wizard.

The SAP SuccessFactors system appears in the list of systems on the Systems page. Its Status field is empty
because the registration process is not yet completed.

3. Start the automated integration process on the SAP SuccessFactors company side:

 Note
If you do not have permissions to access the Extension Center for the corresponding SAP SuccessFactors system, you
need to send the registration token to a user with such permissions who will configure the integration on the SAP
SuccessFactors system side. For the requires permissions, check the prerequisites.

a. In SAP SuccessFactors Admin Center, navigate to Extension Center.

b. On the Extensions on SAP BTP tab page, navigate to the Add Integration with SAP BTP screen area, and paste the
registration token in the Integration Token input field.

c. Choose Add.

The system appears in the integration list in the Multi-Cloud Environment screen area, and the status of the integration is
displayed in the Integration Status column. To refresh the status of the process, choose the Check Status icon. Wait for the
integration to finish.

This is custom documentation. For more information, please visit SAP Help Portal. 29
 6/11/25, 2:39 PM

4. In the cockpit, check the status of the registration process. To do so, navigate to your global account, and on the Systems
page, check if the status of the SAP System has changed to Registered.

If you are already on the Systems page, refresh the page to check if the status has changed.

 Note
You can register a system only once with the same name per global account.

 Note
You cannot migrate the registered SAP SuccessFactors systems between global accounts.

If you want to start using another global account, you will have to register your SAP SuccessFactors systems again.

Related Information
Adding, Registering and Deregistering Systems
Deregister or Removе a System

Register an SAP Customer Experience System

Register an SAP Customer Experience system to connect it with a global account in SAP BTP.

Prerequisites
See Adding, Registering and Deregistering Systems.

You are an administrator of the global account where you want to register your SAP Customer Experience system.

To configure the integration on the SAP Customer Experience system side, you need to be an administrator of the SAP
Customer Experience tenant.

This is custom documentation. For more information, please visit SAP Help Portal. 30
 6/11/25, 2:39 PM

Context
The registration process is based on a registration token that is used for the pairing of the SAP Customer Experience system and
the corresponding global account. You create the token in the global account, and then the tenant administrator of the respective
SAP Customer Experience system uses the token to start the automated registration process on the SAP Customer Experience
system side.

The registration process has the following states displayed in the cockpit:

No status displayed in the Status column - the registration token for an SAP system has been created but the registration
on the respective SAP solution system side has not been performed or completed.

Registered - the registration token has been used and the automated registration process has been successfully
completed. The system can be assigned to a formation on the Formations page in the cockpit.

Error while Registering - the registration has failed. Remove the system and then add it to the Systems list and try to
register it again

Deregistering - а deregistration process has started in the SAP BTP cockpit. As a result, the connection between the SAP
solution system and the global account in SAP BTP is removed. The system remains in the list and you can register it again
later on.

Once a system is registered, you can deregister it only after removing it from all entitlement configurations and formations
it takes part in.

Error while Deregistering - the deregistration has failed. Try to deregister the system again. If the problem persists, report a
case in the BC-CP-MP component.

Removing - a system removal process has started in the SAP BTP cockpit. As a result, the link between the SAP solution
and SAP BTP is destroyed and the system is removed from the list. To register the system again, first you must add it to the
list anew, and then initiate the registration procedure.

Once a system is registered, you can only remove it if you first deregister it.

 Note
You will not be able to remove a system if its status is one of the following:

Registered

You first need to deregister the system.

Deregistering

Error while Deregistering

Try to deregister the system again.

Error while Removing - the system removal has failed. Try to remove the system again. If the problem persists, report a
case in the BC-CP-MP component.

 Note
When registering a system or creating a formation, the data you provide in the given input fields is not encrypted with your
customer managed key. The data you enter is only encrypted at rest.

Procedure

This is custom documentation. For more information, please visit SAP Help Portal. 31
 6/11/25, 2:39 PM
1. In the cockpit, navigate to your global account, and then choose System Landscape Systems .

2. On the Systems page, choose Add System.

a. In the Type dropdown list, select the system type.

The following SAP Customer Experience systems are supported:

SAP Commerce Cloud

SAP Field Service Management

SAP Cloud for Customer

b. Enter a name for the system you want to register.

 Note
Use only printable ASCII characters.

 Tip
We recommend that you indicate the type of the system when specifying the system name. For example,
<mysystem>-S/4HANA-cloud. This helps you identify the system type when assigning systems to a
formation.

c. Choose Add.

d. Choose Get Token.

The system generates the registration token.

e. Copy the registration token and send it to the tenant administrator for the respective SAP Customer Experience
system. You need it for configuring the integration on the extended SAP Customer Experience system side.

You can also get the registration token later, once the system appears in the list on the Systems page.

The integration token is valid for 10 minutes after it has been generated. When a token is not used within its validity
period, it is no longer valid and cannot be used for registering a system. If the validity of the token expires before you
use it to configure the integration on the SAP Customer Experience system side and complete the registration, you
need to get a new token. You can then copy it and use it to complete the registration.

 Note
A registration token can be used only once, for registering a single SAP Customer Experience system.

f. Close the wizard.

The SAP Customer Experience system appears in the list of systems on the Systems page. Its Status field is empty
because the registration process is not yet completed.

3. (Recommended) Follow the steps in Automating Integrations Using Formations before proceeding with the registration on
the SAP Customer Experience side.

4. Configure the integration on the SAP Customer Experience system side. See Extending SAP Customer Experience
Products in the Kyma Environment.

5. Check the status of the registration process. To do so, in the cockpit navigate to your global account, and in the Systems
panel, check if the status of the SAP Customer Experience system has changed to Registered.

If you are already in the Systems panel, refresh the page to check if the status has changed.

Results

This is custom documentation. For more information, please visit SAP Help Portal. 32
 6/11/25, 2:39 PM
Once you use the integration token to connect your SAP Customer Experience system, all of the exposed services and events are
propagated to the Kyma runtime.

Related Information
Adding, Registering and Deregistering Systems
Deregister or Removе a System

Register a System of Type SAP BTP Application

Prerequisites
You are a global account administrator, or you are a system landscape administrator of the global account where you want to add
your SAP BTP Application system. See Working with Role Collections.

Context

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

You can connect an application you've developed and deployed in SAP BTP with a global account in SAP BTP. To do that, you add a
system representing your application to the list in the System Landscape Systems page. The system type you use is SAP
BTP Application. You also have to provide the namespace which is unique for this system. A unique system ID is automatically
assigned to any system of type SAP BTP Application. For systems of type SAP BTP Application, this completes the registration
process and you have your system registered with SAP BTP. Even though the system of type SAP BTP Application is registered
directly, no status is displayed.

When you have a systems of your application listed in the Systems page, you can include it in different formations depending on
your needs.

Procedure
1. In the cockpit, navigate to your global account, and then choose System Landscape Systems .

2. On the Systems page, choose Add System.

3. In the Add System wizard:

a. In the Type dropdown list, select SAP BTP Application.

b. Enter a name for the system you want to register.

 Note
Use only printable ASCII characters.

c. In the System ID field, there is an automatically assigned ID which is unique for this system.

d. In the System Namespace, enter a unique technical identifier to avoid global ID and name conflicts. It covers vendor,
system (application or service), authority namespaces and optionally further sub-context namespaces.

e. Choose Add.

Related Information

This is custom documentation. For more information, please visit SAP Help Portal. 33
 6/11/25, 2:39 PM
Declaring System APIs and Events as Dependencies for Business Scenarios

Register a Third-Party System

To connect a third-party systems, for example a Google system, with a global account in SAP BTP, you first need to add this system
to the Systems page.

Prerequisites
You are a global account administrator, or you are a system landscape administrator of the global account where you want to add
your third-party system. See Working with Role Collections.

Context

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

You add a third-party system to the list in the System Landscape Systems page. At this point you provide all the required
details for this system: its type, provider, URL, and system ID. For third-party systems, this completes the registration process and
you have your third-party system registered with SAP BTP. Even though the third-party system is registered directly, no status is
displayed.

When you have this system added in the Systems page, you can select it and open its system details. There, you specify in the
consumption bundles the APIs, and the events. A consumption bundle organizes a set of related APIs and events into a single
group for consumption purposes and expresses information about how the APIs and events that it contains can be accessed. All
APIs and events that are part of the same consumption bundle need to be accessible through the same set of credentials.

 Note
You cannot migrate the added third-party systems between global accounts.

If you want to start using another global account, you will have to add your systems again.

 Note
When adding a system or creating a formation, the data you provide in the given input fields is not encrypted with your
customer managed key. The data you enter is only encrypted at rest.

Procedure
1. In the cockpit, navigate to your global account, and then choose System Landscape Systems .

2. On the Systems page, choose Add System.

3. In the Add System wizard:

a. In the Type dropdown list, select Other System Type.

b. Enter a name for the system you want to register.

 Note
Use only printable ASCII characters.

This is custom documentation. For more information, please visit SAP Help Portal. 34
 6/11/25, 2:39 PM

 Tip
We recommend that you indicate the type of the system when specifying the system name. For example,
<mysystem>-google-workspace.

c. In the System Type Name field, enter the type of your system. This is a user-defined type of the system you want to
add. For example, Workspace.

d. In the Provider field, enter the provider of your system. For example, Google.

e. In the URL field, enter the URL of your system.

f. In the System ID field, enter the unique identifier of the added system that is used in its own domain.

g. Choose Add.

4. (Optional) Find this system in the Systems list and open its system details. Choose Add Consumption Bundle and fill in the
following properties:

Consumption Bundle Name: add a meaningful name

Description:

Credentials Type: choose between OAuth and Basic

If you choose OAuth, fill in these properties:

Client ID

Client Secret

URL: this is the token URL, that is used for obtaining OAuth tokens through the client ID and the client
secret.

If you choose Basic, fill in these properties:

User

Password

Choose Add. Open the consumption bundle from the list.

5. (Optional) If you want to add APIs, choose Add API and fill in the following properties:

API Name: add a meaningful name.

Description: this field is optional.

URL

Specification: this is the file containing the specification. The file format depends on the specification type. For
OpenAPI, you can use YAML and JSON. For OData, you can use JSON and XML.

Type: this is the type of the specification. The API specification type can be OpenAPI or OData.

6. (Optional) If you want to add events, choose Add Event and fill in the following properties:

Event Name: add a meaningful name.

Description: this field is optional.

Specification: this is the file containing the specification. The file format can be JSON and YAML.

Type: this is the type of the specification. The event specification type can be only AsyncAPI.

Results

This is custom documentation. For more information, please visit SAP Help Portal. 35
 6/11/25, 2:39 PM
The system has been added as a record to the list on the Systems page in the SAP BTP cockpit and you have added the respective
APIs or events.

If you no longer need it, you can remove the system depending on its status. See Deregister or Removе a System.

Deregister or Removе a System

When you no longer need the system to be paired with your global account, you can deregister or remove it depending on its
status.

Prerequisites
You are a global account administrator, or you are a system landscape administrator of the global account where you want
to deregister or remove your system. See Working with Role Collections.

You have added your system as a record to the list on the Systems page. See Adding, Registering and Deregistering
Systems.

Context

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

Deregistering an SAP or third-party system means that the connectivity between this system and the global account is disabled
and extension scenarios cannot be established, while removing a system means that this system is no longer part of the system
landscape list. You can deregister or remove a system from the Actions column, or from the System Details page that you access
when selecting the system from the system landscape list.

The deregistration and the removal processes have the following states displayed in the cockpit:

Deregistering - a deregistration process has started. As a result, the connectivity between the SAP or third-party system
and SAP BTP is disabled and extension scenarios cannot be established. The system remains in the system landscape list
and you can register it again later on.

Once a system is registered, you can deregister it only after removing it from all entitlement configurations and formations
it takes part in.

Error while Deregistering - the deregistration has failed. Try to deregister the system again. If the problem persists, you
have to report a case in one of the components mentioned below.

Removing - a system removal process has started in the SAP BTP cockpit. As a result, the SAP or third-party system is
deregistered, and then, it is removed from the system landscape list completely. To register the system again, first, you
must add it to the list anew, and then, initiate the registration procedure.

Once a system is registered, you can only remove it if you first deregister it.

Error while Removing - the system removal has failed. Try to deregister the system again. If the problem persists, you have
to report a case in one of the components mentioned below.

 Note
If the deregistration, or removal errors persist, report a case in one of the following components depending on the system type:

SAP SuccessFactors - BC-NEO-EXT-SF

This is custom documentation. For more information, please visit SAP Help Portal. 36
 6/11/25, 2:39 PM
SAP S/4HANA Cloud - BC-NEO-EXT-S4C

All other system types - BC-CP-MP

Procedure
1. In the cockpit, navigate to your global account, and then choose System Landscape Systems .

2. On the Systems page, select the SAP or third-party system you want to deregister or remove.

To deregister a system, choose  (Deregister system) from the Actions column, or choose Deregister System from
the System Details page that you access when selecting the system from the system landscape list.

You can deregister only registered systems.

 Note
If your system is of type SAP S/4HANA Cloud, SAP SuccessFactors, or part of the SAP Customer Experience
portfolio and you deregister this system, you can register back the same system's tenant and not a different one.

To remove a system, choose  (Remove system) from the Actions column, or choose Remove System from the
System Details page that you access when selecting the system from the system landscape list.

Before removing a system from the list, first you have to check all configurations that this system is part of, such as
entitlements and formations. Then, you have to deregister it and after that you will be able to remove it from the
Systems page. If you try to remove a system before deregistering it, a dialog will appear and will ask you to
deregister the system first.

 Note
You can only remove manually added systems. Depending on their discovery mode the systems that are added
to the list either are Manually added (registered manually by following the procedure in the prerequisites), or
Auto-discovered (added to the list automatically, based on information of the existing system landscape), or
part of the Subaccount/<my-subaccount> (automatically added, based on the information of the SAP BTP
subaccount).

You cannot remove Auto-discovered systems from the list.

Results

The system has been deregistered or removed as a record from the list on the Systems page in the SAP BTP cockpit.

Mergе SAP Systems

Merging the SAP systems allows you to reduce the duplicate systems in the list. You can merge auto-discovered SAP systems
without assigned status in a target system that has already been registered.

Prerequisites
You are a global account administrator, or you are a system landscape administrator of the global account where you want
to deregister or remove your SAP system. See Working with Role Collections.

You have registered the target SAP system. See Adding, Registering and Deregistering Systems.

This is custom documentation. For more information, please visit SAP Help Portal. 37
 6/11/25, 2:39 PM

Context
The logic of the SAP BTP cockpit enables it to discover SAP systems across your landscape and add them automatically on the
Systems page. If you have already added these systems manually at a given point in time and you have registered them, the auto-
discovered systems might create duplicate entries in the list. To avoid duplicates and streamline the list of systems, you can merge
the auto-discovered SAP systems with your manually added systems. The logic automatically detects duplicates based on their
URL and system type. Note that you can only merge auto-discovered SAP systems without assigned status in a target system that
has already been registered. That is, you cannot merge registered auto-discovered systems.

Procedure
1. In the cockpit, navigate to your global account, and then choose System Landscape Systems .

2. On the Systems page, find the auto-discovered SAP system you want to merge.

3. Under the Actions column, choose the  (Merge system) button.

Alternatively, you can choose the system from the list to open the System Details view, and then, choose the Merge
System button on the top-right corner.

The Merge System dialog opens.

4. In the Target System dropdown menu, find and select the SAP system, in which you want to merge your system.

5. Choose Merge.

Results
The auto-discovered system has been merged in the target system. That is, all individual properties of the system were recorded in
the target system and the common properties were preserved. At the end, the duplicate (auto-discovered) system has been
removed as a record from the list on the Systems page in the SAP BTP cockpit.

Integrating SAP Solutions

You can integrate several systems and services as part of the common business scenario. To do that, you create a formation in the
SAP BTP cockpit that includes all systems that the scenario requires.

A formation is a logical grouping of SAP systems that can be integrated as part of a business scenario. Formations allow you to
combine SAP solution systems to simplify the connectivity setup and to provide a unified view of all components required for the
implementation of your integration or extension scenario. To create a fully functional formation, you have to include SAP solution
systems. You do this configuration once and you can change it anytime.

See Automating Integrations Using Formations.

Use Cases

Integrate SAP Systems to Achieve a Business Scenario

This formation use case enables some of the SAP systems included in such a formation to communicate with each other.

These are the formations types following this use case:

Integration with SAP Ariba Buying. See Automating Integrations with SAP Ariba Buying.

Integration with SAP Start. See Automating Integrations with SAP Start.

This is custom documentation. For more information, please visit SAP Help Portal. 38
 6/11/25, 2:39 PM
Data Ingestion for Industry Cloud Solutions. See Automating Integrations with Data Ingestion for Industry Cloud
Solutions.

Integration with SAP Ariba Central Invoice Management. See Automating Integrations with SAP Ariba Central Invoice
Management.

Integration with SAP Subscription Billing. See Automating Integrations with SAP Subscription Billing.

Integration with SAP Collaboration Manager. See Automating Integrations with SAP Collaboration Manager.

Integration with SAP Ariba Central Invoice Management. See Automating Integrations with SAP Advanced Financial
Closing.

Integrate SAP Systems with a Service in SAP BTP

There are formations dedicated to automate the integration between supported SAP systems and a service in SAP BTP. In this use
case the topology is a star topology where the service is in the center and is communicating with every SAP system that is
included in the formation. The formation type is related to the service. The SAP systems that are included do not communicate
between each other.

These are the formations types following this use case:

Integration with Joule. See Enabling Joule.

Eventing Between SAP Cloud Systems. See Enabling Events Exchange Between SAP Cloud Systems.

Integration with SAP Master Data Integration. See Enabling Integration with SAP Master Data Integration.

Integrate SAP Systems to Achieve an Extensibility Scenario

Automated configuration allows you to extend SAP solutions without affecting their core functions. It also provides a central
repository for APIs and data, ensuring easy access to services for developing extensions.

These are the formations types following this use case:

Side-by-Side Extensibility with Kyma. See Setting Up System Landscape for Kyma.

Integration with SAP Build. See Setting Up System Landscape for SAP Build.

Integration with SAP Integration Suite. See Setting Up System Landscape for SAP Integration Suite.

Developing with SAP Business Application Studio. See Setting Up System Landscape for SAP Business Application
Studio.

Automating Integrations Using Formations

You can use the automated integration that allows you to include various SAP systems into a formation and thus combine diverse
SAP solutions into an extended business scenario.

Prerequisites
You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

The SAP solution systems that you want to include to a formation must be listed in the Systems page. See Adding,
Registering and Deregistering Systems.

This is custom documentation. For more information, please visit SAP Help Portal. 39
 6/11/25, 2:39 PM

Context

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

A formation is a logical grouping of SAP systems following a business scenario. Formations allow you to combine SAP solution
systems to simplify the connectivity setup and to provide a unified view of all components required for the implementation of your
integration or extension scenario. There are three formation types: formations for business scenarios, for integrating with a
specific service in SAP BTP, and for extensibility.

When creating a formation in the SAP BTP cockpit, you include the systems of the different SAP solutions you want to extend. If
your business case features more than one SAP solution system, you can use the corresponding button to include additional
systems in the formation. You can start the dialog as many times and add systems to your formation as you want.

A formation can have the following status values:

Ready

The formation has been added as a record to the list and all registered systems are included successfully.

Draft

Not all the systems were included when creating the formation. Include all the missing systems and choose Finalize
Formation.

Action Required

The formation has been created but you cannot use it productively yet.

Based on the formation type and the subaccount that you specified, it might require an SAP BTP Kyma environment
instance or an SAP Business Application Studio subscription. Although the SAP BTP cockpit allows you to create such a
formation, to enable and make use of it, you must also create the respective instance or subscription.

Synchronizing

Systems that are included in the formation are currently synchronizing in the background.

Error

An error occurred while some of the systems that are included in the formation were synchronizing in the background. In
this case, report an incident in the BC-CP-MP component.

When you include systems in a formation, these systems are synchronized in the background. If an error occurs, you can
resynchronize these systems to restart the synchronization process. To do that, choose Resynchronize for the particular
formation. You will have this action available only for formations that are in status Error.

If you want to reconfigure the systems in a formation from scratch without excluding them, you have to choose Reset and
Resynchronize. You will have this action available only for formations that have no status in SAP BTP cockpit and their formation
type is Side-by-Side Extensibility with Kyma.

 Note
When registering a system or creating a formation, the data you provide in the given input fields is not encrypted with your
customer managed key. The data you enter is only encrypted at rest.

Procedure

This is custom documentation. For more information, please visit SAP Help Portal. 40
 6/11/25, 2:39 PM
1. Open the SAP BTP cockpit and navigate to your global account.

2. Choose System Landscape Formations .

3. Choose Create Formation.

The Create Formation dialog opens. There, in a wizard, you can create a formation and include one or more SAP systems to
it.

4. On the General Information step of the wizard, enter the following information:

a. Enter a unique formation name.

The formation name must be up to 128 symbols which can be lowercase or uppercase Latin letters, numbers,
hyphens, spaces, or underscores only. The name must start and end with an alphanumeric character.

b. Specify a type for the formation.

The formation type defines the use case.

Depending on the type, a list of systems that can be included in this formation is loaded at the following step of the
wizard.

5. Choose Next Step.

6. On the Include Systems step, select one or more systems that you want to include in the newly created formation, and
then, choose Next Step.

The wizard prefilters the systems that were added to the Systems page and are valid for the formation type that you
specified at the previous step.

7. On the Review step, double check your entries before you create the formation.

If you want to make any changes, either you can edit the corresponding section directly, or use the Previous button.

8. Choose Create.

9. Optionally, you can include additional systems to the newly created formation, by choosing Include System.

On the systems list that opens, select a system, and then, choose Include.

Results

 Note
When you delete a formation, several activities are performed at one go. First, the systems are excluded from the formation.
Then, the subaccount is unassigned. Finally, the formation is deleted from the Formations page completely.

To restore a deleted formation, first you must create it anew, and then, include all of its systems again, one by one.

Related Information
Automating Integrations with SAP Ariba Buying
Automating Integrations with SAP Start
Automating Integrations with Data Ingestion for Industry Cloud Solutions
Automating Integrations with SAP Ariba Central Invoice Management
Automating Integrations with SAP Subscription Billing
Automating Integrations with SAP Collaboration Manager
Automating Integrations with SAP Advanced Financial Closing
Enabling Joule
Enabling Events Exchange Between SAP Cloud Systems
Enabling Integration with SAP Master Data Integration

This is custom documentation. For more information, please visit SAP Help Portal. 41
 6/11/25, 2:39 PM
Setting Up System Landscape for Kyma
Setting Up System Landscape for SAP Build
Setting Up System Landscape for SAP Integration Suite
Setting Up System Landscape for SAP Business Application Studio

Automating Integrations with SAP Ariba Buying

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

SAP Ariba Buying offers procurement users a unique buying experience through a guided process. SAP Ariba Buying provides
buyers an easy process to shop for items. Buyers can search for, view and purchase items that are available in the connected
shopping sites, or request items from suppliers. SAP Ariba Buying also helps buyers to track their purchase requests.

To set up SAP Ariba Buying with SAP S/4HANA Cloud on SAP BTP you need to have all the necessary systems included in a
formation of type Integration with SAP Ariba Buying in the System Landscape Systems page of the SAP BTP cockpit.

 Note
This documentation refers to SAP S/4HANA Cloud Public Edition. See Introduction to the Universe of SAP S/4HANA Cloud
Public Edition.

Rules
When creating Integration with SAP Ariba Buying formations, keep in mind the following rules:

SAP S/4HANA Cloud systems can be included in at most one Integration with SAP Ariba Buying formation.

Only SAP S/4HANA Cloud systems that are registered with All Communication Scenarios or Integration with SAP Ariba
Buying communication scenario group can be part of a Integration with SAP Ariba Buying formation. See Register an SAP
S/4HANA Cloud System in a Global Account in SAP BTP.

Prerequisites
You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

You have an Identity Authentication tenant. See Indentity Authentication: Initial Setup.

(Optional: if you are using the Set Up SAP Ariba Buying booster in the SAP BTP cockpit, this step will be automatically
done by the booster.) Check that you have a system of type SAP Ariba Buying in the Systems page. This system is added
through a subscription in SAP BTP cockpit associated with a given subaccount. The subscription has been discovered and
added automatically through the subaccount. To have a system of type SAP Ariba Buying in the Systems page, you need
to:

You have subscribed to SAP Ariba Buying. See Get a Subscription to SAP Ariba Buying.

You have subscribed to the services required for SAP Ariba Buying. See Subscribe to Services Required for SAP
Ariba Buying.

Check that you have a system of type SAP S/4HANA Cloud in the Systems page. This system is auto-discovered because it
is associated with your global account and has been discovered and added automatically to the list based on information of
This is custom documentation. For more information, please visit SAP Help Portal. 42
 6/11/25, 2:39 PM
the existing system landscape.

 Note
If you don't find your system of type SAP S/4HANA Cloud in the Systems page, add this system manually. See Register
an SAP S/4HANA Cloud System in a Global Account in SAP BTP.

Register the SAP S/4HANA Cloud system in the Systems page.

When you register an SAP S/4HANA Cloud system, use the All Communication Scenarios or the Integration with SAP
Ariba Buying communication scenario group when you get the registration token for the SAP S/4HANA Cloud system. This
allows the automatic enablement of the communication scenarios SAP_COM_0545 and SAP_COM_0A00 after the
corresponding system is added to the formation of type Integration with SAP Ariba Buying. See Register an SAP S/4HANA
Cloud System in a Global Account in SAP BTP.

Procedure
If you have SAP Ariba Buying set up in your subaccount in SAP BTP, follow these steps to configure the integration between SAP
Ariba Buying and SAP S/4HANA Cloud using a formation of type Integration with SAP Ariba Buying.

If you want to have the end-to-end setup automatically, including creating the formation, use the Set Up SAP Ariba Buying
booster in the SAP BTP cockpit to guide you through the steps to configure SAP Ariba Buying in your subaccount and integrate it
with SAP S/4HANA Cloud.

1. In the Systems page, find the systems of type SAP Ariba Buying and SAP S/4HANA Cloud that you want to include in a
formation.

The SAP S/4HANA Cloud system you are going to include in this formation must not be part of another formation.

2. In the System Landscape Formations page, create a formation of type Integration with SAP Ariba Buying and
include the relevant systems in it.

a. Add any name that helps you identify your formation.

b. In the Formation Type dropdown menu, select Integration with SAP Ariba Buying.

c. Select the SAP Ariba Buying and SAP S/4HANA Cloud systems that you want to include in the formation.

d. Review your selections and create the formation.

Next Steps
When the formation is created, you have SAP Ariba Buying set up with SAP S/4HANA Cloud on SAP BTP.

Automating Integrations with SAP Start

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

SAP Build Work Zone, standard edition is a predefined central entry point for accessing SAP cloud business solutions that are
integrated with it, such as SAP S/4HANA Cloud

This is custom documentation. For more information, please visit SAP Help Portal. 43
 6/11/25, 2:39 PM
To set up SAP Build Work Zone, standard edition with SAP S/4HANA Cloud on SAP BTP you need to have all the necessary
systems included in a formation of type Integration with SAP Start in the System Landscape Systems page of the SAP BTP
cockpit.

 Note
This documentation refers to SAP S/4HANA Cloud Public Edition. See Introduction to the Universe of SAP S/4HANA Cloud
Public Edition.

Rules
When creating Integration with SAP Start formations, keep in mind the following rules:

SAP Build Work Zone systems can be included in at most one Integration with SAP Start formation.

At most one SAP Build Work Zone system can be included in an Integration with SAP Start formation.

Only SAP S/4HANA Cloud systems that are registered with All Communication Scenarios or Integration with SAP Start
communication scenario group can be part of a Integration with SAP Start formation. See Register an SAP S/4HANA
Cloud System in a Global Account in SAP BTP.

Prerequisites
You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

You have an Identity Authentication tenant. See Indentity Authentication: Initial Setup.

(Optional: if you are using the Integration with SAP Start booster in the SAP BTP cockpit, this step will be automatically
done by the booster.) Check that you have a system of type SAP Build Work Zone in the Systems page. This system is
added through a subscription in SAP BTP cockpit associated with a given subaccount. The subscription has been
discovered and added automatically through the subaccount.

Check that you have a system of type SAP S/4HANA Cloud in the Systems list in the Systems page. This system is auto-
discovered because it is associated with your global account and has been discovered and added automatically to the list
based on information of the existing system landscape.

 Note
If you don't find your system of type SAP S/4HANA Cloud in the Systems list, add this system manually. See Register
an SAP S/4HANA Cloud System in a Global Account in SAP BTP.

Register the SAP S/4HANA Cloud system in the Systems list in the System Landscape page.

When you register an SAP S/4HANA Cloud system, use the Integration with SAP Start communication scenario group
when you get the registration token for the SAP S/4HANA Cloud system. This allows the automatic enablement of the
communication scenario SAP_COM_0647 after the corresponding system is added to the formation of type Integration
with SAP Start.

See Register an SAP S/4HANA Cloud System in a Global Account in SAP BTP.

Procedure
If you have SAP Build Work Zone set up in your subaccount in SAP BTP, follow these steps to configure the integration between
SAP Build Work Zone and SAP S/4HANA Cloud using a formation of type Integration with SAP Start.

This is custom documentation. For more information, please visit SAP Help Portal. 44
 6/11/25, 2:39 PM
If you want to have the end-to-end setup automatically, including creating the formation, use the Integration with SAP Start
booster in the SAP BTP cockpit to guide you through the steps to configure SAP Build Work Zone in your subaccount and integrate
it with SAP S/4HANA Cloud.

1. In the SAP BTP cockpit, in the Systems page, find the systems of type SAP Build Work Zone and SAP S/4HANA Cloud that
you want to include in a formation.

The SAP Build Work Zone system you are going to include in this formation must not be part of another formation.

2. In the System Landscape Formations page, create a formation of type Integration with SAP Start and include the
relevant systems in it.

a. Add any name that helps you identify your formation.

b. In the Formation Type dropdown menu, select Integration with SAP Start.

c. Select the SAP Build Work Zone and SAP S/4HANA Cloud systems that you want to include in the formation.

d. Review your selections and create the formation.

Next Steps
When the formation is created, you have SAP Build Work Zone set up with SAP S/4HANA Cloud on SAP BTP. Then, set up SAP Task
Center. See Post-Setup Tasks.

Automating Integrations with Data Ingestion for Industry Cloud

Solutions

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

SAP’s industry cloud provides specialized industry-focused solutions to help you optimize, extend, and transform your core
business processes. Developed by SAP and SAP partners and based on SAP Business Technology Platform (SAP BTP), industry
cloud solutions integrate with SAP S/4HANA Cloud and SAP Business Network. They help you take advantage of the latest
industry-relevant innovations and extend existing capabilities in an efficient way. For a list of all industry cloud solutions published
by SAP, see SAP Store .

Data ingestion for industry cloud solutions allows supported industry cloud solutions to consume data from a shared data
foundation instead of integrating with the source systems individually. This helps to simplify solution implementation, increase
operational visibility, and improve data quality. For a list of all industry cloud solutions published by SAP that support data
ingestion, see Data Integration Overview.

To set up on SAP BTP systems that support data ingestion and are part of the industry cloud solutions published by SAP, you need
to include them in a formation of type Data Ingestion for Industry Cloud Solutions. When you create a new formation of type Data
Ingestion for Industry Cloud Solutions, a system of type Data Ingestion for Industry Cloud Solutions is automatically added to
the System Landscape Systems page and included in this formation.

Rules
When creating Data Ingestion for Industry Cloud Solutions formations, keep in mind the following rules:

This is custom documentation. For more information, please visit SAP Help Portal. 45
 6/11/25, 2:39 PM
Only systems that are part of the industry cloud solutions, support data ingestion, and are provisioned from SAP for Me can
be included in formations of type Data Ingestion for Industry Cloud Solutions.

System that is part of the industry cloud solutions published by SAP are included in at most one Data Ingestion for
Industry Cloud Solutions formation.

System of type Data Ingestion for Industry Cloud Solutions is automatically registered and included in the Data Ingestion
for Industry Cloud Solutions formation.

System of type Data Ingestion for Industry Cloud Solutions cannot be excluded from the Data Ingestion for Industry
Cloud Solutions formation. Once you delete this formation, the Data Ingestion for Industry Cloud Solutions system is
automatically deleted.

Prerequisites
You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

Procedure
1. In the System Landscape Systems page of the SAP BTP cockpit, browse the already added systems that are part of
the industry cloud solutions published by SAP in your customer system landscape.

The system that is part of the industry cloud solutions published by SAP and that you want to include in this formation
must not be part of another formation.

2. In the System Landscape Formations page, create a formation of type Data Ingestion for Industry Cloud Solutions
and include the relevant systems in it.

a. Add any name that helps you identify your formation.

b. In the Formation Type dropdown menu, select Data Ingestion for Industry Cloud Solutions.

c. Select the systems that you want to include in the formation.

d. Review your selections and create the formation.

Related Information
Data Integration Overview

Automating Integrations with SAP Ariba Central Invoice

Management

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

SAP Ariba Central Invoice Management on SAP BTP provides a unified solution for receiving and managing supplier invoices, with
connection to different backend systems like SAP S/4HANA Cloud.

Using a formation of type Integration with SAP Ariba Central Invoice Management, you automatically set up an integration
between systems of type SAP Ariba Central Invoice Management and SAP S/4HANA Cloud.

This is custom documentation. For more information, please visit SAP Help Portal. 46
 6/11/25, 2:39 PM

 Note
This documentation refers to SAP S/4HANA Cloud Public Edition. See Introduction to the Universe of SAP S/4HANA Cloud
Public Edition.

Rules

When creating formations of type Integration with SAP Ariba Central Invoice Management, keep in mind the following rules:

System of type SAP Ariba Central Invoice Management can be included in at most one Integration with SAP Ariba Central
Invoice Management formation.

Formation of type Integration with SAP Ariba Central Invoice Management can contain exactly one system of type SAP
Ariba Central Invoice Management.

System of type SAP S/4HANA Cloud can be included in at most one Integration with SAP Ariba Central Invoice
Management formation when creating this formation.

When registering the SAP S/4HANA Cloud system, you have to choose one of the following communication scenario
groups:

All Communication Scenarios

Integration with SAP Ariba Central Invoice Management

See Register an SAP S/4HANA Cloud System in a Global Account in SAP BTP.

Prerequisites
You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

You have a system of type SAP Ariba Central Invoice Management in the Systems list. This system is auto-discovered
because it is associated with your global account and has been discovered and added automatically to the list based on
information of the existing system landscape.

You have registered the SAP S/4HANA Cloud system that you are going to include in the formation of type Integration
with SAP Ariba Central Invoice Management.

When you register an SAP S/4HANA Cloud system, use the All Communication Scenarios or the Integration with SAP
Ariba Central Invoice Management communication scenario groups when you get the registration token for the SAP
S/4HANA Cloud system. This allows the automatic enablement of the SAP_COM_0897, SAP_COM_0516, and
SAP_COM_0531 communication scenarios after the corresponding system is added to the formation of type Integration
with SAP Ariba Central Invoice Management. See Register an SAP S/4HANA Cloud System in a Global Account in SAP
BTP.

You have created a formation of type Integration with SAP Master Data Integration and have included in it the SAP Ariba
Central Invoice Management and the SAP S/4HANA Cloud systems. See Enabling Integration with SAP Master Data
Integration.

Procedure
As an alternative to the steps that follow, you can use the Set Up SAP Ariba Central Invoice Management booster in the SAP BTP
cockpit and have the end-to-end scenario set up. The booster includes:

Creating new subaccounts

Creating required service instances and subscriptions

This is custom documentation. For more information, please visit SAP Help Portal. 47
 6/11/25, 2:39 PM
Configuring all the required business integrations with the Identity Authentication service, SAP Master Data Integration,
and SAP S/4HANA Cloud

 Tip
We recommend that you use the Set Up SAP Ariba Central Invoice Management booster.

1. In the System Landscape Systems page of the SAP BTP cockpit, browse the already added systems in your system
landscape.

The SAP S/4HANA Cloud and the SAP Ariba Central Invoice Management systems you are going to include in this
formation must not be part of another formation.

2. In the System Landscape Formations page, create a formation of type Integration with SAP Ariba Central Invoice
Management and include the relevant systems in it.

a. Add any name that helps you identify your formation.

b. In the Formation Type dropdown menu, select Integration with SAP Ariba Central Invoice Management.

c. Choose Next Step.

d. Select the SAP Ariba Central Invoice Management system that you want to include in the formation.

e. Select the other systems that you want to include. In the list you can select only systems that are allowed to be
included in this formation.

f. Choose Next Step.

g. Review your selections and create the formation.

Automating Integrations with SAP Subscription Billing

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

SAP Subscription Billing is a public cloud solution that supports innovative, subscription-based business models. It enables
flexible definition of product prices and automates processes such as subscription generation, rating, and preparation of billing
data. SAP Subscription Billing offers comprehensive management of subscriptions throughout their life cycle. See SAP
Subscription Billing.

To set up SAP Subscription Billing with SAP S/4HANA Cloud on SAP BTP you need to have all the necessary systems included in a
formation of type Integration with SAP Subscription Billing in the System Landscape Systems page of the SAP BTP
cockpit.

 Note
This documentation refers to SAP S/4HANA Cloud Public Edition. See Introduction to the Universe of SAP S/4HANA Cloud
Public Edition.

Rules

This is custom documentation. For more information, please visit SAP Help Portal. 48
 6/11/25, 2:39 PM
When creating Integration with SAP Subscription Billing formations, keep in mind the following rule:

Formation of type Integration with SAP Subscription Billing can contain exactly one system of type SAP Subscription
Billing and one system of type SAP S/4HANA Cloud.

System of type SAP Subscription Billing can be included in at most one Integration with SAP Subscription Billing
formation.

System of type SAP S/4HANA Cloud can be included in at most one Integration with SAP Subscription Billing formation
when creating this formation.

Only SAP S/4HANA Cloud systems that are registered with All Communication Scenarios or the Integration with SAP
Subscription Billing communication scenario groups, can be part of an Integration with SAP Subscription Billing
formation. See Register an SAP S/4HANA Cloud System in a Global Account in SAP BTP.

Prerequisites
You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

Register the SAP S/4HANA Cloud system in the Systems page.

When you register an SAP S/4HANA Cloud system, use the All Communication Scenarios or the Integration with SAP
Subscription Billing communication scenario groups when you get the registration token for the SAP S/4HANA Cloud
system. This allows the automatic enablement of the SAP_COM_0845 and SAP_COM_0642 communication scenarios
after the corresponding system is added to the formation of type Integration with SAP Subscription Billing. See Register
an SAP S/4HANA Cloud System in a Global Account in SAP BTP.

Procedure
If you have SAP Subscription Billing set up in your subaccount in SAP BTP, follow these steps to configure the integration between
SAP Subscription Billing and SAP S/4HANA Cloud using a formation of type Integration with SAP Subscription Billing.

1. In the Systems page, find the systems of type SAP Subscription Billing and SAP S/4HANA Cloud that you want to include
in a formation.

The SAP S/4HANA Cloud and the SAP Subscription Billing systems you are going to include in this formation must not be
part of another formation.

2. In the System Landscape Formations page, create a formation of type Integration with SAP Subscription Billing and
include the relevant systems in it.

a. Add any name that helps you identify your formation.

b. In the Formation Type dropdown menu, select Integration with SAP Subscription Billing.

c. Select the SAP Subscription Billing and SAP S/4HANA Cloud systems that you want to include in the formation.

d. Review your selections and create the formation.

Next Steps
When the formation is created, you have SAP Subscription Billing set up with SAP S/4HANA Cloud on SAP BTP. Continue with your
setup activities for the integration scope item 57Z or 5IK. See:

Setup Guide for 57Z (Subscription Management with Sales Billing)

Setup Guide for 5IK (Subscription Management with Convergent Invoicing)

This is custom documentation. For more information, please visit SAP Help Portal. 49
 6/11/25, 2:39 PM

Automating Integrations with SAP Collaboration Manager

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

SAP Collaboration Manager is a chat solution that is integrated into the SAP Fiori launchpad, enabling you to accomplish tasks
quickly in your business applications. Collaborate with colleagues on activities, create notes and chats, and share attachments and
screenshots.

To set up SAP Collaboration Manager with SAP S/4HANA Cloud on SAP BTP, you need to have all the necessary systems included
in a formation of type Integration with SAP Collaboration Manager in the System Landscape Systems page of the SAP BTP
cockpit.

 Note
This documentation refers to SAP S/4HANA Cloud Public Edition. See Introduction to the Universe of SAP S/4HANA Cloud
Public Edition.

Rules
When creating Integration with SAP Collaboration Manager formations, keep in mind the following rule:

Only SAP S/4HANA Cloud systems that are registered with the All Communication Scenarios communication scenario
group can be part of a Integration with SAP Collaboration Manager formation. See Register an SAP S/4HANA Cloud
System in a Global Account in SAP BTP.

Prerequisites
You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

You have an Identity Authentication tenant. See Identity Authentication: Initial Setup.

You have an SAP Collaboration Manager subscription. See Subscribe to SAP Collaboration Manager.

Register the SAP S/4HANA Cloud system in the Systems page.

When you register an SAP S/4HANA Cloud system, use the All Communication Scenarios communication scenario group
when you get the registration token for the SAP S/4HANA Cloud system. This allows the automatic enablement of the
SAP_COM_0835 communication scenario after the corresponding system is added to the formation of type Integration
with SAP Collaboration Manager. See Register an SAP S/4HANA Cloud System in a Global Account in SAP BTP.

Procedure
If you have SAP Collaboration Manager set up in your subaccount in SAP BTP, follow these steps to configure the integration
between SAP Collaboration Manager and SAP S/4HANA Cloud using a formation of type Integration with SAP Collaboration
Manager.

As an alternative to the steps that follow, you can use the SAP Collaboration Manager booster in the SAP BTP cockpit and have
the end-to-end scenario set up. See Run the SAP Collaboration Manager Booster.

This is custom documentation. For more information, please visit SAP Help Portal. 50
 6/11/25, 2:39 PM

 Note
We recommend that you use the SAP Collaboration Manager booster.

1. In the Systems page, find the systems of type SAP Collaboration Manager and SAP S/4HANA Cloud that you want to
include in a formation.

2. In the System Landscape Formations page, create a formation of type Integration with SAP Collaboration Manager
and include the relevant systems in it.

a. Add any name that helps you identify your formation.

b. In the Formation Type dropdown menu, select Integration with SAP Collaboration Manager.

c. Select the SAP Collaboration Manager and SAP S/4HANA Cloud systems that you want to include in the
formation.

d. Review your selections and create the formation.

Next Steps
When the formation is created, you have SAP Collaboration Manager set up with SAP S/4HANA Cloud on SAP BTP. Then, follow
the next steps at Run the SAP Collaboration Manager Booster: Next Steps.

Automating Integrations with SAP Advanced Financial Closing

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

SAP Advanced Financial Closing supports you in planning, processing, monitoring, and analyzing financial closing tasks for the
entities of your group. See SAP Advanced Financial Closing User Guide.

To set up SAP Advanced Financial Closing with SAP S/4HANA Cloud on SAP BTP you need to have all the necessary systems
included in a formation of type Integration with SAP Advanced Financial Closing in the System Landscape Systems page of
the SAP BTP cockpit.

 Note
This documentation refers to SAP S/4HANA Cloud Public Edition. See Introduction to the Universe of SAP S/4HANA Cloud
Public Edition.

Rules

When creating Integration with SAP Advanced Financial Closing formations, keep in mind the following rule:

Only SAP S/4HANA Cloud systems that are registered with All Communication Scenarios or the Integration with SAP
Advanced Financial Closing communication scenario groups, can be part of a Integration with SAP Advanced Financial
Closing formation. See Register an SAP S/4HANA Cloud System in a Global Account in SAP BTP.

Prerequisites
This is custom documentation. For more information, please visit SAP Help Portal. 51
 6/11/25, 2:39 PM
You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

You have an Identity Authentication tenant. See Indentity Authentication: Initial Setup.

Register the SAP S/4HANA Cloud system in the Systems page.

When you register an SAP S/4HANA Cloud system, use the All Communication Scenarios or the Integration with SAP
Advanced Financial Closing communication scenario groups when you get the registration token for the SAP S/4HANA
Cloud system. This allows the automatic enablement of the SAP_COM_0566 communication scenario after the
corresponding system is added to the formation of type Integration with SAP Advanced Financial Closing. See Register an
SAP S/4HANA Cloud System in a Global Account in SAP BTP.

Procedure
If you have SAP Advanced Financial Closing set up in your subaccount in SAP BTP, follow these steps to configure the integration
between SAP Advanced Financial Closing and SAP S/4HANA Cloud using a formation of type Integration with SAP Advanced
Financial Closing.

As an alternative to the steps that follow, you can use the Set Up SAP Advanced Financial Closing booster in the SAP BTP cockpit
and have the end-to-end scenario set up. See SAP Advanced Financial Closing Administration Guide: Automated Setup.

 Note
We recommend that you use the Set Up SAP Advanced Financial Closing booster.

1. In the Systems page, find the systems of type SAP Advanced Financial Closing and SAP S/4HANA Cloud that you want to
include in a formation.

2. In the System Landscape Formations page, create a formation of type Integration with SAP Advanced Financial
Closing and include the relevant systems in it.

a. Add any name that helps you identify your formation.

b. In the Formation Type dropdown menu, select Integration with SAP Advanced Financial Closing.

c. Select the SAP Advanced Financial Closing and SAP S/4HANA Cloud systems that you want to include in the
formation.

d. Review your selections and create the formation.

Next Steps

When the formation is created, you have SAP Advanced Financial Closing set up with SAP S/4HANA Cloud on SAP BTP. See the
Next Steps section at SAP Advanced Financial Closing Administration Guide: Automated Setup.

Enabling Joule

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

This is custom documentation. For more information, please visit SAP Help Portal. 52
 6/11/25, 2:39 PM
Leveraging its generative AI capabilities, Joule aims to understand your requests, retrieve information, and complete your tasks in
a conversational way. You can describe the current task to Joule, who can help automate tasks or take you to places where you can
find desired data. By using Joule, you can easily interact with the system and increase your productivity.

To use Joule in SAP systems, you have to integrate these systems with Joule. To do that, you have to include the SAP systems in a
formation of type Integration with Joule on the System Landscape Formations page of the SAP BTP cockpit. The integration
is between the Joule system and every SAP system in the formation, but not between each and every SAP system.

To see which SAP systems are supported, see Joule Capabilities.

Rules

When creating Integration with Joule formations, keep in mind the following rules:

At most one system of type Joule can be included in one Integration with Joule formation.

A system of type Joule can be included in at most one Integration with Joule formation.

Applicable to systems of type SAP Integrated Business Planning: you can include these systems in a formation of type
Integration with Joule only if they are registered using the All Communication Scenarios communication scenario group.
See Register an SAP Integrated Business Planning System in a Global Account in SAP BTP.

Applicable to systems of type SAP SuccessFactors: you can include these systems in a formation of type Integration with
Joule only after they have been registered. See Register an SAP SuccessFactors System in a Global Account in SAP BTP.

Applicable to systems of type SAP S/4HANA Cloud: you can include these systems in a formation of type Integration with
Joule only if they are registered using the All Communication Scenarios communication scenario group. See Register an
SAP S/4HANA Cloud System in a Global Account in SAP BTP.

 Note
This documentation refers to SAP S/4HANA Cloud Public Edition. See Introduction to the Universe of SAP S/4HANA
Cloud Public Edition.

Prerequisites
You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

You have a Joule system and at least one other system of the supported types that fulfill the rules in the Systems page. The
Joule system is auto-discovered.

Procedure
The following procedure outlines the steps you need to perform to enable the integration between Joule and SAP systems.

As an alternative to the steps that follow, you can use the Setting Up Joule booster in the SAP BTP cockpit and have the end-to-
end scenario set up. See Run the Joule Booster.

 Note
We recommend that you use the Setting Up Joule booster.

1. In the SAP BTP cockpit, in the System Landscape Systems page of the SAP BTP cockpit, browse the already added
systems in your customer system landscape or manually add and register any missing systems.

This is custom documentation. For more information, please visit SAP Help Portal. 53
 6/11/25, 2:39 PM
The Joule system you are going to include in this formation must not be part of another formation.

The customer system landscape features systems that are added to the list in one of the following ways:

Auto-discovered

An auto-discovered system is a system (associated with the given global account) that has been discovered and
added automatically to the list based on information of the existing system landscape. Any SAP system of the
supported system types that is associated with the same customer ID, with which your global account in SAP BTP is
associated, will be added automatically in the system landscape list.

Subaccount/<my-subaccount>

A subscription in SAP BTP cockpit associated with a given subaccount. The subscription has been discovered and
added automatically through the subaccount. Check the value of the Discovery column to see the subaccount
where your system is subscribed.

Manually added

Specifies that the system has been added to the list manually by the global account administrator, using the Add
System button and completing the wizard. The system has been associated with the global account in SAP BTP.

 Note
If a given SAP system is missing on the Systems page, it may be associated with a different customer ID on the SAP BTP
global account you are working in. In this case, you need to add the system manually, and then, register it.

See Adding, Registering and Deregistering Systems.

2. Create a formation of type Integration with Joule and include the relevant systems in it.

a. Add any name that helps you identify your formation.

b. In the Formation Type dropdown menu, select Integration with Joule.

c. Select the systems that you want to include in the formation. One of these systems must be of type Joule.

 Note
Systems can only be added to one formation of type Integration with Joule in a global account.

Also, a formation of type Integration with Joule can contain only one system of type Joule.

d. Review your selections and create the formation.

Next Steps
The next steps of the different SAP solutions integrated with Joule are listed at Integrating Joule with SAP Solutions.

Enabling Events Exchange Between SAP Cloud Systems

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

This is custom documentation. For more information, please visit SAP Help Portal. 54
 6/11/25, 2:39 PM
Systems that are included in Eventing Between SAP Cloud Systems formations on the System Landscape page of the SAP BTP
cockpit can publish and consume events. The process of publishing and consuming events is in fact an exchange of event
information across the customer system landscape and is driven by the system formations on the one hand side and the SAP
Cloud Application Event Hub on the other.

 Note
By creating a formation of type Eventing Between SAP Cloud Systems, keep in mind that there may be event distribution
charges incurred if you exceed the free quota limit when using SAP Cloud Application Event Hub. To learn more about usage
and consumption costs, see Usage and Consumption Costs.

Rules
When creating Eventing Between SAP Cloud Systems formations, keep in mind the following rule:

Every system can be included in at most one Eventing Between SAP Cloud Systems formation.

If you register your SAP S/4HANA Cloud system using the All Communication Scenarios or Eventing Between SAP Cloud
Systems communication scenario group when you get the registration token for this SAP S/4HANA Cloud system, the
communication scenario SAP_COM_0892 will be enabled automatically after this SAP S/4HANA Cloud system is added to
the formation of type Eventing Between SAP Cloud Systems in the Formations page. See Register an SAP S/4HANA Cloud
System in a Global Account in SAP BTP.

Prerequisites

You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

You have subscribed to the SAP Cloud Application Event Hub application. See Subscribing to SAP Cloud Application Event
Hub Application.

Procedure
The following procedure outlines the steps you need to perform to enable the exchange of events across the systems within the
system landscape.

1. In the SAP BTP cockpit, in the System Landscape Systems page of the SAP BTP cockpit, browse the already added
systems in your customer system landscape or manually add and register any missing systems.

Every system you are going to include in this formation must not be part of another formation.

The customer system landscape features systems that are added to the list in one of the following ways:

Auto-discovered

An auto-discovered system is a system (associated with the given global account) that has been discovered and
added automatically to the list based on information of the existing system landscape. Any SAP system of the
supported system types that is associated with the same customer ID, with which your global account in SAP BTP is
associated, will be added automatically in the system landscape list.

Subaccount/<my-subaccount>

A subscription in SAP BTP cockpit associated with a given subaccount. The subscription has been discovered and
added automatically through the subaccount. Check the value of the Discovery column to see the subaccount
where your system is subscribed.

Manually added

This is custom documentation. For more information, please visit SAP Help Portal. 55
 6/11/25, 2:39 PM
Specifies that the system has been added to the list manually by the global account administrator, using the Add
System button and completing the wizard. The system has been associated with the global account in SAP BTP.

 Note
If a given SAP system is missing on the Systems page, it may be associated with a different customer ID on the SAP BTP
global account you are working in. In this case, you need to add the system manually, and then, register it.

 Tip
When you register an SAP S/4HANA Cloud system, you can automate some of the required configuration steps at a
later point. To do this, you can use the All Communication Scenarios or Eventing Between SAP Cloud Systems
communication scenario groups when you get the registration token for the SAP S/4HANA Cloud system. This allows
the automatic enablement of the communication scenario SAP_COM_0892 after the corresponding system is added to
the formation of type Eventing Between SAP Cloud Systems.

See Adding, Registering and Deregistering Systems.

2. Create a formation of type Eventing Between SAP Cloud Systems and include the relevant systems in it.

a. Add any name that helps you identify your formation.

b. In the Formation Type dropdown menu, select Eventing Between SAP Cloud Systems.

c. Select the systems that you want to include in the formation. One of these systems must be of type SAP Event
Broker.

 Note
Systems can only be added to one formation of type Eventing Between SAP Cloud Systems in a global account.

Also, a formation of type Eventing Between SAP Cloud Systems can contain only one system of type SAP Event
Broker.

d. Review your selections and create the formation.

Next Steps
When the formation is created, navigate to the SAP Cloud Application Event Hub application and enable the event subscriptions.
See Enabling SAP Event Subscriptions.

Remove a System from the Formation

If you want to remove an SAP system from a formation of type Eventing Between SAP Cloud Systems, make sure that all active
event subscriptions are disabled first in SAP Cloud Application Event Hub. You can check your subscriptions in the SAP Cloud
Application Event Hub application on the Subscriptions page. See Disabling SAP Event Subscriptions.

Enabling Integration with SAP Master Data Integration

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

This is custom documentation. For more information, please visit SAP Help Portal. 56
 6/11/25, 2:39 PM
SAP Master Data Integration service is a central master data hub. Applications integrate with SAP Master Data Integration to
synchronize their local master data databases with the master data database of the central hub. In a typical setup, there is exactly
one tenant of SAP Master Data Integration for each landscape. See What Is Master Data Integration?.

Using a formation of type Integration with SAP Master Data Integration, you automatically set up an integration between
systems of type SAP Master Data Integration and other systems or applications, for example SAP S/4HANA Cloud.

 Note
This documentation refers to SAP S/4HANA Cloud Public Edition. See Introduction to the Universe of SAP S/4HANA Cloud
Public Edition.

Rules
When creating formations of type Integration with SAP Master Data Integration, keep in mind the following rules:

System of type SAP Master Data Integration can be included in at most one Integration with SAP Master Data
Integration formation.

Formation of type Integration with SAP Master Data Integration can contain exactly one system of type SAP Master Data
Integration.

System of type SAP S/4HANA Cloud can be included in at most one Integration with SAP Master Data Integration
formation.

When registering the SAP S/4HANA Cloud system, you have to choose one of the following communication scenario
groups:

All Communication Scenarios

Integration with SAP Master Data Integration

Integration with SAP Ariba Central Invoice Management

See Register an SAP S/4HANA Cloud System in a Global Account in SAP BTP.

Prerequisites
You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

You have a system of type SAP Master Data Integration in the Systems list. This system is auto-discovered because it is
associated with your global account and has been discovered and added automatically to the list based on information of
the existing system landscape.

You have registered the SAP S/4HANA Cloud system that you are going to include in the formation of type Integration
with SAP Master Data Integration.

When you register an SAP S/4HANA Cloud system, use the All Communication Scenarios or the Integration with SAP
Master Data Integration communication scenario groups when you get the registration token for the SAP S/4HANA Cloud
system. This allows the automatic enablement of the SAP_COM_0008, SAP_COM_0091, SAP_COM_0659, and
SAP_COM_0594 communication scenarios after the corresponding system is added to the formation of type Integration
with SAP Master Data Integration.

Procedure

This is custom documentation. For more information, please visit SAP Help Portal. 57
 6/11/25, 2:39 PM
1. In the System Landscape Systems page of the SAP BTP cockpit, browse the already added systems in your system
landscape.

The SAP S/4HANA Cloud and the SAP Master Data Integration systems you are going to include in this formation must
not be part of another formation.

2. In the System Landscape Formations page, create a formation of type Integration with SAP Master Data Integration
and include the relevant systems in it.

a. Add any name that helps you identify your formation.

b. In the Formation Type dropdown menu, select Integration with SAP Master Data Integration.

c. Choose Next Step.

d. Select the SAP Master Data Integration system that you want to include in the formation.

e. Select the other systems that you want to include. In the list you can select only systems that are allowed to be
included in this formation.

f. Choose Next Step.

g. Review your selections and create the formation.

Next Steps
Depending on the specific scenario, the next steps would be different. For example, if an SAP Ariba Central Invoice Management
system is included in a formation of type Integration with SAP Master Data Integration, then continue with the steps described in
Automating Integrations with SAP Ariba Central Invoice Management.

Setting Up System Landscape for Kyma

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

You want to extend the functionality on top of your existing SAP solution because your specific business needs require it. You also
want to use the SAP BTP Kyma environment. You can build an extension application that contains your business logic and UI
changes and deploy it in SAP BTP Kyma runtime. For the users of your SAP solution, this change will be seamless, it will look as if
it's part of the original functionality. At the same time, you can use the extension capabilities of SAP BTP to implement the
additional workflows or modules. This is called side-by-side extensibility wth Kyma.

Procedure
To enable the side-by-side extensibility with Kyma for your SAP solution, you have to:

1. Create an SAP BTP, Kyma environment instance in your subaccount in SAP BTP.

2. Add the Application Connector module on your Kyma runtime.

3. Connect the corresponding SAP system with the global account in SAP BTP. Use the automated configurations for the
following SAP solutions:

Extending SAP S/4HANA Cloud in the Cloud Foundry and Kyma Environment

This is custom documentation. For more information, please visit SAP Help Portal. 58
 6/11/25, 2:39 PM
Extending SAP Marketing Cloud in the Cloud Foundry and Kyma Environment

Extending SAP SuccessFactors in the Cloud Foundry and Kyma Environment

Extending SAP Customer Experience Products in the Kyma Environment

4. Create a formation of type Side-by-Side Extensibility with Kyma where you can include one or more SAP systems
depending on your use case.

Setting Up System Landscape for SAP Build

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

A registered SAP S/4HANA Cloud system in the SAP BTP cockpit can expose consumption bundles that contain APIs and events.
You can easily discover and consume the APIs exposed by the SAP S/4HANA Cloud systems in your system landscape when you
develop and extend applications on SAP BTP, Cloud Foundry environment, using SAP Build. To do this, first you need to enable
connectivity between your system landscape in SAP BTP cockpit and SAP Build. The integration requires performing several
configuration steps starting with configuration on a global account level, and then, configuration on a subaccount level.

 Note
This documentation refers to SAP S/4HANA Cloud Public Edition. See Introduction to the Universe of SAP S/4HANA Cloud
Public Edition.

Prerequisites
You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

You have an SAP Build subscription.

Procedure
The following procedure outlines the steps you need to perform to consume the APIs of registered SAP S/4HANA Cloud systems
within SAP Build.

1. Add and then register an SAP system of type SAP S/4HANA Cloud in the System Landscape Systems page of SAP
BTP cockpit.

To expose information about its APIs and events and show this information on the Systems page, an SAP system of type
SAP S/4HANA Cloud must be registered in the SAP BTP cockpit. Only when registered, the system communicates
information about its APIs and other technical details across the landscape. See Extending SAP S/4HANA Cloud in the
Cloud Foundry and Kyma Environment.

2. In the Formations page, create a formation of type Integration with SAP Build and include the SAP Build system and the
SAP S/4HANA Cloud systems you want to expose in SAP Build.

 Note
In the formation type Integration with SAP Build, you can include only SAP systems of type SAP Build and SAP
S/4HANA Cloud.

This is custom documentation. For more information, please visit SAP Help Portal. 59
 6/11/25, 2:39 PM
To enable connectivity between given SAP systems of type SAP S/4HANA Cloud from the Systems page of SAP BTP
cockpit and SAP Build, you must create a formation of the corresponding type and include the SAP S/4HANA Cloud
systems in it. See Automating Integrations Using Formations.

3. Create a destination and make sure it has the corresponding system and consumption bundle properties.

Create a destination manually.

You can create the destination manually via the SAP Destination service page in SAP BTP cockpit by specifying one
of the following additional properties variants in it.

Additional Properties (variant 1) Additional Properties (variant 2) Description

x-correlation-id x-correlation-id The property identifies the

consumption bundle and its APIs that
are exposed by the SAP S/4HANA
Cloud system. The destination also
provides the required credentials to
consume the bundle and use it for
further development in SAP Build.

x-system-id x-system-name Properties that uniquely identify the

local tenant of the registered SAP
x-system-type x-system-base-url S/4HANA Cloud system.

All of the required properties of a given SAP S/4HANA Cloud system are accessible in the corresponding System
Details section on the Systems page.

Create a destination automatically.

Alternatively, the destination can be created automatically. You can do this, by creating a service instance of the SAP
S/4HANA Cloud Extensibility service after you register an SAP S/4HANA Cloud system. See Extending SAP
S/4HANA Cloud in the Cloud Foundry and Kyma Environment and Create a Service Instance to Consume the SAP
S/4HANA Cloud APIs.

Next Steps
Develop applications on SAP BTP, Cloud Foundry environment using SAP Build and the system landscape.

When you enable the connectivity, the SAP S/4HANA Cloud systems and their APIs are accessible in SAP Build. Next you can use
the APIs to develop new or extend the existing functionality with the help of SAP Build.

Related Information
SAP Build Process Automation: Using SAP Systems

Setting Up System Landscape for SAP Integration Suite

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

This is custom documentation. For more information, please visit SAP Help Portal. 60
 6/11/25, 2:39 PM
A registered SAP S/4HANA Cloud system in the SAP BTP cockpit can expose consumption bundles that contain APIs and events.
You can easily discover and consume the APIs exposed by the SAP S/4HANA Cloud systems in your system landscape when you
develop and extend applications on SAP BTP, Cloud Foundry environment. To do this, first you need to enable connectivity between
your system landscape in SAP BTP cockpit and SAP Integration Suite. The integration requires performing several configuration
steps starting with configuration on a global account level, and then, configuration on a subaccount level.

 Note
This documentation refers to SAP S/4HANA Cloud Public Edition. See Introduction to the Universe of SAP S/4HANA Cloud
Public Edition.

Rules
When creating Integration with SAP Integration Suite formations, keep in mind the following rule:

At most one system of type SAP Integration Suite can be included in one Integration with SAP Integration Suite
formation.

Prerequisites

You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

You have a subscription to SAP Integration Suite. See Subscribing and Configuring Initial Access to SAP Integration Suite.

 Note
Every time you create a subscription to a new SAP Integration Suite tenant, the system type for the tenant is
automatically defined as SAP Integration Suite.

Procedure
The following procedure outlines the steps you need to perform to consume the APIs of registered SAP S/4HANA Cloud systems
within SAP Integration Suite.

1. Add and then register an SAP system of type SAP S/4HANA Cloud in the System Landscape Systems page of SAP
BTP cockpit.

To expose information about its APIs and events and show this information on the Systems page, an SAP system of type
SAP S/4HANA Cloud must be registered in the SAP BTP cockpit. Only when registered, the system communicates
information about its APIs and other technical details across the landscape. See Register an SAP S/4HANA Cloud System
in a Global Account in SAP BTP.

2. In the System Landscape Formations page, create a formation of type Integration with SAP Integration Suite and
include the SAP S/4HANA Cloud systems you want to expose to SAP Integration Suite. See Automating Integrations Using
Formations.

 Note
In the formation type Integration with SAP Integration Suite, you can include only SAP systems of type SAP S/4HANA
Cloud.

This is custom documentation. For more information, please visit SAP Help Portal. 61
 6/11/25, 2:39 PM

Setting Up System Landscape for SAP Business Application

Studio

Use

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

A registered SAP S/4HANA Cloud system in the SAP BTP cockpit can expose consumption bundles that contain APIs and events.
You can easily discover and consume the APIs exposed by the SAP S/4HANA Cloud systems in your system landscape when you
develop and extend applications on SAP BTP, Cloud Foundry environment, using SAP Business Application Studio. To do this, first
you need to enable connectivity between your system landscape in SAP BTP cockpit and SAP Business Application Studio. The
integration requires performing several configuration steps starting with configuration on a global account level, and then,
configuration on a subaccount level.

 Note
This documentation refers to SAP S/4HANA Cloud Public Edition. See Introduction to the Universe of SAP S/4HANA Cloud
Public Edition.

Prerequisites
You are a global account administrator, or you are a system landscape administrator. See Working with Role Collections.

You have an SAP Business Application Studio subscription. See Subscribe to SAP Business Application Studio.

Procedure
The following procedure outlines the steps you need to perform to consume the APIs of registered SAP S/4HANA Cloud systems
within the SAP Business Application Studio.

1. In the System Landscape Systems page of SAP BTP cockpit, add and then register an SAP system of type SAP
S/4HANA Cloud.

To expose information about its APIs and events and show this information on the Systems page, an SAP system of type
SAP S/4HANA Cloud must be registered in the SAP BTP cockpit. Only when registered, the system communicates
information about its APIs and other technical details across the landscape. See Extending SAP S/4HANA Cloud in the
Cloud Foundry and Kyma Environment.

2. In the System Landscape Formations page, create a formation of type Developing with SAP Business Application
Studio and include the SAP Business Application Studio system and the SAP S/4HANA Cloud systems you want to expose
in SAP Business Application Studio.

 Note
In the formation type Developing with SAP Business Application Studio, you can include only SAP systems of type SAP
Business Application Studio and SAP S/4HANA Cloud.

To enable connectivity between given SAP systems of type SAP S/4HANA Cloud from the Systems page of SAP BTP
cockpit and the SAP Business Application Studio, you must create a formation of the corresponding type and include the
SAP S/4HANA Cloud systems in it. See Automating Integrations Using Formations.

3. Create a destination and make sure it has the corresponding system and consumption bundle properties.

This is custom documentation. For more information, please visit SAP Help Portal. 62
 6/11/25, 2:39 PM
Create a destination manually.

You can create the destination manually via the SAP Destination service page in SAP BTP cockpit by specifying one
of the following additional properties variants in it.

Additional Properties (variant 1) Additional Properties (variant 2) Description

x-correlation-id x-correlation-id The property identifies the

consumption bundle and its APIs that
are exposed by the SAP S/4HANA
Cloud system. The destination also
provides the required credentials to
consume the bundle and use it for
further development in the SAP
Business Application Studio.

x-system-id x-system-name Properties that uniquely identify the

local tenant of the registered SAP
x-system-type x-system-base-url S/4HANA Cloud system.

All of the required properties of a given SAP S/4HANA Cloud system are accessible in the corresponding System
Details section on the Systems page.

Create a destination automatically.

Alternatively, the destination can be created automatically. You can do this, by creating a service instance of the SAP
S/4HANA Cloud Extensibility service after you register an SAP S/4HANA Cloud system. See Extending SAP
S/4HANA Cloud in the Cloud Foundry and Kyma Environment and Create a Service Instance to Consume the SAP
S/4HANA Cloud APIs.

Next Steps
Develop applications on SAP BTP, Cloud Foundry environment using SAP Business Application Studio and the system landscape.

When you enable the connectivity, the SAP S/4HANA Cloud systems and their APIs are accessible in the SAP Business Application
Studio. Next you can use the APIs to develop new or extend the existing functionality with the help of SAP Business Application
Studio. See Unified Customer Landscape Service Provider.

Extending SAP Solutions

The extension capabilities of SAP Business Technology Platform (SAP BTP) enables developers to implement loosely coupled
extension applications securely, thus implementing additional workflows or modules on top of the existing SAP cloud solution they
already have.

Overview

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

With the automated configuration you have the following key benefits:

A way of extending standard SAP solutions without disrupting their performance and core processes

This is custom documentation. For more information, please visit SAP Help Portal. 63
 6/11/25, 2:39 PM
Frameworks that offer simplified, standardized, and unified extensibility and configuration for SAP solutions

A central repository for solutions' APIs, events, credentials, and other data, thereby ensuring easy access to services while
creating your extensions

You can also use dedicated formations that help you integrate automaticatically the SAP solution you want to extend with
runtimes and tools you might need. See:

Setting Up System Landscape for Kyma

Setting Up System Landscape for SAP Build

Setting Up System Landscape for SAP Integration Suite

Setting Up System Landscape for SAP Business Application Studio

Process Flow
You can use the extension capabilities of SAP BTP to implement additional workflows or modules on top of your existing SAP
solutions. You can extend one or more SAP solutions grouped together in a common business case.

To enable the integration, you need to:

1. Connect the corresponding SAP system with the global account.

For systems of type SAP S/4HANA Cloud, SAP Marketing Cloud, SAP SuccessFactors and SAP systems from the
SAP Customer Experience portfolio, during the pairing process you create an registration token which is then used
by the SAP system administrator to configure the registration on the SAP system side. See Adding, Registering and
Deregistering Systems.

For systems of type different than SAP S/4HANA Cloud, SAP Marketing Cloud, SAP SuccessFactors and SAP
systems from the SAP Customer Experience portfolio, the SAP system is already registered when it's part of the
Systems page. However, in the Status column, there is no status shown. See Adding, Registering and Deregistering
Systems.

For third-party systems, the system is already registered when it's part of the Systems page. However, in the Status
column, there is no status shown. See Register a Third-Party System.

 Note
You cannot migrate the registered SAP systems between global accounts.

If you want to start using another global account, you will have to register your SAP systems again.

2. Optional: Group SAP systems so that they can be extended in a business scenario at one go.

To do so, you create a formation containing one or more different systems assigned to a common subaccount. See
Automating Integrations Using Formations.

3. Make the SAP system accessible in the subaccounts in which you want to build your extension applications.

For systems of type SAP S/4HANA Cloud, SAP Marketing Cloud, and SAP SuccessFactors, configure the entitlements and
assign the corresponding quota and service plans to the subaccounts where the extension applications will reside. The
service plans define the access to the corresponding SAP solution APIs. See:

Configure the Entitlements for the SAP S/4HANA Cloud Extensibility Service

Configure the Entitlements for the SAP SuccessFactors Extensibility Service

For the systems of type different than SAP S/4HANA Cloud, SAP Marketing Cloud, and SAP SuccessFactors, you can
continue with developing your extension application.

This is custom documentation. For more information, please visit SAP Help Portal. 64
 6/11/25, 2:39 PM
4. For systems of type SAP S/4HANA Cloud, SAP Marketing Cloud, and SAP SuccessFactors, configure the communication
flow for the extension application.

To be able to consume the SAP S/4HANA Cloud, SAP Marketing Cloud, and SAP SuccessFactors APIs, you need to create a
service instance for the corresponding SAP solution system. During the creation of the service instance, you configure the
communication flow between the subaccount and the corresponding SAP solution. An HTTP destination which contains the
binding properties for establishing the connection is automatically generated.

After you have created the service instance, you have two options to configure the extension application's connectivity to
the corresponding SAP solution:

Consume the HTTP destination

Bind the service instance to the extension application

Related Information
Extending SAP S/4HANA Cloud in the Cloud Foundry and Kyma Environment
Extending SAP SuccessFactors in the Cloud Foundry and Kyma Environment
Extending SAP Customer Experience Products in the Kyma Environment
Extending SAP Marketing Cloud in the Cloud Foundry and Kyma Environment

Declaring System APIs and Events as Dependencies for Business

Scenarios

Context
For certain formation types, systems of type Other System Type, SAP BTP Application, or SAP Integration Suite that are part of
the System Landscape page may need to describe their runtime dependencies so other systems can comply with these
dependencies to be able to interact with these systems in a common scenario.

The integration dependency includes a list of requirements, which point out which API and event resources are involved. Each
requirement describes one aspect and can be used to express alternatives using OR conditions for achieving the same outcome.

To add the necessary API and event resources to an integration dependency, systems use the Open Resource Discovery standard.
The Open Resource Discovery standard is about adding missing or common high-level information and standardizing the
discovery aspects. See Why ORD .

Every integration dependency has the following properties:

Name: a human-readable name that does not exceed 255 characters. For example, Integration Dependency to
realize Customer Order data product.

Description: a plain text that does not exceed 255 characters. For example, SAP S/4HANA Cloud, our next
generation cloud ERP suite designed for in-memory computing.

Version: the version is assigned automatically when adding a new integration dependency.

 Note
If you add a new integration dependency using the same name as an existing integration dependency, the version of the
new integration dependency will be automatically increased. Then, in the given system, there will be two integration
dependencies with the same name and different versions.

Depending on your use case, there are different templates that help you set up the necessary integration dependency:
This is custom documentation. For more information, please visit SAP Help Portal. 65
 6/11/25, 2:39 PM
Blank template

You write integration dependencies from scratch inluding the aspects that contain a set of APIs and/or events of a system
that define the dependencies other systems need to comply with to be able to be part of an integration scenario together.

Simplified Business Eventing template

Integration dependencies are exposed as available event subscriptions in SAP Cloud Application Event Hub. This template
helps you write simplified integration dependencies that identify the types of events a subscribing application wants to
consume. Here's an example. Let's say SAP SuccessFactors publishes a set of events. You want to receive a subset of those
events. You can use the Simplified Business Eventing Template to identify the event types that SAP Cloud Application
Event Hub makes available to your subscribing system.

Add an Integration Dependency Using a Blank Template

Prerequisites
You have a system of type Other System Type or SAP BTP Application listed in the Systems page of your global account in SAP
BTP. See Register a Third-Party System.

Context
Integration dependencies contain aspects. An aspect contains a set of APIs and/or events of a system that define the
dependencies other systems need to comply with to be able to be part of an integration scenario together.

Procedure
1. In the cockpit, navigate to your global account, and then choose System Landscape Systems .

2. On the Systems page, select a system of type Other System Type to which you want to add an integration dependency and
open its system details.

3. In the Integration Dependencies tab, choose Add.

4. Select Blank Template to write an integration dependency from scratch.

5. Define a name and a description for the new integration dependency. Choose Next Step.

 Note
The version is assigned automatically when adding a new integration dependency. If you add a new integration
dependency using the same name as an existing integration dependency, the version of the new integration
dependency will be automatically increased.

6. Define a name and a description for the first aspect and add more if necessary. Choose Next Step.

7. Add at least one API or event to each aspect and choose Review.

8. Check if all the aspects are configured properly and choose Add.

 Note
Once you add an integration dependency to a system, you can no longer edit it and add or delete aspects, APIs or
events. You can only delete an integration dependency.

Add an Integration Dependency Using a Simplified Business

Eventing Template
This is custom documentation. For more information, please visit SAP Help Portal. 66
 6/11/25, 2:39 PM

Prerequisites
An SAP Cloud system is registered in the Systems page in SAP BTP cockpit and has a catalog of events that it plans to
publish. Refer to the product documentation for the publishing system for more details. For example, an SAP
SuccessFactors system can be configured to publish events. See SAP Cloud Application Event Hub Service Guide:
Integration Use Cases.

The SAP system you plan to use as the subscriber is registered in the Systems page. If you want to use SAP Integration
Suite integration flows to consume events from SAP Cloud Application Event Hub, then the tenant with the integration flow
must be registered in the Systems page. See Integration Example using SAP Integration Suite.

Your subscribing system is listed in the Systems page of your global account in SAP BTP.

For example, you have a system of type SAP Integration Suite listed in the Systems page. It appears as auto-discovered.

Context
You can subscribe to events with extension applications. For example, you use SAP SuccessFactors to publish events and an
Integration Suite tenant to consume them. The SAP SuccessFactors system is publishing these events and you add the event
types that you want this system to receive using the Simplified Business Eventing Template of the integration
dependencies. Integration dependencies are exposed as available event subscriptions in SAP Cloud Application Event Hub. The
Simplified Business Eventing Template helps you write simplified integration dependencies specifying only event-specific
information.

Procedure
1. In the cockpit, navigate to your global account, and then choose System Landscape Systems .

2. On the Systems page, select a system of type Integration Suite to which you want to add an integration dependency and
open its system details.

3. In the Integration Dependencies tab, choose Add.

4. Select Simplified Business Eventing Template to identify the system that is publishing events and add the event types that
you want to receive. Integration dependencies are exposed as available event subscriptions in SAP Cloud Application Event
Hub.

5. Define a name and a description for the new integration dependency.

 Note
The version is assigned automatically when adding a new integration dependency. If you add a new integration
dependency using the same name as an existing integration dependency, the version of the new integration
dependency will be automatically increased.

6. In the Publishing System Namespace field, provide the system namespace of the system that is publishing events. You can
find the system namespace in the System Details of the system.

The system namespace has to follow these rules:

Use only lowercase ASCII letters (a-z) and digits (0-9)

Include at least one character

Use the dot (.) only to separate fragments

Include only two fragments separated by a dot

Example: sap.foo

7. In the Event Type field, list the event types published by the system that you want to make available to your subscribing
system.

This is custom documentation. For more information, please visit SAP Help Portal. 67
 6/11/25, 2:39 PM
You can write or paste the event types separated by comma, semicolon or new row. Preferably, each event type should be
on a new row. You have a counter giving the number of event types that are already filled in.

8. Choose Next Step.

9. Check if all the event types are configured properly and choose Add.

 Note
Once you add an integration dependency to a system, you can no longer edit it and add or delete event types. You can
only delete the integration dependency itself.

Extending SAP S/4HANA Cloud in the Cloud Foundry and Kyma

Environment
Extend SAP S/4HANA Cloud with extension applications running on SAP BTP using automated integration configuration.

Overview

 Note
The SAP S/4HANA Cloud Extensibility service is also availаble for global accounts marked with EU Access. See Regions.

 Note
This documentation refers to SAP S/4HANA Cloud Public Edition. See Introduction to the Universe of SAP S/4HANA Cloud
Public Edition.

The extension capabilities of SAP BTP offer a standard way for extending SAP S/4HANA Cloud and developing event-driven
extensions and applications.

You can extend SAP S/4HANA Cloud without disrupting its performance and core processes. When building extension
applications, you can also benefit from the automation of the integration between the cloud platform and SAP S/4HANA Cloud.

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

The following graphic provides a high-level overview of the integration between the cloud platform and SAP S/4HANA Cloud:

This is custom documentation. For more information, please visit SAP Help Portal. 68
 6/11/25, 2:39 PM

Process Flow
To integrate the cloud platform and SAP S/4HANA Cloud so that you can build extension applications, you need to:

Integrating SAP BTP and SAP S/4HANA Cloud

Process Step Related Documentation

1. Connect the SAP S/4HANA Cloud system you want Register an SAP S/4HANA Cloud System in a Global Account in SAP BTP
to extend with the corresponding global account in SAP
BTP.  Note
You cannot migrate the registered SAP S/4HANA Cloud systems between
During the pairing process you create an registration
global accounts.
token which is then used by the SAP S/4HANA Cloud
system tenant administrator to configure the If you want to start using another global account, you will have to register
integration on the SAP S/4HANA Cloud system side.
your SAP S/4HANA Cloud systems again.

2. Make the SAP S/4HANA Cloud system accessible in Configure the Entitlements for the SAP S/4HANA Cloud Extensibility Service
the SAP BTP subaccounts in which you want to build
your extension applications.

To do so, you configure the entitlements and assign the

corresponding quota and service plans to the
subaccounts where the extension applications will
reside for the system you registered in the previous
step.

3. Configure the communication flow.

Creating a Service Instance to Consume the SAP S/4HANA Cloud APIs
You have the following options:
Enable the Consumption of SAP S/4HANA Cloud Events
Consume the SAP S/4HANA Cloud APIs
(inbound connection) or consume APIs
exposed by the extension application from
SAPS/4 HANA Cloud (outbound connection)

This is custom documentation. For more information, please visit SAP Help Portal. 69
 6/11/25, 2:39 PM

Process Step Related Documentation

To do so, you create a service instance of the

SAP S/4HANA Cloud Extensibility service
using the api-access service plan.

For communication arrangements with inbound

connections, an HTTP destination on a
subaccount level is automatically generated in
this subaccount during the service instance
creation. It contains all instance binding
properties which are sufficient to establish
connection to the SAP S/4HANA Cloud system.
When creating the service instance, you
configure the communication arrangement and
the authentication type for the connection.

The following authentication scenarios for SAP

S/4HANA Cloud are supported:

Basic Authentication (inbound and

outbound connections)

OAuth 2.0 SAML Bearer Assertion

(inbound connections)

OAuth 2.0 Client Credentials (outbound

Connections)

No Authentication (outbound
connections)

Both predefined and custom communication

scenarios are supported.

Enable the consumption of SAP S/4HANA

Cloud events.

If you want to create event-based extensions

for SAP S/4HANA Cloud using the SAP Event
Mesh, you have to create a service instance of
the SAP S/4HANA Cloud Extensibility service
using the messaging service plan.

A combination of both

Configure the Entitlements for the SAP S/4HANA Cloud

Extensibility Service
Configure the required entitlements to make the APIs of the registered SAP S/4HANA Cloud system accessible in your subaccount
in which your extension applications will reside.

Prerequisites
You are an administrator of the global account in SAP BTP.

The subaccount is in the SAP BTP, Cloud Foundry environment with enabled Cloud Foundry, or Kyma, or both capabilities.

This is custom documentation. For more information, please visit SAP Help Portal. 70
 6/11/25, 2:39 PM
You have registered an SAP S/4HANA Cloud system. See Register an SAP S/4HANA Cloud System in a Global Account in
SAP BTP.

Context
An entitlement is your right to provision and consume a resource. In other words, the entitlement is the respective service plan,
api-access or messaging, that you're entitled to use.

Procedure
1. In the SAP BTP cockpit, navigate to your global account.

2. In the navigation area, choose Entitlements Entity Assignments .

3. On the Entity Assignments screen, select your subaccount in the Subaccounts/Directories field.

4. Choose Edit, and then choose Add Service Plans.

5. Select the SAP S/4HANA Cloud Extensibility service.

 Note
To have the SAP S/4HANA Cloud Extensibility service in the list, you need to have registered at least one SAP
S/4HANA Cloud system.

6. In the Service Details area, select the system you have registered. In the Available Plans area, select the required service
plans, and then choose Add Service Plan.

 Note
For more information about the available service plans for SAP S/4HANA Cloud Extensibility service, see Supported
Service Plans for SAP S/4HANA Cloud.

7. Choose Save.

Related Information
Configure Entitlements and Quotas for Subaccounts

Create a Service Instance to Consume the SAP S/4HANA Cloud

APIs
To enable the integration of your extension applications with the SAP S/4HANA Cloud system you have registered in the SAP BTP
global account, and to configure the communication flow, you create a service instance of the SAP S/4HANA Cloud Extensibility
service.

Prerequisites
You have configured the required entitlements to make the APIs of the registered SAP S/4HANA Cloud system accessible
in your subaccount in which your extension applications will reside. See Configure the Entitlements for the SAP S/4HANA
Cloud Extensibility Service.

In case of principal propagation, you first need to configure single-sign on (SSO) with the Identity Authentication service
and protect your application. See Integrating the Service with SAP S/4HANA Cloud, SAP Integrated Business Planning and
SAP Analytics Cloud.

This is custom documentation. For more information, please visit SAP Help Portal. 71
 6/11/25, 2:39 PM

Context
In both Cloud Foundry and Kyma environments, you consume services by creating a service instance. Service instances are
created using a specific service plan.

To allow applications running on SAP BTP to consume SAP S/4HANA Cloud APIs, you need to create a service instance of the SAP
S/4HANA Cloud Extensibility service using the api-access service plan.

 Note
These service plans have been deprecated:

sap_com_0109

sap_com_0009

sap_com_0008

However, you can still enable these communication scenarios using the api-access service plan:

Sales Order Integration (SAP_COM_0109): allows you to integrate your extension applications with sales order
processing in SAP S/4HANA Cloud. For more information, see
https://api.sap.com/api/API_SALES_ORDER_SRV/overview .

Product Integration (SAP_COM_0009): enables you to replicate product master data from client system to SAP
S/4HANA system. For more information, see
https://api.sap.com/api/PRODUCTMDMBULKREPLICATEREQUEST/overview .

Business Partner, Customer and Supplier Integration (SAP_COM_0008): allows you to consume the Business Partner
API which enables you to create, read, update, and delete master data related to Business Partners, Suppliers, and
Customers in an SAP S/4HANA system. For more information, see
https://api.sap.com/api/API_BUSINESS_PARTNER/overview .

For a sample JSON for these communication scenarios, see Communication Arrangement JSON/YAML File - Properties.

The api-access service plan define the access to the corresponding SAP S/4HANA Cloud APIs. It supports both predefined and
custom communication scenarios for consuming the SAP S/4HANA Cloud APIs and integrating your extension applications. See:

Supported Service Plans for SAP S/4HANA Cloud

Custom Communication Scenarios

You create the service instance in your subaccount with the respective environment enabled. When creating the service instance,
you configure the connectivity by specifying the required configurations in a JSON format. The following authentication scenarios
are supported for the communication flow between the extension application and SAP S/4HANA Cloud:

Basic Authentication (inbound and outbound connections)

OAuth 2.0 Client Credentials (outbound connections)

OAuth 2.0 SAML Bearer Assertion (inbound connections)

To communicate with SAP S/4HANA Cloud the extension application can use principal propagation which is done using
OAuth 2.0 SAML Bearer Assertion flows. Principal propagation means you forward the identity of the logged-in cloud users
when accessing or updating data in the SAP S/4HANA Cloud system.

This is useful in scenarios where you need to have restricted data access based on the logged-in user from your extension.
Or, you want to ensure only users with the right permissions are able to update the system via extensions deployed in SAP

This is custom documentation. For more information, please visit SAP Help Portal. 72
 6/11/25, 2:39 PM
BTP.

To use this authentication scenario, you first need to configure single-sign on (SSO) with the Identity Authentication service
and protect your application. See Integrating the Service with SAP S/4HANA Cloud, SAP Integrated Business Planning and
SAP Analytics Cloud.

Client Certificate Authentication (inbound and outbound connections)

OAuth2mTLS (outbound connections)

Depending on whether you are using Cloud Foundry or Kyma environment, you have to follow different steps to create an SAP
S/4HANA Cloud Extensibility service instance:

Create an SAP S/4HANA Cloud Extensibility Service Instance in the Cloud Foundry Environment

Create an SAP S/4HANA Cloud Extensibility Service Instance in the Kyma Environment

Related Information
Communication Arrangement JSON/YAML File - Properties

Create an SAP S/4HANA Cloud Extensibility Service Instance in

the Cloud Foundry Environment

Prerequisites
Before creating an SAP S/4HANA Cloud Extensibility service instance in the Cloud Foundry environment, see Create a
Service Instance to Consume the SAP S/4HANA Cloud APIs.

Have enabled Cloud Foundry environment for your subaccount. See Enable Environment or Create Environment Instance.

Have registered an SAP S/4HANA Cloud system. SeeRegister an SAP S/4HANA Cloud System in a Global Account in SAP
BTP.

Have configured the entitlements to the SAP S/4HANA Cloud Extensibility service. See Configure the Entitlements for the
SAP S/4HANA Cloud Extensibility Service.

Context
To consume the SAP S/4HANA Cloud APIs (inbound connection) or consume APIs exposed by the extension application from SAP
S/4HANA Cloud (outbound connection), you create an SAP S/4HANA Cloud Extensibility service instance. When creating the
service instance, you configure the communication arrangement and the authentication type for the connection.

For communication arrangements with inbound connections, a destination on a subaccount level with the same name as the
service instance name is automatically created in this subaccount. It contains all instance binding properties which are sufficient
to establish connection to the SAP S/4HANA Cloud system.

 Note
Make sure that you don't already have a destination with the same name as the service instance. If you do, you will not be able
to create the service instance.

 Note

This is custom documentation. For more information, please visit SAP Help Portal. 73
 6/11/25, 2:39 PM
Multitenant applications, that this subaccount is subscribed to, can access the destination and connect to the SAP S/4HANA
Cloud system without binding to the created service instance.

See Developing Multitenant Business Applications in the Cloud Foundry Environment.

Procedure
1. In the SAP BTP cockpit, navigate to the subaccount in which you want to create a service instance.

2. In the navigation area, choose Services Service Marketplace .

All services available to you appear.

3. To enable the integration with an SAP S/4HANA Cloud system that you have registered in SAP BTP global account, choose
SAP S/4HANA Cloud Extensibility.

4. In the SAP S/4HANA Cloud Extensibility page, choose Create.

5. In the New Instance or Subscription wizard:

a. In the Service dropdown list, ensure you have selected the SAP S/4HANA Cloud Extensibility service.

b. In the Plan dropdown list, select the api-access service plan.

c. In the Runtime Environment dropdown list, select Cloud Foundry.

d. In the Space dropdown list, select your space. If you haven't create a space yet, you can do it at this point.

e. In the System Name dropdown list, select the SAP S/4HANA Cloud system you have registered.

f. In the Instance Name field, enter a name for your instance. Choose Next.

g. To define the communication arrangement and the authentication type for the API access, specify a JSON file or
specify parameters in the JSON format. If you decide to define the communication arrangement and the
authentication type later on, you have to delete this service instance and create it again. Choose Next.

For more information about the structure of the JSON file, see Communication Arrangement JSON/YAML File -
Properties.

h. Choose Create.

After you have created the service instance:

The newly created instance appears in the list of instances in the Instance and Subscriptions page.

An HTTP destination on a subaccount level with the same name as the service instance name is automatically
generated in this subaccount.

Alternatively, you can use the Cloud Foundry Command Line Interface (cf CLI) to create the service instance using the
technical name of the SAP S/4HANA Cloud Extensibility service which is s4-hana-cloud.

For more information, see Create Service Instances Using the Cloud Foundry Command Line Interface.

 Note
You can use the cf CLI to troubleshoot if the creation of the service instance fails. To do that, use this command in the cf
CLI:

cf service <service_instance_name>

Next Steps
After you have created the service instance:

This is custom documentation. For more information, please visit SAP Help Portal. 74
 6/11/25, 2:39 PM
The newly created instance appears in the list of instances in the Instance and Subscriptions page.

An HTTP destination on a subaccount level with the same name as the service instance name is automatically generated in
this subaccount.

Alternatively, you can use the Cloud Foundry Command Line Interface (cf CLI) to create the service instance using the technical
name of the SAP S/4HANA Cloud Extensibility service which is s4-hana-cloud.

For more information, see Create Service Instances Using the Cloud Foundry Command Line Interface.

 Note
You can use the cf CLI to troubleshoot if the creation of the service instance fails. To do that, use this command in the cf CLI:

cf service <service_instance_name>

After creating the SAP S/4HANA Cloud Extensibility service instance, you have the following options for configuring the
connectivity for your extension application:

Bind the instance to an application, and it will be assigned an access URL and credentials to the corresponding API. For
more information about binding applications to service instances, see Binding Service Instances to Applications in the SAP
BTP documentation.

Consume the automatically generated destination.

To consume the destination, you use the destination service. You can either consume the Destination service directly, or
configure the application router to consume it.

 Note
The name of the destination is the same as the name of the service instance you have created.

For more information about consuming the destination service using the application router, see Application Routes
and Destinations.

For more information about consuming the destination service directly, see Consuming the Destination Service
(Cloud Foundry Environment).

Create an SAP S/4HANA Cloud Extensibility Service Instance in

the Kyma Environment

Prerequisites
Before creating an SAP S/4HANA Cloud Extensibility service instance in the Kyma environment, see Create a Service
Instance to Consume the SAP S/4HANA Cloud APIs.

Have the Kyma environment enabled for the subaccount you are using. See Creating a Kyma Instance.

Configure the roles in the Kyma environment. See Assign Roles in the Kyma Environment.

The SAP BTP Operator module is enabled. See Adding and Deleting a Kyma Module

Have the entitlements of the SAP S/4HANA Cloud Extensibility service configured. See Configure the Entitlements for the
SAP S/4HANA Cloud Extensibility Service.

This is custom documentation. For more information, please visit SAP Help Portal. 75
 6/11/25, 2:39 PM

Context
To consume the SAP S/4HANA Cloud APIs (inbound connection) or consume APIs exposed by the extension application from SAP
S/4HANA Cloud (outbound connection), you create an SAP S/4HANA Cloud Extensibility service instance. When creating the
service instance, you configure the communication arrangement and the authentication type for the connection.

For communication arrangements with inbound connections, a destination on a subaccount level with the same name as the
service instance name is automatically created in this subaccount. It contains all instance binding properties which are sufficient
to establish connection to the SAP S/4HANA Cloud system.

 Note
Make sure that you don't already have a destination with the same name as the service instance. If you do, you will not be able
to create the service instance.

Procedure
1. Navigate to the subaccount for which you want to create an SAP S/4HANA Cloud Extensibility service instance.

2. On the subaccount Overview page, in the Kyma Environment section, open the Kyma dashboard.

3. Choose Namespaces from the left-hand side navigation and open the namespace in which you want to create a service
instance.

4. Choose Service Management Service Instances from the left-hand side navigation.

5. In the Service Instances page, choose Create Service Instance in the upper right-hand corner. A new dialog opens.

6. Choose the Simple tab and fill in the following fields:

Give a meaningful name of the new SAP S/4HANA Cloud Extensibility service instance.

In the Offering Name field, enter s4-hana-cloud, which is the technical name of the SAP S/4HANA Cloud
Extensibility service.

In the Plan Name field, enter api-access.

7. Choose the YAML tab.

To define the communication arrangement and the authentication type for the API access, specify in parameters: in the
spec: section, the parameters listed in this YAML file: Communication Arrangement JSON/YAML File - Properties.

For specific examples, see Communication Arrangement YAML File - Examples.

8. Choose Create.

Next Steps
After creating the SAP S/4HANA Cloud Extensibility service instance, you must bind the instance to an application, and it will be
assigned an access URL and credentials to the corresponding API. See Using SAP BTP Services in the Kyma Environment.

Communication Arrangement JSON/YAML File - Properties

Learn how to construct a JSON or YAML file for the SAP S/4HANA Cloud APIs, including parameters such as system name,
communication arrangement, authentication type, communication system, outbound services, and additional properties. It also
provides guidelines and rules for each property.

Context
This is custom documentation. For more information, please visit SAP Help Portal. 76
 6/11/25, 2:39 PM
To construct the JSON file for the Cloud Foundry environment or the YAML file for the Kyma environment for the SAP S/4HANA
Cloud APIs you want to use, you can use these parameters. To access the specific documentation of these APIs, see SAP S/4HANA
Cloud APIs at SAP API Business Hub .

The information that you need to construct the JSON or the YAML file is available in the Display Communication Scenario
application in the corresponding SAP S/4HANA Cloud system. It contains information such as scenario details and properties, and
supported inbound and outbound authentication methods. See Display Communication Scenarios.

For specific sample JSON files, see Communication Arrangement JSON File - Examples.

For specific sample YAML files, see Communication Arrangement YAML File - Examples.

Properties

Parameter Description

systemName The name of the system you have registered in SAP BTP global
account.

 Note
The system must be in status Registered.

Rules/Guidelines

Required: Yes

communicationArrangement Represents a communication arrangement in SAP S/4HANA Cloud.

Rules/Guidelines

Required: Yes

communicationArrangementName A communicationArrangement property.

Meaningful name of the communication arrangement that will be

created for the SAP S/4HANA Cloud tenant.

Rules/Guidelines

Allowed characters: [a-zA-Z0-9_-]

Max length: 80

Required: Yes

scenarioId A communicationArrangement property.

The ID of the SAP S/4HANA Cloud communication scenario.

Rules/Guidelines

Required: Yes

Allowed characters: [A-Z0-9_]

Pattern: SAP_COM_<number>

inboundAuthentication A communicationArrangement property.

The authentication type for the SAP S/4HANA Cloud API access.

This is custom documentation. For more information, please visit SAP Help Portal. 77
 6/11/25, 2:39 PM

Parameter Description

 Note
Currently, the following authentication methods are supported:

Basic Authentication

SAML Bearer Assertion Authentication

 Note
The generated X.509 certificate that is used to
configure the trust between the cloud platform and SAP
S/4HANA Cloud system expires two years after you
have created the instance.

Client Certificate Authentication

Rules/Guidelines

Required: Yes, if there is no outboundAuthentication

defined

Allowed values: OAuth2SAMLBearerAssertion,

BasicAuthentication, and
ClientCertificateAuthentication

outboundAuthentication A communicationArrangement property.

The type of the authentication used by SAP S/4HANA Cloud to call

SAP BTP APIs.

 Note
Currently, the following authentication methods are supported:

Basic Authentication

OAuth 2.0 Client Credentials

No Authentication

OAuth2mTLS

Client Certificate Authentication

Rules/Guidelines

Required: Yes, if there is no inboundAuthentication

defined

Allowed values: BasicAuthentication,

OAuth2ClientCredentials, NoAuthentication,
OAuth2mTLS, and
ClientCertificateAuthentication

communicationSystem A communicationArrangement property.

This represents the Communication System view of the

communication arrangement.

Rules/Guidelines

This is custom documentation. For more information, please visit SAP Help Portal. 78
 6/11/25, 2:39 PM

Parameter Description

Required: No

communicationSystemHostname A communicationSystem property.

The URL of the remote system hosting the APIs that will be
consumed in case the scenario contains outbound communication.
For SAP S/4HANA Cloud extensions on SAP BTP, this is the URL of
the extension application running on SAP BTP.

This is equivalent to Technical Data General Host Name in

the Communication System view.

Rules/Guidelines

Required: Yes, if communicationArrangement is

specified.

port A communicationSystem property.

The port for outbound calls to the remote system hosting the APIs
that will be consumed in case the scenario contains outbound
communication.

Rules/Guidelines

Required: No

If not specified, the default 443 port is used for the

communication.

Type: String

Allowed values: positive integer [1-65535]

oAuthAuthEndpoint A communicationSystem property.

The OAuth authorization endpoint of the remote OAuth service in

case the communication scenario contains outbound
communication. This is equivalent to Technical Data OAuth
2.0 Settings Auth. Endpoint in the Communication System
view.

Rules/Guidelines

Required: No

oAuthTokenEndpoint A communicationSystem property.

The OAuth token endpoint. This is equivalent to Technical Data

OAuth 2.0 Settings Token Endpoint in the Communication
System view.

Rules/Guidelines

Required: No

outboundCommunicationUser A communicationSystem property.

The communication user used for outbound authentication. This is

equivalent to an entry under the Users for Outbound

This is custom documentation. For more information, please visit SAP Help Portal. 79
 6/11/25, 2:39 PM

Parameter Description

Communication table in the Communication System view in the

SAP S/4HANA Cloud system.

 Note
Currently, only users with authentication method User Name
and Password are supported.

Rules/Guidelines

Required: No

username An outboundCommunicationUser property.

The username of the communication user.

Rules/Guidelines

Required: Yes, if the outboundCommunicationUser

property is specified.

password An outboundCommunicationUser property.

The password of the communication user.

Rules/Guidelines

Required: Yes, if the outboundCommunicationUser

property is specified.

outboundServices A communicationArrangement property.

A list of outbound service objects.

This is equivalent to the Outbound Services section in the SAP

S/4HANA Cloud Communication Arrangement view.

Rules/Guidelines

Required: No

outboundService An outboundServices object.

A specific outbound service object.

Rules/Guidelines

Required: No

id An outboundService property.

The id of the outbound service. It must match the Outbound

Service ID displayed in the SAP S/4HANA Cloud system.

Rules/Guidelines

Required: Yes, if the outboundServices property is

specified.

 Note

This is custom documentation. For more information, please visit SAP Help Portal. 80
 6/11/25, 2:39 PM

Parameter Description

When you specify the id property of the outbound

service, you can skip the name property.

name An outboundService property.

The name of the outbound service. It must be an exact match of

the name displayed in the SAP S/4HANA Cloud system.

Rules/Guidelines

Required: Yes, if the outboundServices property is

specified, and the id property is not specified.

 Note
If the id property is specified, the name property is not
required.

urlPath An outboundService property.

This is equivalent to the Path field in the SAP S/4HANA Cloud

system. It is used to configure the API path in the outbound service
URL.

Rules/Guidelines

Required: No

isServiceActive An outboundService property.

This is equivalent to the Service Status checkbox in the SAP

S/4HANA Cloud system. In some communication scenarios, some
outbound services must be disabled. You can achieve that by
setting this parameter to false.

Rules/Guidelines

Required: No

Default value: true

attributes An outboundService parameter.

A list of attribute objects.

This is equivalent to the Additional Properties section of the

outbound service.

Rules/Guidelines

Required: No

attribute An attributes object.

A specific attribute object. Represents an additional property in the

outbound service.

Rules/Guidelines

Required: No

This is custom documentation. For more information, please visit SAP Help Portal. 81
 6/11/25, 2:39 PM

Parameter Description

name An attribute property.

The name of the additional property of the outbound service. It is

equivalent to the Technical Property Name column in the
Additional Properties section in the Display Communication
Scenarios app in the SAP S/4HANA Cloud system. See Display
Communication Scenarios.

Rules/Guidelines

Required: Yes, if an attribute object is specified.

value An attribute property.

Enter value for the additional property of the outbound service.

Rules/Guidelines

Required: Yes, if an attribute object is specified.

attributes A communicationArrangement parameter.

A list of attribute objects.

This is equivalent to the Additional Properties section of the

communication arrangement in SAP S/4HANA Cloud.

Rules/Guidelines

Required: No

attribute An attributes object.

A specific attribute object. Represents an additional property in the

communication arrangement.

Rules/Guidelines

Required: No

name An attribute property.

It is equivalent to the Technical Property Name section in the

Additional Properties table in the Display Communication
Scenarios application in the SAP S/4HANA Cloud system. See
Display Communication Scenarios.

Rules/Guidelines

Required: Yes, if an attribute object is specified for

communicationArrangement.

This is custom documentation. For more information, please visit SAP Help Portal. 82
 6/11/25, 2:39 PM

Parameter Description

value An attribute property.

Enter a value for the additional property of the communication

arrangement.

Rules/Guidelines

Required: Yes, if an attribute object is specified for

communicationArrangement.

Related Information
Communication Arrangement JSON File - Examples
Communication Arrangement YAML File - Examples

Communication Arrangement JSON File - Examples

The examples in this section will help you to create the service JSON descriptor used for defining the communication arrangement
and the authentication type for the SAP S/4HANA Cloud API access.

The information that you need to create the JSON file is available in the Display Communication Scenario app in the
corresponding SAP S/4HANA Cloud system. It contains information such as scenario details and properties, and supported
inbound and outbound authentication methods. See Display Communication Scenarios.

 Note
The purpose of these examples is just to give you an idea how you construct your JSON file. For more details of the properties
of these JSON files, see Communication Arrangement JSON/YAML File - Properties.

Example of Enabling Communication Scenario of Type Basic Authentication

This is an example of a JSON file for a communication arrangement with an inbound connection with Basic Authentication and an
outbound connection with Basic Authentication.

{
"systemName": "DEMO",
"communicationArrangement": {
"communicationArrangementName": "INBOUND_COMMUNICATION_ARRANGEMENT",
"scenarioId": "SAP_COM_0008",
"inboundAuthentication": "BasicAuthentication",
"outboundAuthentication": "BasicAuthentication",
"outboundServices": [
{
"id": "DEBMAS_IDOC",
"isServiceActive": false
},
{
"id": "CREMAS_IDOC",
"isServiceActive": false
},
{

This is custom documentation. For more information, please visit SAP Help Portal. 83
 6/11/25, 2:39 PM
"id": "ADRMAS_IDOC",
"isServiceActive": false
},
{
"id": "ADR3MAS_IDOC",
"isServiceActive": false
},
{
"id": "ADR2MAS_IDOC",
"isServiceActive": false
},
{
"id": "CO_MDG_BP_RPLCTRQ_SPRX",
"isServiceActive": false
},
{
"id": "CO_MDG_BP_RELATIONSHIP_OUT_SPRX",
"isServiceActive": false
},
{
"id": "CO_MDG_BP_RPLCTCO_SPRX",
"isServiceActive": false
},
{
"id": "CO_MDG_BP_RELATIONSHIP_CNF_OUT_SPRX",
"isServiceActive": false
}
],
"communicationSystem": {
"communicationSystemHostname": "default.com",
"outboundCommunicationUser": {
"username": "DefaultUser",
"password": "DefaultPassword"
}
}
}
}

Example of Enabling Communication Scenario of Type OAuth2ClientCredentials

This is an example of a JSON file for a communication arrangement with an outbound connection with authentication type
OAuth2ClientCredentials.

{
"systemName":"DEMO",
"communicationArrangement":{
"outboundAuthentication":"OAuth2ClientCredentials",
"communicationArrangementName":"0219_ARRANGEMENT",
"scenarioId":"SAP_COM_0219",
"communicationSystem":{
"communicationSystemHostname":"default.com",
"oAuthAuthEndpoint":"oauth.com/oauth/authorize",
"oAuthTokenEndpoint":"oauth.com/oauth/token",

This is custom documentation. For more information, please visit SAP Help Portal. 84
 6/11/25, 2:39 PM
"outboundCommunicationUser":{
"username":"DefaultUser",
"password":"DefaultPassword"
}
}
}
}

Example for Enabling Communication Scenario of Type

OAuth2SAMLBearerAssertion
This is an example of a JSON file for a communication arrangement with an inbound connection with
OAuth2SAMLBearerAssertion and an outbound connection with NoAuthentication.

To communicate with SAP S/4HANA Cloud the extension application can use Principal Propagation which is done using OAuth 2.0
SAML Bearer Assertion flows. Principal Propagation means you forward the identity of the logged-in cloud users when accessing or
updating data in the SAP S/4HANA Cloud system.

This is useful in scenarios where you need to have restricted data access based on the logged-in user from your extension. Or, you
want to ensure only users with the right permissions are able to update the system via extensions deployed in SAP BTP, Cloud
Foundry runtime.

{
"systemName": "DEMO",
"communicationArrangement": {
"scenarioId": "SAP_COM_0213",
"communicationArrangementName": "0213_ARRANGEMENT",
"inboundAuthentication": "OAuth2SAMLBearerAssertion",
"communicationSystem": {
"communicationSystemHostname": "default.com"
}
}
}

Example for Enabling Communication Scenario of Type NoAuthentication

This is an example of a JSON file for a communication arrangement with an outbound connection with authentication type
NoAuthentication.

{
"systemName": "DEMO",
"communicationArrangement": {
"outboundAuthentication": "NoAuthentication",
"communicationArrangementName": "0215_ARRANGEMENT",
"scenarioId": "SAP_COM_0215",
"outboundServices": [
{
"id": "SAP_COM_0215_0001_REST",
"isServiceActive": true
}
],
"communicationSystem": {

This is custom documentation. For more information, please visit SAP Help Portal. 85
 6/11/25, 2:39 PM
"communicationSystemHostname": "default.com"
}
}
}

Example for Enabling Communication Scenario of Type Client Certificate

Authentication with Inbound Connection
This is an example of a JSON file for a communication arrangement with an inbound connection with authentication type
ClientCertificateAuthentication.

{
"systemName": "DEMO",
"communicationArrangement": {
"scenarioId": "SAP_COM_0724",
"communicationArrangementName": "CommunicationArrangementName",
"inboundAuthentication": "ClientCertificateAuthentication"
}
}

Example for Enabling Communication Scenario of Type Client Certificate

Authentication with Outbound Connection

This is an example of a JSON file for a communication arrangement with an outbound connection with authentication type
ClientCertificateAuthentication.

{
"systemName": "DEMO",
"communicationArrangement": {
"communicationArrangementName": "CommunicationArrangementName",
"scenarioId": "SAP_COM_0047",
"outboundAuthentication": "ClientCertificateAuthentication",
"communicationSystem": {
"communicationSystemHostname": "default.com"
}
}
}

Example for Enabling Communication Scenario of Type OAuth2mTLS

This is an example of a JSON file for a communication arrangement with an outbound connection with authentication type
OAuth2mTLS.

{
"systemName": "DEMO",
"communicationArrangement": {
"outboundAuthentication": "OAuth2mTLS",
"communicationArrangementName": "CommunicationArrangementName",
"scenarioId": "SAP_COM_0080",
"communicationSystem": {
"communicationSystemHostname": "default.com",
"oAuthAuthEndpoint":"oauth.com/oauth/authorize",
"oAuthTokenEndpoint":"oauth.com/oauth/token",
"outboundCommunicationUser": {
"username": "DefaultUser"
}
}
}
}

This is custom documentation. For more information, please visit SAP Help Portal. 86
 6/11/25, 2:39 PM

Communication Arrangement YAML File - Examples

The examples in this section will help you to create the service YAML descriptor used for defining the communication arrangement
and the authentication type for the SAP S/4HANA Cloud API access.

The information that you need to create the YAML file is available in the Display Communication Scenario app in the
corresponding SAP S/4HANA Cloud system. It contains information such as scenario details and properties, and supported
inbound and outbound authentication methods. See Display Communication Scenarios.

 Note
The purpose of these examples is just to give you an idea how you construct your YAML file. For more details of the properties
of these YAML files, see Communication Arrangement JSON/YAML File - Properties.

Example of Enabling Communication Scenario of Type Basic Authentication

This is an example of a YAML file for a communication arrangement with an inbound connection with Basic Authentication and an
outbound connection with Basic Authentication.

spec:
externalName: ''
serviceOfferingName: s4-hana-cloud
servicePlanName: api-access
parameters:
systemName: DEMO
communicationArrangement:
communicationArrangementName: INBOUND_COMMUNICATION_ARRANGEMENT
scenarioId: SAP_COM_0008
inboundAuthentication: BasicAuthentication
outboundAuthentication: BasicAuthentication
outboundServices:
- id: DEBMAS_IDOC
isServiceActive: false
- id: CREMAS_IDOC
isServiceActive: false
- id: ADRMAS_IDOC
isServiceActive: false
- id: ADR3MAS_IDOC
isServiceActive: false
- id: ADR2MAS_IDOC
isServiceActive: false
- id: CO_MDG_BP_RPLCTRQ_SPRX
isServiceActive: false
- id: CO_MDG_BP_RELATIONSHIP_OUT_SPRX
isServiceActive: false
- id: CO_MDG_BP_RPLCTCO_SPRX
isServiceActive: false
- id: CO_MDG_BP_RELATIONSHIP_CNF_OUT_SPRX
isServiceActive: false
communicationSystem:
communicationSystemHostname: default.com
outboundCommunicationUser:

This is custom documentation. For more information, please visit SAP Help Portal. 87
 6/11/25, 2:39 PM
username: DefaultUser
password: DefaultPassword

Example of Enabling Communication Scenario of Type OAuth2ClientCredentials

This is an example of a YAML file for a communication arrangement with an outbound connection with authentication type
OAuth2ClientCredentials.

spec:
externalName: ''
serviceOfferingName: s4-hana-cloud
servicePlanName: api-access
parameters:
systemName: DEMO
communicationArrangement:
outboundAuthentication: OAuth2ClientCredentials
communicationArrangementName: 0219_ARRANGEMENT
scenarioId: SAP_COM_0219
communicationSystem:
communicationSystemHostname: default.com
oAuthAuthEndpoint: oauth.com/oauth/authorize
oAuthTokenEndpoint: oauth.com/oauth/token
outboundCommunicationUser:
username: DefaultUser
password: DefaultPassword

Example for Enabling Communication Scenario of Type

OAuth2SAMLBearerAssertion
This is an example of a YAML file for a communication arrangement with an inbound connection with
OAuth2SAMLBearerAssertion and an outbound connection with NoAuthentication.

To communicate with SAP S/4HANA Cloud the extension application can use Principal Propagation which is done using OAuth 2.0
SAML Bearer Assertion flows. Principal Propagation means you forward the identity of the logged-in cloud users when accessing or
updating data in the SAP S/4HANA Cloud system.

This is useful in scenarios where you need to have restricted data access based on the logged-in user from your extension. Or, you
want to ensure only users with the right permissions are able to update the system via extensions deployed in SAP BTP, Kyma
runtime.

spec:
externalName: ''
serviceOfferingName: s4-hana-cloud
servicePlanName: api-access
parameters:
systemName: DEMO
communicationArrangement:
communicationArrangementName: 0213_ARRANGEMENT
scenarioId: SAP_COM_0213
inboundAuthentication: OAuth2SAMLBearerAssertion
communicationSystem:
communicationSystemHostname: default.com

This is custom documentation. For more information, please visit SAP Help Portal. 88
 6/11/25, 2:39 PM

Example for Enabling Communication Scenario of Type NoAuthentication

This is an example of a YAML file for a communication arrangement with an outbound connection with authentication type
NoAuthentication.

spec:
externalName: ''
serviceOfferingName: s4-hana-cloud
servicePlanName: api-access
parameters:
systemName: DEMO
communicationArrangement:
communicationArrangementName: 0215_ARRANGEMENT
scenarioId: SAP_COM_0215
outboundAuthentication: NoAuthentication
outboundServices:
- id: SAP_COM_0215_0001_REST
isServiceActive: true
communicationSystem:
communicationSystemHostname: default.com

Example for Enabling Communication Scenario of Type Client Certificate

Authentication with Inbound Connection

This is an example of a YAML file for a communication arrangement with an inbound connection with authentication type
ClientCertificateAuthentication.

spec:
externalName: ''
serviceOfferingName: s4-hana-cloud
servicePlanName: api-access
parameters:
systemName: DEMO
communicationArrangement:
communicationArrangementName: CommunicationArrangementName
scenarioId: SAP_COM_0724
inboundAuthentication: ClientCertificateAuthentication

Example for Enabling Communication Scenario of Type Client Certificate

Authentication with Outbound Connection
This is an example of a YAML file for a communication arrangement with an outbound connection with authentication type
ClientCertificateAuthentication.

spec:
externalName: ''
serviceOfferingName: s4-hana-cloud
servicePlanName: api-access
parameters:
systemName: DEMO
communicationArrangement:
communicationArrangementName: CommunicationArrangementName
scenarioId: SAP_COM_0018
outboundAuthentication: ClientCertificateAuthentication
outboundServices:
- id: CO_MSM_PROJECT_ERPCREATE_REQUE_SPRX
isServiceActive: true
- id: CO_MSM_PROJECT_ERPUPDATE_REQUE_SPRX

This is custom documentation. For more information, please visit SAP Help Portal. 89
 6/11/25, 2:39 PM
isServiceActive: false
- id: CO_MSM_PROJECT_ERPBY_IDQUERY_R_SPRX
isServiceActive: false
communicationSystem:
communicationSystemHostname: default.com

Example for Enabling Communication Scenario of Type OAuth2mTLS

This is an example of a YAML file for a communication arrangement with an outbound connection with authentication type
OAuth2mTLS.

spec:
externalName: ''
serviceOfferingName: s4-hana-cloud
servicePlanName: api-access
parameters:
systemName: DEMO
communicationArrangement:
communicationArrangementName: CommunicationArrangementName
scenarioId: SAP_COM_0080
outboundAuthentication: OAuth2mTLS
outboundServices:
- id: SAP_COM_0080_0001_REST
isServiceActive: true
communicationSystem:
communicationSystemHostname: default.com
oAuthAuthEndpoint: oauth.com/oauth/authorize
oAuthTokenEndpoint: oauth.com/oauth/token
outboundCommunicationUser:
username: DefaultUser

Enable the Consumption of SAP S/4HANA Cloud Events

To create event-based extensions for SAP S/4HANA Cloud you need to set up the messaging between the SAP S/4HANA Cloud
system and the SAP Event Mesh.

Prerequisites
You have registered an SAP S/4HANA Cloud tenant in the global account in SAP BTP. See Register an SAP S/4HANA Cloud
System in a Global Account in SAP BTP.

Context
To consume SAP S/4HANA Cloud events, you need to configure the connectivity between SAP Event Mesh and the SAP S/4HANA
Cloud tenant. To do so, you need to create and configure service instances for both SAP S/4HANA Cloud Extensibility service and
SAP Event Mesh.

When you create a service instance in a subaccount, an event bus for this subaccount is created. All service instances in a
subaccount point to the same event bus and are nothing else but clients providing access credentials for the event bus. You
configure the clients using JSON descriptors. Each client has its own name which can be configured with the emname parameter in
the JSON descriptor file. Thus, the client is identified with a human readable name instead of a GUID. The name of each client must
be unique. As all of the clients point to the same event bus, they must have different namespaces in which to publish events. Each
namespace must be unique per subaccount. Each client should publish only in its own unique namespace.

Communication flow

This is custom documentation. For more information, please visit SAP Help Portal. 90
 6/11/25, 2:39 PM
The SAP S/4HANA Cloud Extensibility service instance is the client which creates the SAP S/4HANA Cloud integration and
provides the credentials for the SAP S/4HANA Cloud system so that the SAP S/4HANA Cloud system can send events to that
event bus. The purpose of this client is to send messages to a topic. It sends messages to the namespace which was configured
while creating the service instance of S/4HANA Cloud Extensibility service. See Define SAP S/4HANA Cloud Extensibility Service
Descriptor JSON/YAML File

The SAP Event Mesh service instance is the client which receives the events. This service instance must have a different name and
a different namespace than the ones configured for the SAP S/4HANA Cloud extensibility service instance. Since the purpose of
this client is to receive messages from a different client the rules have to take care of that. So, for the SAP Event Mesh service
instance, you need to configure the subscribe filter to the SAP S/4HANA Cloud Extensibility service instance. See Define SAP
Event Mesh Service Descriptor JSON/YAML File.

After both instances are created and configured, you can create the topic-to-queue subscription. To do so, you first create a queue
in the client that refers to the SAP Event Mesh service instance and then subscribe the topic of the namespace of the SAP
S/4HANA Cloud Extensibility service to that queue. See Manage Queues in the SAP Event Mesh documentation

The service instance of SAP Event Mesh is the client which consumes the message and should be bound to the extension
application.

Procedure

To configure the connectivity between SAP Event Mesh and the SAP S/4HANA Cloud tenant so that SAP S/4HANA Cloud events
can be produced and then consumed by applications running on SAP BTP, you need to perform the following tasks:

1. Add the required quotas to your subaccount as follows:

a. Assign the messaging SAP S/4HANA Cloud Extensibility service plan to the subaccount in SAP BTP you want to pair
with the SAP S/4HANA Cloud tenant. See Configure the Entitlements for the SAP S/4HANA Cloud Extensibility
Service.

 Note
You can use the service plan on regions where the SAP Event Mesh service is available.

 Note
The messaging service plan enables the Enterprise Eventing Integration (SAP_COM_0092) communication
scenario which allows you to consume SAP S/4HANA Cloud events and create event-based extensions.

This service plan has been renamed from sap_com_0092.

b. Assign the required number of SAP Event Mesh instances to the subaccount in SAP BTP that you want to pair with
the SAP S/4HANA Cloud tenant. See Configure the Entitlements for SAP Event Mesh.

2. Configure the connectivity between SAP Event Mesh and the SAP S/4HANA Cloud tenant, and then configure event topics
for the channel inside SAP S/4HANA Cloud tenant. See Set Up the Connectivity Between Event Mesh and the SAP
S/4HANA Cloud Tenant.

3. Enable the SAP Event Mesh for your subaccount in SAP BTP, create a queue that is specific to your application, and then
subscribe this queue to the channel topic that the SAP S/4HANA Cloud tenant uses to produce events. See Enable the SAP
Event Mesh Service for Your Subaccount in SAP BTP.

Related Information
What Is SAP Event Mesh?

This is custom documentation. For more information, please visit SAP Help Portal. 91
 6/11/25, 2:39 PM

Configure the Entitlements for SAP Event Mesh

To be able to consume SAP S/4HANA Cloud events, you need to configure the entitlements for SAP Event Mesh for the
subaccount in SAP BTP.

Context
The messaging service plan connects SAP S/4HANA Cloud tenant to SAP Event Mesh for the subaccount where the SAP Event
Mesh service entitlement is configured. This SAP Event Mesh service instance allows you to consume events from SAP S/4HANA
Cloud.

You need to configure the entitlements for the SAP Event Mesh service to create an SAP Event Mesh service instance. Then, you
bind this service instance to an application to consume events from this application.

Procedure
1. In SAP BTP cockpit, navigate to the global account that contains the subaccount in which you want to make your SAP
system accessible.

2. In the navigation area, choose Entitlements Entity Assignments .

3. On the Entity Assignments screen, select your subaccount in the Subaccounts/Directories field.

4. Choose Edit, and then choose Add Service Plans.

5. Select the SAP Event Mesh service.

6. In the Service Details area, select the system you have registered. In the Available Plans area, select the default service
plan, and then choose Add Service Plan.

7. Choose Save.

Related Information
Managing Entitlements and Quotas Using the Cockpit

Set Up the Connectivity Between Event Mesh and the SAP

S/4HANA Cloud Tenant

Overview
To configure the connectivity between the SAP S/4HANA Cloud tenant and SAP Event Mesh and to enable the exchange of
credentials between the two systems, you first need to create an SAP S/4HANA Cloud Extensibility service instance with service
plan messaging. For more information about the messaging service plan, see Supported Service Plans for SAP S/4HANA
Cloud.

When creating this service instance, you create the required configurations in both the SAP S/4HANA Cloud tenant and the Event
Mesh system associated with the subaccount in SAP BTP, so that events can flow. Depending on the SAP BTP environment, to
create an SAP S/4HANA Cloud Extensibility service instance, you have to choose one of the following options:

Create an SAP S/4HANA Extensibility Service Instance in the Cloud Foundry Environment

Create an SAP S/4HANA Cloud Extensibility Service Instance in the Kyma Environment

After you have created the SAP S/4HANA Cloud Extensibility service instance, either in the Cloud Foundry or Kyma
environment, you need to configure event topics for the channel inside the SAP S/4HANA Cloud tenant, and then you need to
This is custom documentation. For more information, please visit SAP Help Portal. 92
 6/11/25, 2:39 PM
create an SAP Event Mesh service instance, respectively in the Cloud Foundry or Kyma environment, for the application to
consume SAP S/4HANA Cloud events. You do this in a dedicated JSON file that you add either when creating the service instance,
or after that. To construct this JSON file, see Define SAP S/4HANA Cloud Extensibility Service Descriptor JSON/YAML File.

Process Flow

Process Step Related Documentation

1. Create an SAP S/4HANA Cloud Extensibility service

Create an SAP S/4HANA Extensibility Service Instance in
instance with service plan messaging.
the Cloud Foundry Environment

Create an SAP S/4HANA Cloud Extensibility Service

Instance in the Kyma Environment

2. Define a dedicated JSON file that you add either when creating Define SAP S/4HANA Cloud Extensibility Service Descriptor
the SAP S/4HANA Cloud Extensibility service instance, or JSON/YAML File
after that.

3. Configure event topics for the channel inside SAP S/4HANA Configure Event Topics in SAP S/4HANA Cloud
Cloud tenant.

Create an SAP S/4HANA Extensibility Service Instance in the

Cloud Foundry Environment
Use this procedure to configure the communication between SAP S/4HANA Cloud and SAP Event Mesh.

Prerequisites

Before creating an SAP S/4HANA Cloud Extensibility service instance in the Cloud Foundry environment, see Create a
Service Instance to Consume the SAP S/4HANA Cloud APIs.

Have enabled Cloud Foundry environment for your subaccount. See Enable Environment or Create Environment Instance.

Have registered an SAP S/4HANA Cloud system. SeeRegister an SAP S/4HANA Cloud System in a Global Account in SAP
BTP.

Have configured the entitlements to the SAP S/4HANA Cloud Extensibility service. See Configure the Entitlements for the
SAP S/4HANA Cloud Extensibility Service.

Context
To configure the connectivity between the SAP S/4HANA Cloud tenant and Event Mesh and to enable the exchange of credentials
between the two systems, you first need to create an SAP S/4HANA Cloud Extensibility service instance with service plan
messaging. For more information about the messaging service plan, see Supported Service Plans for SAP S/4HANA Cloud.

When creating this service instance, you create the required configurations in both the SAP S/4HANA Cloud tenant and the Event
Mesh system associated with the subaccount in SAP BTP, so that events can flow.

Procedure
1. In the SAP BTP cockpit, navigate to the subaccount in which you want to create a service instance.

2. In the navigation area, choose Services Service Marketplace .

This is custom documentation. For more information, please visit SAP Help Portal. 93
 6/11/25, 2:39 PM
All services available to you appear.

3. To enable the integration with an SAP S/4HANA Cloud system that you have registered in the global account in SAP BTP,
choose SAP S/4HANA Cloud Extensibility.

4. In the SAP S/4HANA Cloud Extensibility page, choose Create.

5. In the New Instance or Subscription wizard:

a. In the Service dropdown list, ensure you have selected the SAP S/4HANA Cloud Extensibility service.

b. In the Plan dropdown list, select the messaging service plan.

c. In the Runtime Environment dropdown list, select Cloud Foundry.

d. In the Space dropdown list, select your space. If you haven't create a space yet, you can do it at this point.

e. In the System Name dropdown list, select the SAP S/4HANA Cloud system you have registered.

f. In the Instance Name field, enter a name for your instance. Choose Next.

g. Specify a JSON file or specify parameters in the JSON format to define the communication arrangement for the
communication scenario Enterprise Eventing Integration (SAP_COM_0092) in the SAP S/4HANA Cloud tenant and
to configure the parameters for the Enterprise Messaging service. If you decide to define the communication
arrangement later on, you have to delete this service instance and create it again. Choose Next.

For more information about the structure of the JSON file, see Define SAP S/4HANA Cloud Extensibility Service
Descriptor JSON/YAML File.

h. Choose Create.

The newly created instance appears in the list of instances in the Instance and Subscriptions page.

Alternatively, you can create the instance using cf CLI. To do so, execute the following command

cf create-service s4-hana-cloud messaging emsconnect -c '{"systemName": "<system_name>","comm

For more information, see Create Service Instances Using the Cloud Foundry Command Line Interface.

 Note
You can use the cf CLI to troubleshoot if the creation of the service instance fails. To do that, use this command in the cf
CLI:

cf service <service_instance_name>

Next Steps

Configure Event Topics in SAP S/4HANA Cloud

Create an SAP S/4HANA Cloud Extensibility Service Instance in

the Kyma Environment
Use this procedure to configure the communication between SAP S/4HANA Cloud and SAP Event Mesh in the Kyma environment.

Prerequisites

In the SAP BTP cockpit, you have assigned the messaging SAP S/4HANA Cloud service plan to the subaccount you want to pair
with the SAP S/4HANA Cloud tenant. See Configure the Entitlements for the SAP BTP Subaccount.

This is custom documentation. For more information, please visit SAP Help Portal. 94
 6/11/25, 2:39 PM

Context

To configure the connectivity between an SAP S/4HANA Cloud tenant and Event Mesh and to enable the exchange of credentials
between the two systems, you first need to create an SAP S/4HANA Cloud Extensibility service instance with messaging service
plan in the Kyma dashboard. For more information about the messaging service plan, see Supported Service Plans for SAP
S/4HANA Cloud.

When creating this service instance, you create the required configurations in both the SAP S/4HANA Cloud tenant and the Event
Mesh system associated with the subaccount in SAP BTP, so that the events can flow from one system to the other.

Procedure
1. In the SAP BTP cockpit, navigate to the subaccount for which you want to create an SAP S/4HANA Cloud Extensibility
service instance.

2. On the subaccount Overview page in the Kyma Environment section, open the Kyma dashboard.

3. Navigate to the default namespace from the drop-down list in the top navigation.

4. Choose Service Management BTP Service Instances from the left-hand side navigation.

5. In the Service Instances page, choose Create Service Instance in the upper right-hand corner. A new dialog opens.

6. Choose the Simple tab and fill in the following fields:

Give a meaningful name of the new SAP S/4HANA Cloud Extensibility service instance.

In the Offering Name field, enter s4-hana-cloud, which is the technical name of the SAP S/4HANA Cloud
Extensibility service.

In the Plan Name field, enter messaging.

7. Choose the YAML tab.

In parameters: in the spec: section, specify the parameters to define the communication arrangement for the
communication scenario Enterprise Eventing Integration (SAP_COM_0092) in the SAP S/4HANA Cloud tenant and to
configure the parameters for the Event Mesh service. Make sure you include at least these two required parameters:
systemName and emclientId. The parameters are listed in this YAML file: Define SAP S/4HANA Cloud Extensibility
Service Descriptor JSON/YAML File.

8. Choose Create.

Next Steps

After creating the SAP S/4HANA Cloud Extensibility service instance with the messaging plan, a respective messaging client is
created for you in the sap/S4HANAOD/{emClientId} namespace of the Event Mesh service. As the next step, you must relate
the two clients (SAP S/4HANA Cloud Extensibility and Event Mesh) in the Kyma dashboard. To do this, create an instance of the
Event Mesh service with the details of the automatically created Event Mesh namespace. Follow the steps in Create an SAP Event
Mesh Service Instance in the Kyma Environment.

Define SAP S/4HANA Cloud Extensibility Service Descriptor

JSON/YAML File
The SAP S/4HANA Cloud Extensibility service descriptor defines details of a message client and needs to be provided when
provisioning new SAP S/4HANA Cloud Extensibility service instances with service plan messaging.

Procedure
This is custom documentation. For more information, please visit SAP Help Portal. 95
 6/11/25, 2:39 PM

Define the SAP S/4HANA Cloud Extensibility service descriptor in a JSON structure for the Cloud Foundry environment and in a
YAML structure for the Kyma environment. It has to contain two sections:

For the parameters needed to activate the communication arrangement for the communication scenario Enterprise
Eventing Integration (SAP_COM_0092) in the SAP S/4 HANA Cloud tenant.

There are only two required parameters, emClientId and systemName. The rest of the parameters are automatically
generated. However, you can still provide the optional parameters in the descriptor to override the automatically generated
values.

For the parameters for configuring the SAP Event Mesh service.

If this section is not explicitly added to the JSON/YAML file, the values of its parameters are automatically generated based
on the values of the emClientId and systemName parameters.

Parameters required to activate the communication arrangement in SAP S4/HANA Cloud tenant

This is custom documentation. For more information, please visit SAP Help Portal. 96
 6/11/25, 2:39 PM

Parameter Description

systemName The name of the system you have registered in the global account
in SAP BTP.

Rules/Guidelines

Required: Yes

The name must be the same as the one you have used
when registering the SAP S/4HANA Cloud system during
the pairing process.

emClientId Using default patterns, it generates communication arrangement

name, channel name, emname, and namespace, when these
parameters are not explicitly provided. The default values are
described in the table bellow containing the parameters required to
configure SAP Event Mesh service.

 Note
The values of the emname and namespace parameters must be
the same as the values of the emname and namespace
parametes in the SAP Event Mesh service descriptor. See Define
SAP Event Mesh Service Descriptor JSON/YAML File.

Rules/Guidelines

Required: Yes

Allowed characters: [a-zA-Z0-9]

Maximum length: 4

communicationArrangement Defines the communication arrangement for the SAP S4/HANA

Cloud tenant.

communicationArrangementName A communicationArrangement property.

The name of the communication arrangement for the SAP

S/4HANA Cloud tenant.

Rules/Guidelines

Required: No

Allowed characters: [a-zA-Z0-9_-]

Maximum length: 80

Default value:
"SAP_CLOUD_PLATFORM_XF_<emClientId>"

attributes A communicationArrangement property.

Defines the configuration properties for the communication

arrangement.

The name of the property is equivalent to the Technical Property

Name column in the properties table in the Display Communication
Scenarios app in the SAP S/4HANA Cloud system. See Display
Communication Scenarios.

This is custom documentation. For more information, please visit SAP Help Portal. 97
 6/11/25, 2:39 PM

Parameter Description

CHANNEL NAME An attributes property.

The name of the communication channel.

Rules/Guidelines

Required: No

Allowed characters: [A-Z0-9_-]

Default value: "SAP_CP_XF_<emclientId>"

 Note
Have in mind that the <emclientId> will be
automatically capitalized.

Must be unique within the SAP S/4 HANA Cloud tenant.

DESCRIPTION An attributes property.

Short description.

Rules/Guidelines

Required: No

Maximum length: 60

Allowed characters: [a-zA-Z0-9_-]

Default value: "Integration with Enterprise

Messaging for EM Client: <emclientId>"

TOPIC SPACE An attributes property.

The identifier for the events that originate from the same source.
This is the topic that the events should use.

Rules/Guidelines

Required: No

Maximum length: 24

Allowed characters: [a-zA-Z0-9//]

Contains exactly three segments, for example a/b/c.

Default value: "sap/S4HANAOD/<emclientId>"

The subscribeFilter in the SAP Event Mesh

configuration must be use the topic space as a prefix.

MQTT_QOS An attributes property.

Defines the quality of service.

Rules/Guidelines

Required: No

Allowed values: 0, 1

This is custom documentation. For more information, please visit SAP Help Portal. 98
 6/11/25, 2:39 PM

Parameter Description

QoS=0, at most once delivery.

The message is delivered according to the capabilities of

the underlying network. No response is sent by the receiver
and no retry is performed by the sender. The message
arrives at SAP Event Mesh either once or not at all.

QoS=1, at least once delivery. This quality of service

ensures that the message arrives at SAP Event Mesh at
least once.

Default value: 1

RECONNECT ATTEMPTS An attributes property.

The number of attempts the Enterprise Event Enablement

framework tries to reestablish the connection if the connection is
lost.

Rules/Guidelines

Required: No

Default value: 0

If no value is entered or the entered value is 0, the

framework tries to connect until connection is established.
If the connection is not established after reaching
reconnect attempts, the communication arrangement and
the underlying channel is deactivated.

WAIT TIME An attributes property.

Specifies the time (in seconds) for which the Enterprise Event
Enablement framework waits before trying to reconnect. If the
attempts fail, framework increases the wait time until the
reconnect wait time (1800 seconds) is reached.

Rules/Guidelines

Required: No

Default value: 10

Parameters required to configure SAP Event Mesh service

Parameter Description

This is custom documentation. For more information, please visit SAP Help Portal. 99
 6/11/25, 2:39 PM

Parameter Description

emname Specifies the name of the SAP Event Mesh client. It is used by SAP
Event Mesh to identify clients.

Rules/Guidelines:

Required: No

Allowed characters:[a-zA-Z0-9_-]

Maximum length: 100

Default value: <emClientId>

It is unique within a subaccount.

namespace Namespace for the message client.

Rules/Guidelines: The namespace in the SAP Event Mesh

configuration must be the same as the first three segments of the
topic space in the configuration of the communication
arrangement in SAP S4/HANA Cloud tenant.

Rules/Guidelines:

Required: No

Allowed characters: [a-zA-Z0-9//]

Maximum length: 24

It is unique within a subaccount

Contains exactly three segments, for example a/b/c.

Default value: "sap/S4HANAOD/<emclientId>".

rules Defines the access privileges of the message client.

Guidelines/Rules:

Required: No

In order to allow access to a queue or a topic the

namespace of the corresponding owner client has to be
added. The placeholder ${namespace} can be used
instead of the defined namespace.

topicRules A rules attribute.

Guidelines/Rules:

Type: object

inboundFilter A topicRules attribute.

Defines if a client (publisher/producer) is allowed to send

messages to the defined topics.

Guidelines/Rules:

Required: No

Allowed characters: [a-zA-Z#?/]

This is custom documentation. For more information, please visit SAP Help Portal. 100
 6/11/25, 2:39 PM

Parameter Description

Type: array

Default value: ${namespace}/#

Example values: ${namespace}/foo/bar,

${namespace}/#.

resources A collection of messaging resources such as queues, connections,

and so on, required for a message client.

Rules/Guidelines

Required: No

units A resources attribute.

Specify this value in the service descriptor to allocate messaging

resources based a specific business scenario. See Syntax for
Service Descriptor.

Guidelines/Rules:

Required: No

Allowed values: 10-50

Type: attribute

Default value: 10

JSON File Example

In this example, only the required properties are provided.

{
"systemName": "DEV",
"emClientId": "s4hc"
}

This descriptor is equivalent to:

 Note
All properties can be overridden explicitly.

{
"systemName": "DEV",
"emClientId": "s4hc",
"communicationArrangement": {
"communicationArrangementName": "SAP_CLOUD_PLATFORM_XF_s4hc",
"attributes": [
{
"name": "CHANNEL NAME",
"value": "SAP_CP_XF_S4HC"
},
This is custom documentation. For more information, please visit SAP Help Portal. 101
 6/11/25, 2:39 PM
{
"name": "DESCRIPTION",
"value": "Integration with Enterprise Messaging for EM Client: s4hc"
},
{
"name": "TOPIC SPACE",
"value": "sap/S4HANAOD/s4hc"
},
{
"name": "MQTT_QOS",
"value": "1"
},
{
"name": "RECONNECT ATTEMPTS",
"value": "0"
},
{
"name": "WAIT TIME",
"value": "10"
}
]
},
"ems": {
"parameters": {
"emname": "s4hc",
"namespace": "sap/S4HANAOD/s4hc",
"rules": {
"topicRules": {
"inboundFilter": [
"${namespace}/#"
]
}
},
"resources": {
"units": "10"
}
}
}
}

YAML File Example

In this example, only the required properties are provided.

parameters:
systemName: DEV
emClientId: s4hc

This descriptor is equivalent to:

This is custom documentation. For more information, please visit SAP Help Portal. 102
 6/11/25, 2:39 PM

 Note
All properties can be overridden explicitly.

spec:
externalName: ''
serviceOfferingName: s4-hana-cloud
servicePlanName: messaging
parameters:
systemName: DEV
emClientId: s4hc
communicationArrangement:
communicationArrangementName: SAP_CLOUD_PLATFORM_XF_s4hc
attributes:
- name: CHANNEL NAME
value: SAP_CP_XF_S4HC
- name: DESCRIPTION
value: 'Integration with Enterprise Messaging for EM Client: s4hc'
- name: TOPIC SPACE
value: sap/S4HANAOD/s4hc
- name: MQTT_QOS
value: '1'
- name: RECONNECT ATTEMPTS
value: '0'
- name: WAIT TIME
value: '10'
ems:
parameters:
emname: s4hc
namespace: sap/S4HANAOD/s4hc
rules:
topicRules:
inboundFilter:
- "${namespace}/#"
resources:
units: '10'

Configure Event Topics in SAP S/4HANA Cloud

Configure event topics for the channel inside the SAP S/4HANA Cloud tenant.

Prerequisites

Уou have created the SAP S/4HANA Cloud Extensibility service instance in the Cloud Foundry or Kyma environment.
See:

Create an SAP S/4HANA Extensibility Service Instance in the Cloud Foundry Environment

Create an SAP S/4HANA Cloud Extensibility Service Instance in the Kyma Environment

Context

This is custom documentation. For more information, please visit SAP Help Portal. 103
 6/11/25, 2:39 PM
After you have created the SAP S/4HANA Cloud Extensibility service instance, you need to configure event topics for the
channel inside the SAP S/4HANA Cloud tenant, and then you need to create an SAP Event Mesh service instance for the
application to consume SAP S/4HANA Cloud events.

Procedure

Configure event topics for the channel inside SAP S/4HANA Cloud tenant. Use the channel you have specified in SAP S/4HANA
Cloud Extensibility service descriptor JSON file when configuring the parameters for the communication arrangement in SAP
S4/HANA Cloud tenant.

As an example, you can use the sap/s4/beh/businesspartner/v1/BusinessPartner/Changed/v1 outbound topic.

Next Steps

Create an SAP Event Mesh service instance in the Cloud Foundry or the Kyma environment. See:

Create an SAP Event Mesh Service Instance in the Cloud Foundry Environment

Create an SAP Event Mesh Service Instance in the Kyma Environment

Enable the SAP Event Mesh Service for Your Subaccount in SAP
BTP

Prerequisites

Уou have created the SAP S/4HANA Cloud Extensibility service instance in the Cloud Foundry or Kyma
environment. See:

Create an SAP S/4HANA Extensibility Service Instance in the Cloud Foundry Environment

Create an SAP S/4HANA Cloud Extensibility Service Instance in the Kyma Environment

You have configured event topics for the channel inside SAP S/4HANA Cloud tenant. See Configure Event Topics in SAP
S/4HANA Cloud.

Overview
To enable the SAP Event Mesh for your subaccount in SAP BTP, you have to create an instance of the SAP Event Mesh service with
service plan default. This instance will specify the details of the namespace that you created in SAP Event Mesh for the SAP
S/4HANA Cloud Extensibility service instance with the messaging plan. This way, you are setting up a contract between SAP
Event Mesh and the Cloud Foundry, or the Kyma environment, and connect them to enable seamless event flow from the given
SAP S/4HANA Cloud tenant.

Depending on the SAP BTP environment, to create an SAP Event Mesh service instance, you have to choose one of these:

Create an SAP Event Mesh Service Instance in the Cloud Foundry Environment

Create an SAP Event Mesh Service Instance in the Kyma Environment

Define the details of your message client in SAP Event Mesh as parameters in a dedicated JSON file. To map the message client to
the client defined in the SAP S/4HANA Cloud JSON file, in the SAP Event Mesh JSON file, you must include the
subscribeFilter parameter which specifies the sap/S4HANAOD/{emClientId} namespace you created for the SAP S/4

This is custom documentation. For more information, please visit SAP Help Portal. 104
 6/11/25, 2:39 PM
HANA Cloud Extensibility instance of the messaging plan. For more information about the structure of the JSON file, see Define
SAP Event Mesh Service Descriptor JSON/YAML File.

Process Flow

Process Step Related Documentation

1. Create an SAP Event Mesh service instance with service plan

Create an SAP Event Mesh Service Instance in the Cloud
default.
Foundry Environment

Create an SAP Event Mesh Service Instance in the Kyma

Environment

2. Define a dedicated JSON file that you add either when creating Define SAP Event Mesh Service Descriptor JSON/YAML File
the SAP Event Mesh service instance, or after that.

3. Create a queue in the message client that refers to the SAP Event Create Queues and Subscribe to Them
Mesh service instance and then subscribe the topic of the
namespace of the SAP S/4HANA Cloud Extensibility service to that
queue.

Create an SAP Event Mesh Service Instance in the Cloud Foundry

Environment
Use this procedure to enable the SAP Event Mesh service for the subaccount where your extension application will reside.

Context
To enable the SAP Event Mesh service for your subaccount in SAP BTP, you have to go through the following steps.

Procedure
1. Prepare a JSON file that contains details of a message client. See Define SAP Event Mesh Service Descriptor JSON/YAML
File.

2. Create an SAP Event Mesh service instance for the application to consume SAP S/4HANA Cloud events.

a. In the SAP BTP cockpit, navigate to the space in which you want to create a service instance.

b. In the navigation area, choose Services Service Marketplace , and then choose Event Mesh in the Service
Marketplace panel.

c. From the Event Mesh service tile, choose Create and follow the steps in the wizard to subscribe to the service.

d. In the New Instance or Subscription wizard:

i. In the Service dropdown list, select Event Mesh.

ii. In the Plan dropdown list select the default service plan.

iii. In the Runtime Environment dropdown list, select Cloud Foundry.

iv. In the Space dropdown list, select your Cloud Foundry space.

v. In the Instance Name field, enter a name for your instance. Choose Next.

vi. Specify the JSON file you prepared in Step 1. Choose Next.

This is custom documentation. For more information, please visit SAP Help Portal. 105
 6/11/25, 2:39 PM
vii. Review and verify the instance details, and choose Create.

Next Steps
Create Queues and Subscribe to Them

Create an SAP Event Mesh Service Instance in the Kyma

Environment
Use this procedure to enable the SAP Event Mesh service for the subaccount where your extension application will reside.

Prerequisites

In the SAP BTP cockpit, you have assigned the messaging SAP S/4HANA Cloud Extensibility service plan to the SAP BTP
subaccount that you want to pair with the SAP S/4HANA Cloud tenant. See Configure the Entitlements for the SAP
S/4HANA Cloud Extensibility Service.

In the Kyma dashboard, you have created the SAP S/4HANA Cloud Extensibility service instance with the messaging plan.
See Create an SAP S/4HANA Cloud Extensibility Service Instance in the Kyma Environment.

In the SAP BTP cockpit, you have assigned the default SAP Event Mesh service plan to the SAP BTP subaccount that you
want to pair with the SAP S/4HANA Cloud tenant. See Configure the Entitlements for the SAP S/4HANA Cloud Extensibility
Service.

Context
In the Kyma dashboard, create an instance of the SAP Event Mesh service. This instance will specify the details of the namespace
that you created in SAP Event Mesh for the SAP S/4HANA Cloud Extensibility service instance with the default plan. This way,
you are setting up a contract between SAP Event Mesh and the Kyma environment, and connect them to enable seamless event
flow from the given SAP S/4HANA Cloud tenant to Kyma.

Procedure
1. In the SAP BTP cockpit, navigate to the subaccount for which you want to create an SAP Event Mesh service instance.

2. On the subaccount Overview page in the Kyma Environment section, open the Kyma dashboard.

3. Navigate to the default namespace from the drop-down list in the top navigation.

4. Choose Service Management BTP Service Instances from the left-hand side navigation.

5. In the Service Instances page, choose Create Service Instance in the upper right-hand corner. A new dialog opens.

6. Choose the Simple tab and fill in the following fields:

Give a meaningful name of the new SAP Event Mesh service instance.

In the Offering Name field, enter enterprise-messaging, which is the technical name of the SAP Event Mesh
service.

In the Plan Name field, enter default.

7. Choose the YAML tab.

In parameters: in the spec: section, specify the parameters to define the details of your message client in the SAP Event
Mesh service. You must include the subscribeFilter parameter which specifies the sap/S4HANAOD/{emClientId}

This is custom documentation. For more information, please visit SAP Help Portal. 106
 6/11/25, 2:39 PM
namespace you created for the SAP S/4 HANA Cloud Extensibility instance of the messaging plan in SAP Event Mesh. For
more information about the structure of the YAML file, see Define SAP Event Mesh Service Descriptor JSON/YAML File.

8. Choose Create.

Results

Once the service instance is provisioned, you can see it under Service Management Instances in the left-hand side
navigation of the Kyma dashboard.

Next Steps

Create Queues and Subscribe to Them

Define SAP Event Mesh Service Descriptor JSON/YAML File

The SAP Event Mesh service descriptor defines details of a message client and needs to be provided when provisioning new SAP
Event Mesh service instances with service plan default.

Prerequisites
You have created an SAP S/4HANA Cloud Extensibility service instance with defined SAP S/4HANA Cloud Extensibility
descriptor. See Define SAP S/4HANA Cloud Extensibility Service Descriptor JSON/YAML File.

Get to know the additional parameters you can have in the SAP Event Mesh service descriptor. In this page only the
parameters that are related to this use case are described. See Syntax for Service Descriptor in SAP Event Mesh
documentation.

Context

You set up service instance of the SAP Event Mesh service to receive the events which are sent by the SAP S/4HANA Cloud
Extensibility service. In the JSON file for the Cloud Foundry environment and in the YAML file for the Kyma environment, this
service instance needs to be created with a different emname as well as a different namespace. The rule set here is important as
each client should only publish in its own namespace. Since this message client's purpose is to receive messages from a different
client, the rules of the subscribeFilter for topics need to take care of that. So the value of the message client defined in the
SAP Event Mesh JSON/YAML file has to be configured to have the value of the subscribeFilter to be the same as the value of
the namespace of the other client defined in the SAP S/4HANA Cloud Extensibility JSON/YAML file.

After both message clients are set up, you have to create a queue in the message client which refers to the SAP Event Mesh service
instance. You can name the queue as you like and it will be created in the namespace of the client. This queue can now be
subscribed to the topic configured step 7 in the Create an SAP S/4HANA Extensibility Service Instance in the Cloud Foundry
Environment page. This topic in defined in the namespace of the S/4HANA Cloud Extensibility service descriptor, for example
sap/S4HANAOD/s4hc/myTopic.

The service instance of SAP Event Mesh is the message client which consumes the messages and should be bound to the actual
application. These are the important aspects of the whole configuration:

When creating a service instance of the SAP S/4HANA Cloud Extensibility service:

Use unique emname per subaccount

Use unique namespace per subaccount, for example a/b/c

This is custom documentation. For more information, please visit SAP Help Portal. 107
 6/11/25, 2:39 PM
When creating a service instance of the SAP Event Mesh service:

Use unique emname per subaccount

Use unique namespace per subaccount, for example d/e/f

Use the namespace defined in the SAP S/4HANA Cloud Extensibility JSON/YAML file and put it in the
subscribeFilter parameter

JSON:

 Sample Code

"subscribeFilter": [
"a/b/c/*",
"${namespace}/*"
]

YAML:

 Sample Code

subscribeFilter:
- a/b/c/*
- "${namespace}/*"

Create queue for this client

Subscribe this queue to the topic defined in the namespace of the SAP S/4HANA Cloud Extensibility JSON/YAML
file

This is custom documentation. For more information, please visit SAP Help Portal. 108
 6/11/25, 2:39 PM

Procedure
Define the JSON file for the SAP Event Mesh service instance following the requirements for the properties and their values listes
below:

Parameter Description

emname Specifies the name of the SAP Event Mesh client. It is used by SAP
Event Mesh to identify clients.

 Note
The emname parameter in this descriptor must be unique per
subaccount, so it must have the different value than the
emname parameter in the SAP S/4HANA Cloud service
descriptor. See Define SAP S/4HANA Cloud Extensibility
Service Descriptor JSON/YAML File.

Rules/Guidelines

Required: Yes

Allowed characters: [a-zA-Z0-9_-]

Max length: 100

Rules/Guidelines: It is unique within a subaccount.

version It specifies the version of the service descriptor.

 Note
The version parameter is optional when you use the deprecated
syntax. See Syntax for Service Descriptor.

Rules/Guidelines

Required: Yes

Allowed value: 1.1.0

namespace Namespace for the messaging client.

 Note
The namespace parameter in this descriptor must be unique
per subaccount, so it must have the different value than the
namespace parameter in the SAP S/4HANA Cloud service
descriptor. See Define SAP S/4HANA Cloud Extensibility
Service Descriptor JSON/YAML File.

Rules/Guidelines

This is custom documentation. For more information, please visit SAP Help Portal. 109
 6/11/25, 2:39 PM

Parameter Description

Required: Yes

Allowed characters: [a-zA-Z0-9//]

Max length: 24

It is unique within a subaccount

Contains exactly three segments, for example d/e/f.

options Defines the access channels for the message client.

management An options attribute.

Enables/disables the usage of the management REST APIs.

Rules/Guidelines

Default: false

Allowed values: true | false

An options attribute.
messagingrest
Enables/Disables the usage of the messaging REST APIs.

Rules/Guidelines

Default: false

Allowed values: true | false

messaging An options attribute.

Enables/disables the usage of the messaging gateway.

Rules/Guidelines

Default: true

Allowed values: true | false

rules Defines the access privileges of the messaging client.

Rules/Guidelines

Required: true

Guidelines/Rules: In order to allow access to a queue or a

topic, the namespace of the corresponding owner client
has to be added. The placeholder ${namespace} can be
used instead of the defined namespace.

topicRules A rules attribute.

Rules/Guidelines

Type: Object

subscribeFilter A topicRules attribute.

This is custom documentation. For more information, please visit SAP Help Portal. 110
 6/11/25, 2:39 PM

Parameter Description

Filters from which topics a client (receiver) is allowed to receive

messages.

Rules/Guidelines

Type: Array

Allowed characters: [a-zA-Z*?/]

Default: no default

Example values: ${namespace}/foo/bar/*,

${namespace}/*.

 Note
The namespace part of the value must be specified exactly as
the namespace value of the SAP S/4HANA Cloud Extensibility
service descriptor JSON File described in Define SAP S/4HANA
Cloud Extensibility Service Descriptor JSON/YAML File.

JSON File Example

{
"emname": "ems-s4hc",
"namespace": "sap/S4HANAOD/ems-s4hc",
"version": "1.1.0",
"options": {
"management": true,
"messagingrest": true,
"messaging": true
},
"rules": {
"queueRules": {
"subscribeFilter": [
"${namespace}/*"
]
},
"topicRules": {
"subscribeFilter": [
"${namespace}/*",
"sap/S4HANAOD/s4hc/*"
]
}
}
}

YAML File Example

spec:
externalName: ''
serviceOfferingName: enterprise-messaging

This is custom documentation. For more information, please visit SAP Help Portal. 111
 6/11/25, 2:39 PM
servicePlanName: default
parameters:
emname: ems-s4hc
namespace: sap/S4HANAOD/ems-s4hc
version: 1.1.0
options:
management: true
messagingrest: true
messaging: true
rules:
queueRules:
subscribeFilter:
- "${namespace}/*"
topicRules:
subscribeFilter:
- "${namespace}/*"
- sap/S4HANAOD/s4hc/*

Related Information
Syntax for Service Descriptor in SAP Event Mesh documentation

Create Queues and Subscribe to Them

Prerequisites

Уou have created the SAP S/4HANA Cloud Extensibility service instance in the Cloud Foundry or Kyma environment.
See:

Create an SAP S/4HANA Extensibility Service Instance in the Cloud Foundry Environment

Create an SAP S/4HANA Cloud Extensibility Service Instance in the Kyma Environment

Уou have created the SAP Event Mesh service instance in the Cloud Foundry or Kyma environment. See:

Create an SAP Event Mesh Service Instance in the Cloud Foundry Environment

Create an SAP Event Mesh Service Instance in the Kyma Environment

Context

After both instances are created and configured, you can create the topic-to-queue subscription. To do so, you first create a
subscription to SAP Event Mesh with plan standard. Then, create a queue in the client that refers to the SAP Event Mesh service
instance and then subscribe the topic of the namespace of the SAP S/4HANA Cloud Extensibility service to that queue.

 Note
You can subscribe to the SAP Event Mesh service once per subaccount.

Procedure

This is custom documentation. For more information, please visit SAP Help Portal. 112
 6/11/25, 2:39 PM
1. Create a subscription to SAP Event Mesh.

a. In the SAP BTP cockpit, navigate to the space in which you want to create a service instance.

b. In the navigation area, choose Services Service Marketplace , and then choose Event Mesh in the Service
Marketplace panel.

c. From the Event Mesh service tile, choose Create and follow the steps in the wizard to subscribe to the service.

d. In the New Instance or Subscription wizard:

i. In the Service dropdown list, select Event Mesh.

ii. In the Plan dropdown list, select the standard service plan. Choose Create.

2. Assign the necessary roles to your user.

a. In the SAP BTP cockpit, navigate to your subaccount.

b. In the navigation area, choose Security Trust Configuration , and then choose SAP ID Service in the Trust
Configuration panel.

c. On the Role Collection Assignment page, enter the e-mail of your user in the empty field and choose Show
Assignments. Then, choose Assign Role Collection.

d. In the Assign Role Collection wizard, select the following role collections:

Enterprise Messaging Administrator

Enterprise Messaging Developer

Enterprise Messaging Display

Enterprise Messaging Subscription Administrator

e. Choose Assign Role Collection.

3. Open the SAP Event Mesh application.

a. In the SAP BTP cockpit, navigate to the space in which you want to create a service instance.

b. In the navigation area, choose Services Instances and Subscriptions .

c. In the Subscriptions tab, choose the Event Mesh application.

d. From the Event Mesh page, choose Go to Application and open the SAP Event Mesh application.

 Note
If you are using the sample JSON files when creating the SAP S/4HANA Extensibility and the Event Mesh service
instances, you should see 2 message clients in the SAP Event Mesh application, s4hc and ems-s4hc.

4. Create a queue that is specific to your application.

a. Open the message client created when creating the Event Mesh service instance. For example, choose the ems-
s4hc tile.

b. Choose the Queues tab in the message client page and then choose Create Queue.

c. Enter a queue name. Note that in the blue field of the Create a New Queue wizard, the final queue name is
displayed. For example, if you write my-queue in the Queue Name field, the final queue name would be
sap/S4HANAOD/ems-s4hc/my-queue. Choose Create.

5. Subscribe this queue to the channel topic that SAP S/4HANA Cloud tenant uses to produce events.

a. From the Actions of your newly created queue, select Queue Subscriptions.

b. In the Topic field, enter the topic you configured in the SAP S/4HANA Cloud tenant. For example,
sap/S4HANAOD/s4hc/ce/sap/s4/beh/businesspartner/v1/BusinessPartner/Changed/v1.

c. Choose Add.

Related Information
This is custom documentation. For more information, please visit SAP Help Portal. 113
 6/11/25, 2:39 PM
Manage Queues
REST APIs for Events

Supported Service Plans for SAP S/4HANA Cloud

The following service plans are available for subaccounts in SAP BTP paired with an SAP S4/HANA Cloud tenant.

api-access
This service plan enables all communication scenarios, both predefined and custom, which allow you to consume SAP S/4HANA
Cloud APIs and integrate your extension applications with the respective SAP S/4HANA Cloud functionality.

To access the specific documentation of these APIs, see SAP S/4HANA Cloud APIs at SAP Business Accelerator Hub .

For more information about SAP S/4HANA Cloud communication scenarios see:

Communication Management

Custom Communication Scenarios

 Note
These service plans have been deprecated:

sap_com_0109

sap_com_0009

sap_com_0008

However, you can still enable these communication scenarios using the api-access service plan:

Sales Order Integration (SAP_COM_0109): allows you to integrate your extension applications with sales order
processing in SAP S/4HANA Cloud. For more information, see
https://api.sap.com/api/API_SALES_ORDER_SRV/overview .

Product Integration (SAP_COM_0009): enables you to replicate product master data from client system to SAP
S/4HANA system. For more information, see
https://api.sap.com/api/PRODUCTMDMBULKREPLICATEREQUEST/overview .

Business Partner, Customer and Supplier Integration (SAP_COM_0008): allows you to consume the Business Partner
API which enables you to create, read, update, and delete master data related to Business Partners, Suppliers, and
Customers in an SAP S/4HANA system. For more information, see
https://api.sap.com/api/API_BUSINESS_PARTNER/overview .

For a sample JSON for these communication scenarios, see Communication Arrangement JSON/YAML File - Properties.

messaging
This service plan enables the Enterprise Eventing Integration (SAP_COM_0092) communication scenario which allows you to
consume SAP S/4HANA Cloud events and create event-based extensions.

 Note
This service plan has been renamed from sap_com_0092.

This is custom documentation. For more information, please visit SAP Help Portal. 114
 6/11/25, 2:39 PM

Configuring Backup
You can back up and restore the destination and the trust configuration settings for the integration between the SAP S/4HANA
Cloud and the global account in SAP BTP.

You can back up and restore the following configuration settings:

The HTTP destination configured during the creation of the SAP S/4HANA Cloud Extensibility service instance. For more,
see Export Destinations.

Your subaccount X.509 certificates. For more information, see Set up Trust Between Systems

Your subaccount-specific IdP metadata.

To download your SAP SuccessFactors IdP SAML 2.0 metadata, in the SAP BTP cockpit, navigate to Connectivity
Destinations Download IdP Metadata .

Your identity provider configurations.

You can back up identity provider configurations with the Identity Provider Management API. For more information see:
Identity Provider Management API.

Auditing and Logging Information

Here you can find a list of the events that are logged by SAP S/4HANA Cloud Extensibility service. To retrieve the audit logs stored
for SAP S/4HANA Cloud Extensibility create a support ticket in component BC-NEO-EXT-S4C.

Events written in audit logs

Event grouping What events are logged How to identify related log Additional information
events

Creating an integration Start creating integration Event that signifies an

"type":"s4Integration"
integration of a global account

"attributes":[{"name": with an SAP S/4HANA Cloud

<object_name>,"new": system has been started. The

<integration_details>} log contains integration details
such as the SAP S/4HANA
"status":"BEGIN" Cloud tenant host name and ID,
the Identity Authenticattion
tenant ID, the integration ID,
and other.

The customDetails attribute

contains the SAP S/4HANA
Cloud user ID of the user who
has triggered the integration
process.

Created integration Event that signifies an

"type":"s4Integration"
integration of a global account
"attributes":[{"name": with an SAP S/4HANA Cloud

<object_name>,"new": system has been completed.

<integration_details>} The log contains integration

details such as the SAP
"status":"END" S/4HANA Cloud tenant host
name and ID, the Identity

This is custom documentation. For more information, please visit SAP Help Portal. 115
 6/11/25, 2:39 PM

Event grouping What events are logged How to identify related log Additional information
events

Authenticattion tenant ID, the

integration ID, and other.

The customDetails attribute

contains the SAP S/4HANA
Cloud user ID of the user who
has triggered the integration
process.

Delete integration Event that signifies a deletion of

"type":"s4Integration"
an integration of a global
"attributes":[{"name": account with an SAP S/4HANA
<object_name>,"old": Cloud system has been
<integration_details>} triggered. The log contains
integration details such as the
"status":"BEGIN" SAP S/4HANA Cloud tenant
host name and ID, the Identity
Authenticattion tenant ID, the
integration ID, and other.

The customDetails attribute

contains the SAP S/4HANA
Cloud user ID of the user who
has triggered the deletion
process.

Deleted integration Event that signifies a deletion of

"type":"s4Integration"
an integration of a global
"attributes":[{"name": account with an SAP S/4HANA
<object_name>,"old": Cloud system has been
<integration_details>} completed. The log contains
integration details such as the
"status":"END" SAP S/4HANA Cloud tenant
host name and ID, the Identity
Authenticattion tenant ID, the
integration ID, and other.

The customDetails attribute

contains the SAP S/4HANA
Cloud user ID of the user who
has triggered the deletion
process.

Setting up the connectivity Start creating connectivity Event that signifies a creation of
"type":"s4Configuration"
configuration a service instance of the SAP
"attributes":[{"name": S/4HANA Cloud Extensibility
<object_name>,"new": service has been triggered. The
<connection_details>} log contains details such as the
global account ID, the
"status":"BEGIN" subaccount ID, the
communication arrangement,
and the authentication
mechanism.

Created connectivity Event that signifies a creation of

"type":"s4Configuration"
configuration a service instance of the SAP
S/4HANA Cloud Extensibility

This is custom documentation. For more information, please visit SAP Help Portal. 116
 6/11/25, 2:39 PM

Event grouping What events are logged How to identify related log Additional information
events

"attributes":[{"name": service has been completed.

<object_name>,"old": The log contains details such as
<connection_details>} the global account ID, the
subaccount ID, the
"status":"BEGIN"
communication arrangement,
and the authentication
mechanism.

Start deleting connectivity Event that signifies the deletion

"type":"s4Configuration"
configuration of a service instance of the SAP
"attributes":[{"name": S/4HANA Cloud Extensibility
<object_name>,"old": service has been started. The

<connection_details>} log contains details such as the

global account ID, the
"status":"BEGIN" subaccount ID, the
communication arrangement,
and the authentication
mechanism.

Deleted connectivity Event that signifies the deletion

"type":"s4Configuration"
configuration of a service instance of the SAP
"attributes":[{"name": S/4HANA Cloud Extensibility

<object_name>,"old": service has been completed.

<connection_details>} The log contains details such as
the global account ID, the
"status":"END" subaccount ID, the
communication arrangement,
and the authentication
mechanism.

The following information is described in the table columns:

Event grouping - Events that are logged with a similar format or are related to the same entities.

What events are logged - Description of the security or data protection and privacy related event that is logged.

How to identify related log events - Search criteria or key words, that are specific for a log event that is created along with
the logged event.

Additional information - Any related information that can be helpful.

Related Information
Audit Logging in the Cloud Foundry Environment

Accessibility Features in SAP S/4HANA Cloud Extensibility

Service
To optimize your experience of SAP S/4HANA Cloud Extensibility service, SAP Business Technology Platform (SAP BTP) provides
features and settings that help you use the software efficiently.

 Note

This is custom documentation. For more information, please visit SAP Help Portal. 117
 6/11/25, 2:39 PM
SAP S/4HANA Cloud Extensibility service runs on the SAP BTP cockpit. For this reason, accessibility features for SAP BTP
cockpit also apply. See the accessibility documentation for SAP BTP cockpit on SAP Help Portal at Accessibility Features in SAP
BTP cockpit.

For more information on screen reader support and keyboard shortcuts, see Accessibility for End Users.

Troubleshooting for SAP S/4HANA Cloud Extensibility Service

Information about troubleshooting issues you might experience when extending SAP S/4HANA Cloud on SAP BTP using the SAP
S/4HANA Cloud Extensibility service.

Cloud Foundry Environment

These are some issues you might experience when extending SAP S/4HANA Cloud on SAP BTP, Cloud Foundry environment:

Cannot create an SAP S/4HANA Cloud Extensibility Service Instance of the Messaging Plan

My SAP S/4HANA Cloud Extensibility Service Instance Failed to Create and It Didn't Say Why

Cannot create an SAP S/4HANA Cloud Extensibility Service

Instance of the Messaging Plan
Cannot create an SAP S/4HANA Cloud Extensibility service instance of the messaging plan.

Issue/Symptom

You are trying to create an SAP S/4HANA Cloud Extensibility service instance of the messaging plan and you get the following
error message:"Creation Failed."

Reason
You are probably providing in the JSON file the same emClientId that was already used in the subaccount.

Solution
Make the value of the emClientId parameter unique within the subaccount.

Related Information
Set Up the Connectivity Between Event Mesh and the SAP S/4HANA Cloud Tenant

My SAP S/4HANA Cloud Extensibility Service Instance Failed to

Create and It Didn't Say Why
My SAP S/4HANA Cloud Extensibility service instance failed to create and it didn't say why.

Issue/Symptom
This is custom documentation. For more information, please visit SAP Help Portal. 118
 6/11/25, 2:39 PM
You are trying to create an SAP S/4HANA Cloud Extensibility service instance but the creation fails with no error message.

Solution

This is what you can do:

You can use the Cloud Foundry command line interface to get the error message by executing the command:

cf service <service_instance_name>

Check for any error messages there.

Can you reach the SAP S/4HANA Cloud tenant? Check that the tenant is not in maintenance or being updated.

If this didn't help, you can try some more specific actions. What service plan are you using?

I am using the messaging service plan

Issue/Symptom

Your SAP S/4HANA Cloud Extensibility service instance of the messaging plan failed to create and it didn't say why.

Solution

Try to do the following:

Is the Enterprise Messaging Integration scenario (SAP_COM_0092) enabled on your SAP S/4HANA Cloud tenant? Check
whether you see it in the Display Communication Scenarios application in your SAP S/4HANA Cloud tenant.

The clients for SAP Event Mesh require unique values (within your subaccount in SAP BTP) for the emname and
namespace properties. In the messaging plan, you have either provided these manually, or you have only set the
emClientId property and let it generate them. If the latter, then these values would be emClientId> for emname and
sap/S4HANAOD/emClientId> for namespace. Check whether your subaccount already has existing clients with such
emname or namespace values. You can do this by using the Enterprise Messaging Business Application from the SAP
Event Mesh subscription of your subaccount. See View Event Catalog for a Subaccount.

I am using the api-access service plan

Issue/Symptom

Your SAP S/4HANA Cloud Extensibility service instance of the api-access plan failed to create and it didn't say why.

Solution

Try to do the following:

Is the communication scenario with the scenarioId that you provided enabled on that tenant? Check whether you see it in
the Display Communication Scenarios application in your SAP S/4HANA Cloud tenant.

Are you using supported authentication types? In the scenario definition, you can see which authentication types are
supported for both outbound and inbound connectivity. Verify that the types you are providing in the descriptor are
supported by the scenario.

Extending SAP Marketing Cloud in the Cloud Foundry and Kyma

Environment

Overview

This is custom documentation. For more information, please visit SAP Help Portal. 119
 6/11/25, 2:39 PM

 Note
The SAP S/4HANA Cloud Extensibility service is also availаble for global accounts marked with EU Access. See Regions.

SAP BTP offers a standard way for extending SAP solutions.

You can extend SAP Marketing Cloud in the Cloud Foundry or the Kyma environment without disrupting the performance and the
core processes. When building extension applications, you can also benefit from the automation of the integration between the
cloud platform and SAP Marketing Cloud.

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

The following graphic provides a high-level overview of the integration between SAP BTP and SAP Marketing Cloud:

Process Flow
To integrate SAP BTP and SAP Marketing Cloud so that you can build extension applications, you have to use the SAP S/4HANA
Cloud Extensibility service. All the steps are the same from the SAP BTP side. You register an SAP Marketing Cloud system in the
SAP BTP cockpit. Then, you take the generated token and use it to configure the connectivity on the SAP Marketing Cloud side.
These are the tasks you need to follow:

Integrating SAP BTP and SAP Marketing Cloud

Process Step Related Documentation

This is custom documentation. For more information, please visit SAP Help Portal. 120
 6/11/25, 2:39 PM

Process Step Related Documentation

1. Connect the SAP Marketing Cloud system you want Register an SAP Marketing Cloud System in a Global Account in SAP BTP
to extend with the corresponding global account in SAP
BTP.  Note
You cannot migrate the registered SAP Marketing Cloud systems between
During the pairing process you create an registration
token which is then used by the SAP Marketing Cloud global accounts.

system tenant administrator to configure the

If you want to start using another global account, you will have to register
integration on the SAP Marketing Cloud system side.
your SAP Marketing Cloud systems again.

2. Make the SAP Marketing Cloud system accessible in Configure the Entitlements for the SAP S/4HANA Cloud Extensibility Service
the subaccounts in SAP BTP in which you want to build
your extension applications.

To do so, you configure the entitlements and assign the

corresponding quota and service plans to the
subaccounts where the extension applications will
reside for the system you registered in the previous
step.

3. Configure the communication flow.

Creating a Service Instance to Consume the SAP S/4HANA Cloud APIs
You have the following options:
Enable the Consumption of SAP S/4HANA Cloud Events
Consume the SAP Marketing Cloud APIs
(inbound connection) or consume APIs
exposed by the extension application from SAP
S/4 HANA Cloud (outbound connection)

To do so, you create a service instance of the

SAP S/4HANA Cloud Extensibility service
using the api-access service plan.

During the service instance creation an HTTP

destination on a subaccount level is
automatically generated in this subaccount. It
contains all instance binding properties which
are sufficient to establish connection to the
SAP Marketing Cloud system. When creating
the service instance, you configure the
communication arrangement and the
authentication type for the connection. The
following authentication scenarios for SAP
Marketing Cloud are supported:

Basic Authentication (inbound and

outbound connections)

OAuth 2.0 SAML Bearer Assertion

(inbound connections)

OAuth 2.0 Client Credentials (outbound

Connections)

No Authentication (outbound
connections)

Both predefined and custom communication

scenarios are supported.

This is custom documentation. For more information, please visit SAP Help Portal. 121
 6/11/25, 2:39 PM

Process Step Related Documentation

Enable the consumption of SAP Marketing

Cloud events.

If you want to create event-based extensions

for SAP Marketing Cloud using the SAP
Enterprise Messaging service, you have to
create a service instance of the SAP S/4HANA
Cloud Extensibility service using the
messaging service plan.

A combination of both

Extending SAP SuccessFactors in the Cloud Foundry and Kyma

Environment
Use SAP BTP to extend SAP SuccessFactors with extension applications running on the cloud platform.

Overview

 Note
The SAP SuccessFactors Extensibility service is also availаble for global accounts marked with EU Access. See Regions.

SAP BTP offers a standard way for extending SAP solutions.

You can extend SAP SuccessFactors systems without disrupting the performance and the core processes. When building
extension applications, you can also benefit from the automation of the integration between the cloud platform and SAP
SuccessFactors.

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

The following graphic provides a high-level overview of the integration between SAP BTP and SAP SuccessFactors:

This is custom documentation. For more information, please visit SAP Help Portal. 122
 6/11/25, 2:39 PM

Process Flow
To integrate SAP BTP and SAP SuccessFactors so that you can build extension applications, you need to perform the following
tasks:

Integrating SAP BTP and SAP SuccessFactors

Process Step Related Documentation

1. Connect the SAP SuccessFactors system that you Register an SAP SuccessFactors System in a Global Account in SAP BTP.
want to extend with the corresponding global account
in SAP BTP.  Note
During the pairing process you create a registration You cannot migrate the registered SAP SuccessFactors systems between
global accounts.
token which is then used by the SAP SuccessFactors
system tenant administrator to configure the If you want to start using another global account, you will have to register
integration on the SAP SuccessFactors system side. your SAP SuccessFactors systems again.

2. Make the SAP SuccessFactors system accessible in Configure the Entitlements for the SAP SuccessFactors Extensibility Service
the subaccounts in which you want to build your
extension applications.

To do so, you configure the entitlements and assign the

corresponding quota where the extension applications
will reside.

3. Configure the communication flow. Create a Service Instance to Consume the SAP SuccessFactors HXM Suite
OData API
To do so, create a service instance of the SAP
SuccessFactors Extensibility service using the api-
access service plan.

During the service instance creation an HTTP

destination on a subaccount level is automatically
generated in this subaccount. It contains all instance

This is custom documentation. For more information, please visit SAP Help Portal. 123
 6/11/25, 2:39 PM

Process Step Related Documentation

binding properties which are sufficient to establish

connection to the SAP SuccessFactors system.

SAP BTP supports the following authentication

scenarios for SAP SuccessFactors:

OData access with OAuth 2.0 SAML bearer

assertion

OData access with OAuth 2.0 SAML bearer

assertion with technical user

4. Configure the Single-Sign On (SSO) between the Configure Single Sign-On Between a Subaccount in SAP BTP and SAP
subaccount in SAP BTP and the SAP SuccessFactors SuccessFactors
system.

To ensure the required security for accessing the

applications, you need to configure the single sign-on
between the subaccount in SAP BTP and the SAP
SuccessFactors system using a SAML identity provider.

5. If you have performed an automated instance refresh Restore Configuration Settings After an Instance Refresh
or your cloud operators have performed a manual
instance refresh, you need to restore some of the
extension configuration settings.

Configure the Entitlements for the SAP SuccessFactors

Extensibility Service
Configure the required entitlements to make the SAP SuccessFactors HXM Suite OData APIs of the registered SAP
SuccessFactors system accessible in your subaccount in which your extension applications will reside.

Prerequisites

You are an administrator of the global account in SAP BTP.

The subaccount is in the SAP BTP, Cloud Foundry environment with enabled Cloud Foundry, or Kyma, or both capabilities.

You have registered an SAP SuccessFactors system. See Register an SAP SuccessFactors System in a Global Account in
SAP BTP.

Context

An entitlement is your right to provision and consume a resource. In other words, the entitlement is the api-access service plan
that you're entitled to use, and the sso-configuration service plan that allows you to register an assertion consumer service in SAP
SuccessFactors automatically.

Procedure
1. In the SAP BTP cockpit, navigate to your global account.

2. In the navigation area, choose Entitlements Entity Assignments .

3. On the Entity Assignments screen, select your subaccount in the Subaccounts/Directories field.

This is custom documentation. For more information, please visit SAP Help Portal. 124
 6/11/25, 2:39 PM
4. Choose Edit, and then choose Add Service Plans.

5. Select the SAP SuccessFactors Extensibility service.

 Note
To have the SAP SuccessFactors Extensibility service in the list, you need to have registered at least one SAP
SuccessFactors system.

6. In the Service Details area, select the system you have registered. In the Available Plans area, select the api-access and
sso-configuration service plans, and then choose Add 2 Service Plans.

Related Information
Configure Entitlements and Quotas for Subaccounts

Create a Service Instance to Consume the SAP SuccessFactors

HXM Suite OData API
To enable the integration of your extension applications with the SAP SuccessFactors system you have registered in the global
account in SAP BTP, you first need to create a service instance of the corresponding service.

Context

In both Cloud Foundry and Kyma environment, you consume services by creating a service instance. Service instances are created
using a specific service plan.

To allow applications running on SAP BTP to consume SAP SuccessFactors HXM Suite OData APIs, you need to create a service
instance of the SAP SuccessFactors Extensibility service using the api-access service plan.

You create the service instance in your subaccount with the respective environment enabled. When creating the service instance,
you configure the authentication type for the communication by specifying the required configurations in a JSON format. SAP BTP
supports the following authentication scenarios for SAP SuccessFactors:

OData access with OAuth 2.0 SAML bearer assertion

To use this authentication type, you must protect your application. See Adding Authentication and Authorization.

OData access with OAuth 2.0 SAML bearer assertion with technical user

The process for creating a service instance depends on the environment you are using:

For Cloud Foundry environment, see Create an SAP SuccessFactors Extensibility Service Instance in the Cloud Foundry
Environment.

For Kyma environment, see Create an SAP SuccessFactors Extensibility Service Instance in the Kyma Environment.

Create an SAP SuccessFactors Extensibility Service Instance in

the Cloud Foundry Environment
To enable the integration of your extension applications with the SAP SuccessFactors system you have registered in the global
account in SAP BTP, you first need to create a service instance of the corresponding service.

This is custom documentation. For more information, please visit SAP Help Portal. 125
 6/11/25, 2:39 PM

Prerequisites

You have registered an SAP SuccessFactors system. See Register an SAP SuccessFactors System in a Global Account in
SAP BTP.

Before creating an SAP SuccessFactors Extensibility service instance in the Cloud Foundry environment, see Create a
Service Instance to Consume the SAP SuccessFactors HXM Suite OData API.

Have enabled Cloud Foundry environment for your subaccount. See Enable Environment or Create Environment Instance.

Have configured the entitlements to the SAP SuccessFactors Extensibility service. See Configure the Entitlements for the
SAP SuccessFactors Extensibility Service.

Context

In the Cloud Foundry environment, you consume services by creating a service instance. Service instances are created using a
specific service plan. The services are offered in the Service Marketplace, from which you can create service instances to provision
the reserved resources.

To allow applications running on SAP BTP to consume SAP SuccessFactors HXM Suite OData APIs, you need to create a service
instance of the SAP SuccessFactors Extensibility service using the api-access service plan.

You create the service instance in a space of your subaccount. When creating the service instance, you configure the
authentication type for the communication by specifying the required configurations in a JSON format. SAP BTP supports the
following authentication scenarios for SAP SuccessFactors:

OData access with OAuth 2.0 SAML bearer assertion

To use this authentication type, you must protect your application. See Authentication for Applications.

OData access with OAuth 2.0 SAML bearer assertion with technical user

During the creation of the service instance, a destination on a subaccount level with the same name as the service instance name
is automatically created in this subaccount. It contains all instance binding properties which are sufficient to establish connection
to the SAP SuccessFactors system.

 Note
Make sure that you don't already have a destination with the same name as the service instance. If you do, you will not be able
to create the service instance.

Procedure
1. In the SAP BTP cockpit, navigate to the subaccount in which you want to create a service instance.

2. In the navigation area, choose Services Service Marketplace .

All services available to you appear.

3. To enable the integration with an SAP SuccessFactors system that you have registered in SAP BTP global account, choose
SAP SuccessFactors Extensibility.

4. In the SAP SuccessFactors Extensibility page, choose Create.

5. In the New Instance or Subscription wizard:

a. In the Service dropdown list, ensure you have selected the SAP SuccessFactors Extensibility service.

b. In the Plan dropdown list, select the api-access service plan.

c. In the Runtime Environment dropdown list, select Cloud Foundry.

This is custom documentation. For more information, please visit SAP Help Portal. 126
 6/11/25, 2:39 PM
d. In the Space dropdown list, select your space. If you haven't create a space yet, you can do it at this point.

e. In the System Name dropdown list, select the SAP SuccessFactors system you have registered.

f. In the Instance Name field, enter a name for your instance. Choose Next.

g. (Optional) To define a technical user the access to the SAP SuccessFactors HXM Suite API, specify a JSON file or
specify parameters in the JSON format. If you decide to add a technical user later on, you have to delete this service
instance and create it again. Choose Next.

For more information about the structure of the JSON file, see API Access Configuration JSON File.

h. Choose Create.

Results

After you have created the service instance:

The newly created instance appears in the list of instances in the Instance and Subscriptions page.

An HTTP destination on a subaccount level with the same name as the service instance name is automatically generated in
this subaccount.

Alternatively, you can use the Cloud Foundry Command Line Interface (cf CLI) to create the service instance using the technical
name of the SAP SuccessFactors Extensibility service which is sap-successfactors-extensibility.

For more information, see Create Service Instances Using the Cloud Foundry Command Line Interface.

 Note
You can use the cf CLI to troubleshoot if the creation of the service instance fails. To do that, use this command in the cf CLI:

cf service <service_instance_name>

Next Steps

After creating the SAP SuccessFactors Extensibility service instance, you have the following options for configuring the
connectivity for your extension application:

Bind the instance to an application, and it will be assigned an access URL and credentials to the corresponding API. For
more information about binding applications to service instances, see Binding Service Instances to Applications.

Consume the automatically generated destination.

To consume the destination, you use the Destination service. You can either consume the Destination service directly, or
configure the application router to consume it.

 Note
The name of the destination is the same as the name of the service instance you have created.

For more information about consuming the destination service using the application router, see Application Routes
and Destinations.

For more information about consuming the destination service directly, see Consuming the Destination Service
(Cloud Foundry Environment).

This is custom documentation. For more information, please visit SAP Help Portal. 127
 6/11/25, 2:39 PM

Create an SAP SuccessFactors Extensibility Service Instance in

the Kyma Environment

Prerequisites
Before creating an SAP SuccessFactors Extensibility service instance in the Kyma environment, see Create a Service
Instance to Consume the SAP SuccessFactors HXM Suite OData API.

Have the Kyma environment enabled for the subaccount you are using. See Creating a Kyma Instance.

Configure the roles in the Kyma environment. See Assign Roles in the Kyma Environment.

The SAP BTP Operator module is enabled. See Adding and Deleting a Kyma Module

Have the entitlements of the SAP SuccessFactors Extensibility service configured. See Configure the Entitlements for the
SAP S/4HANA Cloud Extensibility Service.

Context
During the creation of the service instance, a destination on the subaccount level with the same name as the service instance
name is automatically created in this subaccount. It contains all instance binding properties which are sufficient to establish
connection to the SAP SuccessFactors system.

 Note
Make sure that you don't already have a destination with the same name as the service instance. If you do, you will not be able
to create the service instance.

Procedure
1. Navigate to the subaccount for which you want to create an SAP SuccessFactors Extensibility service instance.

2. On the subaccount Overview page, in the Kyma Environment section, open the Kyma dashboard.

3. Choose Namespaces from the left-hand side navigation and open the namespace in which you want to create a service
instance.

4. Choose Service Management Service Instances from the left-hand side navigation.

5. In the Service Instances page, choose Create Service Instance in the upper right-hand corner. A new dialog opens.

6. Choose the Advanced tab and fill in the following fields:

Give a meaningful name of the new SAP SuccessFactors Extensibility service instance.

In the Offering Name field, enter sap-successfactors-extensibility, which is the technical name of the
SAP SuccessFactors Extensibility service.

In the Plan Name field, enter api-access.

Expand Instance Parameters.

To define the authentication type for the API access, specify the parameters listed in this JSON file: API Access
Configuration JSON File.

7. Choose Create.

Next Steps

This is custom documentation. For more information, please visit SAP Help Portal. 128
 6/11/25, 2:39 PM
After creating the SAP SuccessFactors Extensibility service instance, you have to bind the instance to an application, and it will be
assigned an access URL and credentials to the corresponding API. See Using SAP BTP Services in the Kyma Environment.

API Access Configuration JSON File

Use the authentication type JSON descriptor to define the authentication type for the inbound connectivity to the SAP
SuccessFactors HXM Suite OData API.

Parameter Description

systemName The name of the system you have registered in a global account in
SAP BTP.

 Note
The system must be in status Registered.

Rules/Guidelines

Required: Yes

technicalUser The name of the technical user for consuming the SAP
SuccessFactors HXM Suite OData API without a logged-in user.

 Caution
This property specifies the systemUser property in the
destination that is created as a result of creating the SAP
SuccessFactors Extensibility service instance.

The systemUser is deprecated and will be removed soon. We

recommend that you work on behalf of specific (named) users
instead of working with a technical user.

 Note
The technical user can be any user with the respective
permissions. These permissions depend on the use case and
the API you want to access. To find out which permission you
need to assign to the technical user, go to SAP Business
Accelerator Hub , find the SAP SuccessFactors API you want
to access and from the Overview tab go to the Documentation
section and open the help.sap.com link. There you find the right
information for each API.

Rules/Guidelines

Required: No

Allowed characters: [a-zA-Z0-9_-]

Max length: 100

Example

This is custom documentation. For more information, please visit SAP Help Portal. 129
 6/11/25, 2:39 PM

{
"systemName":"MY_SYSTEM",
"technicalUser":"technicalonboarder"
}

Configure Single Sign-On Between a Subaccount in SAP BTP and

SAP SuccessFactors
Use this procedure to configure the single sign-on (SSO) between SAP BTP and the SAP SuccessFactors system.

Prerequisites
You have the UI and Role Administrator role assigned to your user. See Security Administration: Managing Authentication and
Authorization.

Context

The authentication to SAP SuccessFactors applications is restricted to the authorized users. The identification of a user is verified
by the identity provider, as specified by SAML 2.0. The Identity Authentication service stores a list of all users that are allowed to
access the SAP SuccessFactors system along with their credentials. The integration between the SAP SuccessFactors and the
identity provider is based on a trust configuration. When a user attempts to access SAP SuccessFactors for the first time, the
system redirects the user to the identity provider for identification. From then on, the user session is kept active, and the user is no
longer prompted for credentials when trying to use the SAP SuccessFactors application. This is called single sign-on (SSO).

To ensure the required security for accessing the applications, you need to configure the single sign-on between the subaccount in
SAP BTP and the SAP SuccessFactors system using a SAML identity provider. The single sign-on requires both solutions to be
configured as trusted SAML service providers for the identity provider, and at the same time, the identity provider to be configured
as trusted identity provider for the two solutions.

If you have an account in the Cloud Foundry environment, you need to set up the single sign-on (SSO) according to this
environment.

Procedure
1. Configure SAP SuccessFactors as a Trusted Identity Provider in SAP BTP.

2. Configure the Subaccount as a Trusted Service Provider in SAP SuccessFactors.

Configure SAP SuccessFactors as a Trusted Identity Provider in

SAP BTP
Use this procedure to set up the trust configuration of the subaccount in SAP BTP and add SAP SuccessFactors as an identity
provider.

Procedure
1. Download SAML metadata from the SAP SuccessFactors system.

a. Go to https://<sap_successfactors_system>/idp/samlmetadata?company=
<company_id>&cert=sha2 where:

This is custom documentation. For more information, please visit SAP Help Portal. 130
 6/11/25, 2:39 PM
<sap_successfactors_system> is the hostname of your SAP SuccessFactors system

<company_id> is the ID of your SAP SuccessFactors company

b. When you are prompted, save the file on your local file system and change its extension to .xml.

2. Register the SAP SuccessFactors identity provider in the SAP BTP cockpit.

a. Open the cockpit and navigate to your subaccount.

b. Choose Security Trust Configuration .

c. Choose New SAML Trust Configuration.

d. To upload the SAML metadata you downloaded in step 1, choose Upload. Browse to the XML file you saved and
select it. Some of the fields are automatically filled in.

e. In the Name field, enter a meaningful name for the trust configuration.

f. Save the changes.

3. Make the trust configuration to the SAP SuccessFactors identity provider the only configuration that is active.

Configure the Subaccount as a Trusted Service Provider in SAP

SuccessFactors
To configure the subaccount as a trusted service provider in SAP SuccessFactors, you have to create an SAP SuccessFactors
Extensibility service instance using the sso-configuration service plan.

Prerequisites
Register an SAP SuccessFactors System in a Global Account in SAP BTP

Configure the Entitlements for the SAP SuccessFactors Extensibility Service

Configure SAP SuccessFactors as a Trusted Identity Provider in SAP BTP

Context

With the SAP SuccessFactors Extensibility service instance using the sso-configuration service plan, you can create automatically
an assertion consumer service in SAP SuccessFactors for the subaccount in which this service instance is created and a logout
URL for each extension application you have deployed in SAP BTP that is extending the functionality of the registered SAP
SuccessFactors system. To create an assertion consumer service, you either go to the SAP SuccessFactors Provisioning and create
these assertion consumer services manually, or create them automatically in the SAP BTP cockpit via an SAP SuccessFactors
Extensibility service instance using the sso-configuration service plan without loggin in to the Provisioning.

To create an assertion consumer service automatically, you create an SAP SuccessFactors Extensibility service instance of plan
sso-configuration providing all the necessary information in a JSON file. You can have only one service instance of plan sso-
configuration per subaccount.

In the JSON file you provide, in the systemName parameter, you specify the SAP SuccessFactors system where you want the
assertion consumer services to be created. Then, you automatically get an assertion consumer service for the subaccount where
the service instance is created and assertion consumer services for each logout URL you provided.

If you want to add or delete assertion consumer services with logout URLs, you have to update the SAP SuccessFactors
Extensibility service instance of plan sso-configuration and provide a JSON file with the respective information. Before updating
the service instance, you have the option to view the JSON that was previously passed.

When updating the service instance:

This is custom documentation. For more information, please visit SAP Help Portal. 131
 6/11/25, 2:39 PM
All the new assertion consumer services with logout URLs will be created in SAP SuccessFactors.

All the assertion consumer services with logout URLs that were previously created but are not part of the new JSON file will
be deleted.

All the assertion consumer services with logout URLs that were previously created and are part of the new JSON file will be
recreated.

When you delete the SAP SuccessFactors Extensibility service instance of plan sso-configuration, all the assertion consumer
services with logout URLs created by this service instance will also be deleted.

 Note
You cannot bind the service instance of sso-configuration service plan.

Procedure
1. In the SAP BTP cockpit, navigate to the subaccount in which you want to create a service instance.

2. In the navigation area, choose Services Service Marketplace .

All services available to you appear.

3. To enable the integration with an SAP SuccessFactors system that you have registered in the global account, choose SAP
SuccessFactors Extensibility.

4. In the SAP SuccessFactors Extensibility page, choose Create.

5. In the New Instance or Subscription wizard:

a. In the Service dropdown list, ensure you have selected the SAP SuccessFactors Extensibility service.

b. In the Plan dropdown list, select the sso-configuration service plan.

c. In the Runtime Environment dropdown list, select Other.

d. In the System Name dropdown list, select the SAP SuccessFactors system you have registered.

e. In the Instance Name field, enter a name for your instance. Choose Next.

f. To configure the assertion consumer service of the subaccount and the respective applications, specify a JSON file
or specify parameters in a JSON format. You can also do this later on. Choose Next.

 Note
The content of the JSON file must be up to 5120 characters without spaces.

For more information about the structure of the JSON file, see Single Sign-On Configuration JSON File.

g. Choose Create.

Results

You have the assertion consumer services created in SAP SuccessFactors and have the SSO between your subaccount in SAP BTP
and your SAP SuccessFactors system.

You can check the assertion consumer services. To do so, go to the Admin Center of you SAP SuccessFactors company and in the
Search field, enter Authorized SP Assertion Consumer Service Settings. This is a read-only information that allows you to verify if
all the assertion consumer services that you need are created.

Single Sign-On Configuration JSON File

This is custom documentation. For more information, please visit SAP Help Portal. 132
 6/11/25, 2:39 PM
Use the single sign-on (SSO) configuration JSON file to define the assertion consumer services in SAP SuccessFactors for the
subaccount in SAP BTP and for each extension application you have deployed in SAP BTP that is extending the SAP
SuccessFactors system functionality.

 Note
The content of the JSON file must be up to 5120 characters without spaces.

Parameter Description

systemName The name of the system you have registered in the global account
in SAP BTP

Rules/Guidelines

The name must be the same as the one defined during the system
registration in the global account. See Register an SAP
SuccessFactors System in a Global Account in SAP BTP.

 Note
The system must be in status Registered.

logoutURLs (Optional) This is a list of the logout URLs. A logout URL is the
absolute URL that corresponds to the URL of the application router
with the appended value of the logoutEndpoint property. See
logout.

 Note
Make sure that the value of the logoutMethod property is set
to GET in the xs-app.json file.

 Note
The SameSite attribute of the Set-Cookie HTTP response
header needs to be set to None so that the cookies are sent in
all responses to both first-party and cross-origin requests. You
also need to set the cookie Secure attribute, because it
requires a secure context/HTTPS. See Environment Variables.

 Note
If you don't specify the logoutURLs parameter, only an
assertion consumer service for the subaccount in SAP BTP will
be created.

 Sample Code

{
"systemName": "MY_SYSTEM",
"logoutURLs": ["https://my-first-site.com/logout", "https://my-second-site.com/logout"]
}

Restore Configuration Settings After an Instance Refresh

This is custom documentation. For more information, please visit SAP Help Portal. 133
 6/11/25, 2:39 PM
After an instance refresh, you must restore some of your extension integration artifacts and configuration settings for the SAP
SuccessFactors target company.

Prerequisites

You have a dedicated SAP SuccessFactors company instance.

You have a registered SAP SuccessFactors system in your global account in SAP BTP.

You have performed the instance refresh with the Instance Refresh tool or your cloud operators have performed an
instance refresh manually.

Context
In SAP SuccessFactors, instance refresh is a procedure in which the data and the settings of a source company instance are copied
into another company instance. During the instance refresh the data of the target company instance is deleted and replaced by the
data of the source company instance. Therefore, after an instance refresh, if the target company has been integrated with a global
account in SAP BTP, the extension integration configuration settings and artifacts in the target company are overwritten by the
configuration settings and data coming from the source company.

You can trigger the instance refresh automatically with the Instance Refresh tool or your cloud operators can trigger it manually.

If you have performed an instance refresh with the Instance Refresh tool, the OAuth clients, and the Assertion Consumer Services
(ACS) created by the cloud platform are recreated. In Provisioning, the Extension Management Configuration page displays the
integration details for the target system.

 Note
The OAuth clients are assigned new IDs. This does not affect the configuration settings.

However, if you have the following artifacts, you must reconfigure them in the SAP SuccessFactors target company instance:

Custom home page tiles

Permission roles

Permission groups

 Note
After a manual instance refreshed, no artifacts are reconfigured. If you want to restore the integration settings for the target
company instance, you need to recreate the SAP SuccessFactors Extensibility service instance.

Procedure

To restore the configuration settings after an instance refresh, proceed as follows:

After an automated instance refresh:

a. If you have configured custom home page tiles in the target company instance, reconfigure them. See Custom
Home Page Tiles.

b. If you have configured permission roles and permission groups, you need to reconfigure them. See What Are Role-
Based Permissions?.

This is custom documentation. For more information, please visit SAP Help Portal. 134
 6/11/25, 2:39 PM
After a manual instance refresh:

a. For SAP SuccessFactors, Second Half 2021 Release or later, proceed as follows:

i. Recreate the SAP SuccessFactors Extensibility service instance. See Create a Service Instance to Consume
the SAP SuccessFactors HXM Suite OData API.

ii. If you have configured permission roles and permission groups, you need to reconfigure them. See Custom
Home Page Tiles.

iii. Reconfigure the permission roles and permission groups. See What Are Role-Based Permissions?.

Results

You have restored the extension integration artifacts and configuration setting of the target company instance.

Auditing and Logging Information

Here you can find a list of the events that are logged by SAP SuccessFactors Extensibility service. To retrieve the audit logs stored
for SAP SuccessFactors Extensibility create a support ticket in component BC-NEO-EXT-SF.

Events written in audit logs

Event grouping What events are logged How to identify related log events Additional information

Creating an integration Start of create-integration Event that signifies an

"type":"integration"
process integration of a global account
"attributes":[{"name":" with an SAP SuccessFactors
<object_name>","new":" system has been started.
<integration_details>"}
The customDetails attribute
"status":"BEGIN" contains details such as the
issuer of the integration token,
the global account ID, the
name of the SAP
SuccessFactors system and
the SAP SuccessFactors
company ID, the SAP
SuccessFactors host name,
and other.

End of create-integration Event that signifies an

"success":true
process integration of a global account

"type":"integration" with an SAP SuccessFactors

system has been completed.
"attributes":[{"name":"
<object_name>","new":" The customDetails attribute
<integration_details>"} contains details such as the
issuer of the integration token,
"status":"END" the global account ID, the
name of the SAP
SuccessFactors system and
the SAP SuccessFactors
company ID, the SAP
SuccessFactors host name,
and other.

This is custom documentation. For more information, please visit SAP Help Portal. 135
 6/11/25, 2:39 PM

Event grouping What events are logged How to identify related log events Additional information

Failure of create-integration Event that signifies an

"success":true
process integration of a global account
"type":"integration" with an SAP SuccessFactors
system could not be
"attributes":[{"name":" completed.
<object_name>","new":"
<integration_details>"} The customDetails attribute
contains details such as the
"status":"END" issuer of the integration token,
the global account ID, the
name of the SAP
SuccessFactors system and
the SAP SuccessFactors
company ID, the SAP
SuccessFactors host name,
and other.

Start of delete-integration Event that signifies a deletion

"type":"integration"
of the integration of a global
"attributes":[{"name":" account with an SAP
<object_name>","old":" SuccessFactors system has
<integration_details>"} been triggered.

"status":"BEGIN" The customDetails attribute

contains details such as the
issuer of the integration token,
the global account ID, the
name of the SAP
SuccessFactors system and
the SAP SuccessFactors
company ID, the SAP
SuccessFactors host name,
and other.

End of delete-integration Event that signifies a deletion

"success":true
of the integration of a global
"type":"integration" account with an SAP
SuccessFactors system has
"attributes":[{"name":" been completed.
<object_name>","old":"
<integration_details>"} The customDetails attribute
contains details such as the
"status":"END" issuer of the integration token,
the global account ID, the
name of the SAP
SuccessFactors system and
the SAP SuccessFactors
company ID, the SAP
SuccessFactors host name,
and other.

Failure of delete-integration Event that signifies a deletion

"success":false
of the integration of a global

"type":"integration" account with an SAP

SuccessFactors system could
"attributes":[{"name":" not be completed.
<object_name>","old":"
<integration_details>"}

This is custom documentation. For more information, please visit SAP Help Portal. 136
 6/11/25, 2:39 PM

Event grouping What events are logged How to identify related log events Additional information

"status":"END" The customDetails attribute

contains details such as the
issuer of the integration token,
the global account ID, the
name of the SAP
SuccessFactors system and
the SAP SuccessFactors
company ID, the SAP
SuccessFactors host name,
and other.

Setting up the connectivity Start of create-inbound- Event that signifies a creation

"type":"inboundConnection"
connection process of a service instance of the

"attributes":[{"name": SAP SuccessFactors

<object_name>,"new":" Extensibility service has been

<connection_details>" triggered.

"status":"BEGIN" The customDetails attribute

contains details such as the
subaccount ID, the global
account ID, SAP
SuccessFactors host name,
and other.

End of create-inbound- Event that signifies a creation

"type":"inboundConnection"
connection process of a service instance of the
"attributes":[{"name": SAP SuccessFactors
<object_name>,"new":" Extensibility service has been
<connection_details>" completed.

"status":"END" The customDetails attribute

contains details such as the
subaccount ID, the global
account ID, SAP
SuccessFactors host name,
and other.

Start of delete-inbound- Event that signifies the

"type":"inboundConnection"
connection deletion of a service instance
"attributes":[{"name": of the SAP SuccessFactors
<object_name>,"old":" Extensibility service has been
<connection_details>" started.

"status":"BEGIN" The customDetails attribute

contains details such as the
subaccount ID, the global
account ID, SAP
SuccessFactors host name,
and other.

This is custom documentation. For more information, please visit SAP Help Portal. 137
 6/11/25, 2:39 PM

Event grouping What events are logged How to identify related log events Additional information

End of delete-inbound- Event that signifies the

"success":true
connection deletion of a service instance
"type":"inboundConnection" of the SAP SuccessFactors
Extensibility service has been
"attributes":[{"name": completed.
<object_name>,"old":"
<connection_details>" The customDetails attribute
contains details such as the
"status":"END" subaccount ID, the global
account ID, SAP
SuccessFactors host name,
and other.

Failure of delete-inbound- Event that signifies the

"success":false
connection deletion of a service instance
"type":"inboundConnection" of the SAP SuccessFactors
Extensibility service could not
"attributes":[{"name": be completed.
<object_name>,"old":"
<connection_details>" The customDetails attribute
contains details such as the
"status":"END" subaccount ID, the global
account ID, SAP
SuccessFactors host name,
and other.

The following information is described in the table columns:

Event grouping - Events that are logged with a similar format or are related to the same entities.

What events are logged - Description of the security or data protection and privacy related event that is logged.

How to identify related log events - Search criteria or key words, that are specific for a log event that is created along with
the logged event.

Additional information - Any related information that can be helpful.

Related Information
Audit Logging in the Cloud Foundry Environment

Configuring Backup
You can back up and restore the destination and the trust configuration settings for the integration between the SAP
SuccessFactors system and the global account in SAP BTP.

You can back up the following configuration settings:

The HTTP destination configured during the creation of the SAP SuccessFactors Extensibility service instance. For more,
see Export Destinations.

Your subaccount X.509 certificates. For more information, see Set up Trust Between Systems

Your SAP SuccessFactors IdP SAML 2.0 metadata.

This is custom documentation. For more information, please visit SAP Help Portal. 138
 6/11/25, 2:39 PM
To download your SAP SuccessFactors IdP SAML 2.0 metadata, in the SAP BTP cockpit, navigate to Connectivity
Destinations Download IdP Metadata .

Your identity provider configurations.

You can back up identity provider configurations with the Identity Provider Management API. For more information see:
Identity Provider Management API.

Accessibility Features in SAP SuccessFactors Extensibility

Service
To optimize your experience of SAP SuccessFactors Extensibility service, SAP Business Technology Platform (SAP BTP) provides
features and settings that help you use the software efficiently.

 Note
SAP SuccessFactors Extensibility service runs on the SAP BTP cockpit. For this reason, accessibility features for SAP BTP
cockpit also apply. See the accessibility documentation for SAP BTP cockpit on SAP Help Portal at Accessibility Features in SAP
BTP cockpit.

For more information on screen reader support and keyboard shortcuts, see Accessibility for End Users.

Troubleshooting for SAP SuccessFactors Extensibility Service

Information about troubleshooting issues you might experience when extending SAP SuccessFactors on SAP BTP using the SAP
SuccessFactors Extensibility service.

Cloud Foundry Environment

These are some issues you might experience when extending SAP SuccessFactors on SAP BTP, Cloud Foundry environment:

My SAP SuccessFactors OData Destination Does Not Work

My SAP SuccessFactors Extensibility Service Instance Failed to Create and It Didn't Say Why

My SAP SuccessFactors OData Destination Does Not Work

SAP SuccessFactors OData destination does not work.

Issue/Symptom
You are extending SAP SuccessFactors on SAP BTP, Cloud Foundry environment using the SAP SuccessFactors Extensibility
service. You are trying to configure the integration between SAP SuccessFactors and SAP Business Technology Platform (SAP
BTP) and your SAP SuccessFactors OData destination does not work.

Solution
To fix your SAP SuccessFactors OData destination, you can try the following:

Make sure that the names of the destination properties, and their values match the names described in Create an HTTP
Destination in SAP BTP.
This is custom documentation. For more information, please visit SAP Help Portal. 139
 6/11/25, 2:39 PM
Make sure that the values of the Client Key and apiKey properties match the API Key value specified in the SAP
SuccessFactors OAuth client.

Make sure that the X509 certificate specified in the SAP SuccessFactors OAuth client is the same as the one you have in
the Cloud Foundry environment. See Configuring the Extension Application's Connectivity to SAP SuccessFactors.

Make sure that you have the uaa.user authorization scope defined in the xs-security.json file. See:

Update a Service Instance

UAA Scopes

Make sure that the uaa.user authorization scope is defined in the role template in the xs-security.json file. See Accessing
Business Service Data.

Make sure you consume the destination correctly, as described in Consumе the Destination.

Make sure that you use the user_token OAuth grant for retrieving the destination. See OAuth User Token Exchange
Authentication.

Make sure that the name of the destination that you use in your application matches the name of the one created in the
SAP BTP cockpit.

Note that if you have a destination defined as an environment variable, it will overrule the one created in the cockpit.

Check the logs in Kibana. If you do not have the application logging service, you can add it. See Access and Analyze
Application Logs and Container Metrics.

Make sure that the name of the destination is the same as the name of the SAP SuccessFactors Extensibility service
instance you have created. See Access and Analyze Application Logs, Container Metrics and Custom Metrics.

My SAP SuccessFactors Extensibility Service Instance Failed to

Create and It Didn't Say Why
My SAP SAP SuccessFactors extensibility service instance failed to create and it didn't say why.

Issue/Symptom

You are trying to create an SAP SuccessFactors Extensibility service instance but the creation fails without an error message.

Solution

This is what you can do:

You can use the Cloud Foundry command line interface to get the error message by executing the command:

cf service <service_instance_name>

Check for any error messages there. See Managing Service Instances .

Can you reach the SAP SuccessFactors company? Check that the tenant is not in maintenance or being updated.

Check that there is not an already existing destination with the same name as the SAP SuccessFactors Extensibility service
instance you are creating. When creating this service instance, a destination with the same name will be automatically
created. See Create an SAP SuccessFactors Extensibility Service Instance in the Cloud Foundry Environment.

Extending SAP Customer Experience Products in the Kyma

Environment
You can configure the integration between SAP BTP and SAP Customer Experience automatically to extend SAP Customer
Experience products with applications running on the cloud platform.
This is custom documentation. For more information, please visit SAP Help Portal. 140
 6/11/25, 2:39 PM

Overview

 Note
The content in this section is not relevant for China (Shanghai) and Government Cloud (US) regions.

SAP BTP offers a standard way for extending SAP solutions.

You can extend SAP Customer Experience products in SAP BTP, Kyma runtime without disrupting the performance and the core
processes. You can build extension applications for SAP Commerce Cloud, SAP Field Management, and SAP Cloud for Customer.
When building extension applications, you can also benefit from the automation of the integration between the cloud platform and
SAP Customer Experience.

Process Flow
To integrate SAP BTP and SAP Customer Experience products so that you can build extension applications, you need to perform
the following tasks:

Integrating SAP BTP and SAP Customer Experience Products

Process Step Related Documentation

1. Add the Application Connector module, and connect Register an SAP Customer Experience System
the SAP Customer Experience system you want to
extend with the corresponding global account in SAP
BTP.

During the registration process you create an

integration token which is then used in the SAP
Customer Experience system for configuring the
integration on the SAP Customer Experience side.

2. Configure the integration on SAP Customer

For an SAP Commerce Cloud system, see steps 2-7 in Retrieving Client
Experience side.
Certificate.
To do so, you pair the integration token with your SAP
For an SAP Field Service Management system, see SAP BTP
Customer Experience system.
Extensions.

For an SAP Cloud for Customer system, see SAP BTP Extensions
Step 2 Configuration in SAP Cloud for Customer Event Notifications
in Configure an Event Notification .

3. Assign the SAP Customer Experience system to a Automating Integrations Using Formations
formation to enable the API access to the
corresponding SAP Customer Experience product's
APIs.

4.Call a registered external service using Central Call a registered external service from Kyma
Application Gateway URL.

Related Information
Getting Started in the Kyma Environment
Development in the Kyma Environment
Administration and Operations in the Kyma Environment

This is custom documentation. For more information, please visit SAP Help Portal. 141