This project is developed for the purpose of an organised partner bootcamp. Participants may clone the repository, install/build & run on your local environment or (recommended) SAP Business Application Studio. It is a use case to illustrate a simple bookshop management solution extended to S/4HANA Cloud with SAP Cloud SDK. To deploy this successful, please make sure you've the prior knowledge of CAP and HAVE attended the bootcamp session.
Please note that even though S/4HANA Cloud is not a mandatory component, please adjust the code accordingly if you'd like to extend this use case further without S/4HANA Cloud. This project is developed with the intention to extend S/4HANA Cloud.
Regardless whether you're using Visual Studio code or (recommended) SAP Business Application Studio, please ensure you have these components installed & setup in your local environment.
Check the following (line-by-line) command if they have already been installed, if not, install them with the respective commands below.
Hint: Click here to check if your framework version is updated.
In most cases on SAP Business Application Studio, it should match and work fine. The tricky cases are coming from your local computers where we could not maintain the specific versions of all frameworks used. Thus, it is your responsibility to make sure you have the matching or latest version. If not, please follow through next step to install the frameworks in your local computer.
Bash Terminal from SAP Business Application Studio
node -v
cf --version
cds v
mbt --version
mta --version
cf pluginsInstall (line-by-line) on the respective libraries if any one of them above is missing.
npm install -g @sap/cds-dk
npm install -g @sap/cds
npm install -g mta
npm install -g mbt
cf install-plugin multiappsAnd please make sure you have both of these SAP BTP services setup successfully in your BTP trial account:
(1) SAP HANA Cloud from SAP BTP Cockpit > Cloud Foundry > Spaces > dev > SAP HANA Cloud (make sure you select the option to "Allow ALL IP Addresses" during creation).
(2) SAP Launchpad Service from SAP BTP Cockpit > Services > Instances & Subscriptions > Create > SAP Launchpad Service.
Step 1: Clone this Git Repo into a bookshop project folder.
git clone https://github.com/jacobahtan/bootcamp-cap-bookshop.git bookshopStep 2: Define a unique app name for your own Bookshop solution.
Open bookshop/mta.yaml, go to line 128, locate appname parameter and replace the following: <REPLACE_THIS_WITH_SUBDOMAIN> with your Unique Subdomain Name.
Results: Parameter
appnameshould be something likebookcatalog-b7194982trial.
Hint: How to locate your unique Subdomain name.
Step 3: Package & Build with MTA then Deploy in your SAP BTP trial account.
Navigate into your bookshop folder, package your app with the MTA Build Tool.
cd bookshop
mbt build -t ./Once completed, deploy the bookshop_1.0.0.mtar file in the bookshop folder, to your SAP BTP Cloud Foundry environment.
Please note that it depends if you follow the correct build command described above, the mtar file should be in
root project folder, else check inside the mta_archives folder.
cf deploy bookshop_1.0.0.mtarOnce you've successfully deployed, in the next part we will focus on running & test if the entire solution stack is running well within the Cloud (SAP BTP Trial Account). (Optionally) You could also test running your app locally in your IDE by creating a default-env.json file in your project root folder, connecting to the cloud with SAP HANA Cloud service key defined & (optional) destination services to S/4 HANA Cloud. More details on this Hybrid approach will be shared below.
Step 4: Run & Test your Solution in SAP BTP Trial Account - Cloud Foundry Environment.
(Full Cloud experience in SAP BTP) Run & Test your solution that is up & running hosted in your SAP BTP Trial Account.
- i) Service App (
bookshop-srv): Navigate from your SAP BTP Account > Cloud Foundry > Spaces > Applications > bookshop-srv
- ii) UI App (
catalog): Navigate from your SAP BTP Account > HTML5 Applications > catalog
- iii) Database (
bookshop-db): Navigate from your SAP BTP Account > Cloud Foundry > Spaces > SAP HANA Cloud > Manage SAP HANA Cloud > Start > Open in SAP HANA Database Explorer > Add HANA DB ( + ) > Choose bookshop-db in the list > Explore Catalog > Table > Open SAP_CAPIRE_BOOKSHOP_BOOKS > Check if data exists in the table.
If the above full cloud experience is working perfectly fine,
Congratulations!You've successfully deployed the solution stack in SAP BTP! You may skip below supplement step.
Supplement Topic: (Optional) How to Run your App Local while connecting to Cloud Services in SAP BTP.
(Hybrid experience with App local & DB cloud) Run it (locally) with cds watch in your bookshop folder.
Navigate into the bookshop folder & install the required npm dependencies declared in the package.json (takes about a few minutes).
cd bookshop
npm install
cds watchTo run it locally and connect with SAP BTP services, you'd need to create a local file default-env.json in your bookshop folder bookshop/default-env.json with the hana, destination & xsuaa service key credentials. You may refer to the default-env file as a template, then copy the service key into each component's credentials.
Repeat this for
hana,destination&xsuaaservice key; copy credentials key into thedefault-envfile.
Supplement Topic: (Not Required) How to Undeploy MTA from my SAP BTP Account.
There are situations where you would required to redeploy a new version of MTA or met with an issue, for example change of database structure that requires to redeploy your SAP HANA Cloud DB, why not just undeploy the entire MTA solution and run end-to-end deployment again.
cf mtas
cf undeploy bookshop --delete-services --delete-service-keys
(Optional) Step 5: Connecting to your S/4 HANA Cloud System, please follow these steps.
In this step, you will require a S/4 HANA Cloud instance for this to work. Thus, if you do not have a S/4 HANA Cloud instance or NOT planning to work on the S/4 HANA component with Customer module within the Bookshop solution, you may skip this optional step entirely. However, do note that by skipping, eventually the customer module will not be working in your Bookshop solution. You should manage that accordingly prior to your newly acquired CAP knowledge.
- Create a destination in your SAP BTP trial account, pointing to your S/4 HANA Cloud system.
Destination Name:
S4HC
Destination URL: https://
<tenant>.s4hana.ondemand.com
Authentication: BasicAuthentication
User: make sure this is a technical user setup to manage BusinessPartner service
Password: xxxxxxxxxx
Please note that the above destination name S4HC will be used in the Custom Logic file Line 3 located in srv/admin-service.js. Prior to that, please make sure you've done your own testing of calling the API with Postman to ensure that your credentials works.
If you face a problem with the example application or the description, feel free to create an issue.
MBT build Error: could not build the MTA project: could not execute the "make -f Makefile_20210721132444.mta p=cf mtar= strict=true mode= t="./"" command: exec: "make": executable file not found in %PATH%
The make tool is required by the mbt tool. Linux and macOS are already shipped with make. For Windows you can download it from the GNU Make site:
Go to http://gnuwin32.sourceforge.net/packages/make.htm. Choose the download with the description Complete package, except sources. Run the installer. Enter Edit the System Environment Variables in the Windows search box (Windows icon in the task bar). The System Properties dialog is opened. Choose Environment Variables…. Choose your Path environment variable under User Variables for <your_user_name> and choose Edit. Choose Browse and navigate to GNU make (usually C:\Program Files (x86)\GnuWin32\bin). Click OK to add GNU make to your Path environment variable. Restart VS Code to make the change effective.
- The problem is that you do not have the GNU Make 4.2.1 (min version) installed in your local environment, which is a dependency of the MTA Build Tool. Please, refer to the Prerequisites section of this link from the Help Portal: https://help.sap.com/viewer/c2b99f19e9264c4d9ae9221b22f6f589/2020_04_QRC/en-US/1412120094534a23b1a894bc498c2767.html
SAP HANA Cloud Issues. DB Deployer Crashed. Execution of task "deploy" on application "bookshop-db-deployer" failed. Connection failed. Socket closed by peer.
- Make sure your SAP HANA Cloud service in your SAP BTP Trial account is up & running.
- Usually the service will be switched off automatically daily.
- In the SAP HANA Cloud advanced settings, make sure the connection is Open to
Allow all IP addresses.
Learn more about the core concepts at SAP Developer Tutorials on CAP Topic.
Copyright (c) 2021 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under SAP Sample Code License Agreement, except as noted otherwise in the LICENSE file.