Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sap-samples/cloud-espm-multi-environment
This sample application demonstrates how to build applications on SAP Business Technology Platform (BTP) with the Java runtime. This version showcases how to adapt an ESPM application developed to run on SAP BTP Neo Environment to run on SAP BTP, Cloud Foundry environment.
https://github.com/sap-samples/cloud-espm-multi-environment
cloud-foundry espm neo-environment sample sample-code sap-btp sap-btp-cloud-foundry sap-cloud-platform
Last synced: about 1 month ago
JSON representation
This sample application demonstrates how to build applications on SAP Business Technology Platform (BTP) with the Java runtime. This version showcases how to adapt an ESPM application developed to run on SAP BTP Neo Environment to run on SAP BTP, Cloud Foundry environment.
- Host: GitHub
- URL: https://github.com/sap-samples/cloud-espm-multi-environment
- Owner: SAP-samples
- License: apache-2.0
- Created: 2018-11-08T19:11:09.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2022-10-05T06:35:40.000Z (about 2 years ago)
- Last Synced: 2023-08-04T22:51:22.726Z (over 1 year ago)
- Topics: cloud-foundry, espm, neo-environment, sample, sample-code, sap-btp, sap-btp-cloud-foundry, sap-cloud-platform
- Language: Java
- Homepage:
- Size: 2.32 MB
- Stars: 1
- Watchers: 7
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://api.reuse.software/info/github.com/SAP-samples/cloud-espm-multi-environment)
# ESPM
The ESPM (Enterprise Sales & Procurement Model) application is a reference application which demonstrates how to build applications on SAP Business Technology Platform (BTP) with the Java runtime. This version of the ESPM application(cloud-espm-multi-environment) showcases how to adapt a ESPM application developed to run on SAP BTP Neo Environment to run on SAP BTP Cloud Foundry (CF) Environment as well. The adapted application has one code-base for running on both Neo and CF environment.
# Description
## Business Scenario
The business scenario is that of an eCommerce application that sells electronics products.
- The Customers can order products and provide reviews on the products.
- The Retailer can then accept the sales orders created against orders created by customers. The Retailer can also update the product stock information.
ESPM application has 2 underlying applications
- Webshop - this application is a web shopping app, which doesn't have any authentication
- Retailer - this application is used by a retailer to manage stocks, approve/reject sales orders. A user needs to be authenticated and should have a retailer role to perform these operations.
# Requirements
- [Java8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) (version 1.8.0_131 or higher)
- [Maven](https://maven.apache.org/download.cgi) (version 3.3.9 or higher)
- [Cloud Foundry CLI](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/4ef907afb1254e8286882a2bdef0edf4.html) (version 6.23.1 or higher)
- If you do not yet have a SAP Businsess Technology Platform trial or enterprise account, signup for a SAP Business Technology Platform trial account by following the [documentation](https://developers.sap.com/tutorials/hcp-create-trial-account.html).
For Setting up the development environment, refer to the [quick start guide](https://github.com/SAP/cloud-espm-v2#1-quick-start-guide)
# Download and Installation
## Build the application
A maven build of the application generates a separate `war` file for the `Neo` and `CF` environment.
_Note: Follow the below steps before the maven build to download the ngdbc driver to your local ~.m2 repository, as its not available in central maven repository_
1. Download the SAP Business Technology Platform SDK from https://tools.hana.ondemand.com/#cloud
2. Take the latest version of "Java Web Tomcat 8" (neo-java-web-sdk-3.70.9.3 or higher) from the download section.
3. Unzip the archive to an arbitrary location on your laptop/desktop.
4. Extract the JDBC driver (ngdbc.jar) from the archive (you will find the driver in the archive under: repository/.archive/lib/ngdbc.jar). The driver is closed source, so it is NOT available from public Maven repositories!
5. Put the driver to your local maven repository with maven command
```
mvn install:install-file -Dfile= -DgroupId=com.sap.db.jdbc
-DartifactId=ngdbc -Dversion=2.0.13 -Dpackaging=jar
```
6. From the root directory (i.e. cloud-espm-multi-environment), run the following Maven command
```
mvn clean install
```
This command builds the application and generates `war` for the `Neo` and `CF` environment.
## Running the application in NEO environment
### 1. Deploy application
The `war` file for the NEO environment can be found at `neo/espm-cloud-web-neo/target/espm-cloud-web-neo.war` .
Open the hanatrial account cockpit and upload the war file as follows.
- Go to SAP BTP Cockpit --> Click on Java Application under Applications --> Click on Deploy Application
- Add War File Location, Give Application Name "espm", select Runtime Name "Java Web Tomcat 8" and JVM Version as "JRE 8"
- After Successful deployment, Click on Start
### 2. Configure Roles
- Configure the application role assignments from the [cockpit](https://help.hana.ondemand.com/help/frameset.htm?db8175b9d976101484e6fa303b108acd.html). You basically need to add the "Retailer" role to your SAP Business Technology Platform user to access the Retailer UI
You can access the application from the URL
* The eCommerce site can be accessed via the URL: https://espm\.hanatrial.ondemand.com/espm-cloud-web/webshop
* The Retailer UI can be accessed via the URL: https://espm\.hanatrial.ondemand.com/espm-cloud-web/retailer
**Note! The application name must be "espm", else the above URL will change based on the application name given during deployment**
### 3. Bind the database to espm application and start espm application
Below is the process to bind the database to the java application in BTP trial account using a Shared HANA database
- In the cockpit, select an account and choose Persistence -> Databases & Schemas -> in the navigation area.
- Click on the new button
- In the popup window, enter the below information
```sh
Schema ID: espm
Database System: HANA ()
Version: 1.00*
Click on Save button
```
- In the cockpit, select an account and choose Applications -> Java Application -> Click on the name of the espm application that you deployed
- In the navigation area in the cockpit, select Configuration -> Data Source Bindings
- Click "New Binding" button in detail plane
- In the popup window, enter the below information
```sh
Data Source -
DB/Schema ID - select espm (the one that you created above)
Click on Save button
```
- Now you need to restart espm application (stop, if already running and start the application) from the cockpit.
## Running the application in CF environment
From root folder, navigate to `cf` folder.
#### 1. Login to Cloud Foundry
```
cf api
cf login -o -s
```
#### 2. Create Service
Depending on the requirement, create a service instance for either of the database (HANA or PostgreSQL).
```
cf create-service hana schema espm-hana (HANA)
or
cf create-service postgresql v9.4-dev espm-postgres (PostgreSQL)
```
Create service instance for the XSUAA
```
cf cs xsuaa application espm-uaa -c xs-security.json
```
#### 3. Edit Manifest
Open the manifest.yml file and edit the following
Replace placeholders with your ```I/D/C numbers``` so that the application name and host name is unique in the CF landscape.
```DATABASE_TYPE: ```
Replace the `````` with the Database name for which you have created the service instance
For HANA – ```hana```
For PostgreSQL – ```postgresql```
``````
Replace the `` with the service instance that you have created for the database.
#### 4. Push the application
```cf push -f manifest.yml```
#### 5. Setup Role collections
For the application to work, the Retailer application needs the template role called "Retailer" assigned to the user.
- In your trial account, in the left pane select Role collections under the Security tab.
- Add a new Role collection named, "Retailer"
- Click on the newly created "Retailer "role collection and add new Role.
- Select the application identifier name similar to the one you have given in the xs-security.json file.
- Select the role template and assign the Role you have created in the previous step.
#### 6. Assign Role to the user
We need to assign the role which we have created in the previous step to the user.
- In your trial account, in the left pane select "Trust Configuration" under the Security tab.
- Click on the default IDP service.
- Enter username/email and click on the add Assignment button.
- Select the Role as "Retailer" to assign it to the user.
# Out of Scope
Document services is out of scope currently in Cloud Foundry application
# Known issues
None
# Support
Please use GitHub [issues](https://github.com/SAP/cloud-espm-multi-environment/issues/new) for any bugs to be reported.
# License
Copyright (c) 2018 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSES/Apache-2.0.txt) file.