Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gregorwolf/epmbp-consumer-app

EPM Business Partner - Consumer App
https://github.com/gregorwolf/epmbp-consumer-app

Last synced: 11 days ago
JSON representation

EPM Business Partner - Consumer App

Host: GitHub
URL: https://github.com/gregorwolf/epmbp-consumer-app
Owner: gregorwolf
License: mit
Created: 2020-02-11T06:45:37.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-01-22T08:50:17.000Z (10 months ago)
Last Synced: 2024-10-11T02:35:24.469Z (28 days ago)
Language: TypeScript
Size: 1.77 MB
Stars: 25
Watchers: 4
Forks: 8
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# EPM Business Partner - Consumer App

This example application demonstrates how to use an OData Service available on the [SAP Gateway Demo Server - ES5](https://developers.sap.com/tutorials/gateway-demo-signup.html) with the SAP Cloud SDK for NodeJS and the SAP Cloud Application Programming Model.

You can also run this app against your on premise [ABAP Developer Edition](https://blogs.sap.com/2019/07/01/as-abap-752-sp04-developer-edition-to-download/) using the SAP Cloud Connector to establish the connection. Here you can then configure end-to-end authentication with principal propagation. In that case the service in the ABAP Backend is called not with a technical user, but with the user that was authenticated in the SAP Cloud Platform.

This example wouldn't work without the help of [Dennis Hempfing](https://github.com/mr-flannery) who steped in to help in this questions:

- [First letter of entity attributes converted to lowercase by @sap/cloud-sdk-generator](https://answers.sap.com/questions/12973825/first-letter-of-entity-attributes-converted-to-low.html)
- [Using destination from package.json / default-env.json in implementation](https://answers.sap.com/questions/12973947/using-destination-from-packagejson-default-envjson.html)
- [Unable to build destination for service binding: Unable to find a service binding for given name](https://answers.sap.com/questions/12982450/unable-to-create-sap-connectivity-authentication-h.html)

## Run local

To run against the local mock service [epmbp-mock-service](https://github.com/gregorwolf/epmbp-mock-service) you have to create a file named _default-env.json_ with the following content:

```json
{
"VCAP_SERVICES": {},
"destinations": [
{
"name": "ES5",
"url": "http://localhost:3000/sap/opu/odata/sap/EPM_REF_APPS_PROD_MAN_SRV"
}
]
}
```

If you want to da a local test against the ES5 system / S/4HANA Cloud Sandbox then use this content for the _default-env.json_

```json
{
"VCAP_SERVICES": {},
"destinations": [
{
"name": "ES5",
"url": "https://sapes5.sapdevcenter.com/sap/opu/odata/sap/EPM_REF_APPS_PROD_MAN_SRV",
"username": "",
"password": ""
},
{
"name": "APIBusinessHub",
"url": "https://sandbox.api.sap.com/s4hanacloud",
"headers": {
"APIKey": "Your API Key"
}
}
]
}
```

Then execute:

`npm run setup`

Followed by:

`npm start`

## Deploy to SAP Cloud Platform - Cloud Foundry

### Prerequisite

- You have a [SAP Cloud Platform Trial account](https://hanatrial.ondemand.com/)
- The [Cloud MTA Build Tool (MBT)](https://sap.github.io/cloud-mta-build-tool/) is installed
- The [Cloud Foundry commandline tool](https://docs.cloudfoundry.org/cf-cli/install-go-cli.html) is installed
- The [MultiApps CF CLI Plugin](https://github.com/cloudfoundry-incubator/multiapps-cli-plugin) is installed
- You've connected using `cf login`to your trial account
- Three destinations either to the ES5 or your local ABAP system

Optional

- You've connected a SAP Cloud Connector to your subaccount
- Principal Propagation is setup in the Cloud Connector to the ABAP Backend

### Preperation for a Connection to ES5

Destination ES5 used by the approuter, CAP and SAP Cloud SDK:

```properties
Description=SAP Gateway Demo System
Type=HTTP
Authentication=BasicAuthentication
WebIDEUsage=odata_abap,ui5_execute_abap,dev_abap,bsp_execute_abap
Name=ES5
WebIDEEnabled=true
URL=https\://sapes5.sapdevcenter.com
ProxyType=Internet
User=
WebIDESystem=ES5
```

### Preperation for on premise connection with principal propagation

Destination ES5 used by the approuter, CAP and SAP Cloud SDK:

```properties
URL=http\://\:
Name=ES5
ProxyType=OnPremise
Type=HTTP
sap-client=001
Authentication=PrincipalPropagation
```

### Build

`npm run build:cf`

### Deploy

`npm run deploy:cf`

## Deploy to SAP HANA XSA on Premise

It's possible to deploy this application also to an on Premise instance of SAP HANA.

### Preperation

The connection information to the ES5 system is provided via a user-provided service. Such a services needs a configuration file. The actual content can't be used in the destination. Please create _default-es5destination.json_ in the root folder of the project and fill it with:

```JSON
{
"name": "ES5",
"url": "https://sapes5.sapdevcenter.com"
}
```

The credentials for the backend access should never appear in a Git repository. That is why I suggest to use a MTA extension. Please create the file _xsa.mtaext_ in the root folder with the following content. Replace YourES5user and YourES5password with your own credentials.

```YAML
_schema-version: '3.1'
ID: epmbp-consumer-app.extension
extends: epmbp-consumer-app

resources:
- name: es5destination
properties:
name: ES5
username: YourES5user
password: YourES5password
```

### Build

`npm run build:xsa`

### Deploy

`npm run deploy:xsa:user`

### Test

Start the Application: epmbp-consumer-app-app via the created Application Route from the SAP HANA XS Advanced Cockpit. You should be able to open the Link _/catalog/SEPMRA_I_Product_E - Public Service from ES5_ and see a list of Products returned as JSON.