Run the Metering Scenario End-to-End Locally

This chapter explains the steps to run all services involved in the metering scenario locally. This can be done on Windows, Mac or Linux.

You can use these services locally:

Database service
Easy Franchise service
Business Partner service
Day2 service
Easy Franchise UI
Day2 UI

Prepare Application Properties for Local Test Run of Day2 Service

Using Spring Boot you can configure properties using application.properties files. There is one under day2-service/src/main/resources/application.properties. For local testing you can overwrite the properties providing a application.properties file in the spring-boot run command.

Copy code/day2-operations/source/day2-service/application-template.properties as application.properties
Update the values for those properties:
- datasource.sqlendpoint: SAP HANA sql endpoint
- spring.datasource.username: DBADMIN
- spring.datasource.password: <YOURPASSWORD for DBADMIN>

Note: If you have used the btp-setup-automator you can find the password for the database either in the usecasefile. Search for the systempassword in the hana-cloud entry. Alternatively you can have a look at the db-config secret which is located in the integration namespace of your kyma cluster.

Note: if you use a new database user, you have to redo the onboarding tenant steps from the the related mission Develop a Multitenant Extension Application in SAP BTP, Kyma Runtime.

Build and Test Run the Day2 Service Locally

Open a command prompt and change directory to code/day2-operations/source/day2-service/.
To run the application you have the choice between using spring-boot-plugin or an executive JAR file.

Use the following command if you go for the spring-boot plugin:

./mvnw spring-boot:run -Dspring.config.location="application.properties"

In case of debugging use:

./mvnw spring-boot:run -Dspring-boot.run.jvmArguments="-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8888" -Dspring.config.location="application.properties"

Use the following command if you go for the executive JAR file:

./mvnw clean package
java -jar target/day2-service-0.0.1-SNAPSHOT.jar -Dspring.config.location="application.properties"

Check in the browser that the server is up and running by opening http://localhost:8091/. You should get something like this:

Hint: in case you would like to use an application.properties file in another file location you can also specify the full path as follow:
-Dspring.config.location="file:///Users/home/config/application.properties"

Call the APIs of the Locally Running Day2 Service

Let us see if everything is working fine by simulating the user login with the following CURL statement. As a result, this should insert a new record in the database table USERLOGININFO.

curl --request PUT 'http://localhost:8091/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tenantid": "tenant1",
    "user": "Jon Smith"    
}'

Let us now verify that the login has been saved by calling the API to get the metrics about active users. Use the following CURL statement and don't forget to replace the date (<CURRENT-YEAR>and <CURRENT-MONTH-NUMBER>) before running it.
```
curl --request GET 'http://localhost:8091/user/metric?year=<CURRENT-YEAR>&month=<CURRENT-MONTH-NUMBER>' 
```
You should then get a JSON response as follow:
```
[{ "tenantid": ""tenant1", "activeUsers": 1 }]
```
If you like, add other users and/or other tenants and verify the results.

Start the Database Service, the Easy Franchise Service, and the Business Partner Service

Prerequisites

You have prepared the SAP HANA Cloud properties (name, endpoints, ...) for a JDBC connection.
You have a SAP S/4HANA Cloud system or a Business Partner mock server up and running.

Configure the hiddenconfig.properties File

To run locally the services listed above, you have to configure some properties in the hiddenconfig.properties file:

Open the prepared sources from the previous steps. As alternative you can download it from the endresult branch.
Copy the file code/easyfranchise/source/backend/shared-code/src/main/resources/hiddenconfig-template.properties to hiddenconfig.properties in the same folder.
Maintain your SAP HANA Cloud JDBC connection properties in the db.* section. This should look like this:
```
db.name: EasyFranchiseHANADB
db.sqlendpoint: your_hostname.hanacloud.ondemand.com:443
db.admin: DBADMIN
db.password: your_dbadmin_password
```
For more details, see How to find JDBC Connection Properties.

Update the s4hana.destination.* properties.

If you use the SAP Business Partner mock server to run the application locally, use:

s4hana.destination.URL: http://localhost:8081
s4hana.destination.User:
s4hana.destination.Password:
s4hana.destination.Authentication: NoAuthentication
s4hana.destination.Type: http

If you use your SAP S/4HANA Cloud system, copy the following snippet. Be sure to update with your own values:

s4hana.destination.URL: https://xxxxxxxx-api.s4hana.ondemand.com
s4hana.destination.User: <your Communicatrion Arragement User>
s4hana.destination.Password: <Password of the Communication User>
s4hana.destination.Authentication: BasicAuthentication
s4hana.destination.Type: http

Build the Project

Open a command prompt and change the directory to code/easyfranchise/source/backend containing the main '''pom.xml'''. Run the following Maven command: mvn clean install

Info: When running this command the first time, many JAR files will be downloaded to your local Maven repository.

The second run will be faster as all these downloads will no longer be necessary.

You should see a successful build of all four modules and an allover BUILD SUCCESS:

   [INFO] Reactor Summary for easyfranchise 1.0-SNAPSHOT:
   [INFO]
   [INFO] easyfranchise ...................................... SUCCESS [  0.784 s]
   [INFO] shared-code ........................................ SUCCESS [ 18.696 s]
   [INFO] db-service ......................................... SUCCESS [  9.189 s]
   [INFO] bp-service ......................................... SUCCESS [  4.606 s]
   [INFO] ef-service ......................................... SUCCESS [  6.742 s]
   [INFO] ------------------------------------------------------------------------
   [INFO] BUILD SUCCESS
   [INFO] ------------------------------------------------------------------------

In each project folder, a new folder target is created containing the build result.

Start All Backend Services

Run the following commands to start the services. Start each in a separate command prompt and in the correct folder.

In folder code/easyfranchise/source/backend/ef-service:

	command (`> cd ef-service`)
windows	`java -cp ".\target\;.\target\dependency\" -Dlocal_dev=true dev.kyma.samples.easyfranchise.EFServer 8080`
unix	`java -cp "./target/:./target/dependency/" -Dlocal_dev=true dev.kyma.samples.easyfranchise.EFServer 8080`

In folder code/easyfranchise/source/backend/bp-service:

	command (`> cd bp-service`)
windows	`java -cp ".\target\;.\target\dependency\" -Dlocal_dev=true dev.kyma.samples.easyfranchise.ServerApp 8100`
unix	`java -cp "./target/:./target/dependency/" -Dlocal_dev=true dev.kyma.samples.easyfranchise.ServerApp 8100`

In folder code/easyfranchise/source/backend/db-service:

	command (`> cd db-service`)
windows	`java -cp ".\target\;.\target\dependency\" -Dlocal_dev=true dev.kyma.samples.easyfranchise.ServerApp 8090`
unix	`java -cp "./target/:./target/dependency/" -Dlocal_dev=true dev.kyma.samples.easyfranchise.ServerApp 8090`

Each service will run on a different port (8080, 8100, 8090). Don't use different ones. The hiddenconfig.properties relies on them!

Hint: Just in case you want to debug one of the applications using port 8888, you can start the Java process using the following command. Then, connect with your IDE to the external Java process on port 8888.

java -Xdebug -Xrunjdwp:transport=dt_socket,address=8888,server=y,suspend=y -cp "./target/*;./target/dependency/*" -Dlocal_dev=true dev.kyma.samples.easyfranchise.ServerApp <port>

Test the APIs

Onboard the first tenant by following these instructions.
Check that you can get all mentors. You should get an empty array if you haven't open the app UI till now.
```
curl  --request GET 'http://localhost:8080/easyfranchise/rest/efservice/v1/mentor' 
```
Note: If the request fails, check the logs of ef-service and db-service.
Check that you can read franchisees.
```
curl --request GET 'http://localhost:8080/easyfranchise/rest/efservice/v1/franchisee' 
```
Note: If the request fails, check the logs of ef-service and db-service.

Run the Easy Franchise UI

Check that you have defined the URL path of the backend API to the local backend service. Open the file code/easyfranchise/source/ui/src/main.js and check the value for Vue.prototype.$backendApi.
```
Vue.prototype.$backendApi = "http://localhost:8080/easyfranchise/rest/efservice/v1";
```
Open a new terminal and change directory to ui.
```
cd ui
```
Install Node.js modules in your repository by running:
```
npm install
```
Run the server:
```
npm run serve
```
As result you get the url of the application. The port may be different if you started the mock server for example.
```
http://localhost:8082
```
Open this URL in a browser.
Opening the Easy Franchise UI will create a login metering info, which you should be able to see in the Day2 UI in the next step.

Run the Day2 UI

Similary to what we did for the Easy Franchise UI, we need to update the URL path of the backend API to the local Day2 service. Open the file code/day2-operations/source/day2-ui/src/main.js and check the value for Vue.prototype.$backendApi. Be sure to use the right port started by your terminal for the Day2 service as it may be different from the documentation below.
```
Vue.prototype.$backendApi = "http://localhost:8091/user";
```
Now you can open a command prompt and go to code/day2-operations/source/day2-ui.
Install the Node.js modules.
```
npm install
```
Start the service.
```
npm run serve
```
As result you get the url of the application. The port may be different if you started the mock server for example.
```
http://localhost:8083
```
Open this URL in a browser.
As you already logged in to the Easy Franchise service, which is using the tenant ID 123456789-local-tenant-id, you should find an according record.
If you would like to see a second tenant or increase the number of active users, you can achieve this by :
- Updating the properties devmode.tenantid in the hiddenconfig.properties of the backend services. Stop, build and start the application again, so that the new tenant ID gets activated and reopen the Easy Franchise UI.
- (Optional) Running a REST call against the Day2 service via CURL command and fake a user login of, for example, "Jon Smith" for "second-local-tenant-id":
```
curl --request PUT 'http://localhost:8091/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{"tenantid": "second-local-tenant-id", "user": "Jon Smith"}'
```

Note: check our troubleshooting page if you can't see any active user metering values.

Result

You understand now how to run a local test of all microservices and know the limitations of running the application locally.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Run the Metering Scenario End-to-End Locally

Prepare Application Properties for Local Test Run of Day2 Service

Build and Test Run the Day2 Service Locally

Call the APIs of the Locally Running Day2 Service

Start the Database Service, the Easy Franchise Service, and the Business Partner Service

Prerequisites

Configure the hiddenconfig.properties File

Build the Project

Start All Backend Services

Test the APIs

Run the Easy Franchise UI

Run the Day2 UI

Result

Files

README.md

Latest commit

History

README.md

File metadata and controls

Run the Metering Scenario End-to-End Locally

Prepare Application Properties for Local Test Run of Day2 Service

Build and Test Run the Day2 Service Locally

Call the APIs of the Locally Running Day2 Service

Start the Database Service, the Easy Franchise Service, and the Business Partner Service

Prerequisites

Configure the hiddenconfig.properties File

Build the Project

Start All Backend Services

Test the APIs

Run the Easy Franchise UI

Run the Day2 UI

Result