Setting Up the Mobile Apps

Setup Overview

Before letting the mobile users download and use an app, you need to perform administrative tasks on the Oracle E-Business Suite server for your app. These tasks include installing server patches, configuring the mobile app, granting the app access role to responsibilities, completing additional setup tasks such as device integration if required for your app, and validating the server URL before communicating the information to the users.

The following diagram illustrates these high level setup tasks for the administrators to perform on the server. Once the server-side setup is complete, the mobile users can start to download and use the app on the go.

Oracle E-Business Suite Mobile Apps High Level Implementation Steps

the picture is described in the document text

This chapter describes the following administrative tasks:

  1. Applying Prerequisite Patches on the Oracle E-Business Suite Server

  2. Configuring the Mobile Apps on the Oracle E-Business Suite Server

  3. Setting Up Mobile App Access to Responsibilities

  4. Additional Setup for Device Integration

  5. Additional App-Specific Setup

  6. Additional Setup for Deploying Mobile Apps with Enterprise Mobility Management (EMM) Solutions

  7. Communicating Mobile App Information to Users

Applying Prerequisite Patches on the Oracle E-Business Suite Server

For each Oracle E-Business Suite mobile app, apply the corresponding consolidated product family patch and conditionally required patches if needed.

Note: Ensure that you run AutoConfig after applying the consolidated product family patch for Oracle E-Business Suite Release 12.1. In Oracle E-Business Suite Release 12.2, when you apply patches using the adop (AD Online Patching) utility, adop runs AutoConfig by default.

To support the "Apps SSO Login" authentication (previously known as "Web SSO") from Oracle E-Business Suite Mobile Foundation Release 4.0 and onwards, you must also apply required patches and perform additional setup tasks to enable the feature. See: Mobile Specific Setup Tasks to Enable Apps SSO Login Authentication Security.

Tasks and Patches Required for Mobile Apps Built with Oracle E-Business Suite Mobile Foundation Release 8.0

This section describes the patch information and tasks required for the mobile apps that are built with Oracle E-Business Suite Mobile Foundation Release 8.0. Perform the required tasks to apply prerequisite patches in the following sequence:

  1. Performing Conditional Pre-Install Tasks

  2. Applying Patches for Mobile Apps Built with Oracle E-Business Suite Mobile Foundation Release 8.0

  3. Applying Conditional Post-Install Patches

For information on prerequisite patches for earlier Oracle E-Business Suite Mobile Foundation releases, see Product Family Patches for Earlier Oracle E-Business Suite Mobile Foundation Releases.

Step 1: Performing Conditional Pre-Install Tasks

For Mobile Apps Built with Oracle E-Business Suite Mobile Foundation Release 8.0

Perform any additional conditionally required pre-install tasks from the following list for your apps built with Oracle E-Business Suite Mobile Foundation Release 8.0:

Conditional Pre-Install Tasks for Mobile Apps Built with Oracle E-Business Suite Mobile Foundation Release 8.0
Oracle E-Business Suite Release or Mobile App Name Requirement Patch Information
Oracle E-Business Suite Release 12.2 and 12.1.3
  • Oracle Mobile Maintenance for Oracle E-Business Suite

Required only if you plan to implement Oracle Mobile Maintenance for Oracle E-Business Suite Oracle Mobile Maintenance "Disconnected" feature uses the Oracle Mobile Field Service Multiplatform framework, which does not require Oracle Lite and consequently Oracle Lite should be uninstalled.
If the "mobileadmin" schema exists, refer to My Oracle Support Knowledge Document 2188514.1, Oracle Mobile Field Service Store and Forward Multiple Platforms Support.

Step 2: Applying Patches for Mobile Apps Built with Oracle E-Business Suite Mobile Foundation Release 8.0

Important: If you install or upgrade your apps to the version built with Oracle E-Business Suite Mobile Foundation Release 8.0, then you must apply the server-side prerequisites through one of the methods described in this section.

Important: The Oracle E-Business Suite 12.2 server-side patches listed in this section for Oracle E-Business Suite Mobile Foundation Release 8.0 are already included in the respective product family patches in Oracle E-Business Suite Release 12.2.8. If you have installed Oracle E-Business Suite 12.2.8, skip this section and simply apply the post-install patches, as described in Applying Conditional Post-Install Patches.

Apply the server-side patches in either of the following ways based on your needs:

Note: Starting from Oracle E-Business Suite Mobile Foundation Release 7.0 and onwards, Oracle allows you to apply the server-side patches either through Oracle E-Business Suite level patch or product family level patch for your Oracle E-Business Suite release depending on your needs.

Step 3: Applying Conditional Post-Install Patches

For Mobile Apps Built with Oracle E-Business Suite Mobile Foundation Release 8.0

Apply any additional conditionally required post-install patches from the following list for your apps built with Oracle E-Business Suite Mobile Foundation Release 8.0:

Conditional Post-Install Patches for Mobile Apps Built with Oracle E-Business Suite Mobile Foundation Release 8.0
Oracle E-Business Suite Release or Mobile App Name Requirement Patch Information
Oracle E-Business Suite Release 12.2 and 12.1.3
  • Oracle E-Business Suite Mobile Foundation Release 8.0 Online Help

Required for all Oracle E-Business Suite mobile apps, built with Oracle E-Business Suite Mobile Foundation Release 8.0, connected to Oracle E-Business Suite Release 12.1.3 or Release 12.2
  • Release 12.2 and 12.1.3: Patch 27678444

Oracle E-Business Suite Release 12.2 and 12.1.3 Required for all Oracle E-Business Suite mobile apps, built with Oracle E-Business Suite Mobile Foundation Release 8.0, connected to Oracle E-Business Suite Release 12.1.3 or Release 12.2
  • Release 12.2 - Patch 28278350:R12.OWF.C

  • Release 12.1.3 - Patch 28278350:R12.OWF.B

Oracle E-Business Suite Release 12.2 and 12.1.3 Required only if your Oracle E-Business Suite environment has the following patches applied:
  • Release 12.2 - Patch 27761509:12.2.0 (Oracle Applications Release 12.2 : Consolidated Patch for Data Removal Tool)

  • Release 12.1.3 - Patch 27822242:12.1.0 (Oracle Applications Release 12.1 : Consolidated Patch for Data Removal Tool)

Perform the following steps in the specified order:
  • Release 12.2:

    1. Apply Patch 28295762:R12.PER.C.

    2. Apply Patch 28303904:R12.FND.C.

    3. Recompile the data removal metadata by running the concurrent program "Recompile Metadata for Data Removal Tool", with the "Entity Type" parameter set to "ALL".

  • Release 12.1.3:

    1. Apply Patch 28295762:R12.PER.B.

    2. Apply Patch 28303904:R12.FND.B.

    3. Recompile the data removal metadata by running the concurrent program "Recompile Metadata for Data Removal Tool", with the "Entity Type" parameter set to "ALL".

Additional Information: To develop custom apps for Oracle E-Business Suite, you need to download the following client-side patch for Oracle E-Business Suite Release 12.1.3 and Release 12.2:

This patch enables the Oracle E-Business Suite Mobile Foundation client libraries, application template, and sample app; therefore, apply this patch on the mobile client, not on the Oracle E-Business Suite server.

For information on developing custom apps for Oracle E-Business Suite and using the sample app. See: Oracle E-Business Suite Mobile Apps Developer's Guide, Release 12.1 and 12.2.

Configuring the Mobile Apps on the Oracle E-Business Suite Server

Before letting the mobile users download and use the app, you must first enable the mobile app that you want to configure, and then specify configuration parameter values for the app. Oracle E-Business Suite provides default values for the configuration parameters, which you can optionally override as needed.

Oracle E-Business Suite mobile apps use the configuration service to download the configuration file from the server to the mobile apps. The apps then use the parameters specified in the configuration files to connect securely from the mobile client to the Oracle E-Business Suite instance. You must validate the configuration service URL to ensure the mobile app is ready for the users.

This section includes the following topics:

Note: This setup is a one-time process for each app. You can enable and set up each app individually through the Mobile Applications Manager UI pages or set up multiple apps simultaneously using a script.

After the initial setup, you can update the configuration parameters if necessary. If the configuration is changed after the initial setup is complete and loaded to a user's app, starting from the Oracle E-Business Suite Mobile Foundation Release 7.0, the updated parameters will be automatically downloaded to the app every five logins. See Directing Users to Obtain Connection Details and Download Updates from the Server.

Oracle E-Business Suite Mobile Apps Server Connectivity Options

Oracle E-Business Suite mobile app users have the following server connectivity options to access the mobile apps:

  1. Over the Internet

    To access the Oracle E-Business Suite mobile apps over the Internet, your Oracle E-Business Suite environment must be set up in a DMZ configuration. For additional information on performing this configuration, see Advanced Configurations for Demilitarized Zone.

  2. Over the Intranet

    If your Oracle E-Business Suite environment is not set up in a DMZ configuration, mobile app users must access the Oracle E-Business Suite mobile apps through an intranet connection, such as a virtual private network (VPN).

  3. Through Enterprise Mobility Management (EMM) Solutions

    Oracle E-Business Suite mobile apps developed using Oracle Mobile Application Framework (MAF) can integrate with third-party Enterprise Mobility Management solutions that support common AppConfig standards, such as VMware AirWatch. For more information, see Integrating Oracle E-Business Suite Mobile Apps with Enterprise Mobility Management Solutions.

The following diagram illustrates the Oracle E-Business Suite mobile apps server connectivity options:

Oracle E-Business Suite Mobile Apps Server Connectivity Options

the picture is described in the document text

Enabling a Mobile App Individually and Specifying the Configuration Through the UI Pages

To access Oracle E-Business Suite Mobile Applications Manager UI pages, log in to Oracle E-Business Suite as a user who has the Mobile Applications Manager responsibility.

Note: The Mobile Applications Manager responsibility is assigned to the Mobile Applications Administrator role (UMX|FND_MBL_ROLE_ADMIN) and the Mobile Applications Developer role (UMX|FND_MBL_ROLE_DEV). A system administrator assigns these roles to users through Oracle User Management. See: Assigning Roles to or Revoking Roles from Users, Oracle E-Business Suite Security Guide.

Users granted different roles can perform various tasks as described in the following table:

Privileges Mobile Applications Administrator Mobile Applications Developer
Search enterprise apps Yes Yes
Configure the Push Notification System Yes Yes
Register enterprise apps Yes Yes
Configure enterprise apps Yes Yes
Update application definitions Yes Yes
Delete application definitions Yes Yes
View configuration files Yes Yes
View mobile app installation details Yes No
View mobile app usage metrics Yes No

To configure mobile apps, users can obtain the responsibility through the Mobile Applications Administrator role. The SYSADMIN user is granted the Mobile Applications Administrator role by default.

Select the Mobile Applications Manager responsibility and choose the Applications link from the navigator. The Search Mobile Applications page appears.

The Search Mobile Applications Page

the picture is described in the document text

This Search Mobile Applications page is the entry point to access the application definition details for each Oracle E-Business Suite mobile app. After performing a search, a user who has the Mobile Applications Administrator role can perform the following tasks from the search result table:

Additional Information: A user who has the Mobile Applications Developer role can register, update, and delete the application metadata definition of an app modified from an MAA file for enterprise distribution or a custom app developed for Oracle E-Business Suite. For information on these tasks, see Registering and Updating Your Mobile App Definition Metadata, Oracle E-Business Suite Mobile Apps Developer's Guide, Release 12.1 and 12.2.

Enabling and Configuring a Mobile App Individually

Perform the following steps to configure your mobile app on the Oracle E-Business Suite server:

  1. Log in to Oracle E-Business Suite as a user who has the Mobile Applications Administrator role. For example, log in as SYSADMIN.

  2. Select the Mobile Applications Manager responsibility and choose the Applications link from the navigator.

  3. In the Search Mobile Applications page, enter desired search criteria and click the Search button. The page displays the mobile apps that match the search criteria in the search result table.

    Note: The Users and App Usage columns are available from Oracle E-Business Suite Mobile Foundation 5.0 and onwards for viewing user installation and app usage information. See: Viewing Mobile App Installation and Usage Metrics.

    For metadata information that you can enter in the search criteria to locate your desired app, see Appendix C: Application Definition Metadata.

  4. Click the Configure icon for the mobile app that you want to configure from the search result table.

  5. Review the app details in the Configure Mobile Applications page. If the selected app is not configured, change the status to "Enabled".

    • Enabled: This allows you to configure the app against Oracle E-Business Suite.

    • Disabled: The app was configured previously but is currently disabled. This prevents any further configuration on the app against Oracle E-Business Suite. If an app was configured successfully prior to setting its status to "Disabled", the app will continue to work.

    • Not Configured (default): The app's definition was just installed on the server and it is not configured yet.

      Note that after an app is configured, although it is possible to change its status to "Not Configured", it is recommended that you change it to "Disabled" only.

    Enabling the Selected App in the Configuring Mobile Applications Page

    the picture is described in the document text

  6. In the Configuration Categories region, two types of category values can be displayed depending on the selected app that you want to enable:

  7. In the Configuration Categories region, optionally choose the Show link next to the "Connection Settings" or "Push Notifications" category to display the parameters corresponding to the selected authentication type or the parameters for the push notifications. You can modify these parameter values for the configuration. If you want to proceed with the default parameter values, skip the next step 8, and go to step 9.

  8. Update the configuration parameter values in the Configuration Parameters region to appropriate values for your Oracle E-Business Suite instance, if the configuration parameter settings for your instance are different from the default settings. For example, for the authentication type, if the location of a web entry point specific to a mobile app is stored in a custom profile option, then update the Service Endpoint (APPS_MOBILE_AGENT) parameter with the custom profile option name. For information on configuring parameters in the Configuration Parameters region, see:

    Configuration parameters to be included in the configuration file depends on the selected authentication type in the Sub Category field. For example, if "Apps SSO Login" is selected for an app, the corresponding parameters of the "Apps SSO Login" authentication type are included in the configuration file. Additionally, if the app is enabled with push notifications available from Oracle E-Business Suite Mobile Foundation Release 7.0 and onwards, the relevant parameter settings for push notifications are also included in the configuration file, along with the "Apps SSO Login" associated parameters.

    When the configuration file is loaded to a mobile app, the app uses these parameters to connect to the intended instance.

    Note: The service version for the app is also included as a parameter in the configuration file in Oracle E-Business Suite Mobile Foundation Release 2.1 and onwards, but the parameter value is set by Oracle and it cannot be modified. Therefore, it is not listed in the Configuration Parameters region.

  9. Click the Apply button. This action saves the selected authentication type and relevant configuration parameters you specified to the database to be used to generate the configuration file ebs-mobile-config.xml during the initial launch of the app. When an app is launched for the first time, the selected authentication type along with the configuration parameters including the parameter settings for push notifications if available will be loaded to the app to connect to an Oracle E-Business Suite instance, invoke configuration service to download configuration data, and invoke Oracle E-Business Suite services with the selected authentication type.

To validate the configuration, click the Configuration File icon from the search result table. See: Viewing and Validating Your Mobile App Configuration.

On the client side, once the configuration file is downloaded from the server to the mobile app during the initial login, it will be parsed to retrieve the configuration parameters. The app user can view the downloaded parameters and connection details from the mobile app in the device.

Mobile apps may have configuration updates after the initial launch. For example, an administrator changes the timeout values or the service endpoint for an app, or an app's server-side patch provides additional features that require the user to check for updates as described in the patch readme. Starting from the Oracle E-Business Suite Mobile Foundation Release 7.0 and onwards, each app periodically checks for configuration updates and automatically downloads them to the app from the Oracle E-Business Suite server. Additionally, the user can still manually check if any new updates from the server are required in the app if necessary. See Directing Users to Obtain Connection Details and Initiate Server Updates.

Supporting Apps Local Login and Apps SSO Login Authentication Types for All Mobile Apps

Oracle E-Business Suite mobile apps support "Apps Local Login" and "Apps SSO Login" authentication types that are displayed under the "Connection Settings" category in the Configuration Categories region.

Note: The "Apps Local Login" type (previously known as "HTTP Basic") corresponds to the "HTTP Basic" authentication server type used in Oracle Mobile Application Framework; the "Apps SSO Login" type (previously known as "Web SSO") corresponds to the "Web SSO" authentication server type used in Oracle Mobile Application Framework.

Authentication type is preselected or defined for an app during the app registration. Each authentication type is associated with a set of configuration parameters required to set for an app. When you enable or configure an app, the preselected type (either "Apps Local Login" or "Apps SSO Login") is displayed in the Sub Category field in the Configuration Categories region. You can override the selected type if needed by selecting a different value from the Sub Category drop-down list. After the change, the parameters corresponding to the selected authentication type will be loaded and displayed in the Configuration Parameters region.

Important: Make sure Oracle E-Business Suite mobile apps work with "Apps Local Login" before you change it to the "Apps SSO Login" authentication type. If an app initially connects to Oracle E-Business Suite through "Apps Local Login", and later its authentication type is changed to "Apps SSO Login", the app users should initiate the manual update to refresh the configuration. This is performed by tapping Settings from the mobile app navigation menu, then tapping Connection Details, and then tapping the Sync icon.

Please note that for an app built with Oracle E-Business Suite Mobile Foundation Release 7.0 or later, if this manual update process is not initiated, the new configuration will be downloaded at a later time during the automatic check for updates. See: Directing Users to Obtain Connection Details and Initiate Server Updates.

Oracle E-Business Suite mobile apps support the following authentication scenarios:

Configuring Parameters for the Apps Local Login Authentication Type

If the default "Apps Local Login" type (previously known as "HTTP Basic") is used as the authentication type to authenticate users locally, update the following parameter values:

Configuring an App with the Apps Local Login Type

the picture is described in the document text

Configuring Parameters for the Apps SSO Login Authentication Type

Important: Before configuring apps with "Apps SSO Login" (previously known as the "Web SSO" type), make sure your apps work with "Apps Local Login" first. If an app initially connects to Oracle E-Business Suite through "Apps Local Login", and later its authentication type is changed to "Apps SSO Login", the app users should initiate the manual update to refresh the configuration. This is performed by tapping Settings from the mobile app navigation menu, then tapping Connection Details, and then tapping the Sync icon.

Please note that for an app built with Oracle E-Business Suite Mobile Foundation Release 7.0 or later, if this manual update process is not initiated, the new configuration will be downloaded at a later time during the automatic check for updates. See: Directing Users to Obtain Connection Details and Initiate Server Updates.

Configuring an App with the Apps SSO Login Type

the picture is described in the document text

If "Apps SSO Login" is selected as the authentication type to authenticate users remotely, update the following parameter values:

Configuring Push Notifications for Supported Mobile Apps

Starting from Oracle E-Business Suite Mobile Foundation 7.0 and onwards, push notifications are supported when using Oracle Mobile Cloud Service in the following apps:

If a selected app is one of the above supported apps for push notifications, a mobile applications developer can add the "Push Notifications" category while registering the app and defining the application definition metadata. For information on adding the "Push Notifications" category during the app registration, see Adding Push Notifications to App Configuration, Oracle E-Business Suite Mobile Apps Developer's Guide, Release 12.1 and 12.2.

In order to receive push notifications from your mobile devices, ensure to complete the following required setup tasks both on the server and mobile client. See:

Configuring Parameters for Push Notifications

If the "Push Notifications" category appears in the Configuration Categories region, and if you also want to implement push notifications for the app, select "Yes" in the Sub Category.

Note: Although the "Push Notifications" category appears, you can still leave the default "No" value unchanged if you do not want the app to be enabled with push notifications. The app still works simply without push notifications.

You can update the following parameter values for push notifications:

Configuring Parameters for Push Notifications

the picture is described in the document text

For information on entering these push notification parameters, see Configuring Supported Mobile Apps with Push Notifications.

Viewing and Validating Your Mobile App Configuration

After configuring a mobile app and applying the changes, you can view and validate the updated configuration file ebs-mobile-config.xml for the app.

To validate the configuration, click the Configuration File icon from the search result table in the Search Mobile Applications page. This displays the content of the configuration file in the Configuration Service Response pop-up window.

Configuration File in the Configuration Service Response Window

the picture is described in the document text

Note that if the selected app is configured with push notifications, the relevant parameter settings are also displayed as part of the configuration file.

Configuration File with Parameters for Push Notifications

the picture is described in the document text

Additionally, you can validate the configuration by accessing the configuration service URL through a web browser. See Validating the Configuration.

Reviewing Your Mobile App Details

You can review existing application definition metadata and configuration details for your app if needed before or after configuring your app.

To view the app details, click a desired mobile app's Application Name link from the search result table. The Application Details page displays the existing definition information in read-only mode for your selected app.

For example, click the "EBS Approvals" link to view the Application, Distributions, and Configuration regions in the Application Details page for Oracle Mobile Approvals for Oracle E-Business Suite.

To update the selected mobile app details, click the Update button. See: Updating Your Mobile App Definition, Oracle E-Business Suite Mobile Apps Developer's Guide, Release 12.1 and 12.2.

Enabling and Setting Up Multiple Mobile Apps Using a Script

Instead of enabling and specifying the configuration information for each app one at a time through the Mobile Applications Manager UI pages, you can complete the setup tasks for multiple apps simultaneously by using an ant script called EBSMblConfigApps.xml. For example, use the script to easily copy the configuration details for your apps on different Oracle E-Business Suite instances, or use the script to reconfigure the mobile apps on the target environment after cloning.

Perform the following steps to configure multiple apps at the same time by using the script:

  1. Copy the template file Applications.xml and the script EBSMblConfigApps.xml from the $JAVA_TOP/oracle/apps/fnd/mobile/ant/ directory to a temporary directory in the Oracle E-Business Suite instance. Working with a copy helps you avoid changes to the seeded template file Applications.xml.

    The template file Applications.xml contains metadata for all the Oracle E-Business Suite mobile apps. The following example shows a sample template Applications.xml file:

    Note: From Oracle E-Business Suite Mobile Foundation Release 4.0, the script supports the selection of the Sub Category (<sub-category>) attribute that indicates either of the following authentication types to be used by a mobile app.

    • HTTP_BASIC: The type corresponds to "Apps Local Login" (display name) from the Mobile Applications Manager UI pages.

    • WEB_SSO: The type corresponds to "Apps SSO Login" (display name) from the Mobile Applications Manager UI pages.

    Note: If an app supports push notifications, available from Oracle E-Business Suite Mobile Foundation Release 7.0 and onwards, it cannot be configured using the script. Instead, configure the app with push notifications from the Mobile Applications Manager UI pages. See: Enabling a Mobile App Individually and Specifying the Configuration Through the UI Pages.

    <applications configureAll="N">
     	<application configure="N">
    			<app-info>
    				<name>EBS Approvals</name>
    				<app-short-name>WF_APPROVALS</app-short-name>
    				<bundle-id>com.oracle.ebs.atg.owf.Approvals</bundle-id>
    				<status>NOT_CONFIGURED</status>
    			</app-info>
    			<connection-settings>
    				<sub-category name="HTTP_BASIC" select="Y">
    					<param name="APPS_MOBILE_IDLE_TIMEOUT" type="SERVER_DEFAULT"/>
    					<param name="APPS_MOBILE_SESSION_TIMEOUT" type="SERVER_DEFAULT"/>
    					<param name="APPS_MOBILE_AGENT" type="SERVER_DEFAULT"/>
    				</sub-category>
    				<sub-category name="WEB_SSO" select="N">
    					<param name="APPS_MOBILE_AGENT" type="SERVER_DEFAULT"/>
    					<param name="APPS_SESSION_SERVICE" type="SERVER_DEFAULT"/>
    					<param name="LoginFailureURL" type="SERVER_DEFAULT"/>
    					<param name="LoginSuccessURL" type="SERVER_DEFAULT"/>
    					<param name="LoginURL" type="SERVER_DEFAULT"/>
    					<param name="LogoutURL" type="SERVER_DEFAULT"/>
    					<param name="SessionTimeOutValue" type="SERVER_DEFAULT"/>
    				</sub-category>
    			</connection-settings>
        </application>
    		...
    	</applications>
  2. To configure all the Oracle E-Business Suite mobile apps at the same time, set the attribute ConfigureAll in the Applications.xml file to Y at the root element (applications) level. Otherwise, leave the ConfigureAll attribute to N and set the Configure attribute to Y at the applications level for each particular app that you want to configure.

    • If you set the ConfigureAll attribute to Y, and set the "Configure" attribute to N for an app at the application level, the ConfigureAll attribute set to Y at the root element will override the value set at the Configure attribute and will configure all the Oracle E-Business Suite mobile apps.

      Note that the ConfigureAll attribute with its value set to Y at the root element level only configures all the apps whose definitions exist in the instance. If the definition of an app, (for example, the Timecards app) does not exist in that instance, even thought you set the ConfigureAll attribute to Y, only those apps that are defined in the instance will be configured, and the Timecards app will not be configured. An appropriate message would be shown as the output of the script indicating the result.

    • If the ConfigureAll attribute is set to N, then the attribute of each individual app determines if the app will be configured or not depending on whether you set the Configure attribute to Y or N for each app at the application level. In this situation, only the specified apps will be configured.

  3. For each app you want to configure, change the status from the default "NOT_CONFIGURED" to "ENABLED".

  4. For each app you want to configure, set the select attribute for the desired authentication type. By default, the select attribute for the "HTTP_BASIC" type (Apps Local Login) is set to Y.

    Note: If the select attribute for the "WEB_SSO" type (Apps SSO Login) is set to Y, you must set the select attribute for the "HTTP_BASIC" type to N. If both types are set to Y, then the following errors may occur:

    [java] There are two Authentication types selected for the Application, <name> (such as EBS Approvals). 
    [java] There can be only one type of authentication selected while configuring <name>.

  5. Set each parameter type attribute to one of the following values only.

    • SERVER_DEFAULT: The default value of the parameter is used to configure the app. For example, 28800 is the server default for Session Timeout parameter.

    • CONSTANT: A constant override value is used to replace the default value for the parameter. In this situation, provide a value for that parameter, such as a constant URL for your Oracle E-Business Suite instance as a constant value for the APPS_MOBILE_AGENT parameter.

    • PROFILE_OPTION: A profile option is used to override the default value for the parameter. For example, provide the internal name of a profile option for the APPS_MOBILE_AGENT parameter.

    The options listed above are the same as those are shown in the Configuration Parameters region if you configure the app from the Mobile Applications Manager UI pages.

    Configuring an App with the Apps Local Login Type

    the picture is described in the document text

    The following example shows a sample custom template Applications.xml file after setting the parameters with the Apps Local Login (HTTP Basic) authentication type:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>   
    <applications configureAll="N">
     	<application configure="Y">
    			<app-info>
    				<name>EBS Approvals</name>
    				<app-short-name>WF_APPROVALS</app-short-name>
    				<bundle-id>com.oracle.ebs.atg.owf.Approvals</bundle-id>
    				<status>ENABLED</status>
    			</app-info>
    			<connection-settings>
    				<sub-category name="HTTP_BASIC" select="Y">
    					<param type="SERVER_DEFAULT" name="APPS_MOBILE_IDLE_TIMEOUT"/>
    					<param type="CONSTANT" name="APPS_MOBILE_SESSION_TIMEOUT">28800</param>
    					<param type="PROFILE_OPTION" name="APPS_MOBILE_AGENT">APPS_FRAMEWORK_AGENT</param>
    				</sub-category>
    			</connection-settings>
        </application>
    
  6. After completing the changes in the template file Applications.xml, execute the following command from the folder where the template file is placed to initiate the configuration process.

    ant -f EBSMblConfigApps.xml

    If any validation error occurs during the configuration process, the error information will be reported in the command line. Additionally, an error log file EBSMblConfigError.log is created in the same directory to capture other types of errors. You can use the generated log file to trace and troubleshoot the errors if needed.

    When the process is completed successfully, you can verify the configuration details as described in Validating the Configuration or validate the configuration from the Mobile Applications Manager UI pages.

Validating the Configuration

Once the app-specific configuration parameters are specified, these values are stored on the server and the associated configuration file of the app is not generated at this time. When a user logs in to the app for the first time, the configuration file ebs-mobile-config.xml is then generated when requested and downloaded to the mobile app using the configuration service.

To validate the configuration for your app, construct the configuration service URL and verify if the URL is accessible through a web browser.

Note: In Oracle E-Business Suite Mobile Foundation Release 3.0 and onwards, you can also validate the configuration through the Search Mobile Applications UI pages by clicking the Configuration File icon from the search result table, as described in Enabling a Mobile App Individually and Specifying the Configuration through the UI.

  1. Verify if the configuration service URL is accessible through a web browser by performing the following steps:

    1. Construct the configuration service URL in the following format: http(s)://<hostname>:<port>/OA_HTML/RF.jsp?function_id=mConfig&bundleId=<application bundle id>&file=ebs-mobile-config.xml

      Please note that this step is only for you to validate the configuration service URL for the app, and you should not provide this URL information to the mobile app users.

      For the Application Bundle Id for each app, see Appendix C: Application Definition Metadata.

    2. Copy the configuration service URL you just constructed and paste it into a browser window. The configuration file is uploaded and displayed in the browser window.

      The following example shows a sample ebs-mobile-config.xml file returned as the response payload for the configuration service:

      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>   
      <ebs-mobile-config>
      		<app-info>
      				<name>EBS Approvals</name>
      				<bundle-id>com.oracle.ebs.atg.owf.Approvals</bundle-id>
      				<status>ENABLED</status>
       			<distributions>
      					<distribution version="1.1.0" platform="IOS"/>
      				</distributions>
      		</app-info>
      		<connection-settings>
      				<param name="APPS_MOBILE_IDLE_TIMEOUT">7200</param>
      				<param name="APPS_MOBILE_SESSION_TIMEOUT">28800</param>
      				<param name="APPS_MOBILE_AGENT">example.com:1234</param>
      		</connection-settings>
        </ebs-mobile-config>
      

      Please note that a version value used to identify a given app's server level is retrieved from the app's definition metadata and is included in the ebs-mobile-config.xml file (as shown above), along with the configuration parameters specified either through the Mobile Applications Manager UI pages or through the script.

      Starting from Oracle E-Business Suite Mobile Foundation Release 7.0 and onwards, the "Push Notifications" configuration category is added to a mobile app to implement push notifications, the associated ebs-mobile-config.xml file (as shown below) will include relevant XML elements indicating whether the push notifications feature is enabled for this app, as well as the Android Sender ID for use in the Android mobile apps.

      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>   
      <ebs-mobile-config>
      		<app-info>
      				<name>EBS Approvals</name>
      				<bundle-id>com.oracle.ebs.atg.owf.Approvals</bundle-id>
      				<status>ENABLED</status>
       			<distributions>
      					<distribution version="1.0.1"
      				</distributions>
      		</app-info>
      		<connection-settings AuthServerType="HTTP_BASIC">
      				<param name="APPS_MOBILE_IDLE_TIMEOUT">7200</param>
      				<param name="APPS_MOBILE_SESSION_TIMEOUT">28800</param>
      				<param name="APPS_MOBILE_AGENT">example.com:1234</param>
      		</connection-settings>
           <push-notifications>
      				<param name="PUSH_STATUS">ENABLED</param>
      				<param name="ANDROID_SENDER_ID">559011138198</param>
           </push-notifications>
        </ebs-mobile-config>
      

      For information on enabling push notifications for mobile apps, see Configuring Supported Mobile Apps with Push Notifications.

    3. Verify the content to ensure that the configuration file for your mobile app is valid, well-formed XML, and validate that the configuration parameter values are the same values as configured from the Mobile Applications Manager UI pages or using the script.

  2. Install an app on a mobile device and verify if the server URL is accessible through the configuration screen in the mobile app by performing the following configuration steps:

    1. Enter the server URL in the following format: http(s)://<hostname>:<port>

    2. Check whether the configuration on the device was successful by logging into the app and verifying that you can access the app content.

    Please note the difference between the full configuration service URL used for validation in step 1 in this section and the server URL shared with the app users.

  3. Make sure the setup is valid at this point and ensure that your app works with the "Apps Local Login" (previously known as "HTTP Basic") authentication type before proceeding to any advanced configurations.

    1. In the Mobile Applications Manager UI pages, configure the mobile app with authentication type as "Apps Local Login".

      See: Configuring Parameters for the Apps Local Login Authentication Type.

    2. Log in to the mobile app as a user whose password is stored in Oracle E-Business Suite, such as sysadmin.

      You should be able to successfully log in and view the mobile app pages.

For more information about the configuration steps in earlier Oracle E-Business Suite Mobile Foundation releases, see Oracle E-Business Suite Mobile Foundation Release Update History in Oracle E-Business Suite Mobile Foundation Release Notes, My Oracle Support Knowledge Document 1642431.1.

Setting Up Mobile App Access to Responsibilities

Oracle E-Business Suite mobile apps use role-based access control to protect mobile app data from unauthorized access.

Most mobile apps have app-specific access roles. Only users who are assigned those app-specific roles can access the corresponding mobile apps. In order for those users to be able to access Oracle E-Business Suite data in a mobile app that invokes REST services, all REST services that the mobile app uses are grouped into a permission set that is then granted to an app-specific access role. To provide the mobile app access capability to existing Oracle E-Business Suite users, you must assign each access role to the responsibilities that you want to associate with the corresponding mobile app. Users who have the predefined mobile app access roles through those responsibilities will have access to the corresponding mobile apps.

Note: Oracle Mobile Approvals for Oracle E-Business Suite does not have an app-specific access role required for users to access the app.

For Oracle E-Business Suite mobile apps, responsibility selection is based on the combination of user role and mobile app. If the mobile app access role is assigned to a single responsibility, then the responsibility is automatically set and selected for a user using that mobile app. If a user has more than one responsibility to which the mobile app access role is assigned, then those responsibilities will be displayed for selection.

Please note that it is not required to create or assign any new responsibility to users to use mobile apps. For information on the app-specific access roles, see Mobile App Access Roles.

For information on creating new mobile app access roles if needed for enterprise distribution or custom apps for Oracle E-Business Suite, see Creating and Using Mobile App Access Roles, Oracle E-Business Suite Mobile Apps Developer's Guide Release 12.1 and 12.2.

Note: For the access roles created for enterprise-distributed apps, ensure to grant the REST services permission sets of the corresponding seeded apps to the app access roles. See: Mobile App REST Services Permission Sets.

Assigning Mobile App Access Roles to Responsibilities

To secure mobile app data, perform the following steps to assign predefined app-specific mobile app access roles to responsibilities:

  1. Log in to Oracle E-Business Suite as a user who has the User Management responsibility. For example, log in as SYSADMIN.

    Note: The User Management responsibility is assigned to the Security Administrator role. This seeded role is assigned to the SYSADMIN user by default.

  2. Select the User Management responsibility and navigate to the Roles and Role Inheritance page.

  3. Search for the responsibility you want.

  4. In the search results table, click the "View In Hierarchy" icon for your responsibility. Note that the codes for responsibilities start with FND_RESP, while the codes for roles start with UMX.

  5. In the Role Inheritance Hierarchy, click the Add Node icon for your responsibility.

    Oracle User Management displays the next role hierarchy page with a message informing you that the role you select will be inherited. In this page, either search or expand nodes until you find the app-specific access role that you want to add to the responsibility. Use the Quick Select icon to choose that role.

  6. Oracle User Management then displays the initial page again, with a confirmation message at the top. On this page, verify that the custom UMX role appears underneath the responsibility. You may need to expand one or more nodes to display the UMX role under the responsibility. Any other inherited roles appear as well.

  7. When you add the role to the responsibility, you must also update the associated grant for the app-specific access roles to reference the specific responsibility as the security context. You need a separate grant for each responsibility to which you are adding the role, so in some cases you should duplicate the shipped grant rather than updating it.

    In the row of the role that you just added, click the Update icon for your role to navigate to the Update Role page.

  8. In the Grants Table at the end of the page, if this is the first responsibility to which you are adding to the role, click the Update icon for the grant you want to update. If this is the second responsibility or more to which you are adding the role, click the Duplicate icon for the grant instead of the Update icon. In the duplicate grant, you must provide a unique name for the grant.

  9. Apply your changes.

If you want to use the app-specific access role with more than one responsibility, you must have a separate grant with a security context corresponding to each responsibility. You can also add grants for a given role as a separate process, rather than while you are adding the role to the responsibility. To do so, perform the following steps:

  1. In the User Management responsibility, navigate to the Roles and Role Inheritance page.

  2. Search for the app-specific access role you want.

  3. Click the Update icon for your role to navigate to the Update Role page.

  4. In the Grants Table at the end of the page, click the Duplicate icon for the grant you want to duplicate.

  5. Modify the grant name of the new grant to make it unique.

  6. In the Security Context region, enter the name of the additional responsibility to which you are adding the app-specific access role. Enter the name of a shipped responsibility from the table above, or, if you are using a custom responsibility, enter the name of that custom responsibility.

  7. Click Next, Next, Finish, and OK to complete your grant.

For more information, see the Oracle E-Business Suite Security Guide.

Additional Setup for Device Integration

This section describes additional setup steps if your mobile app integrates with person contact cards or maps on the mobile devices, and provides details about barcode integration. It includes the following topics:

  1. Setting Up Person Contact Cards

  2. Setting Up Maps

  3. Support for Barcodes

Setting Up Person Contact Cards

Mobile Apps Integrated with Person Contact Cards

The following Oracle E-Business Suite mobile apps integrate with person contact cards:

If your mobile app integrates with person contact cards and you would like to show the contact information within the context of the app, perform the setup tasks described in this section:

  1. Step 1: Setting Up a Qualifier

  2. Step 2: Scheduling the "HR Mobile Utils Person Data Full Synch" Concurrent Program

  3. Step 3: Allowing Apps to Access Local Contacts

Step 1: Setting Up a Qualifier

Setting up a qualifier involves the following key steps:

  1. Step 1.1: Creating a Qualifier

  2. Step 1.2: Identifying the Flexfield Structure for Your Business Group

  3. Step 1.3: Enabling the Qualifier for the Flexfield Segment

  4. Step 1.4: Adding the "HR Mobile Utils Person Data Full Synch" Concurrent Program to a Request Group

Step 1.1: Creating a Qualifier

Perform the following steps to create a qualifier for a key flexfield:

  1. Log in to Oracle E-Business Suite as a user who has access to the Application Developer responsibility. For example, log in as SYSADMIN.

  2. Select the Application Developer responsibility. Choose the Flexfield link, then the Key link, and then the Register link from the navigator. This displays the Key Flexfields window.

  3. In the Key Flexfields window, search for the flexfield with the title "Job Flexfield" and the application name “Human Resources”.

    Key Flexfields Window

    the picture is described in the document text

  4. Click the Qualifiers button. Enter the following case sensitive information in the Flexfield Qualifiers window and then save.

    • Name: Mobile

    • Prompt: Mobile

    • Ensure that the Global, Required, and Unique check boxes are not selected

    Flexfield Qualifiers Window

    the picture is described in the document text

Step 1.2: Identifying the Flexfield Structure for Your Business Group

Perform the following steps to identify the flexfield structure for your business group:

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

  2. Select the HRMS Manager responsibility. Choose the Work Structures link, then the Organization link, and then the Description link from the navigator.

  3. In the Find Organization window, query your business group in the Name field, such as "Vision Corporation". Click the Find button. This displays the Organization window for the selected organization.

  4. In the Organization Classifications region, select "Business Group" and click the Others button.

    Flexfield Structure in the Organization Window

    the picture is described in the document text

  5. The Additional Organization Information window appears. Select "Business Group Info".

    Additional Organization Information Window

    the picture is described in the document text

  6. Place the cursor in the Business Group Info field.

    Business Group Info Field in the Additional Organization Information Window

    the picture is described in the document text

  7. The complete Business Group Info window is displayed. This is the structure for the Job Flexfield for your business group. Copy the value in the Job Flexfield Structure field. This value will be used later to locate the flexfield that you want to qualify.

    Business Group Info Window

    the picture is described in the document text

Step 1.3: Enabling the Qualifier for the Flexfield Segment

After obtaining the key flexfield structure name for your business group, perform the following steps to qualify the key flexfield segment:

  1. From the navigator, select the Flexfield link, then the Key link, and then the Segment link.

  2. In the Key Flexfield Segments window, search for the flexfield with the application name "Human Resources" and the flexfield title that you obtained from the Job Flexfield Structure field described in Step 1.2: Identifying the Flexfield Structure for Your Business Group, such as "Job Flexfield".

  3. In the Structures region, select the Job Flexfield and then deselect the Freeze Flexfield Definition check box. This allows you to update the selected Job Flexfield definition. Click the Segments button. This displays the Segments Summary window for the selected Job Flexfield.

    Key Flexfield Segments Window

    the picture is described in the document text

  4. Select the segment you want to qualify and click the Flexfield Qualifiers button.

    Segments Summary Window for Job Flexfield

    the picture is described in the document text

  5. Select the qualifier "Mobile" and then select the Enabled check box to enable the selected qualifier for this segment. Save your work.

    Flexfield Qualifiers Window for the Selected Segment "Mobile"

    the picture is described in the document text

Step 1.4: Adding the "HR Mobile Utils Person Data Full Synch" Concurrent Program to a Request Group

Perform the following steps to add the "HR Mobile Utils Person Data Full Synch" concurrent program to a request group, and then run the program for the first time:

Note: Ensure that you have applied the patches for your app. The "HR Mobile Utils Person Data Full Synch" concurrent program should then be automatically created.

For patch information for each app, see Applying Prerequisite Patches.

  1. Log in to Oracle E-Business Suite as a user who has the System Administrator responsibility. For example, log in as SYSADMIN.

  2. Select the System Administrator responsibility. Choose the Security link, then the Responsibility link, and then the Define link from the navigator. This displays the Responsibilities window.

  3. In the Responsibilities window, search for the responsibility, such as "US Super HRMS Manager", that you want to run the "HR Mobile Utils Person Data Full Synch" concurrent program.

    Responsibilities Window

    the picture is described in the document text

  4. In the Request Group region, record the value of the request group Name field which in this example is "US SHRMS Reports & Processes" for the "US Super HRMS Manager" responsibility. Close the window.

  5. From the navigator, select the Security link, then the Responsibility link, and then the Request link. This displays the Request Groups window.

  6. In the Request Groups window, search for the request group name "US SHRMS Reports & Processes" you recorded earlier in the Group field.

  7. In the Requests region, click the New icon to add the "HR Mobile Utils Person Data Full Synch" concurrent program to this security group. Save your entry and close the window.

    Request Groups Window for Adding the "HR Mobile Utils Person Data Full Synch" Concurrent Program

    the picture is described in the document text

  8. From the navigator, select the Requests link and then the Run link. This displays the Submit Request window.

  9. Enter the "HR Mobile Utils Person Data Full Synch" concurrent program as the request name.

    Submit Request Window for Selecting the Concurrent Program

    the picture is described in the document text

    The Parameters window appears.

    Parameters Window

    the picture is described in the document text

  10. Select "Person Card" as the Process Name parameter. Click OK and Submit to execute the request for the first time. This concurrent request refreshes the related HR tables with the person data.

Step 2: Scheduling the "HR Mobile Utils Person Data Full Synch" Concurrent Program

After adding the "HR Mobile Utils Person Data Full Synch" concurrent program to a request group and executing the concurrent request for the first time, you can schedule the concurrent request be run at the desired frequency to refresh the related tables with the latest person data.

Step 3: Allowing Apps to Access Local Contacts

After the setup mentioned above is complete and an iOS mobile user has installed an app that integrates with person contact cards, the first time the user accesses a page that has person contacts embedded within it, the app will request permission to access the user's local contacts on the iOS mobile device.

Note: Unlike iOS mobile users, Android users do not have the option to choose whether or not to grant an app permission to access the local contacts on the devices. While installing an app from Google Play, users must grant the following permissions to the app:

If a user does not grant these permissions, then the app will not be installed.

After installing the app, users can review the permissions by tapping Settings, then App Name, and then Permissions on their Android devices.

For example, Oracle Mobile iProcurement for Oracle E-Business Suite requests the permission to access the user's local contacts on the iOS device as shown below:

Permission to Access Local Contacts in My Requisitions Screen

the picture is described in the document text

Note: iOS mobile users can modify the setting that determines whether the app can access local contacts at any time by tapping Settings, then Privacy, and then Contacts on their iOS devices.

On Android devices, and if the user gives permission on an iOS device, the app will fetch the person information from the local contacts along with the enterprise information from Oracle E-Business Suite as shown below.

Local Contacts and Enterprise Information Shown in the Mobile Page

the picture is described in the document text

In this case, the user can also save enterprise contact information to add or update local contacts. If the user does not allow the app to access the local contacts on the iOS device, then the app displays only the enterprise contact information from Oracle E-Business Suite, and the user cannot save this information to the local contacts on the device.

Note: Saving person contacts will not save the person's image to local contacts on the Android devices. The app on Android always displays the images for the person contacts from enterprise contacts. If the image of an enterprise contact is not present, then the app displays the person contact only without the image on the Android devices.

Note: Oracle E-Business Suite mobile apps use the email address for an enterprise contact to determine whether the enterprise contact matches any existing local contact on the device.

Please note that if the setup tasks for person contact cards are not performed properly, depending on how your app is integrated with person contact cards, either the app page that includes person contact (such as the Requisition page shown above) shows a blank page with no data on it or the person contact details (such as the contact details for Pat Stock in this example) are not shown on the page.

For information on setting up person contact cards, see Setting Up Person Contact Cards.

Setting Up Maps

Mobile Apps Integrated with Maps

The following Oracle E-Business Suite mobile apps integrate with maps:

For example, Oracle Mobile Product Information for Oracle E-Business Suite presents the supplier information and its geographical location in a Google map as shown below.

Mobile Page with a Google Map

the picture is described in the document text

Note: Any use of this map is subject to Google's Privacy Policy and not Oracle's Privacy Policy.

Oracle Mobile Maintenance for Oracle E-Business Suite presents the asset information and its geographical location in an Oracle map as shown below.

Mobile Page with an Oracle Map

the picture is described in the document text

Setting Up Google Maps

To integrate your mobile app with Google Maps, set the "CSF: Google Map Key" profile option value on the Oracle E-Business Suite instance to the Google Map JavaScript API license key. You can obtain this key by registering with Google, Inc.

If you do not provide a license key as the profile value, the map feature in Oracle E-Business Suite mobile apps will be disabled. The app users can view data (such as supplier information as shown in the screenshot) displayed in a list only. If the provided license key is not valid, even though the app displays the map option, the Google map will not be rendered when a user taps the map option. An error message also occurs indicating it is an invalid license key.

For information on how to set this profile option, see the Oracle Field Service Implementation Guide.

Support for Barcodes

Some Oracle E-Business Suite mobile apps provide support through the Cordova plugin for scanning barcodes to capture data or scanning an item or work order.

Note: There is no additional setup task required to integrate Oracle E-Business Suite mobile apps with barcodes.

For example, Oracle Mobile Maintenance for Oracle E-Business Suite uses barcode scanning to capture data for assets, work orders, and work requests.

Data Captured and Shown in the Mobile Page Using Barcode Scanning

the picture is described in the document text

Mobile Apps Integrated with Barcodes

The following Oracle E-Business Suite mobile apps integrate with barcodes:

Supported Barcode Types

For mobile apps that include barcode scanning, the following barcode types are supported:

Additional App-Specific Setup

Perform any appropriate app-specific implementation steps described in each release note of the following mobile apps:

For the list of Oracle E-Business Suite mobile apps mentioned here, see the Oracle E-Business Suite Mobile Apps, Release 12.1 and 12.2 Documentation Index, My Oracle Support Knowledge Document 1641772.1.

Additional Setup for Deploying Mobile Apps with Enterprise Mobility Management Solutions

Starting from Oracle E-Business Suite Mobile Foundation 8.0, administrators can preconfigure Server URL in an Enterprise Mobility Management (EMM) console before deploying Oracle E-Business Suite mobile apps to users. These apps include:

To enable this feature, administrators need to perform required setup tasks to preconfigure the Server URL that the apps will use to connect to Oracle E-Business Suite. Once the setup tasks are complete, app users no longer need to enter this URL manually after launching an app installed from an EMM's app catalog.

For information about integration with EMM solutions and the setup tasks to preconfigure the Server URL for mobile apps, see Integrating Oracle E-Business Suite Mobile Apps with Enterprise Mobility Management Solutions.

Communicating Mobile App Information to Users

After you have completed the setup tasks for your app, provide the following information required to access the app to the users who will install and use the mobile app: