orkungedik/SAP-basis-dataset huggingface dataset:
## 9. Add Filters
To filter metrics by namespaces, define a MetricPipeline that has the namespaces section defined in one of the inputs. For example, you can specify the namespaces from which metrics are collected or the namespaces from which metrics are dropped. Learn more about the available parameters and attributes .
- The following example collects runtime metrics only from the foo and bar namespaces:
- The following example collects runtime metrics from all namespaces except the foo and bar namespaces:
```
apiVersion: telemetry.kyma-project.io/v1alpha1 kind: MetricPipeline metadata: name: backend spec: input: runtime: enabled: true namespaces: include: - foo - bar output: otlp: endpoint: value: https://backend.example.com:4317
```
```
apiVersion: telemetry.kyma-project.io/v1alpha1 kind: MetricPipeline metadata: name: backend spec: input: runtime: enabled: true namespaces: exclude: - foo - bar output:
```
```
otlp: endpoint: value: https://backend.example.com:4317
```
- The following example collects metrics from all namespaces including system namespaces :
```
apiVersion: telemetry.kyma-project.io/v1alpha1 kind: MetricPipeline metadata: name: backend spec: input: istio: enabled: true namespaces: {} prometheus: enabled: true namespaces: {} runtime: enabled: true namespaces: {} output: otlp: endpoint: value: https://backend.example.com:4317
```
##  Note
The default settings depend on the input:
If no namespace selector is defined for the prometheus or runtime input, then metrics from system namespaces are excluded by default.
However, if the namespace selector is not defined for the istio and otlp input, then metrics from system namespaces are included by default.
## 10. Activate Diagnostic Metrics
If you use the prometheus or istio input, for every metric source typical scrape metrics are produced, such as up , scrape\_duration\_seconds , scrape\_samples\_scraped , scrape\_samples\_post\_metric\_relabeling , and scrape\_series\_added .
By default, they are disabled.
If you want to use them for debugging and diagnostic purposes, you can activate them. To activate diagnostic metrics, define a MetricPipeline that has the diagnosticMetrics section defined.
- The following example collects diagnostic metrics only for input istio :
```
apiVersion: telemetry.kyma-project.io/v1alpha1 kind: MetricPipeline metadata: name: backend spec: input: istio: enabled: true diagnosticMetrics: enabled: true output: otlp: endpoint: value: https://backend.example.com:4317
```
- The following example collects diagnostic metrics only for input prometheus :
```
apiVersion: telemetry.kyma-project.io/v1alpha1 kind: MetricPipeline metadata: name: backend spec: input: prometheus: enabled: true diagnosticMetrics: enabled: true output: otlp: endpoint: value: https://backend.example.com:4317
```
##  Note
Diagnostic metrics are only available for inputs prometheus and istio . Learn more about the available parameters and attributes .
## 4.3.2  Access a Kyma Instance Using kubectl
As an alternative to managing Kyma with a graphical user interface, Kyma dashboard, you can also use the Kubernetes command-line tool, kubectl.
## Prerequisites
You have a Kyma instance created in your subaccount of the SAP BTP cockpit.
## Context
To start using kubectl, follow these steps:
## Procedure
1. Install kubectl oidc-login . Follow the original instruction from the project repository. Use the relevant commands for macOS, Linux, or Windows users.
##  Recommendation
On Windows, we recommend using the release binaries to install the kubectl oidc-login plugin. The installation of the kubectl oidc-login plugin using Chocolatey and Krew could cause issues.
2. In the SAP BTP cockpit, in your subaccount Overview , go to the Kyma Environment section, and click on the KubeconfigURL link to download kubeconfig.yaml .
3. In the terminal, export the kubeconfig file.
- On macOS, run:
```
export KUBECONFIG={KUBECONFIG_FILE_PATH}
```
- On Windows (PowerShell), run:
$ENV:KUBECONFIG="{KUBECONFIG\_FILE\_PATH}"
## Results
Now you can manage your Kyma instance using kubectl.
-  Tip
If you authenticate in the Kyma environment with an Identity Provider using OpenID Connect, the downloaded kubeconfig.yaml can be used indefinitely to re-authenticate.
## Related Information
Configuring a Custom Identity Provider for Kyma [page 3299]
## 4.3.3  Using SAP BTP Services in the Kyma Environment
With the Kyma environment, you can connect SAP BTP services to your cluster and manage them using the SAP BTP Operator module.
## Context
To consume SAP BTP services and use their functionality for building and deploying your own applications, you must create and manage the service instances and bindings. To learn how to do it, see Creating Service Instances and Service Bindings [page 1892] and Deleting Service Bindings and Service Instances [page 1897].
For an example of how to use a service, see Create an SAP S/4HANA Cloud Extensibility Service Instance in the Kyma Environment.
## Related Information
SAP BTP Operator Module [page 1884]
Preconfigured Credentials and Access [page 1887] Working with Multiple Subaccounts [page 1901] Instance-Level Mapping [page 1902]
Namespace-Level Mapping [page 1905] Passing Parameters [page 1907] Rotating Service Bindings [page 1909] Formatting Service Binding Secrets [page 1910]
## 4.3.3.1 Creating and Managing Services Using Kyma dashboard
Create and manage Service Instances and Service Bindings using Kyma dashboard.
## Context
Use Kyma dashboard to create and manage your resources.
## Procedure
1. In the Namespace view, go to Service Management → Service Instances .
2. Create Service Instance using the required service details.
You see the status PROVISIONED .
3. Go to Service Management → Service Bindings and create Service Binding, choosing your instance name from the dropdown list.
You see the status PROVISIONED .
## Results
You can now use a given service in your Kyma cluster.
## 4.3.3.2 Creating and Managing Services Using kubectl
Create and manage Service Instances and Service Bindings using kubectl.
## Context
Use kubectl to create and manage your resources.
## Procedure
## 1. Create a Service Instance:
```
kubectl create -f - <<EOF apiVersion: services.cloud.sap.com/v1 kind: ServiceInstance metadata: name: {INSTANCE_NAME} namespace: {NAMESPACE} spec: serviceOfferingName: {NAME_FROM_SERVICE_MARKETPLACE} servicePlanName: {PLAN_FROM_SERVICE_MARKETPLACE} externalName: {INSTANCE_NAME} EOF
```
## 2. To see the output, run:
kubectl get serviceinstances.services.cloud.sap.com {INSTANCE\_NAME} -o yaml
You can see the status created and the message ServiceInstance provisioned successfully .
3. Create a Service Binding:
```
kubectl create -f - <<EOF apiVersion: services.cloud.sap.com/v1 kind: ServiceBinding metadata: name: {BINDING_NAME} namespace: {NAMESPACE} spec: serviceInstanceName: {INSTANCE_NAME} externalName: {BINDING_NAME} secretName: {BINDING_NAME} parameters: key1: val1 key2: val2 EOF
```
## 4. To see the output, run:
```
kubectl get servicebindings.services.cloud.sap.com {BINDING_NAME} -o yaml
```
You can see the status created and the message ServiceBinding provisioned successfully .
## Results
You can now use a given service in your Kyma cluster. To see credentials, run:
```
kubectl get secret {BINDING_NAME} -o yaml
```
## Next Steps
To clean up your resources, run:
```
kubectl delete servicebindings.services.cloud.sap.com {BINDING_NAME}
```
```
kubectl delete serviceinstances.services.cloud.sap.com {INSTANCE_NAME}
```
## 4.3.7  Choose a Backend for Kyma Eventing
The event service in Kyma runtime supports two backends: NATS and SAP Event Mesh. Learn how to set up your preferred eventing backend.
## Prerequisites
- You have added the Kyma Eventing module. See Adding and Deleting a Kyma Module [page 3157].
- If you want to use NATS, you have added the Kyma NATS module.
- If you want to use SAP Event Mesh, you have configured it for Kyma Eventing. See Configure SAP Event Mesh for Kyma Eventing [page 2030].
## Context
You can send and receive events in Kyma with the built-in eventing infrastructure. By default, Kyma clusters have no eventing backend defined. You must set up an eventing backend, either based on the NATS technology or SAP Event Mesh.
## Procedure
1. Log in to Kyma dashboard. The URL is in the Overview section of your subaccount.
2. Go to the kyma-system namespace.
3. Go to Kyma Eventing , open the eventing resource, and choose Edit .
4. Under Backend Type , select your preferred backend.
5. If you selected EventMesh , go to Event Mesh Secret , and select the namespace and name of your SAP Event Mesh service binding.
##  Remember
If you selected NATS , make sure the Kyma NATS module is enabled.
## 6. Choose Save .
## Results
You have set up your eventing backend for Kyma.
If you want to choose another backend, edit the eventing resource again, select the preferred backend, and save your changes.
You can no longer return to an empty eventing backend.
## Next Steps
Learn more about the Kyma Eventing Module and follow the Eventing Tutorials .
## Related Information
Configure SAP Event Mesh for Kyma Eventing [page 2030] SAP Event Mesh
## 4.3.7.1 Configure SAP Event Mesh for Kyma Eventing
If you want to use SAP Event Mesh as backend for Kyma Eventing, you must first set up the credentials.
## Prerequisites
- The Kyma Eventing module is added to your cluster. See Adding and Deleting a Kyma Module [page 3157].
- The Kyma SAP BTP Operator module is added to your cluster.
- You are using an enterprise account.
## Procedure
1. Log in to Kyma dashboard. The URL is in the Overview section of your subaccount.
2. To generate an SAP Event Mesh Secret, select a namespace and go to Service Management Service Instances .
3. Choose Create , and enter the following information:
- Name - enter the name of your instance.
- Offering Name - type: enterprise-messaging .
- Plan Name - type: default .
4. In Parameters , paste the following sample config.json :
5. Replace &lt;{EVENT\_MESH\_NAME}&gt; and &lt;{EVENT\_MESH\_NAMESPACE}&gt; with the values you want your SAP Event Mesh instance to have.
```
{ "options": { "management": true, "messagingrest": true }, "rules": { "topicRules": { "publishFilter": [ "${namespace}/*" ], "subscribeFilter": [ "${namespace}/*" ] }, "queueRules": { "publishFilter": [ "${namespace}/*" ], "subscribeFilter": [ "${namespace}/*" ] } }, "resources": { "units": "10" }, "version": "1.1.0", "emname": "<{EVENT_MESH_NAME}>", "namespace": "<{EVENT_MESH_NAMESPACE}>" }
```
```
 Note The must follow the SAP Event Specification; for example, it cannot
```
&lt;{EVENT\_MESH\_NAMESPACE}&gt; exceed 64 characters, or begin or end with a dot or hyphen.
6. Go to Service Management Service Bindings and choose Create .
7. Provide the name of your binding, select the name of your instance from the list, and choose Create .
## Results
You have set up SAP Event Mesh for Kyma Eventing.
## Next Steps
Choose SAP Event Mesh as your backend for Kyma Eventing.
## Related Information
Choose a Backend for Kyma Eventing [page 2029]
## 4.3.8  Available Technology
You can deploy your application in SAP BTP, Kyma runtime as a Docker container.
You can use any technology of choice as long as you can package it as a Docker container. The Docker container can be built using Cloud Native Buildpacks (CNB). It is also possible to build lightweight Serverless Functions in Python and JavaScript.
Text is not SVG - cannot display
<!-- image -->
With microservices, you build and maintain the Docker image.
When working with Serverless Functions, you write the code and Kyma takes care of creating and deploying the Docker image.
## 5.1 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/&lt;my-subaccount&gt; 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 [page 2044].
## Integration and Extensibility
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 [page 2075]
- Extending SAP S/4HANA Cloud in the Cloud Foundry and Kyma Environment [page 2110]
- Extending SAP Marketing Cloud in the Cloud Foundry and Kyma Environment [page 2173]
- Extending SAP SuccessFactors in the Cloud Foundry and Kyma Environment [page 2177]
- Extending SAP Customer Experience Products in the Kyma Environment [page 2201]
## 5.4.1.1 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 .
## 5.4.2.1 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 .
## 5.4.3.1 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 .
## 5.4.6  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 [page 2351].
## 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 . Y ou 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 subcontext namespaces.
- e. Choose Add .
## Related Information
Declaring System APIs and Events as Dependencies for Business Scenarios [page 2107]
## 5.4.9  Mergе SAP Systems
Merging the SAP systems allows you to reduce the duplicate systems in the list. You can merge autodiscovered 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 [page 2351].
- You have registered the target SAP system. See Adding, Registering and Deregistering Systems [page 2044].
## 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.
## 5.5.1.1 Formations for Business Scenarios
## 5.5.1.2 Formations for Services in SAP BTP
## 5.5.1.3 Formations for Extensibility
## 5.5.1.3.1 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. Y ou 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 [page 2110]
- Extending SAP Marketing Cloud in the Cloud Foundry and Kyma Environment [page 2173]
- Extending SAP SuccessFactors in the Cloud Foundry and Kyma Environment [page 2177]
- Extending SAP Customer Experience Products in the Kyma Environment [page 2201]
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.
## 5.5.1.3.3 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.
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 [page 2351].
- 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
2. 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 [page 2048].
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 [page 2075].
##  Note
In the formation type Integration with SAP Integration Suite , you can include only SAP systems of type SAP S/4HANA Cloud .
## 5.6.1  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:
- 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.
## 5.6.1.1 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 [page 2069].
## 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.
## 5.6.2.1 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.
- You have registered an SAP S/4HANA Cloud system. See Register an SAP S/4HANA Cloud System in a Global Account in SAP BTP [page 2048].
## 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 [page 2166].
7. Choose Save .
## Related Information
Configure Entitlements and Quotas for Subaccounts [page 2269]
## 5.6.2.2.2 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 [page 2115].
- Have the Kyma environment enabled for the subaccount you are using. See Creating a Kyma Instance [page 3125].
- Configure the roles in the Kyma environment. See Assign Roles in the Kyma Environment [page 3301].
- The SAP BTP Operator module is enabled. See Adding and Deleting a Kyma Module [page 3157]
- Have the entitlements of the SAP S/4HANA Cloud Extensibility service configured. See Configure the Entitlements for the SAP S/4HANA Cloud Extensibility Service [page 2114].
## 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 [page 2121].
For specific examples, see Communication Arrangement YAML File - Examples [page 2133].
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 [page 2019].
## 5.6.2.3.1 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 [page 2261]
## 5.6.2.3.2.2  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 [page 2114].
## 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 [page 2166].
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 [page 2145].
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 [page 2156].
## 5.6.2.3.2.4  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 [page 2141]
- Create an SAP S/4HANA Cloud Extensibility Service Instance in the Kyma Environment [page 2143]
## Context
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 [page 2155]
- Create an SAP Event Mesh Service Instance in the Kyma Environment [page 2156]
## 5.6.2.3.3.1  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 [page 2158].
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:
1. In the Service dropdown list, select Event Mesh .
2. In the Plan dropdown list select the default service plan.
3. In the Runtime Environment dropdown list, select Cloud Foundry .
4. In the Space dropdown list, select your Cloud Foundry space.
5. In the Instance Name field, enter a name for your instance. Choose Next .
6. Specify the JSON file you prepared in Step 1 . Choose Next .
7. Review and verify the instance details, and choose Create .
## Next Steps
Create Queues and Subscribe to Them [page 2164]
## 5.6.2.3.3.2  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 [page 2114].
- 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 [page 2143].
- 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 [page 2114].
## 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} 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 [page 2158].
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 [page 2164]
## 5.6.2.4 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 [page 2121].
## 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 .
## 5.6.2.5 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.
## 5.6.2.7 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
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 [page 2206].
For more information on screen reader support and keyboard shortcuts, see Accessibility for End Users.