remote-service-deploy-to-kyma.md

Deploy and Run the Incident Management Application in the SAP BTP, Kyma Runtime with SAP S/4HANA Cloud Backend

In this tutorial, you learn how to connect to your SAP S/4HANA Cloud system, how to extend the existing Helm chart with the settings for the SAP S/4HANA Cloud extension service, and how to test the application with your SAP S/4HANA Cloud system.

Prerequisites

• You've set up the connection to an SAP S/4HANA Cloud system. Follow the steps in the Configure Connectivity Between SAP S/4HANA Cloud and SAP Business Technology Platform tutorial that is part of the Consume Remote Services from SAP S/4HANA Cloud in Your Full-Stack CAP Application Following the SAP BTP Developer's Guide and Deploy in SAP BTP, Kyma Runtime tutorial group.
• You have an enterprise global account in SAP BTP. To use services for free, you can sign up for an SAP BTPEA (SAP BTP Enterprise Agreement) or a Pay-As-You-Go for SAP BTP global account and use the free tier services only. See Using Free Service Plans.
• You have a platform user. See User and Member Management.
• You're an administrator of the global account in SAP BTP.
• You have a subaccount in SAP BTP to deploy the services and applications.

This tutorial follows the guidance provided in the SAP BTP Developer's Guide.

Prepare the Incident Management application

First, you create a service instance for the SAP S/4HANA Cloud Extensibility service with plan api-access. The SAP S/4HANA Cloud system provides pre-defined communication scenarios that contain one or multiple APIs. When creating the service instance, the communication scenario needs to be specified along with some configuration. Under the hood, a communication arrangement based on the given scenario is created in the SAP S/4HANA Cloud system.

1. Create a new file bupa.json in the root folder of the project and paste the following code snippet in it:

   {
       "systemName": "<SYSTEM_NAME>",
       "communicationArrangement": {
           "communicationArrangementName": "<COMM_NAME>",
           "scenarioId": "SAP_COM_0008",
           "inboundAuthentication": "BasicAuthentication",
           "outboundAuthentication": "BasicAuthentication",
           "outboundServices": [
               {
                   "name": "Replicate Customers from S/4 System to Client",
                   "isServiceActive": false
               },
               {
                   "name": "Replicate Suppliers from S/4 System to Client",
                   "isServiceActive": false
               },
               {
                   "name": "Replicate Company Addresses from S/4 System to Client",
                   "isServiceActive": false
               },
               {
                   "name": "Replicate Workplace Addresses from S/4 System to Client",
                   "isServiceActive": false
               },
               {
                   "name": "Replicate Personal Addresses from S/4 System to Client",
                   "isServiceActive": false
               },
               {
                   "name": "Business Partner - Replicate from SAP S/4HANA Cloud to Client",
                   "isServiceActive": false
               },
               {
                   "name": "Business Partner Relationship - Replicate from SAP S/4HANA Cloud to Client",
                   "isServiceActive": false
               },
               {
                   "name": "Business Partner - Send Confirmation from SAP S/4HANA Cloud to Client",
                   "isServiceActive": false
               },
               {
                   "name": "BP Relationship - Send Confirmation from SAP S/4HANA Cloud to Client",
                   "isServiceActive": false
               }
           ],
           "communicationSystem": {
               "communicationSystemHostname": "default.com",
               "outboundCommunicationUser": {
                   "username": "DefaultUser",
                   "password": "DefaultPassword"
               }
           }
       }
   }

   • For systemName, enter the name of your registered SAP S/4HANA Cloud system. For example, SAP S/4HANA DEV System.
   • For communicationArrangementName, enter a name for the communication arrangement that is created for the SAP S/4HANA Cloud tenant. For example, INCIDENT_MANAGEMENT_0008.

   For more information, see Communication Arrangement JSON/YAML File - Properties.

2. Navigate to the package.json file in the root folder of the application. Add the [production] profile credentials (destination and path) to the settings for API_BUSINESS_PARTNER:

   "API_BUSINESS_PARTNER": {
       "kind": "odata-v2",
       "model": "srv/external/API_BUSINESS_PARTNER",
       "[production]": {
           "credentials": {
               "destination": "incident-management-s4-hana-cloud",
               "path": "/sap/opu/odata/sap/API_BUSINESS_PARTNER"
           }
       }
   }

3. Open the chart/Chart.yaml file and add the following code snippet to it:

   - name: service-instance
     alias: s4-hana-cloud
     version: ">0.0.0"

4. Open the chart/values.yaml file and add the following code snippet to it:

   s4-hana-cloud:
     serviceOfferingName: s4-hana-cloud
     servicePlanName: api-access
   ....

Build images

• Make sure you're logged in to your Kyma cluster. See Login to your Kyma cluster for detailed steps how to log in.

• Make sure you're logged in to your container registry.

• If you're using any device with a non-x86 processor (for example, MacBook M1/M2), you need to instruct Docker to use x86 images by setting the DOCKER_DEFAULT_PLATFORM environment variable using the command export DOCKER_DEFAULT_PLATFORM=linux/amd64. Check Environment variables for more info.

1. Create the productive CAP build for your application:

   cds build --production

   The CAP build writes to the gen/srv folder.

2. Build a new version of the CAP Node.js image:

   pack build <your-container-registry>/incident-management-srv:<new-image-version> \
       --path gen/srv \
       --builder paketobuildpacks/builder-jammy-base \
       --publish

   • Make sure to replace <your-container-registry> with your docker server URL.

   • Keep in mind that <new-image-version> is a string that’s different from the string defined in Deploy in SAP BTP, Kyma Runtime to reflect the changes in the Incident Management app.

   Looking for your docker server URL?

   The docker server URL is the same as the path used for docker login, so you can quickly check it by running the following command in your terminal:

   cat ~/.docker/config.json

   In case you're using Docker Hub as your container registry, replace the placeholder <your-container-registry> with your Docker Hub user ID.

   The pack CLI builds the image that contains the build result in the gen/srv folder and the required npm packages by using the Cloud Native Buildpack for Node.JS provided by Paketo.

3. In the VS Code terminal, navigate to the ui-resources folder and run the following command:

   npm install && npm run package

   This command builds and copies the archive nsincidents.zip inside the ui-resources/resources folder.

4. In the VS Code terminal, navigate back to the root folder of your project:

   cd ..

5. Build the UI deployer image:

   pack build <your-container-registry>/incident-management-html5-deployer:<image-version> \
       --path ui-resources \
       --builder paketobuildpacks/builder-jammy-base \
       --publish

   • Make sure to replace <your-container-registry> with your docker server URL.

   • Keep in mind that <new-image-version> is a string that’s different from the string defined in Deploy in SAP BTP, Kyma Runtime to reflect the changes in the Incident Management app.

   Looking for your docker server URL?

   The docker server URL is the same as the path used for docker login, so you can quickly check it by running the following command in your terminal:

   cat ~/.docker/config.json

   In case you're using Docker Hub as your container registry, replace the placeholder <your-container-registry> with your Docker Hub user ID.

Since the database image is unchanged, you don't need to build it again.

Deploy the Incident Management application

1. Check your container image settings to your chart/values.yaml file:

   global:
     domain: 
     imagePullSecret:
       name: 
     image:
       registry: <your-container-registry>
       tag: <image-version>

   Make sure to replace <your-container-registry> with the link to your container registry and keep in mind that <image version> is a string.

2. Overwrite the global image version for the CAP Node.js image and for the UI deployer image:

   srv:
     image:
       repository: incident-management-srv
       tag: <new-image-version>
   ...
   html5-apps-deployer:
     ...
     image:
       repository: "incident-management-html5-deployer"
       tag: <new-image-version>

3. Update the productive CAP build for your application:

   cds build --production

4. Make sure that your SAP HANA Cloud instance is running. Free tier HANA instances are stopped overnight.

   Your SAP HANA Cloud service instance is automatically stopped overnight, according to the time zone of the region where the server is located. That means you need to restart your instance every day before you start working with it.

   You can either use the SAP BTP cockpit or the terminal in the SAP Business Application Studio to restart the stopped instance:

   cf update-service incident-management -c '{"data":{"serviceStopped":false}}'

5. Deploy using the Helm command:

   helm upgrade --install incident-management --namespace incident-management ./gen/chart \
   --set-file xsuaa.jsonParameters=xs-security.json --set-file s4-hana-cloud.jsonParameters=bupa.json

   This command installs the Helm chart with the release name incident-management in the namespace incident-management.

Test the Incident Management application

When creating new entries in the Incident Management application, you see all values from your SAP S/4HANA Cloud system in the value help of the Customer field.

Before you continue with this step, don’t forget to perform the steps from the tutorials Assign the User Roles and Integrate Your Application with SAP Build Work Zone, Standard Edition.

1. Open your SAP Build Work Zone, standard edition site as described in Integrate Your Application with SAP Build Work Zone, Standard Edition.

2. Choose the Incident Management tile.

   

3. Choose Create to start creating a new incident.

   

4. Open the value help for the Customer field.

   

5. Verify that customer data is fetched from the SAP S/4HANA Cloud system.

   

Congratulations! You have successfully developed, configured, and deployed the Incident Management application using an external service and an SAP S/4HANA Cloud system.