Using the Sample App as a Reference

Overview

Oracle E-Business Suite mobile Login component provides a sample mobile app that lets you use as a reference implementation. It implements various features of the Login component that are described earlier for Oracle E-Business Suite Mobile Apps Release 9.x and Earlier only. It does not apply to Oracle E-Business Suite Mobile Apps Release 10.x.

To better understand the sample app, this appendix includes the following topics:

Sample App Features

The sample app implements the following features in Oracle E-Business Suite as a sample only for developers to use as a reference. This app should not be deployed against a production environment.

Sample App Patterns

Apart from providing several built-in features through the Login component, the sample app implements the following patterns that you can refer to and use in your mobile apps:

Preparing to Run the Sample App

The sample app includes the following components:

Before you run the sample app, ensure that you perform the following tasks:

  1. Enable the REST interfaces used by the sample app through the following steps:

    1. Ensure that Oracle E-Business Suite Integrated SOA Gateway (ISG) is set up correctly and the REST service framework is enabled, as described in Configuring Oracle E-Business Suite REST Services and Implementing Oracle E-Business Suite REST Services.

      Important: If the REST service framework is not enabled, patches for the sample app REST services cannot be applied successfully.

      Note: Configuring Oracle E-Business Suite REST services provided through ISG is also required if you use Oracle E-Business Suite REST APIs for custom app development. However, it is not required if you use standard Oracle E-Business Suite mobile apps installed from the Apple App Store or Google Play, or apps provided to users through enterprise distribution.

    2. Ensure you have applied the following patches for the REST services that the sample app uses:

      Note: These two patches are included in all product family patches which are consolidated into the Oracle E-Business Suite level patches. See: Applying Patches for Mobile Apps Built with Oracle E-Business Suite Mobile Foundation Release 9.1 and Release 9.0, Oracle E-Business Suite Mobile Apps Administrator's Guide, Release 12.1 and Release 12.2.

      • For Oracle E-Business Suite Release 12.1.3, apply patch 21316087:R12.FND.B.

      • For Oracle E-Business Suite Release 12.2, apply patch 21316087:R12.FND.C.

      These patches contain the following information:

      • Sample REST service implementations

      • Application definition metadata for the sample app

      • A mobile app access role for the sample app

    3. Log in to Oracle E-Business Suite as a user who has the Integration Administrator role (or the Integration Repository Administrator role in Oracle E-Business Suite 12.1.3 and 12.2.3). Select the Integrated SOA Gateway responsibility and the Integration Repository link from the navigation menu.

    4. Select "Product Family" from the View By drop-down list in the Integration Repository.

    5. Expand the "Applications Technology" folder, then the "Application Object Library" folder, and then select "Mobile Sample".

      This retrieves the following APIs that the sample app uses.

      • Mobile Sample AM Interface

      • Mobile Sample PL/SQL Interface

      • Organization Picker

    6. For each interface that the sample app uses, perform the following tasks:

      1. Select the Grants tab.

        Create security grants for all the operations contained in the selected interface so that the users who will be running the sample app can access these operations.

        For more information on creating security grants, refer to Managing Grants for Interfaces with Support for SOAP and REST Web Services, Administering Native Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

      2. Select the REST Web Service tab.

        Enter the following information for each interface:

        • Service Alias: Specify service alias information for each selected interface:

          • Mobile Sample AM Interface - mobileamsample

          • Mobile Sample PL/SQL Interface - mobileplsqlsample

          • Organization Picker - mobileorgsample

        • Verb: Select "POST" as the HTTP verb for each selected interface.

      3. Click Deploy to deploy each selected interface as a REST service.

        For more information about deploying REST services, refer to Chapter 3 Administering Native Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

    7. The REST interfaces are now ready to be used by the sample mobile app.

  2. Enable the sample app by configuring the app in Oracle E-Business Suite:

    1. Log in to Oracle E-Business Suite as a user who has the Mobile Applications Manager responsibility.

      Select the Mobile Applications Manager responsibility and choose the Applications link from the navigation menu.

    2. Locate the sample mobile app in the Search Mobile Applications page by entering the following information:

      • Application Name: EBS Sample App

      • Application Bundle ID: com.oracle.ebs.atg.mbl.Sample

    3. Enable and configure the sample app by clicking the Configure icon.

    4. If desired, specify configuration parameter values for the sample app.

    For information on configuring a mobile app, refer to Configuring the Mobile Apps on the Oracle E-Business Suite Server, Oracle E-Business Suite Mobile Apps Administrator's Guide, Release 12.1 and 12.2.

  3. Assign the sample app access role (role code UMX|FND_MBL_SAMPLE_ROLE) to responsibilities through the following steps:

    1. Identify one or two responsibilities that are already available to the Oracle E-Business Suite users using which you plan to log in to the sample app.

    2. Assign the sample app access role to those responsibilities.

    For information on assigning the role to responsibilities, refer to Setting Up Mobile App Access to Responsibilities, Oracle E-Business Suite Mobile Apps Administrator's Guide, Release 12.1 and 12.2.

Deploying and Running the Sample App

Unzip the sample app and open it in Oracle JDeveloper that is already set up to run Oracle Mobile Application Framework applications. Deploy the sample app to either an iOS Simulator or Android Emulator and test it.

Please note that the Developer mode is disabled for the sample app by default. Therefore, when you run it, you are required to accept the End User License Agreement and enter the Server URL for the Oracle E-Business Suite environment where you have enabled the REST APIs and configured the app.