Skip to Content

Extend SAP S/4HANA Cloud on SAP BTP, Cloud Foundry Environment

Requires Customer/Partner License
Extend SAP S/4HANA Cloud with an extension application running on SAP BTP, Cloud Foundry environment using automated integration configuration.
You will learn
  • How to extend the functionality of your SAP S/4HANA Cloud system to manage business partners
PetevaAneta PetevaAugust 30, 2022
Created by
ekaterina-mitova
August 31, 2021
Contributors
ekaterina-mitova
thecodester

Prerequisites

  • Tools:
  • On SAP BTP side:
    • You have a global account in SAP BTP.
    • You have an S-user or P-user. See User and Member Management.
    • You are an administrator of the global account where you want to register your SAP S/4HANA Cloud system.
    • You have enabled the Cloud Foundry capabilities for your subaccount in SAP BTP.
  • On SAP S/4HANA Cloud side:
    • You have a dedicated SAP S/4HANA Cloud tenant with an Identity Authentication tenant configured. You need to use the same Identity Authentication tenant for your subaccount in SAP BTP.
    • To configure the integration on the SAP S/4HANA Cloud system side, you need a business user with the roles:
      • SAP_BR_ADMINISTRATOR that contains the Business Catalog SAP_CORE_BC_COM necessary to access and administer the SAP S/4HANA Cloud tenant.
      • SAP_BR_BPC_EXPERT to be able to maintain the event topics in the SAP S/4HANA Cloud tenant.
        You can check whether your user has the required roles via the Maintain Business Users application in your SAP S/4HANA Cloud tenant. See Maintain Business Roles.

You can extend the functionality of your SAP S/4HANA Cloud system with an extension application deployed in a subaccount in SAP Business Technology Platform (SAP BTP) and at the same time fully integrated in your SAP S/4HANA Cloud system.

In this tutorial, you use the business partner sample application for SAP S/4HANA Cloud is to learn some best practices when building SAP S/4HANA Cloud extension applications on SAP BTP. We recommend to use this sample application only as a proof of concept and a starting point for implementing extensions.

Using this application, you can:

  • View a list of all your business partners
  • Add new business partners

The following diagram shows the technical components that take part in this scenario.

Architecture Diagram

  • Step 1

    To do that, you must register your SAP S/4HANA Cloud system in your global account in SAP BTP. During this process, an integration token is created and then used by the SAP S/4HANA Cloud system tenant administrator to configure the integration on the SAP S/4HANA Cloud system side.

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

    2. In the Systems tab, choose Add System.

      In the <strong>Systems</strong> panel, choose <strong>Add System</strong>.
    3. In the Add System dialog box:

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

        Use only printable ASCII characters.

        Enter a name for the system you want to register.
      • In the Type dropdown list, select the system type.

        In the <strong>Type</strong> dropdown list, select the system type.
      • Choose Add.

        SAP BTP generates an integration token that the tenant administrator of the extended SAP S/4HANA Cloud system uses when configuring the integration between your SAP S/4HANA Cloud system and the cloud platform on the respective SAP S/4HANA Cloud system side.

    4. To get a token to register this system with global account, choose Get Token. You need it for configuring the integration on the extended SAP S/4HANA Cloud system side.

    5. Copy the registration token and close the dialog box.

      The SAP S/4HANA Cloud system appears in the list of added systems. Its status is Pending because the registration process is not yet completed.

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

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

    3. In the Integration Token field, enter the content of the integration token you have copied in the SAP BTP cockpit.

      In the <strong>Integration Token</strong> input field, paste the integration token.
    4. Choose Save.

      A new entry with status Enabling appears in the table.

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

      The status of the integration should have changed to Enabled.

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

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

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

      Check if the status of the SAP System has changed to <strong>Registered</strong>.
  • Step 3

    You need to configure the entitlements for the subaccount where the business partner sample application for SAP S/4HANA Cloud will be deployed and assign the api-access service plan for the SAP S/4HANA Cloud Extensibility service instance to the system you registered in the previous step.

    1. In the SAP BTP cockpit, navigate to your global account.

    2. In the navigation area, choose Entitlements > Entity Assignments.

    3. Select your subaccount from the Select Entities: drop down menu, and then choose Go.

      Select your subaccount from the <strong>Select Entities:</strong> drop down menu, and then choose <strong>Go</strong>.
    4. Choose Configure Entitlements.

      Choose <strong>Configure Entitlements</strong>.
    5. Choose Add Service Plans, and then select the SAP S/4HANA Cloud Extensibility service.

      Choose <strong>Add Service Plans</strong>, and then select the <strong>SAP SuccessFactors Extensibility</strong> service.
    6. In the Available Service Plans area, select the system you have registered and the api-access service plan, and then choose Add Service Plan.

      Select the system you have registered and the <strong>api-access</strong> service plan, and then choose <strong>Add Service Plan</strong>.
    7. Save the changes.

  • Step 4
    1. Make sure you are logged on to SAP BTP cockpit as a Cloud Foundry administrator.

    2. In your trial global account, choose Entitlements > Entity Assignments.

    3. If there is no entry for the Cloud Foundry runtime, choose Configure Entitlements, and then Add Service Plans.

    4. In the popup, proceed as follows:

      • Choose Cloud Foundry Runtime.

      • Under Available Service Plans, select the MEMORY checkbox.

      • Choose Add 1 Service Plan.

      Choose <strong>Cloud Foundry Runtime</strong>, select the <strong>MEMORY</strong> service plan and then choose <strong>Add 1 Service Plan</strong>.
    5. On the Entity Assignments screen, choose + on the SAP S/4HANA Cloud Extensibility service row to add at least 1 quota to the subaccount, and then choose Save.

  • Step 5
    1. Clone the GitHub repository:

      Git
      Copy
      git clone https://github.com/SAP/business-partner-sample-app-s4hana-cloud
      
    2. In the root of the project, locate the s4-hana-cloud.json file, and replace the values of the following parameters:

      • systemName

      Enter the name of the system you registered in step 1.

      • communicationArrangementName

      Enter a name for the communication arrangement. The name you specify here will be the same name of the communication arrangement that is going to be automatically created in your SAP S/4HANA Cloud tenant.

    3. In the root of the project locate the vars.yml file and replace the values of the following parameters:

      • ID.

      Enter your user in SAP BTP. It is either an S-user, a P-user, or a trial user.

      • REGION_HOST.

      Enter eu10.hana.ondemand.com for the trial global account in SAP BTP. To check the <region_host>, go to the SAP BTP cockpit, navigate to the subaccount, go to Overview and copy the API endpoint from the Cloud Foundry section, and remove the https://api.cf.

    4. Open a console and navigate to the root folder of the project that is created on you local file system after cloning the GitHub repository.

      Shell
      Copy
      cd <root folder of the project>
      
    5. Build the application. To do so, use the following command:

      Shell
      Copy
      mvn clean install
      
  • Step 6

    To connect the business partner sample application for SAP S/4HANA Cloud to your SAP S/4HANA Cloud tenant, you use a destination. For that, you first need to create a Destination service instance using the lite service plan.

  • Step 7

    To consume the SAP S/4HANA Cloud APIs, you create an SAP S/4HANA Cloud Extensibility service instance using the api-access service plan.

    During the service instance creation, an HTTP destination on a subaccount level is automatically generated in this subaccount. You use this destination to establish connection to your SAP S/4HANA Cloud system. When creating the service instance, you configure the communication arrangement and the authentication type for the connection in a JSON file.

  • Step 8

    To configure the business partner sample application for SAP S/4HANA Cloud authentication, you create an Authorization and Trust management service instance with application service plan.

  • Step 9

    You use Cloud Foundry Command Line Interface (cf CLI) to deploy and run the business partner sample application for SAP S/4HANA Cloud.

    1. Log on to the cf CLI, using the following command:

      cf CLI
      Copy
      cf login -a <api_endpoint>
      

      For the <api_endpoint>, go to the SAP BTP cockpit, navigate to the subaccount, go to the Overview page and copy the API endpoint from the Cloud Foundry section. For example https://api.cf.eu10.hana.ondemand.com is the <api_endpoint> of the trial global account in SAP BTP.

    2. Navigate to your Org by typing in the console the number that corresponds to your Org in the list with Orgs that is displayed after you log on to cf CLI.

    3. If you have more than one space, navigate to your space, by typing in the console the number that corresponds to your space in the list with spaces.

      If you have only one space, you will be redirected to it right after you specify your Org.

    4. In the cf CLI, push the vars.yml file using the following command:

      cf CLI
      Copy
      cf push --vars-file vars.yml
      
  • Step 10
    1. In the SAP BTP cockpit, navigate to > Applications, and then choose the approuter-business-partners link to go to the Overview page for the application.

    2. On the approuter-business-partners - Overview page, choose the URL in the Application Routes screen area to open the application in your browser.

    3. The Business Partner Center page opens in your browser and a list of business partners is displayed.

    Copy the URL in the Application Routes screen area and paste it here. Make sure to skip the "https://" prefix.

Back to top