Supported Properties in the Login Component

Supported Properties

The following table lists all the properties in the ebs.properties file and how each property can be used to implement different features of the Login component 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.

Important: If you have already copied and modified the ebs.properties file from a previous version of the Login component, you need to manually merge the new ebs.properties file into your existing file and configure the new properties appropriately.

Property Name Description Possible Values
oracle.ebs.login.server.url
(available from Oracle E-Business Suite Mobile Foundation Release 8.0 and onwards)		 This is the Oracle E-Business Suite server URL that an app will use to connect to Oracle E-Business Suite by default. If a valid Oracle E-Business Suite server URL is entered for this property, the app users will not be prompted to enter a Server URL when the app is launched for the first time. A valid Oracle E-Business Suite Server URL, such as https://example.com
oracle.ebs.login.server.url.allow_change
(available from Oracle E-Business Suite Mobile Foundation Release 8.0 and onwards)		 If a default Oracle E-Business Suite server URL is used in property oracle.ebs.login.server.url, this property indicates whether mobile users are allowed to change it in an app.
By default, mobile users are not allowed to change the server URL. Change its value to Y only if you allow users to change the default server URL.		 Y or N
oracle.ebs.login.useresppicker

  • N: Do not use the responsibility picker in the app. Your app does not require application responsibility context to retrieve data from Oracle E-Business Suite.

  • Y: Use the responsibility picker in the app. Your app requires application responsibility context. This will display the responsibility picker after a user signs in to the app for the first time.

 Y or N
oracle.ebs.login.init.defaultfeature If oracle.ebs.login.useresppicker=Y, this property should point to the MAF feature Id of the page for any additional steps in the context initialization flow after a user picks a responsibility in the Responsibility Picker screen. For example, if the organization picker is required for your app after a responsibility is selected, then the value of this property would be the feature Id of the organization picker. This property is applicable only when oracle.ebs.login.useresppicker=Y. Valid MAF Feature Id
oracle.ebs.login.responsibilitypicker.usedonebutton

  • Y: Show the Done button on the Responsibility Picker screen. This marks the end of the context initialization flow and after a user taps the Done button, the Login component shows the app's landing page.

  • N: Show the Next button on the Responsibility Picker screen. This means that a user can continue to the next step in the context initialization flow and the app displays the feature set in the property oracle.ebs.login.init.defaultfeature. This property is applicable only when oracle.ebs.login.useresppicker=Y.

 Y or N
oracle.ebs.login.initializeresp

  • Y: The responsibility context is initialized when a user leaves the Responsibility Picker screen (either using the Done or Next button) and the selected responsibility is stored in the local database.

  • N: The selected responsibility is set to application scope variables but the context is not initialized. Developers should read the selected responsibility value from the application scope variables, store it in the local database using the provided API and initialize required context.

    This scenario is useful when the app uses the organization picker immediately following the responsibility picker. This gives developers the control on when the security context is initialized. This property is applicable only when the oracle.ebs.login.useresppicker=Y.

 Y or N
oracle.ebs.login.app.defaultfeature This is the MAF feature Id of the app's functional default landing page after the application context is initialized. This is the first feature that a user will see after the user logs in once the initial setup is completed. This property value can also be updated from the application using the API PreferenceStore.setDefaultFeature(String userName, String featureId); Valid MAF Feature Id
oracle.ebs.login.dbname Do not use. Oracle Internal use only.  
oracle.ebs.login.dbkey Do not use. Oracle Internal use only.  
oracle.ebs.login.sql This is the path to a SQL file that contains required DML statements to create a local database on the device. This database is specific a mobile app in which the app data can be stored on the device. The .sql file should be placed inside the .adf/META-INF/ebs folder.
For example, .adf/META-INF/ebs/myapp.sql.		 Path to SQL file
oracle.ebs.features.settings.id This is the MAF feature Id of the app's Settings feature that is accessible from Springboard. This property is required when oracle.ebs.login.useresppicker=Y. Valid MAF Feature Id of the Settings feature
oracle.ebs.login.rolecode This is the internal code of the mobile app access role that is granted to certain responsibilities that can access this mobile app. If your app requires the responsibility context (oracle.ebs.login.useresppicker=Y), it is required that you create a role using the User Management responsibility, grant that role to the responsibilities that can access this app. The same role code should be set up in this property. A valid UMX role code
oracle.ebs.login.roleappname Application Code to which the mobile app access role belongs.
For example, FND, PO, EAM and so on.		 App short name
oracle.ebs.login.rolemode Leave the default value "parent". parent
oracle.ebs.login.springboard.type Use List only. Grid is not supported. List, Grid
oracle.ebs.login.android.eulahtmllocation This is the location of End User License Agreement (EULA) for your app's Android users and is placed under .adf/META-INF/ebs. The file should be formatted in HTML.
For example, .adf/META-INF/ebs/Android-EULA.html.		 Valid HTML file path
oracle.ebs.login.ios.eulahtmllocation This is the location of End User License Agreement (EULA) for your app's iOS users and is placed under .adf/META-INF/ebs. The file should be formatted in HTML. For example, .adf/META-INF/ebs/iOS-EULA.html. Valid HTML file path
oracle.ebs.login.branding.showeula Enable or disable the feature of showing the EULA content.

  • Y: Show the EULA content when the app is launched for the first time and in the About screen.

  • N: Hide the EULA content when the app is launched for the first time and in the About screen.

 Y or N
oracle.ebs.login.branding.copyrightfilelocation This is the location of a text file that contains any copyright content for the app. This property is required only if the app has any copyright text in the About screen of the app. For example, .adf/META-INF/ebs/My-Copyright.txt. Valid text file path
oracle.ebs.login.branding.privacypolicyurl URL to the company's privacy policy page to be shown to the users in the About screen of the app. Valid URL
oracle.ebs.login.branding.applogo.location App logo (same as the app launch icon with rounded corner) with size 152x152.
This logo is shown on the About screen of the app. For example, .adf/META-INF/ebs/my_app_icon.png.		 PNG image file location
oracle.ebs.login.bundle.name Full XLF bundle name in which your app's translatable app name is stored. If your app's name is "Product Information", you should define the value in the ViewController project bundle and include its path here. A bundle with a fully qualified name
oracle.ebs.login.appname App name to show on the Server URL, Springboard and About screens. This property takes the following values:

  • Actual value of the app, such as "Approvals", "Product Information" and so on. Such values are shown on the app as is and not translated.

  • EL expression that evaluates to a translated string from the XLF bundle setup mentioned earlier for the property oracle.ebs.login.bundle.name.

 An EL or a constant
oracle.ebs.login.branding.corporatelogo.style Styling for the corporate logo to be shown in the Server URL screen. This property takes the height and width styles for the corporate logo. The height and width should be specified in pixels. The height and width values should be one half of the actual height and width of the image. For example, if a corporate logo image is 408 by 92 pixels, then the value of this property would be width:204px; height:46px. Height and width style values in pixels
oracle.ebs.login.development.mode

  • Y: Run the app in the developer mode. The app does not show the EULA and Server URL screens.

  • N: Default value if this property is not set. The app runs in the production mode.

 Y or N
oracle.ebs.login.development.server.url Oracle E-Business Suite server URL that an app will connect to. This property is used only if the developer mode is turned on. Valid Oracle E-Business Suite server URL
oracle.ebs.login.development.logging.finest

  • Y: Turn on FINE Logging for the app.

  • N: Default value if this property is not set.

    This property is used only if the developer mode is turned on.

 Y or N