Show TOC

Enabling Models as OData ServicesLocate this document in the navigation structure

Use the API Toolkit for SAP Mobile Platform to enable models as OData services for consumption through SAP Mobile Platform.

Context

SAP Mobile Platform Tools provide Eclipse-based developer tools for the provisioning and consumption of OData services regardless of the service provisioning platform and service consumption technology. Among these tools, is the API Toolkit for SAP Mobile Platform, developed specifically for Integration Gateway to enable OData models as OData services, by mapping the model definition to database tables and then binding that data to various datasources (SOAP, JPA, JDBC, and ODC) for consumption in SAP Mobile Platform.

Prior to using API Toolkit for SAP Mobile Platform, ensure that your environment is set up appropriately:
Additionally, review the known constraints for Integration Gateway and the API Toolkit for SAP Mobile Platform:
  • SAP Note 1931374Information published on SAP site—Integration Gateway for SAP Mobile Platform 3.0 Known Constraints contains information about restrictions and constraints for Integration Gateway and Gateway Management Cockpit.
  • SAP Note 2049574Information published on SAP site—Constraints for SAP Mobile Platform Tools 1.0 contains information about restrictions and constraints for API toolkit for SAP Mobile Platform..

Procedure

  1. (Optional) Deploy the JDBC driver on SAP Mobile Platform Server. This step is only required for Integration Gateway JDBC connections. SAP Mobile Platform Server can only establish a JDBC connection if the JDBC driver is already deployed.
    • If your JDBC driver is an OSGi bundle JAR file, copy the file into <SMP_HOME>\Server\pickup.
    • If your JDBC driver is not an OSGi bundle JAR file, follow the instructions in Converting JDBC JARs to OSGi JARs.
  2. Map the logical roles required by API Toolkit for SAP Mobile Platform users. SAP Mobile Platform includes default logical roles that are manually mapped to physical roles in your identity management system in order to grant role-based access to specific capabilities in SAP Mobile Platform. Follow the instructions in Administrator > Security Administration > Configuring Security in SAP Mobile Platform > Role Mapping for information about the default logical roles for Integration Gateway, and for instruction on mapping logical roles to physical roles.
  3. Create your OData Model using the SAP Mobile Platform Tools Odata Model Editor. This tool was installed when you installed the API Toolkit for SAP Mobile Platform. For information about using the SAP Mobile Platform Tools OData Model Editor, see the SAP Mobile Platform Tools Developer GuideInformation published on SAP site.
  4. Enable your Model as an OData Service. Enabling your model as a service registers the service with SAP Mobile Platform so that it can be accessed by mobile applications. The procedure for enabling your model as an OData service will vary depending upon the datasource connection (JDBC, JPA, SOAP, or OData). Select the appropriate topic below for information specific to your data integration scenario.
    For reference purposes, the Enterprise Sales and Procurement Model (ESPM) scenario is included in the SAP Mobile Platform Server installation. This scenario can be used as a sample service to demonstrate managing services using Gateway Management Cockpit.