Deploy a CAP Business Service to SAP Business Technology Platform

1. If cds watch is still running in VS Code, choose Ctrl + C in the command line to stop the service.

2. To prepare the project, execute in the root level of your project in VS Code:

   Shell/Bash Copy

   cds add hana,mta,xsuaa,approuter --for production

   --for production adds all configuration added by this command in the package.json file into a cds.requires.[production] block.

   hana configures deployment for SAP HANA, so a data source of type hana is added in the cds.requires.[production].db block. See section Node.js configuration in the CAP documentation for more details.

   mta adds the mta.yaml file. This file reflects your project configuration.

   xsuaa creates an xs-security.json and also the needed configuration in the mta.yaml file. An authentication of kind xsuaa is added in the cds.requires.[production].auth block.

   approuter adds the configuration and needed files for a standalone AppRouter so that the authentication flow works after deployment.

   Learn more about those steps in the Deploy to Cloud Foundry guide in the CAP documentation.

3. Update your dependencies, as with the previous command you added some dependencies to your package.json.

   Shell/Bash Copy

   npm update --package-lock-only

4. (Optional) Following this tutorial strictly, you don’t have an own UI yet in your project. To enable the index page with SAP Fiori preview, add the following configuration in the package.json of your my-bookshop project in VS Code:

   JSON Copy

   "cds": {
     "fiori": {
       "preview": true
     },
     "server": {
       "index": true
     },
   }

   server.index:true enables the generated index page also in production mode as you saw it in your local application in the previous tutorial in step 4 when using cds watch. fiori_preview:true enables SAP Fiori preview in the same way. These features are meant to help you during development and should not be used in productive applications.

The Cloud Foundry API endpoint is required so that you can log on to your SAP BTP Cloud Foundry space through Cloud Foundry CLI.

1. Go to the SAP BTP Trial Cockpit and choose Go To Your Trial Account.

   

2. From the Account Explorer overview navigate to your subaccount.

   

3. From your subaccount copy the Cloud Foundry Environment API Endpoint value.

   

4. Go back to VS Code to the command line. Authenticate with your login credentials using the following command:

   Shell/Bash Copy

   cf login

   For this you need the cf command line client, see the prerequisites.

   This will ask you to select Cloud Foundry API, org, and space.

   The API endpoint is taken by default. If you want to change the API endpoint use cf api <CF_API_ENDPOINT> to change the API. Replace <CF_API_ENDPOINT> with the actual value you obtained in the previous step.

   If you don’t know whether you’re logged on to Cloud Foundry or if you’re wondering to which Cloud Foundry org and space are you logged on, you can always use cf target in a terminal to find out.

Make sure that your SAP HANA Cloud instance is running, see Prerequisites, before you go on with this step.

SAP provides an application format that respects the single modules and their technologies and keeps those modules in the same lifecycle: Multitarget Application

The MBT Build tool uses the mta.yaml file that has been created using cds add mta before, to build the deployable archive. The MultiApps CF CLI plugin adds the deploy command and orchestrates the deployment steps.

In the previous step, you identified your API endpoint. If that has a format like ...us10-001..., you need to add the following configuration to your xs-security.json:

JSON Copy

"oauth2-configuration": {
    "redirect-uris": ["https://*.us10-001.hana.ondemand.com/**"]
}

For other API endpoints you’d need to adapt it accordingly.

1. In VS Code, in the root of your project, execute the following command to build the archive.

   Shell/Bash Copy

   mbt build -t gen --mtar mta.tar

   For this you need the MBT Build Tool, see the prerequisites.

   The -t option defines the target folder of the build result as the gen folder of your project. As part of this build implicitly cds build --production is executed. This implicit build uses then all the configuration you’ve added in the step 1.2 when using --for production.

2. Deploy the archive using cf deploy.

   Shell/Bash Copy

   cf deploy gen/mta.tar

   For this you need the MultiApps CF CLI plugin, see the prerequisites.

   During deployment all needed service instances are created and the applications as well as database artifacts are deployed.

   This process takes some minutes. In this one step the archive is uploaded to Cloud Foundry, service instances are created, the applications are staged, and then deployed to their target runtimes.

   If your deployment fails during deploy of my-bookshop-db-deployer, make sure that your IP address is configured for connections to SAP HANA Cloud. Or allow connections to all IP addresses at your own risk. We recommend to revert that setting after you’ve completed the tutorial.

3. In the deploy log, find the application URL of my-bookshop:

   Shell/Bash Copy

   Application "my-bookshop" started and available at "[org]-[space]-my-bookshop.cfapps.[region].hana.ondemand.com"

   This is the URL of the AppRouter, which enforces the authentication flow.

4. Open this URL in the browser and try out the provided links, for example, /odata/v4/catalog/Books. Application data is fetched from SAP HANA. If enabled in step 1.4 you can also try the Fiori preview.

   

What you achieved

You’ve deployed your CAP application as multitarget application including deployment to SAP HANA Cloud, using the standalone AppRouter, and using authentication (XSUAA). Congratulations!