SAP HANA XS Advanced - Consume the OData service in a basic HTML5 module

In this previous tutorial, you created an XSJS compatible Node.js module to expose an OData V2 service that provides data from your database module. Consuming that model using SAP UI5 is simplified thanks to the concept of binding.

Take a look at the output of the OData service in JSON format

Add the following script to your index.html file, where the logics for the button used to be.

<script>

	var oModel = new sap.ui.model.odata.ODataModel("/xsodata/purchaseOrder.xsodata", true);
	var oTable = new sap.ui.table.Table({ title: "My first table" });
	oTable.addColumn(new sap.ui.table.Column({ label: "PO ID", template: "PURCHASEORDERID" }));
	oTable.setModel(oModel);
  oTable.bindRows("/POHeader");
	oTable.placeAt("uiArea");

	</script>

More about binding

You are using an OData model that will load data as required by the client and delegate the sorting and filtering operations to the server-side. This model will provide the data from the service you defined before. You are then creating a table and binding the model to the table, so that all changes in the data are reflected also in the table. Check the Help for more information about SAPUI5 and binding

Save and run the HTML5 module. You should get an error. Press F12 in your browser and look at the errors in the console.

You will see that the source of the SAP UI5 library is a public, remote resource.

In a productive scenario, there are many reasons to use a local version of the library. As of SAP HANA 2.0, SPS01, SAP UI5 was incorporated to XS Advanced as a micro-service for local consumption. You need to create an instance of the service to use on your Multi-Target Application just like you did with the UAA service.

Alternate between normal and incognito mode or use another browser to log in to the XSA Cockpit with the user XSA_ADMIN. In an SAP HANA, express edition instance this application has been incorporated in SPS03 and is found on port 51036 (i.e., https://hxehost:51036 ).

Navigate to the service marketplace for the space where your application is deployed and click on the sapui5 service

Click instances and create a New instance

Choose plan sapui5-1.52 and click Next

Call it ui5. When asked to specify parameters, you can click Next.

Note: If you do not have SPS03 yet, add the following resource to your mta.yaml file, adjusting the UI5 version accordingly instead of running the previous wizard, which is not available. The following example works for SPS02

- name: ui5
    type: configuration
    parameters:
      provider-id: 'com.sap.ui5.dist.sapui5-dist-xsa.XSAC_UI5_FESV3:sapui5_fesv3'
      version: '>=1.44.0'

Just like with the UAA service, you want to bind the instance you have created to your Multi-Target Application. Open the MTA.yaml file and click add a new resource called ui5.

Use org.cloudfoundry.managed-service as the type and the following key-value pairs under parameters:

• service : sapui5_sb
• service-plan : sapui5-1.52

Where are the values coming from?

The name of the service instance, the type of service and service plan are use to bind the instance of the UI5 service to the web module. You can see these values under Service Instances in the XS Advanced cockpit or by listing them using the XS CLI with command xs services

Save the yaml file and navigate to the resources tab. Use the drop-down menu to choose the newly created resource.

Note: If you do not have SPS03 yet, skip the previous configuration and add the following dependency to the web module in the yaml file instead

- name: ui5
  properties:
    url: ~{url}

Open the file xs-app.json and add the following code at the end of the route declarations

{
		"source": "/(.*)",
		"localDir": "resources",
		"authenticationType": "xsuaa",
		"replace": {
			"pathSuffixes": ["index.html", "odataTest.html"],
			"services": {
				"sapui5_sb": {
					"tag": "ui5"
					}
				}		
				}
			}

You will need to add a comma before adding the new route with the replacement values, the full file looks as follows:

Save the file

What does this mean?

Take a look at the package.json file. You will notice a node module,approuter.js, is called. This module will read the file xs-app.json, use the welcomeFile value to redirect to index.html by default, and interpret the routes requests should take according to the regular expressions in the source key.
It can also replace placeholders in static text resources, such as a placeholder for the URL to the UI5 service in index.html. In this case, the AppRouter finds the service with tag ui5 like you created in step 4, bound to the web application. If you use command xs env APP, where APP is the name of your web application, you will see the configuration details for the UI5 service.

You can find more information about the AppRouter in the SAP Help portal