Show TOC

Native OData App Development Using the OData API Locate this document in the navigation structure

The OData SDK provides an open and flexible framework for native OData application development for online and offline applications. OData SDK components are implemented as static runtime libraries.

The OData API supports OData service manipulation, and leverages other SAP Mobile Platform components such as Client Hub, MAF, Core Services and so on:

The ODataAPI library is an interface for application developers that provides:
  • OData service implementation independence.
  • Worry free assembling of OData results (parsing of ATOM/XML or JSON is handled internally).
  • Separation of ‘life cycle’ APIs (open, close, refresh of online and offline stores is store specific) from the OData query API, since access to the online and offline stores uses the same ODataAPI.
  • Consistent API usage across both online (remote) OData access and offline (local) OData access.
The ODataAPI contains:
  • ODataStore API – describes how to send and recieve OData requests asynchronously or synchronously.
  • Payload API – describes payload information: entity, feed, property, link, and so on.
  • Metadata API – includes ODataMetadata that describes how the feed, data, or resource is structured.
Tip The application calls the same ODataAPI library whether the OData store is offline or online.
Online, Occasionally Offline, and Offline OData Application Support

Develop applications that are online, occasionally offline, or offline:

  • Online an online OData store is initialized and the ODataAPI library accesses exposed back-end OData services without any caching or local storage of data. This is best suited when the application requires up to date back-end data and has reliable connectivity.
  • Offline an offline OData store is initialized and populated with a list of OData collection end-points to be stored offline on the device. Device users can fully manipulate this data (query, update, create, delete, and so on), then merge the updates to the back-end with offline changes. An Offline application is well suited when connectivity may become unrelaible, or requires infrequent updates of back-end data. For example, an application used by field service personel, who download service information at the beginning of the day, update the data offline throughout the day, then update the back-end data at the end of the day.
  • Occasionally Offline an online application (uses an online store) that shares characteristices of an offline application, and may be appropriate for occasionally connected scenarios.
Native OData Webinars, How-to Guides, and Blogs

Authorized users can visit the SAP Community Network (SCN) published on SAP site Web site to view additional OData app development resources.