This document provides instructions for exercises working with OData services in SAPUI5. It covers disabling batch processing for debugging, displaying related entity data using $expand, and optionally updating mock server metadata.
This document provides instructions for exercises working with OData services in SAPUI5. It covers disabling batch processing for debugging, displaying related entity data using $expand, and optionally updating mock server metadata.
This document provides instructions for exercises working with OData services in SAPUI5. It covers disabling batch processing for debugging, displaying related entity data using $expand, and optionally updating mock server metadata.
This document provides instructions for exercises working with OData services in SAPUI5. It covers disabling batch processing for debugging, displaying related entity data using $expand, and optionally updating mock server metadata.
Please perform the exercises below in your app project as shown in the video.
Table of Contents
1 Disable Batch Processing for Debugging .................................................................................... 2
2 Display Data From a Related Entity Using Expand ..................................................................... 3 3 (Optional) Update Mock Server Metadata ................................................................................... 5
Preview
Figure 1 - Preview of the app after doing this unit’s exercises
openSAP – Developing Web Apps with SAPUI5
1 DISABLE BATCH PROCESSING FOR DEBUGGING
In this step, we manually turn off batch processing to inspect the calls of the OData model.
webapp/Component.js sap.ui.define([ "sap/ui/core/UIComponent" ], function (UIComponent) { "use strict";
init : function () { // call the init function of the parent UIComponent.prototype.init.apply(this, arguments);
// used only for this lessons to show the request individually...
this.getModel().setUseBatch(false);
// additional initialization can be done here
}
}); });
In the init method of the component, we add a single line that manually turns off batch processing to be able to debug calls from the ODataModel to the server easily. By default, batch processing is turned on in SAPUI5, so all calls that would otherwise be sent to a server in a single request are composed to a batch request that combines multiple requests.
This is a great performance boost, especially when network latency is high, but also makes debugging hard. That is why we manually turn off batch processing in our app so that you can analyze how changes in your app - for example adding or removing filters - influence the calls sent to the backend service.
Note: Only do this for testing!
Do not turn of batch processing in productive applications as it might slow down the application flow and impact performance negatively!
Copyright/Trademark openSAP – Developing Web Apps with SAPUI5
2 DISPLAY DATA FROM A RELATED ENTITY USING EXPAND
In this step, we will expand the list binding to show data from another OData entity
In this step we want to use the OData query parameter $expand to be able to display additional information from a related entity.
Copyright/Trademark openSAP – Developing Web Apps with SAPUI5
First we have to add the parameter to the list binding. For that, we use the parameters setting in the binding and pass the ToSupplier navigation property to this parameter. We can now use properties from this entity using relative paths. We add the secondStatus aggregation to our list item and add an sap.m.ObjectStatus control into it. We bind its property text to the City property in the BusinessPartner entity of the service, which is the target type of navigation property ToSupplier.
webapp/i18n/i18n.properties … # Data Binding Content productListTitle=Products ... statusDeliveryFrom=From …
As we use a new translatable text, we adjust the i18n file as well.
Note: Mock Server and expands
If you use the mock data workaround, your page might stay blank at this point and there is an error in the console saying that the ‘ToSupplier’ path could not be resolved. The service metadata does not contain this navigation property yet, so replace your metadata with the contents in the next step.
Related Information OData.org
Copyright/Trademark openSAP – Developing Web Apps with SAPUI5
3 (OPTIONAL) UPDATE MOCK SERVER METADATA
If using the mock server, we need to modify the service metadata so that the supplier expand can be mocked. The value will remain empty however, as the mock server is not able to automatically generate mock data for expanded entities.
Note: This workaround is only applicable if you are using the mock server as described in week 2 unit 1. It will create random test data in your app if the service connection is too slow during these exercises. The MockServer will be explained later in the course in more detail and would be set up a bit differently in a real project.
Replace the contents of the file metadata.xml with the updated service interface. The entity BusinessPartner has been added.
Coding Samples Any software coding or code lines/strings (“Code”) provided in this documentation are only examples and are not intended for use in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules for certain SAP coding. SAP does not warrant the correctness or completeness of the Code provided herein and SAP shall not be liable for errors or damages cause by use of the Code, except where such damages were caused by SAP with intent or with gross negligence.
