SAP-samples/cap-sflight

Welcome to the CAP SFLIGHT App

This is a sample app for the travel reference scenario, built with the SAP Cloud Application Programming Model (CAP) and SAP Fiori Elements.

The purpose of this sample app is to:

• Demonstrate SAP Fiori annotations
• Demonstrate and compare SAP Fiori features on various stacks (CAP Node.js, CAP Java SDK, ABAP)
• Run UI test suites on various stacks

The app still contains some workarounds that are going to be addressed over time. In some cases, the model and the handlers can be improved or simplified once further planned CAP features become available. In other cases, the app itself could be improved. For example, calculation of the total price for a travel currently simply sums up the single prices ignoring the currencies.

For enabling all features of the Analytical List Page (ALP) in the Node.js runtime, we have switched on the new OData parser (odata_new_parser: true in package.json), which is still in an experimental state. Early adopters may use this feature in own projects on their own risk. You can also use the ALP with the standard OData parser, but then some features like grouping in the table are not available.

Run locally

Build and Run - Node.js Backend

Prerequisite:

npm i -g @sap/cds-dk

In the root folder of your project, run

npm ci
cds watch

Accessing the SAP Fiori Apps

Open these links in your browser:

• http://localhost:4004/sap.fe.cap.travel/index.html for processing the travel data
• http://localhost:4004/sap.fe.cap.travel_analytics/index.html for the Analytical List Page (ALP)

Build and Run - Java Backend

In the root folder of your project, run

npm ci
npm run build:ui
mvn spring-boot:run

At the moment, there is no watch mode for Fiori UI changes. Run npm run build:ui after each change there.

Accessing the SAP Fiori Apps

Open these links in your browser:

• http://localhost:4004/travel_processor/dist/index.html for processing the travel data
• http://localhost:4004/travel_analytics/dist/index.html for the Analytical List Page (ALP)

Log in with user amy and empty password.

Integration Tests

To start OPA tests, open this link in your browser: http://localhost:4004/travel_processor/webapp/test/integration/Opa.qunit.html

Test documentation is available at: https://ui5.sap.com/#/api/sap.fe.test

Deployment to SAP Business Technology Platform

The project contains a configuration for deploying the CAP services and the SAP Fiori app to the SAP Business Technology Platform (SAP BTP) using a managed application router. The app then becomes visible in the content manager of the SAP Build Work Zone.

The configuration file mta.yaml is for the Node.js backend of the app. If you want to deploy the Java backend, copy mta-java.yaml to mta.yaml.

Prerequisites

SAP Business Technology Platform

• Create a trial account on SAP BTP. See this tutorial for more information. Alternatively, you can use a sub-account in a productive environment.
• Get a SAP Cloud Identity Services tenant and establish trust
• Subscribe to the SAP Build Work Zone.
• Create an SAP HANA Cloud Service instance or use an existing one. Then, provision an instance - make sure to choose the Cloud Foundry Runtime environment.

Local Machine

• Install the Cloud Foundry command line interface (CLI). See this tutorial for more details.

• Install the MultiApps CF CLI Plugin:

  cf add-plugin-repo CF-Community https://plugins.cloudfoundry.org
  cf install-plugin multiapps

• Install the Cloud MTA Build Tool globally:

  npm install -g mbt

Build the Project

Build the project from the command line:

mbt build

The build results will be stored in the directory mta_archives.

Deploy

1. Log in to the target space.
2. Deploy the MTA archive using the CF CLI: cf deploy mta_archives/capire.sflight_1.0.0.mtar

Assign Role Collection

Any authorized user has read access to the app. For further authorization, assign a role collection to your user in the SAP BTP Cockpit:

• sflight-reviewer-{spacename} for executing actions Accept Travel, Reject Travel, and Deduct Discount
• sflight-processor-{spacename} for full write access

Integrate SFlight with SAP Build Work Zone, Standard Edition

CAP SFlight uses the managed AppRouter, which in case of a trial account, is provided by the Navigation Service in SAP Build Work Zone, Standard Edition. Please consult this tutorial to make sure that your Build Work Zone is configured correctly to serve the CAP SFlight Frontend.

Local Development with a HANA Cloud Instance

You need to have access to a HANA Cloud instance and SAP BTP.

1. Deploy the HDI content to a HANA HDI container (which is newly created on first call): cds deploy --to hana.
2. Start the application with the Spring Profile cloud.
   1. From Maven: mvn spring-boot:run -Dspring-boot.run.profiles=cloud
   2. From your IDE with the JVM argument -Dspring.profiles.active=cloud or env variable spring.profiles.active=cloud

The running application is now connected to its own HDI container/schema. Please keep in mind that the credentials for that HDI container are stored locally on your filesystem (default-env.json).

Deployment to SAP Business Technology Platform - Kyma Runtime

The deployment to Kyma Runtime is explained in file README-Kyma.md.

Creating an SAP Fiori App from Scratch

If you want to implement an SAP Fiori app, follow these tutorials:

• Create a List Report Object Page App with SAP Fiori Tools
• Developing SAP Fiori applications with SAP Fiori Tools

Get Support

In case you've a question, find a bug, or otherwise need support, use the SAP Community to get more visibility.

License

Copyright (c) 2021 SAP SE or an SAP affiliate company and cap-sflight contributors. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.