17 Deploying ADF Mobile Applications

This chapter describes how to deploy ADF Mobile applications for testing and for publishing.

This chapter includes the following sections:

17.1 Introduction to Deployment of Mobile Applications

Before you can publish an application for distribution to end users, you must test it on a simulator or on an actual device to assess its behavior and ease of use. By deploying an iOS application bundle (.ipa and .app files) or Android application package (.apk) file to the platform-appropriate device or simulator, ADF Mobile enables you to test applications before publishing them to the App Store (Apple iTunes), or to an application marketplace, such as Google Play.

17.1.1 How ADF Mobile Deploys Applications

ADF Mobile executes the deployment a project by copying a platform-specific template application to a temporary location, updating that application with the code, resources, and configuration defined in the ADF Mobile project. ADF Mobile then builds and deploys the application using the tools of the target platform. The tasks that comprise deployment are as follows:

  1. Validate that the platform-specific build tools are available from the specified platform SDK.

  2. Validate the application's content, including the XML files.

  3. If necessary, unzip the platform-dependent template file to a temporary location.

    Note:

    The template file may not be present if you selected Build > Clean All.

  4. Copy default images to the proper location in the template.

  5. Copy custom images to the proper location in the template.

  6. Copy the web content (including any images related to feature application) to the template location.

  7. Copy the libraries of the Java Virtual Machine 1.4 (JVM 1.4) and any support libraries to the proper location in the template. For more information, see Section 17.1.1.2, "Deployment of the JVM 1.4 Libraries."

  8. Copy custom content into the proper location in the template (this includes libraries and JAR files that have been included in the project properties).

  9. Copy, or update, the metadata files in the template with preferences defined in the deployment profiles and the adfmf-application.xml and adfmf-feature.xml files.

  10. Run the platform-specific build tools on the template project.

  11. Run the platform-specific tools on the template project to sign the project (if necessary) and package the project for the chosen deployment.

For a detailed description of the deployment flow for Android applications, see Section 17.2.3.6, "What Happens in JDeveloper When You Deploy an Application to an Android Emulator or Android-Powered Device." For iOS applications, see Section 17.4.5.1, "What Happens in JDeveloper When You Deploy an Application to an iOS Simulator or iOS-Powered Device."

17.1.1.1 Deployment of Project Libraries

The libraries that you declare for the project using the Customize Libraries and Classpaths Dialog, shown in Figure 17-1, are included in the deployment artifacts for the project. This dialog enables the application features to access these libraries at runtime.

Figure 17-1 Adding Libraries to the Project

Selected project libraries are deployed.

17.1.1.2 Deployment of the JVM 1.4 Libraries

For both Android and iOS applications, each ADF Mobile deployment includes a set of a different libraries that are specific to the type of deployment (release or debug) in combination with the deployment target (simulators or actual devices). In addition, each set of these libraries includes a JAR file of JVM 1.4. The application binding layer resides within this virtual machine, which is a collection of Objective-C libraries. For example, ADF Mobile deploys a JVM 1.4 JAR file and a set of libraries for a debug deployment targeted at an iOS simulator, but deploys a different JVM 1.4 JAR file and set of libraries to a debug deployment targeted to an actual iOS-powered device.

17.2 Working with Deployment Profiles

Preparing ADF Mobile applications for deployment begins with the creation of platform-specific deployment profiles. A deployment profile defines how an application is packaged into the archive that will be deployed to iOS- or Android-powered devices, iOS simulators, or Android emulators. The deployment profile does the following:

  • Specifies the format and contents of the archive. For iOS, the archive format is an .ipa file, known as an application bundle. For Android, the format is an Android application package (.apk) file.

    Note:

    The .apk file is archive-compatible, meaning that you can view its contents using an archiving tool such as WinZip or 7-Zip.

  • Lists the source files, deployment descriptors, and other auxiliary files that will be packaged into the archive file.

  • Describes the type and name of the archive file to be created.

  • Highlights dependency information, platform-specific instructions, and other information.

17.2.1 How to Create a Deployment Profile

As described in Section 4.2.2.3, "About Automatically Generated Deployment Profiles," ADF Mobile creates a set of deployment profiles when you create an ADF Mobile application. You can deploy an application using these profiles, edit them, or construct new ones using the ADF Mobile-specific deployment profile pages. The Create Deployment Profile wizard, shown in Figure 17-2, enables you to create a default deployment profile from these pages. You can create as many deployment profiles as needed. For more information on these standard ADF deployment profile pages, click Help to see the JDeveloper online help.

Note:

ADF Mobile application deployment only requires the creation of an application-level deployment profile; you do not have to create a view controller-level deployment profile.

Before you begin:

To enable JDeveloper to deploy ADF Mobile applications, you must designate the SDKs for the target platforms using the ADF Mobile Preferences page as described in Section 3.3.1, "How to Configure the Development Environment for Platforms and Form Factors." See also the Certification and Support Matrix on Oracle Technology Network (http://www.oracle.com/technetwork/developer-tools/jdev/jdev11gr2-cert-405181.html).

Tip:

For iOS deployments, run iTunes and the iOS Simulator at least once before you configure their directory locations in the ADF Mobile Platforms preferences page.

To create a deployment profile:

  1. Choose Application and then Deploy.

  2. Choose New Deployment Profile.

  3. Depending on the target platform, select either ADF Mobile for Android, ADF Mobile for iOS, or ADF Mobile Application Archive, as shown in Figure 17-2.

  4. Accept the default name for the profile or enter a new one. Click OK.

  5. If needed, use the Options and Application Images pages as required for the applications and then click OK.

    Figure 17-2 The Create Deployment Profile Wizard

    Select the type of deployment profile.

17.2.2 What Happens When You Create a Deployment Profile

After you complete the wizard, JDeveloper creates a deployment profile and opens the Deployment Profile Properties editor.

Table 17-1 lists the ADF Mobile-specific pages in the Deployment Profile Properties editor, shown in Figure 17-7.

Table 17-1 ADF Mobile-Specific Deployment Profile Pages

Page Function

iOS Options

Enables you to modify the settings for an application to be deployed on an iOS-powered device or iOS simulator.

Android Options

Enables you to modify the settings for an application deployed to an Android-powered device or Android emulator.

Application Images

Enables you to assign custom icons to an application by adding the appropriate graphics file.

Device Orientations

Enables you to restrict the display of an application to certain device orientations. This page is used only for iOS deployment profiles.

Note:

Deployment depends on the needs of your application. You can deploy an application using the default values seeded in the pages listed in Table 17-1.

When you deploy an application, JDeveloper creates a deployment directory and related subdirectory. It also creates Feature Archive files (FARs) for the view controller projects (which must have different names) and application controller project. In addition to these two FARs, JDeveloper creates copies of any FARs that were imported into the project. Changes to the compilation profiles require the removal of the deployment directory. You can remove this directory, as well as the deployment directory within the view controller project that contains the FAR, by selecting Build and then Clean All.

Using the Filters panel, shown in Figure 17-3, you can exclude any selected artifact from being deployed. In particular, you can use the Filters panel to exclude any artifact that does not match the target deployment platform. For more information, refer to the online help for Oracle JDeveloper.

Figure 17-3 Removing Files from Deployment Using the Filters Panels

The Filters panel.

17.2.3 How to Create an Android Deployment Profile

The deployment profile creates the template for the application deployment to an Android device or emulator, or for creating an application as an Android application package (.apk) file.

To create the deployment profile for Android, you must define the signing options for the application, the behavior of the javac compiler, and if needed, override the default Oracle images used for application icons with custom ones.

Before you begin:

Install and download the Android SDK as described in Section 3.5, "Setting Up Development Tools for Android Platform."

To enable ADF Mobile deployment framework to compile files required for push notifications, install the package for the Google Cloud Messaging Library (Revision 3 and later) in the Android SDK Manager, as shown in Figure 17-4.

Figure 17-4 The Google Cloud Messaging For Android Library Package

Install Google Cloud Messaging Android Library.

If you deploy to an Android emulator, you must create a virtual device for each emulator instance using the Android Virtual Device Manager, as described in the "Managing Virtual Devices" document, available from the Android Developers website (http://developer.android.com/tools/devices/index.html). In creating an Android Virtual Device (AVD), ensure that the CPU/ABI value reflects an ARM system image, such as ARM (armeabi-v7a) in Figure 17-5. In addition, set the size of the AVD's SD card image file to a large RAM size, such as the value of 1024 MB (1 GB) set for the Device ram size property in Figure 17-5. You can, however, opt for a smaller size.

Note:

ADF Mobile only supports the ARM EABI v7a System Image. Although ADF Mobile supports Android-powered devices that run on the Android 2.3.n platform (API Level 9), it does not support deployment to emulators running on this platform because they are based on the ARM926EJ-S rev 5 (v51) processor. Further, JVM 1.4 cannot run properly when deployed to Android emulators for the 2.n platform.

Figure 17-5 Creating an Android Virtual Device

Ensure that ARM is the CPU.

You must also set the ADF Mobile preferences for the Android platform SDKs (accessed by choosing Tools, then Preferences, then ADF Mobile, then Platforms, and then Android) to point to the locations for the Android SDK itself and its tool components.

The SDK and platform locations for Android 4.2 (API 17) differ from previous versions, which are illustrated by the directory structures in Figure 17-6.

  • For Android SDK Location, the path is:

    SDK Installation\adt-bundle-windows-x86\sdk

    For example, enter:

    C:\adt-bundle-windows-x86\sdk

  • For Android Platform Location, the path is:

    SDK Installation\adt-bundle-windows-x86\sdk\platforms\android-17

    For example, enter:

    C:\adt-bundle-windows-x86\sdk\platforms\android-17

    Note:

    The structure of the SDK tools is changed in the release of Revision 22, with the build tools components relocated from the platform-tools directory to the build-tools directory. To enable deployment, the Android Build Tools Location field must reference the location of one of these build tools, the aapt file (aapt.exe on Windows systems). The location of this file differs depending on the SDK revision. For Revision 22, this file is located within the build-tools directory (such as SDK Installation\adt-bundle-windows-x86\sdk\build-tools\Android-4.n). For earlier revisions, it is located within the platform-tools directory (such as SDK Installation\adt-bundle-windows-x86\platfrom-tools).

    ADF Mobile queries the Android SDK for the location of the appt file and populates the Android Build Tools Location field accordingly. For Revision 22 of the SDK, ADF Mobile populates the field with the latest version of the build-tools directory that is installed on the development computer. For revisions prior to 22, ADF Mobile populates the field with the location of the platform-tools directory. In this case, the field is read-only.

Note:

Push notifications require devices and emulators running Android 2.2 platform (or later). The Google Play store must be installed on these devices. The Google API must be installed in the SDK to enable push notifications on emulators. Users must create a Google account (and be logged in) on devices running platforms earlier than 4.0.4 (API 15).

See also "GCM Architecture Overview" chapter in Google Cloud Messaging for Android, available from the Android Developers website (http://developer.android.com/index.html) and Section 17.2.3, "How to Create an Android Deployment Profile."

Figure 17-6 Setting the Android SDK, Platform, and Signing Properties

Setting the Android SDK and platform information.

Using the Platforms page, you also define the debug and release properties for a key that is used to sign the Android applications. Within the deployment profile, you subsequently designate an ADF Mobile application's release as either debug or release. You only need to define the signing key properties once. For more information, see Section 17.2.3.3, "Defining the Android Signing Options." See also the application publishing information in the "Signing Your Applications" document, available from the Android Developers website (http://developer.android.com/tools/publishing/app-signing.html).

Note:

To deploy an application to an Android emulator, you must install API 14 or later (that is, Platform 4.0.n)

17.2.3.1 Setting the Options for the Application Details

The Android Options page, shown in Figure 17-7, enables you to do the following:

  • Denote the version of the application. For more information, refer to the "Versioning Your Applications" document, available from the Android Developers website (http://developer.android.com/tools/publishing/versioning.html).

  • Configure the Android zipalign tool, an archive alignment tool that optimizes the packaging of .apk files. Data files stored in each application package, such as data manifests, are continually accessed by multiple processes within the Android operating environment. For more information, see the "zipalign" document, available from the Android Developers website (http://developer.android.com/tools/help/zipalign.html).

  • Set the logging level output as either non-verbose or debug (verbose).

  • Set the signing options appropriate to the deployment target (emulator or device). For more information, see Section 17.2.3.3, "Defining the Android Signing Options."

Figure 17-7 The Deployment Profile Properties Editor (Android Options Page)

Enter basic Android deployment options.

To set the application options:

  1. Choose Android Options, as shown in Figure 17-7.

  2. Accept the default values, or define the following options:

    • Application Bundle ID—A unique ID for the application, as set in the id attribute of the adfmf-application.xml file. Each application deployed to an Android device has a unique ID, one that cannot start with a numeric value. For more information, see Section 5.3, "Setting the Basic Information for an ADF Mobile Application."

      If needed, you can override this value in the deployment file. However, for the application to deploy, this name must follow the <manifest> element's package attribute of the Android manifest file. This element is described in the document entitled "The AndroidManifest.xml File," which is available from the Android Developers website (http://developer.android.com/guide/topics/manifest/manifest-intro.html). Specifically, the ID uses a reverse package format of an internet domain (com.company.application). To avoid naming collisions, the package name reflects domain ownership, such as com.oracle.application.

      Note:

      The application bundle ID cannot contain spaces.

    • Application Archive Name—If needed, enter the name for the .apk file created by ADF Mobile. Otherwise, accept the default name.

      By default, ADF Mobile bases the name of the .apk file on the application id attribute configured in the adfmf-application.xml file. For more information, see Section 5.3, "Setting the Basic Information for an ADF Mobile Application."

    • Version Name—The release version of the application code that displays for the user. See also Section 5.3, "Setting the Basic Information for an ADF Mobile Application."

    • Version Code—An integer value that represents the version of the application code, which is checked programmatically by other applications for upgrades or downgrades. The minimum and default value is 1. You can select any value and increment it by 1 for each successive release.

17.2.3.2 Setting Deployment Options

The Options page enables you to set values that are passed in by the javac compiler tool options, set the zipalign options, and also the Android API revisions.

To set the JDK-Compatibility level for the R.java and .class files:

  1. Select the JDK-compatibility level from the Source Files dropdown list. The default value is 1.5. The value is specified when the deployment runs the javac tool to compile R.java, the Android-generated file for referencing application resources, using the javac -source option. Available values include:

    • 1.5

    • 1.6

    For information on R.java, see the "Accessing Resources" document, available from the Android Developers website (http://developer.android.com/guide/topics/resources/accessing-resources.html).

  2. Select the JDK version compatibility for the compiled .class files from the Class Files dropdown list. The value is specified when the deployment runs the javac tool to compile the R.java file using the javac -target option. The default value is 1.5. Available values include:

    • 1.5

    • 1.6

  3. Select the intended API Level on which the application is designed to run from the Target SDK API Level dropdown list. The minimum (and default) value is API Level 9, which corresponds to the Android 2.3.n platform. For more information, refer to the description of the <uses-sdk> attribute in the document entitled "The AndroidManifest.xml File," available through the Android Developers website (http://developer.android.com/guide/topics/manifest/manifest-intro.html).

  4. Select the minimum API Level on which the application is able to run from the Minimum SDK API Level dropdown list. The minimum and default value is 9, which corresponds to Android 2.3.n platform.

  5. Select the native-encoding name that controls how the compiler interprets characters beyond the ASCII character set from the Character Encoding dropdown list. The default is UTF-8.

To set the ZIP alignment options:

Select the byte alignment (32-bit or 64-bit). Selecting 32-bit (the default) provides 4-byte boundary alignment.

To set the logging level:

Select Verbose Output for the Android deployment to log the full output provided by each of the command-line tools invoked by the deployment while building the .apk. If you do not select this option, then the deployment does not log the full output.

17.2.3.3 Defining the Android Signing Options

An application must be signed before it can be deployed to an Android device or emulator. Android does not require a certificate authority; an application can instead be self-signed.

Defining how the deployment signs an ADF Mobile application is a two-step process: within the ADF Mobile Platforms preference page, you first define debug and release properties for a key that is used to sign Android applications. You only need to configure the debug and release signing properties once. After you define these options, you configure the deployment profile to designate if the application should be deployed in the debug or release mode.

Before you begin:

If no keystore file exists, you can create one using the keytool utility, as illustrated in Example 17-1.

Example 17-1 Generating a Keystore

keytool -genkey
        -v
        -keystore c:\jdeveloper\mywork\releasesigning.keystore
        -alias releaseKeyAlias
        -keyalg RSA
        -keysize 2048
        -validity 10000

As described in the "Signing Your Applications" document, available from the Android Developers website (http://developer.android.com/tools/publishing/app-signing.html), the keytool prompts you to provide passwords for the keystore and key, and to provide the Distinguished Name fields for your key before it generates the keystore. In Example 17-1, the keystore contains a single key, valid for 10,000 days. Refer to Java SE Technical Documentation (http://download.oracle.com/javase/index.html) for information on how to use the keytool utility.

Tip:

Use the -genkeypair instead of the -genkey command for Java Platform Standard Edition (Java SE) 7.

To configure the key options for the debug mode:

  1. Choose Tools, then Preferences, and then ADF Mobile.

  2. Choose Platforms.

  3. Select the Debug tab, shown in Figure 17-8.

    Figure 17-8 Configuring a Debug Deployment

    Select, or accept the default password (Android).

  4. Enter a password used by the deployment to create a keystore file and key needed for a debug deployment in the Key and Keystore Password field. This password, which generates a keystore and keyfile for deployment to an Android-powered device or emulator, can be any value, but must be at least six characters long. The default password is Android.

To configure the key options for a release mode:

  1. Choose Tools, then Preferences, and then ADF Mobile.

  2. Choose Platforms.

  3. Select the Release tab, shown in Figure 17-6, and then define the following:

    • Keystore Location—Enter, or browse to and retrieve, the directory of the keystore containing the private key used for signing the application for distribution.

    • Keystore Password—Enter the password for the keystore. This password allows access to the physical file.

    • Key Alias—Enter an alias for the key. This is the value set for the keytool's -alias argument. Only the first eight characters of the alias are used.

    • Key Password—Enter the password for the key. This password allows access to the key (identified by the alias) within the keystore.

      Tip:

      Enter the password and key password requested by the keytool utility before it generates the keystore.

      In addition to designating how the application will be signed, these parameters designate how the R.Java classes are compiled. For more information, see Section 17.2.3.6, "What Happens in JDeveloper When You Deploy an Application to an Android Emulator or Android-Powered Device."

  4. Click OK.

To Set the Android build mode:

  1. In the Options page, select either Debug or Release as the build mode:

    • Select Debug for developing and testing an application (such as Java and JavaScript debugging). This option enables you to deploy an application on the Android platform without having to provide a private key. Use this option when deploying an application to an Android emulator or to an Android-powered device for testing. See also Section 19.3.4, "How to Enable Debugging of Java Code and JavaScript."

      Note:

      You cannot publish an application signed with the debug keystore and key; this keystore and key are used for testing purposes only and cannot be used to publish an application to end users.

    • When the application is ready to be published, select Release. Use this option when the application is ready to be published to an application marketplace, such as Google Play.

      Tip:

      Use the release mode, not the debug mode, to test application performance.

  2. Click OK.

    After the .apk file is signed in either the debug or release modes, you can deploy it to a device or to an emulator.

17.2.3.4 How to Add a Custom Image to an Android Application

Enabling ADF Mobile application icons to display properly on Android-powered devices of different sizes and resolutions requires low-, medium-, and high-density versions of the same images. ADF Mobile provides default Oracle images that fulfill these display requirements. However, if the application requires custom icons, you can use the Application Images page, shown in Figure 17-9, to override default images by selecting PNG-formatted images for the application icon and for the splash screen. For the latter, you can add portrait and landscape images. If you do not add a custom image file, then the default Oracle icon is used instead. To create custom images, refer to the "Iconography" document, available from the Android Developers website (http://developer.android.com/design/style/iconography.html).

Figure 17-9 Setting Custom Images for an Android Application

Use to override the default image.

Before you begin:

Obtain the images in the PNG, JPEG, or GIF file format that use the dimensions, density, and components that are appropriate to Android theme and that can also support multiple screen types. For more information, see "Supporting Multiple Screens" document, available from the Android Developers website (http://developer.android.com/guide/practices/screens_support.html).

To add custom images:

  1. Click Application Images.

  2. Use the Browse function to select the splash screen and icon image files from the project file. Figure 17-9 shows selecting images for application icons and portrait orientation splash screen images that applications use for displaying on devices with low-, medium-, high- and extra-high density displays. Figure 17-10 shows the Landscape tab selected for splash screen images, which enables you to add the landscape-orientation splash screen images that applications use for devices with low-, medium-, high- and extra-high density displays. These files can be located anywhere within the ADF Mobile application.

  3. Click OK.

    Figure 17-10 Setting Landscape Splash Screen Images

    Landscape splash-screen images.

17.2.3.5 What Happens When JDeveloper Deploys Images for Android Applications

During deployment, ADF Mobile enables JDeveloper to copy the images from their source location to a temporary deployment folder. For the default images that ship with the ADF Mobile extension (located at application workspace directory\Application Resources\Resources\images), JDeveloper copies them from their seeded location to a deployment subdirectory of the view controller project (application workspace\ViewController\deploy). As shown in Table 17-2, each image file is copied to a subdirectory called drawable, named for the drawable object, described on the Android Developers website (http://developer.android.com/reference/android/graphics/drawable/Drawable.html). Each drawable directory matches the image density (ldpi, mdpi, hdpi, and xhdpi) and orientation (port, land). Within these directories, JDeveloper renames each icon image file as adfmf_icon.png and each splash screen image as adfmf_loading.png.

Table 17-2 Deployment File Locations for Seeded Application Images

Source File (...\resource\Android) Temporary Deployment File (...ViewController\deploy)

display-ldpi-icon.png

drawable-ldpi\adfmf_icon.png

display-mdpi-icon.png

drawable-mdpi\adfmf_icon.png

display-hdpi-icon.png

drawable-hdpi\adfmf_icon.png

display-xhdpi-icon.png

drawable-xhdpi\adfmf_icon.png

display-port-ldpi-splashscreen.png

drawable-port-ldpi\adfmf_loading.png

display-port-mdpi-splashscreen.png

drawable-port-mdpi\adfmf_loading.png

display-port-hdpi-splashscreen.png

drawable-port-hdpi\adfmf_loading.png

display-port-xhdpi-splashscreen.png

drawable-port-xhdpi\adfmf_loading.png

display-land-ldpi-splashscreen.png

drawable-land-ldpi\adfmf_loading.png

display-land-mdpi-splashscreen.png

drawable-land-mdpi\adfmf_loading.png

display-land-hdpi-splashscreen.png

drawable-land-hdpi\adfmf_loading.png

display-land-xhdpi-splashscreen.png

drawable-land-xhdpi\adfmf_loading.png

For custom images, JDeveloper copies the set of application icons from their specified location to the corresponding density and orientation subdirectory of the temporary deployment location.

17.2.3.6 What Happens in JDeveloper When You Deploy an Application to an Android Emulator or Android-Powered Device

For the runtime deployment to an Android-powered device, the deployment framework performs the following:

  1. Validates all selected deployment options.

  2. Deletes any pre-existing template for this deployment profile.

  3. Unzips Android template from Oracle_ADFmf_Framework.zip.

  4. Creates an AndroidManifest.xml file from an AndroidManifest.template.xml file that is provided in the template.

  5. Generates the Android preferences.xml, strings.xml, and arrays.xml files from the content in the adfmf-application.xml and adfmf-feature.xml files. For more information, see Section C.2, "Converting Preferences for Android."

  6. Invokes the Android Asset Packaging Tool (aapt.exe on Windows, appt on Mac) to generate an R.java file and initial .apk file.

  7. Compiles the R.java file by invoking javac externally from the JDeveloper project compilation process. This file must be compiled with a JDK version compatibility of 1.5 (or later) because the file runs within the Android JVM.

  8. Analyzes and evaluates dependencies. Compiles user-added .java code using the JVM 1.4 JDK. These files must be compiled with the JDK and are executed in the JVM 1.4.

  9. Invokes the Android tool that generates Dalvik byte code (dex.bat) from .class files or archive compatible files containing .class files. The content in the Android template JAR files is included as well (cordova-2.2.0.jar, container.jar, and ksoap.jar).

  10. Invokes the Android Asset Packaging Tool (aapt.exe) tool to update the application file created in Step 6 with the Dalvik byte code file.

  11. Creates a keystore and key for debug-mode deployment.

  12. Signs the Android application file.

  13. Aligns application (for a release-mode deployment).

  14. Invokes the Android Debug Bridge (adb.exe on Windows, adb on Mac) tool to deploy the application to an Android-powered device.

17.2.4 How to Create an iOS Deployment Profile

For iOS, use the Deployment Profiles Properties Editor to define the iOS application build configuration as well as the locations for the splash screen images and application icons.

Before you begin:

Download Xcode 4.6 (the minimum supported version required to compile applications), which includes the Xcode IDE, performance analysis tools, the iOS simulator, the Mac OS X and iOS SDKs, to the Apple computer that also runs JDeveloper.

Because Xcode is used during deployment, you must install it on the Apple computer before you deploy the ADF Mobile application from JDeveloper.

Tip:

While the current version of Xcode is available through the App Store, you can download prior versions through the following site:

https://developer.apple.com/xcode/

Access to this site requires an Apple ID and registration as an Apple developer.

After you download Xcode, you must enter the location of its xcodebuild tool and, for deployment to iOS simulators, the location of the iOS simulator's SDK, in the ADF Mobile Platforms preference page. For more information, see Chapter 3, "How to Configure the Development Environment for Platforms and Form Factors."

Note:

Run both iTunes and the iOS simulator at least once before entering their locations in the ADF Mobile Platforms preference page.

To deploy an ADF Mobile application to an iOS-powered device (as opposed to deployment to an iOS simulator), you must obtain both a provisioning profile and a certification from the iOS Provisioning Profile as described in Section 17.2.4.2, "Setting the Device Signing Options."

To create a deployment profile:

  1. Choose iOS Options, as shown in Figure 17-11.

  2. Accept the default values, or define the following:

    • Application Bundle Id—If needed, enter a bundle ID to use for this application that identifies the domain name of the company. The application bundle Id must be unique for each application installed on an iOS device and must adhere to the reverse-package style naming conventions described in the "Application ID Errors" section in iOS Development Workflow Guide (that is, com.<organization name>.<company name>). For information on obtaining the Bundle Seed Id using the iOS Provisioning Portal, see Section 17.4.4.3, "Registering an Application ID." See also Section 5.3, "Setting the Basic Information for an ADF Mobile Application."

      Note:

      The application bundle ID cannot contain spaces.

      Because each application bundle ID is unique, you can deploy multiple ADF Mobile applications to the same device. Two applications can even have the same name as long as their application bundle IDs are different. Mobile applications deployed to the same device are in their own respective sandboxes. They are unaware of each other and do not share data (they have only the Device scope in common).

    • Application Archive Name—If needed, enter the name for the .ipa file or the .app file. ADF Mobile creates an .ipa file when you select either the Deploy to distribution package or Deploy to iTunes for synchronization to device options in the Deployment Action dialog, shown in Figure 17-22. It creates an .app file when you select the Deploy application to simulator option. Otherwise, accept the default name. For more information, see Section 17.4.2, "How to Deploy an Application to an iOS-Powered Device" and Section 17.4.5, "How to Distribute an iOS Application to the App Store."

      By default, ADF Mobile bases the name of the .ipa file (or .app file) on the application id attribute configured in the adfmf-application.xml file. For more information, see Section 5.3, "Setting the Basic Information for an ADF Mobile Application."

    • Minimum iOS Version—Indicates the earliest version of iOS to which you can deploy the application. The default value is the current version. The version depends on the version of the installed SDK.

      Note:

      You can deploy an application to an iOS-powered device that runs SDK 5.0.

    • Simulator Target Version—Select the version of the emulator to which you are deploying the application. To find the available target versions, select Hardware and then Version on an iPhone simulator. The minimum version is 6.0. The default setting is <Highest Available>. See also the "Using iOS Simulator" chapter in Tools Workflow Guide for iOS, which is available through the iOS Developer Library (http://developer.apple.com/library/ios/navigation/).

      Note:

      Older versions of the iOS target version are usually available in the simulator for testing.

    • Target Family—Select the family of iOS products on which the application is intended to run. The default option is for both iPad and iPhone.

    Figure 17-11 Setting the iOS Options

    Entering iOS options.

17.2.4.1 Defining the iOS Build Options

The iOS build options enable you to deploy an application with debug or release bits and libraries. The Options page presents the configuration options for the iOS signing modes, debug and release modes.

Before you begin:

Deployment of an iOS application (that is, an .ipa file) to an iOS-powered device requires a provisioning profile, which is a required component for installation, and also a signed certificate that identifies the developer and an application on a device. You must obtain these from the iOS Provisioning portal as described in Section 17.4.4, "What You May Need to Know About Deploying an Application to an iOS-Powered Device." In addition, you must enter the location for a provisioning profile and the name of the certificate in the ADF Mobile Platforms preference page, as described in Section 17.2.4.2, "Setting the Device Signing Options."

How to set the build options:

  1. Chose iOS Options, as shown in Figure 17-11.

  2. Select one of the following build options.

17.2.4.2 Setting the Device Signing Options

The ADF Mobile Platforms preference page for iOS includes fields for the location of the provisioning profile on the development computer and the name of the certificate. You must define these parameters if you deploy an application to an iOS device or as an ADF Mobile Application Archive.

Note:

Neither a certificate nor a provisioning profile are required if you deploy an ADF Mobile application to an iOS simulator.

To set the signing options:

  1. Choose Tools, then Preferences, and then ADF Mobile.

  2. Choose Platforms and then choose iOS.

  3. In the Device Signing section of the page, shown in Figure 17-12, enter the location of the provisioning profile in the Provisioning Profile field.

  4. In the Certificate field, enter the name of the developer or distribution certificate that identifies the originator of the code (such as a developer or a company). You can view the name of the certificate using the Keychain Access utility (accessed from the Applications folder). Copy the entire name from the Keychain Access utility. The name entered into Certificate field must be in the following format:

    iPhone Developer: John Smith (PN3ENLQ3DU)

    Figure 17-12 The Device Signing Section of the ADF Mobile Platforms Preference Page

    Enter provisioning profile location and certificate name.

Note:

There are provisioning profiles used for both development and release versions of an application. While a provisioning profile used for the release version of an application can be installed on any device, a provisioning profile for a development version can only be installed on the devices whose IDs are embedded into the profile. For more information, see the "Configuring Development and Distribution Assets" chapter in Tools Workflow Guide for iOS, which is available from the iOS Developer Library (http://developer.apple.com/library/ios/navigation/).

17.2.4.3 Adding a Custom Image to an iOS Application

The Application images page enables you to override the default Oracle image used for application icons with custom images. The options in this page, shown in Figure 17-14, enable you to enter the locations of custom images used for different situations, device orientation, and device resolutions. For more information on iOS application icon images, see the "Custom Icon and Image Creation Guidelines" section in iOS Human Interface Guidelines. These documents are available from the iOS Developer Library (http://developer.apple.com/library/ios/navigation/).

Note:

All images must be in the PNG format.

To add custom images:

  1. Click Application Images.

  2. Select Do Not Add Gloss Effect to Icons if the default iOS-style icon, which has a shine effect over the top of the icon is not used. Figure 17-13 illustrates the gloss effect.

    Figure 17-13 An Icon with the Default Gloss Effect

    Example of glossy, iOS-style Oracle icon.

  3. Select the device type:

    • iPad

    • iPhone

    • iPad Mini

    • iPhone 5

    • iPad Retina

    • iPhone Retina

    ADF Mobile displays the location within the Resources directory for the image files that are appropriate to each selected device type.

  4. Choose Browse to select images for the following:

    • Application Icons—Enter the location of the icon images for iPhones and iPads, or for the versions of these images used for devices equipped with Retina displays. The file names must be the same for both the Retina and non-Retina version of the icon. For iPhone icons, the ADF Mobile deployment framework differentiates between the two by adding the @2x modifier to the file name of the Retina image. For iPad Retina displays, the deployment framework adds -144 to the file name to reflect the dimensions of its associated image (144 x 144, in pixels). For non-Retina iPad displays, the deployment framework likewise denotes the image dimensions (72 x 72, in pixels) by adding the -72 modifier to the iPad icon file name. For more information on iOS application icon images, see the "App Icons" section in iOS App Programming Guide, available from the iOS Developer Library (http://developer.apple.com/library/ios/navigation/). Table 17-3 lists the required dimensions, in pixels, for the device-specific application images.

      Table 17-3 Dimensions for Application Icons

      Device Dimension (in Pixels)

      iPad

      72 x 72

      iPhone

      57 x 57

      iPad Mini

      72 x 72

      iPhone 5

      114 x 114

      iPhone Retina

      114 x 114

      iPad Retina

      144 x 144

    • Splash Screen Images—Enter the location of the image used when the application launches. For the iPhone, this image must be named Default.png. Depending on the device type and orientation, this image can be overridden by the images selected for its portrait or landscape versions. The ADF Mobile deployment framework attaches the Portrait and Landscape modifiers to the file names, as well as @2x to denote the high-resolution images used on iPhone 5 and Retina displays. For more information, see the "App Launch (Default) Images" and "Providing Device-Specific Launch Images" sections in iOS App Programming Guide, available from the iOS Developer Library (http://developer.apple.com/library/ios/navigation/). Table 17-4 lists the required dimensions, in pixels, for the splash screen images.

      Table 17-4 Dimensions for Splash Screen Images

      Device Portrait Landscape

      iPad

      768 x 1024

      1024 x 768

      iPhone

      320 x 480

      N/A

      iPad Mini

      768 x 1024

      1024 x 768

      iPhone 5

      640 x 1136

      N/A

      iPad Retina

      1536 x 2008

      2048 x 1496

      iPhone Retina

      640 x 960

      N/A

    Note:

    JDeveloper notes errors to safeguard against selecting an incorrect (or nonexistent) image file, such as the erroneously entered resources/android/icon@2x.png for the iPad application icon shown in Figure 17-16. See also Section 5.10.2, "What You May Need to Know About Selecting External Resources."

  5. Click OK.

Figure 17-14 Adding Custom Images

Enter the custom image file locations.

17.2.4.4 What You May Need to Know About iTunes Artwork

By default, ADF Mobile applications deployed to an iOS device through iTunes, or deployed as an archive (.ipa file) for download, use the default Oracle image, shown in Figure 17-13 unless otherwise specified.

By selecting an iTunes artwork image as the icon for the deployed application, you override the default image. You can use an image to differentiate between versions of the application. Figure 17-15 illustrates the difference between the default image and a user-selected image, where Application4 is displayed with the default image and Application6 is displayed with a user-selected image (the Oracle icon, scaled to 512 x 512 pixels).

Figure 17-15 Custom and Default Application Icons

Custom and default icons in iTunes.

During deployment, ADF Mobile ensures that the icon displays in iTunes by adding the iTunes artwork image to the top-level of the .ipa file in a file called iTunesArtwork.

17.2.4.5 How to Restrict the Display to a Specific Device Orientation

By default, ADF Mobile supports all orientations for both iPhone and iPad. If, for example, an application must display only in portrait and in upside-down orientations on iPads, you can limit the application to rotate only to these orientations using the Device Orientation page, shown in Figure 17-16

Figure 17-16 Select a Device Orientation

Select the type of device orientation.

To limit the display of an application to a specific device orientation: 

  1. Choose Device Orientations, as shown in Figure 17-16.

  2. Clear all unneeded orientations from among those listed in Table 17-5. By default, ADF Mobile deploys to all of these device orientations. By default, all of these orientations are selected.

    Table 17-5 iPhone Device Orientations

    Icon Description

    Icon for iPod (Portrait).

    iPad, portrait—The home button is at the bottom of the screen.

    iPad icon (upside-down).

    iPad, upside-down—The home button is at the top of the screen.

    iPad icon (landscape, left)

    iPad, landscape left—The home button is at the left side of the screen.

    iPad icon (landscape right)

    iPad, landscape right—The home button is at the right side of the screen.

    iPhone icon (portrait)

    iPhone, portrait—The home button is at the bottom of the screen.

    iPhone icon (landscape, left)

    iPhone, upside-down—The home button is at the top of the screen.

    iPhone icon (landscape, left).

    iPhone, landscape left—The home button is at the left side of the screen.

    iPhone icon (landscape, right)

    iPhone, landscape right—The home button is at the right side of the screen.

  3. Click OK.

17.2.4.6 What Happens When You Deselect Device Orientations

Deselecting a device orientation updates the source .plist file.

17.3 Deploying an Android Application

After you define the deployment profile, you can deploy an ADF Mobile application to the Android platform using the Deployment Action dialog, shown in Figure 17-17. Using this dialog, you can deploy the completed application to an Android emulator or to an Android-powered device for testing. After you have tested and debugged the application, this dialog enables you to bundle the ADF Mobile application as an Android application package (.apk) file so that it can be published to end users through an application marketplace, such as Google Play.

Tip:

As an alternative to the Deployment Action dialog, you can deploy an ADF Mobile application to the Android platform manually using the OJDeploy command line tool as described in Section 17.8, "Deploying ADF Mobile Applications from the Command Line."

Figure 17-17 Deployment Action Dialog for Android Applications

The Deployment Action dialog.

17.3.1 How to Deploy an Android Application to an Android Emulator

You can deploy the ADF Mobile application directly to an Android emulator.

Before you begin:

Deployment to an Android emulator requires the following:

  • Configure the debug password in the ADF Mobile Platforms preference page (accessed by choosing Tools > Preferences > ADF Mobile).

    Note:

    You must install the Android 4.0.n platform (API 14 or later).

  • Ensure that the Android Virtual Device instance configuration reflects the ARM system image.

  • In the Android Options page of the deployment profile:

    1. Ensure that Debug is selected.

    2. Click OK.

    Note:

    The ADF Mobile Platforms preferences page must be configured with the password that is used to generate the keystore and key for debug-mode deployment. See Section 17.2.3.3, "Defining the Android Signing Options."

  • Start the Android emulator before you deploy an application.

    You can start the emulator using the Android Virtual Device Manager, as illustrated in Figure 17-18, or from the command line by first navigating to the tools directory (located in Android\android-sdk) and then starting the emulator by first entering emulator -avd followed by the emulator name (such as -avd AndroidEmulator1).

    Note:

    You can run only one Android emulator during a deployment.

    Figure 17-18 Starting an Emulator Using Android Virtual Device Manager

    Using Android SDK tools to start emulator.

To deploy an application to an Android emulator:

  1. Choose Applications, then Deploy, and then select an Android deployment profile.

  2. Choose Deploy application to emulator and then choose Next.

  3. Review the Summary page, shown in Figure 17-2, choose Back to select another deployment activity or choose Finish. The Summary page displays the following parameters from the deployment profile:

    • Application Bundle Id—The unique, Java language-like package name identifying the application.

      Note:

      The Summary page shown in Figure 17-19 shows that the application bundle ID is in the reverse package format required for a successful deployment to an emulator. Deploying an application that does not follow the reverse-package format causes the emulator to shut down, which prevents the deployment from completing.

    • File—The name of the .apk that is deployed to an Android target.

    • Deploy Mode—The build mode. This value is either Release or Debug, depending on the value set in the deployment profile.

    Figure 17-19 Summary for Android Emulator Deployment

    The Deployment Summary dialog.

  4. Review the deployment log, as shown in Figure 17-20. The deployment log notes that the deployment framework starts the Android Debug Bridge server when it detects a running instance of an Android emulator. See also Section 17.3.6, "What You May Need to Know About Using the Android Debug Bridge."

    Figure 17-20 The Deployment Log

    The deployment log window.

17.3.2 How to Deploy an Application to an Android-Powered Device

You can deploy an ADF Mobile application directly to an Android-powered device that runs on a platform of 2.n (API Level 9) or later.

Before you begin:

Connect the device to the development computer that hosts JDeveloper, as described in Section 3.5.2, "How to Set Up an Android-Powered Device."

In the Deployment Options page, shown in Figure 17-7, select Debug as the build mode. Ensure that the debug signing credentials are configured in the ADF Mobile Platforms Preferences page, shown in Figure 17-8.

To deploy an application to an Android device:

  1. Choose Applications, then Deploy, then select an Android deployment profile.

  2. Choose Deploy application to device and then choose Next.

  3. Review the Summary page. Click Back or Next.

  4. Click Finish.

17.3.3 How to Publish an Android Application

After you have tested and debugged the application, as described in Chapter 19, "Testing and Debugging ADF Mobile Applications," you can publish it to an application marketplace (such as Google Play) by following the instructions provided on the Android Developers website (http://developer.android.com/tools/publishing/publishing_overview.html).

Before you begin:

In the Android Options page of the deployment profile, select Release as the build mode.

Note:

You must configure the signing options in the ADF Mobile Platforms preferences page (accessed by choosing Tools > Preferences > ADF Mobile) as described in Section 17.2.3.3, "Defining the Android Signing Options."

To deploy an application as an .apk file:

  1. Choose Applications, then Deploy, then select an Android deployment profile.

  2. Choose Deploy application to package and then choose Next.

  3. Review the Summary page, shown in Figure 17-19. Click Back or Next.

  4. Click Finish.

  5. Publish the application to an application marketplace.

17.3.4 What Happens in JDeveloper When You Create an .apk File

Deploying an application results in the following being deployed in an .apk file.

  • The content in the adfmsrc

  • The content in the .adf folder

  • adfmf-application.xml and adfmf-feature.xml files

  • logging.properties file

  • The JVM 1.4 files

Table 17-6 Contents of the .apk File

Content Location Within the .apk File

The content in the .adf folder

The root folder of the Android application file ([apkRoot]\.adf)

The content in the adfmsrc folder

The deployment packages the content in the adfmsrc folder into the default JAR file, which is located in a folder called user ([apkRoot]\user). This JAR file is added to the .apk using the Android Asset Packaging Tool (AAPT) and has a default name of the form ANDROID_MOBILE_NATIVE_archiveN where N is the nth Android created profile (you can override this name when creating the profile).

This JAR file contains the following:

  • Any .class files generated from .java files that are added to the view controller project, as well as the adfmsrc content. The .java files are compiled using the JVM 1.4 JDK javac tool.

  • Contains data binding and pagedef metadata files.

This JAR file is not processed by the Dalvik virtual machine. Because the .class files run in the JDK, they do not need to be converted into the Dalvik bytecode format (.dex).

adfmf_application.xml and adfmf_feature.xml files

Located in a file called Configuration ([apkRoot]\Configuration).

logging.properties file

Located in the root of the application file.

JVM 1.4 files

The JVM files are packaged into two separate folders:

  • The library file (\framework\build\java_res\libs\ ) in the template will be packaged into a lib folder in the APK - [apkRoot]\lib.

  • The \framework\build\java_res\assets\storage file is packaged in the assets\storage directory in the APK - [apkRoot]\assets\storage.

17.3.5 Selecting the Most Recently Used Deployment Profiles

After you select a deployment action, JDeveloper creates a shortcut on the Deploy menu that enables you to easily redeploy the application using that same deployment action.

17.3.6 What You May Need to Know About Using the Android Debug Bridge

The deployment restarts the Android Debug Bridge server five times until it detects a device (if deploying to a device) or emulator (if deploying to an Android emulator). If it detects neither, then it ends the deployment process, as shown in Figure 17-21.

Figure 17-21 Deployment Terminated

Android Bridge Server stopped, deployment canceled.

If you are using the Android Debug Bridge command line tool prior to deployment, then you must enter the same command again after the deployment has completed. For example, if you entered adb logcat to view logging information for an emulator or device prior to deployment, you would have to enter adb logcat again after the application has been deployed to resume the retrieval of the logging output. For more information about the Android Debug Bridge command line tool, which is located within (and executed from) the platform-tools directory of the Android SDK installation, refer to the Android Developers website (http://developer.android.com/tools/help/adb.html).

17.4 Deploying an iOS Application

The Deployment Action dialog, shown in Figure 17-22, enables you to deploy an iOS application directly to an iOS simulator or to a device through iTunes. You can only deploy an iOS application from an Apple computer. Deployment to the iOS simulator does not require membership to either the iOS Developer Program or the iOS Developer Enterprise Program; registration as an Apple developer, which provides access to versions of Xcode that are not available through the App Store, will suffice. For more information on iOS developer programs, which are required for deployment to iOS-powered devices (and are described at Section 17.4.2, "How to Deploy an Application to an iOS-Powered Device," and Section 17.4.5, "How to Distribute an iOS Application to the App Store"), see https://developer.apple.com/programs/.

Figure 17-22 The Deployment Action Dialog (for iOS Applications)

The Deployment Action dialog for iOS applications.

Tip:

As an alternative to the Deployment Action dialog, you can deploy an ADF Mobile application to the iOS platform manually using the OJDeploy command line tool as described in Section 17.8, "Deploying ADF Mobile Applications from the Command Line."

17.4.1 How to Deploy an iOS Application to an iOS Simulator

The Deployment Actions dialog enables you to deploy an iOS application directly to an iOS simulator.

Before you begin:

To enable deployment to an iOS simulator, you must perform the following tasks:

  • Run Xcode after installing it, agree to the licensing agreements, and perform other post-installation tasks, as prompted.

    Note:

    You must run Xcode at least once before you deploy the application to the iOS simulator. Otherwise, the deployment will not succeed.

  • Run the iOS simulator at least once after installing Xcode.

  • Set the location of the SDK of the iOS simulator in the ADF Mobile Platforms preference page, shown in Figure 17-24.

  • In the iOS Options page of the deployment profile, select Debug, and then click OK.

    Note:

    You must enter the location of the provisioning profile and the name of the certificate in the ADF Mobile Platforms page (accessed by choosing Tools > Preferences > Platforms). For more information, refer to Section 17.2.4.2, "Setting the Device Signing Options."

  • Before you deploy an application, shut down the iOS simulator if it is running. If you do not shut down the simulator, the deployment will do it for you.

  • Refer to the "Using iOS Simulator" section in iOS Development Workflow Guide. The iOS simulator is installed with Xcode.

To deploy an application to an iOS simulator:

  1. Choose Applications, then Deploy, then select an iOS deployment profile.

  2. Choose Deploy application to simulator and then choose Next.

  3. Review the Summary page, shown in Figure 17-23, which displays the following values. Click Finish.

    • Application Bundle Id—The unique name that includes a Java language-like package name (com.<organization name>.<application name>) prefixed with the Bundle Seed that is generated from the iOS Provisioning Portal.

    • File—The file name of the final image deployed to an iOS target.

    • Certificate—The developer or company that authored the application. If this value has not been configured in the Options page of the deployment profile, then the Summary page displays <Not Specified>.

    • Provisioning Profile—The name of the provisioning profile that associates one or more development certificates and devices with an application ID. If this value is not configured in the Options page of the deployment profile, then the Summary page displays <Not Specified>.

    Note:

    Deployment to an iOS simulator does not require that the values for Certificate and Provisioning profile be defined. In this deployment scenario, the Summary page displays <Not Specified> for these values.

    Figure 17-23 The Deployment Actions Summary Dialog

    Deployment actions for iOS applications.

17.4.2 How to Deploy an Application to an iOS-Powered Device

The Deploy to iTunes for Synchronization to device option enables you to deploy an ADF Mobile application to an iOS-powered device for debugging and testing. Deployment to an iOS-powered device or to a distribution site requires membership to either the iOS Developer Program or the iOS Developer Enterprise Program. For more information, see https://developer.apple.com/programs/.

Before you begin:

You cannot deploy an application directly from JDeveloper to a iOS device; an application must instead be deployed from the Applications folder in Apple iTunes. To accomplish this, you must perform the following tasks:

  • Download Apple iTunes to your development computer and run it at least once to create the needed folders and directories.

  • Set the location of the Automatically Add to iTunes folder (the location used for application deployment) in the ADF Mobile Platforms preference page, shown in Figure 17-24.

    Tip:

    Although your user home directory (/User/<username>/Music/iTunes/iTunes Media/Automatically Add to iTunes.localized) is the default directory for the iTunes Media folder, you can change the location of this folder as follows:

    1. In iTunes, select Edit, Preferences, then Advanced.

    2. Click Change and then browse to the new location.

    3. Consolidate the library.

    4. Delete the original iTunes Media folder.

    For instructions, refer to Apple Support (http://support.apple.com).

    You must also update the location in the ADF Mobile Platforms preference page.

  • Set the location of the Xcode folder where the xcodebuild tool is invoked, such as /Developer/usr/bin in Figure 17-24.

    Figure 17-24 Setting the Locations for the iTunes Media Folder and the xcodebuild System

    Enter the Media folder and XCode locations.

  • Enter the name of the certificate and the location of the provisioning profile in the ADF Mobile Platforms preference page. The OS Provisioning Portal generates the certificate and provisioning profile needed for deployment to iOS devices, or for publishing .ipa files to the App Store or to an internal download site.

    Note:

    The deployment will fail unless you set the iOS provisioning profile and certificate to deploy to a device or to an archive. ADF Mobile logs applications that fail to deploy under such circumstances. For more information, see Section 17.4.4, "What You May Need to Know About Deploying an Application to an iOS-Powered Device."

  • In the iOS Options page of the deployment profile, select Debug as the build mode and then OK.

  • Refer to the "Managing Devices and Digital Identities" section in iOS Development Workflow Guide, which is available through the iOS Developer Library (http://developer.apple.com/library/ios/navigation/).

To deploy an application to an iOS-powered device:

  1. Choose Applications, then Deploy, and then select an iOS deployment profile.

  2. Choose Deploy to iTunes for Synchronization to device and then choose Next.

  3. Review the Summary page, which displays the following values. Click Finish.

    • Application Bundle Id—The unique name that includes a Java language-like package name (com.<organization name>.<application name>) prefixed with the Bundle Seed that is generated from the iOS Provisioning Portal.

    • File—The file name of the final image deployed to an iOS target.

    • Certificate—The developer (or company) who authored the application. If this value has not been configured in the Options page of the deployment profile, then the Summary page displays <Not Specified>.

    • Provisioning Profile—The name of the provisioning profile that associates one or more development certificates and devices with an application ID. If this value is not configured in the Options page of the deployment profile, then the Summary page displays <Not Specified>.

    Note:

    The Certificate and Provisioning Profile values cannot be noted as <Not Specified>; you must specify these values in the Options page to enable deployment to iTunes.

  4. Connect the iOS-powered device to the development computer.

  5. Open iTunes and then synchronize the device.

17.4.3 What Happens When You Deploy an Application to an iOS Device

The application appears in the iTunes Apps Folder, similar to the one illustrated in Figure 17-15 after a successful deployment.

17.4.4 What You May Need to Know About Deploying an Application to an iOS-Powered Device

You cannot deploy an iOS application (that is, an .ipa file) to an iOS-powered device or publish it to either the App Store or to an internal hosted download site without first creating a provisioning profile using the iOS Provisioning Portal, which is accessible only to members of the iOS Developer Program. You enter the location of the provisioning profile and the name of the certificate in the Options page as described in Section 17.2.4.2, "Setting the Device Signing Options."

As noted in the "Distributing Apps" chapter in Tools Workflow Guide for iOS (which is available through the iOS Developer Library at http://developer.apple.com/library/ios/navigation/), a provisioning profile associates development certificates, devices, and an application ID. The iOS Provisioning Portal enables you to create these entities as well as the provisioning profile.

Tip:

After you download the provisioning profile, double-click this file to add it to your Library/MobileDevice/Provisioning Profile directory.

Figure 17-25 The iOS Provisioning Portal

The memebers-only iOS Provisioning Profile.

17.4.4.1 Creating iOS Development Certificates

A certificate is an electronic document that combines information about a developer's identity with a public key and private key. After you download a certificate, you essentially install your identity into the development computer, as the iOS Development Certificate identifies you as an iOS developer and enables the signing of the application for deployment. In the iOS operating environment, all certificates are managed by the Keychain.

Using the Certificates page in the iOS Provisioning Portal, you log a CSR (Certificate Signing Request). The iOS Provisioning Portal issues the iOS Development Certificate after you complete the CSR.

17.4.4.2 Registering an Apple Device for Testing and Debugging

After you install a certificate on your development computer, review the Current Available Devices tab (located in the iOS Provisioning Portal's Devices page) to identify the Apple devices used by you (or your company) for testing or debugging. The application cannot deploy unless the device is included in this list, which identifies each device by its serial number-like Unique Device Identifier (UDID).

17.4.4.3 Registering an Application ID

An application ID is a unique identifier for an application on a device. An application ID is comprised of the administrator-created reverse domain name called a Bundle Identifier in the format described in Section 5.3.1, "How to Set the ID and Display Behavior for a Mobile Application" prefixed by a ten-character alpha-numeric string called a bundle seed, which is generated by Apple. Figure 17-26 illustrates an application ID that is unique, one that does not share files or the Keychain with any other applications.

Figure 17-26 An Explicit Application ID

An explicit application ID.

Using a wildcard character (*) for the application name, such as 8E549T7128.com.oracle.*, enables a suite of applications to share an application ID. For example, if the administrator names com.oracle.ADF.* on the iOS Provisioning Portal, it enables you to specify different applications (com.oracle.ADF.application1 and com.oracle.ADF.application2).

Note:

For applications that receive push notifications, the application ID must be a full, unique ID, not a wildcard character; applications identified using wildcards cannot receive push notifications. For more information, see the "Provisioning and Development" section of Local and Push Notification Programming Guide, available from the iOS Developer Library (http://developer.apple.com/library/ios/navigation/)

When applications share the same prefix, such as 8E549T7128, they can share files or Keychains.

Note:

The Bundle ID must match the application ID set in the Options page of the deployment profile.

17.4.5 How to Distribute an iOS Application to the App Store

After you test and debug an application on an iOS device, you can distribute the application to a wider audience through the App Store or an internal download site. To publish an application to the App Store, you must submit the .ipa file to iTunes Connect, which enables you to add .ipa files to iTunes, as well as update applications and create test users.

Before you begin:

Before you distribute the application, you must perform the following tasks:

  • In the ADF Mobile Platforms Preferences page, shown in Figure 17-24, enter the location of the Automatically Add to iTunes directory.

    Tip:

    Run iTunes at least once before entering this location. See also Section 17.4.2, "How to Deploy an Application to an iOS-Powered Device."

  • Test the application on an actual iOS device. See Section 17.4.2, "How to Deploy an Application to an iOS-Powered Device."

  • Obtain a distribution certificate through the iOS Provisioning Portal.

    Note:

    Only the Team Agent can create a distribution certificate.

  • Obtain an iTunes Connect account for distributing the .ipa file to iTunes. For information, see "Prepare App Submission" in the iOS Development Center's App Store Resource Center. Specifically, review the App Store Review Guidelines to ensure acceptance by the App Review Team.

  • You may want to review both the "Distributing Apps" section in Tools Workflow Guide for iOS and iTunes Connect Developer Guide. These guides are both available through the iOS Developer Library (http://developer.apple.com/library/ios/navigation/).

  • In the iOS Options page of the deployment profile, select Release as the build mode and then click OK.

To distribute an iOS application to the App Store:

  1. Choose Applications, then Deploy, and then select an iOS deployment profile.

  2. Choose Deploy to Distribution Package.

  3. Review the Summary page, which displays the following values. Click Finish.

    • Application Bundle Id—The unique name that includes a Java language-like package name (com.<organization name>.<application name>) prefixed with the Bundle Seed that is generated from the iOS Provisioning Portal.

    • File—The file name of the final image deployed to an iOS target.

    • Certificate—The application's author. If this value has not been configured in the ADF Mobile Platforms preference page of the deployment profile, then the Summary page displays <Not Specified>.

    • Provisioning Profile—The name of the provisioning profile that associates one or more development certificates and devices with an application ID. If this value is not configured in the ADF Mobile Platforms preference of the deployment profile, then the Summary page displays <Not Specified>.

    Note:

    The Certificate and Provisioning Profile values cannot be noted as <Not Specified>; you must specify these values in the Options page to enable the .ipa file to be accepted by iTunes.

  4. Log in to iTunes Connect.

  5. Submit the .ipa file to iTunes Connect for consideration using the Manage Your Applications module and the Application Loader described in the "Adding New Apps" and "Using Application Loader" sections in iTunes Connect Developer Guide.

  6. After the application has been approved, refer to the "Creating Test Users" section in iTunes Connect Developer Guide for information on using the Manage Users module. For testing multi-language applications, create a test user account for the regions for which the application is localized.

  7. Refer to the "Editing and Updating App Information" section in iTunes Connect Developer Guide for information on updating the binary using the Managing Your Application module.

17.4.5.1 What Happens in JDeveloper When You Deploy an Application to an iOS Simulator or iOS-Powered Device

JDeveloper performs the following tasks after you complete the deployment wizard:

  1. Validates that the necessary software prerequisites are installed. For example, such tasks include:

    1. Validating that the path to the iOS SDK that was set in Preferences is valid and accessible.

    2. Validating that the path to the xcodebuild tool (which is set in the ADF Mobile Platforms page) that was set in Preferences is valid and accessible. The xcodebuild tools is an Apple utility that compiles iOS projects.

    3. Performing other validation as needed.

  2. Deletes any pre-existing template for this deployment profile to ensure that any new deployment does not use configuration set for previous deployments.

  3. Validates the applications and all of the XML content of both the applications and the projects.

  4. For a first-time deployment (or after you select Build > Clean), JDeveloper unzips the Oracle_ADFmc_Container_Template file for iOS to a temporary location. That is, modules\adf-mobile\dist\jdev\extensions\oracle.adf.mobile\Oracle_ADFmc_Container_Template.zip is unpacked to a profile sub-directory in the deploy directory.

    Tip:

    Selecting Build > Clean enables you to modify the Xcode project settings, which provide additional options to those available in JDeveloper.

    JDeveloper also unzips the necessary ADF Mobile libraries from modules\adf-mobile\dist\jdev\extensions\oracle.adf.mobile\Oracle_ADFmc_Framework_Libraries.zip to the Framework directory in the previously unzipped template.

    Note:

    Any libraries dependent the type of deployment (that is, debug, release, or deployment to a simulator, device, or as an archive) are added to the template at a later stage.

  5. If custom images have been selected in the deployment profile, JDeveloper copies those images to a template location and renames them to the appropriate name. The iOS template internally uses the names icon.png, icon-2x.png, icon-72.png, Default.png, Default-Landscape.png, and Default-Portrait.png for the application icon names and splash screen names. For any image that has not been customized, JDeveloper copies the default image to the template.

  6. Copies the web content (including any images related to features) to the template location. As a result, the public_html folder and its subdirectories within the ADF Mobile project are copied to the www folder in the template.

  7. Copies the metadata files to the template location:

    1. Copies the adfmf-application.xml file.

    2. Combines all of the adfmf-feature.xml files into one file and places it in the template.

  8. Creates and updates the .plist files. See Property List Programming Guide, available from the iOS Developer Library (http://developer.apple.com/library/ios/navigation/) and also Section C.3, "Converting Preferences for iOS."

    1. Creates the preferences .plist files from the metadata files. These files create the preferences that are available from the iOS Settings application.

    2. Updates the root.plist file with the application name, the bundle identifier, the version, and the flag that determines the use of pre-rendered icons. The application name, bundle identifier, and version are retrieved from the adfmf-application.xml file and the iOS Options page, shown in Figure 17-11, "Setting the iOS Options".

  9. Runs the xcodebuild utility with the correct flags for the chosen deployment. For example, a debug build deployed to an iOS simulator (Version 5.0) is as follows:

    xcodebuild clean install -configuration Debug -sdk iphonesimulator5.0

  10. Deploys the newly built application to the proper location.

    1. Copies the iOS application bundle to a unique application directory, as required for deployment to the iOS simulator.

    2. Runs the xcrun command to package the application into the .ipa file. This command creates an .ipa file that has a folder entitled Payload, which contains the application. It also adds the provisioning profile and signs the application with the developer's name. An example of the xcrun command is as follows:

      /usr/bin/xcrun -sdk iphoneos PackageApplication -v "%PROJECT_BUILDDIR%/SampleApp.app" -o "SampleApp.ipa" --sign "iPhone Developer: John Doe (A1BC2DEFGH)" --embed "/Users/jdoe/Desktop/my_profile.mobileprovision"

  11. If this is a deployment to a device, JDeveloper moves the .ipa file to the iTunes Media/Automatically Add to iTunes directory.

17.5 Deploying Feature Archive Files (FARs)

To enable re-use by ADF Mobile view controller projects, application features— typically, those implemented as ADF Mobile AMX or Local HTML— are bundled into an archive known as a Feature Archive (FAR). A FAR is essentially a self-contained collection of application feature elements that can be consumed by ADF Mobile applications, such as icon images, resource bundles, HTML, JavaScript, or other implementation-specific files. (A FAR can also contain Java classes, though these classes must be compiled.) Example 17-2 illustrates the contents of a FAR, which includes a single adfmf-feature.xml file and a connections.xml file. For more information on connections.xml, see the "Lookup Defined in the connections.xml File" section and "Reusing Application Components" chapter in Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework.

Example 17-2 Contents of a Feature Archive File

connections.xml (or some form of connection metadata)
 
  META-INF
     adfm.xml
     adfmf-feature.xml
     MANIFEST.MF
     task-flow-registry.xml
 
  oracle
    application1
      mobile
         Class1.class
         DataBindings.cpx
         pageDefs
           view1PageDefs
 
  model
     adfc-mobile-config.adfc.diagram
     ViewController-task-flow.adfc.diagram
 
  public_html
     adfc-mobile-config.xml
       index.html
       navbar-icon.html
       springboard-icon.html
     view1.amx
     ViewController-task-flow.xml

Working with Feature Archive files involves the following tasks:

  1. Creating a Feature Archive file—You create a Feature Archive by deploying a feature application as a library JAR file.

  2. Using the Feature Archive file when creating an ADF Mobile application—This includes importing FARs and re-mapping the imported connection.

  3. Deploying an ADF Mobile application that includes features from FARs—This includes unpacking the FAR to a uniquely named folder within the deployment template.

    Note:

    ADF Mobile generates FARs during the deployment process. You only need to deploy a view controller project if you use the FAR in another application.

17.5.1 How to Create a Deployment Profile for a Feature Archive

Use the Create Deployment Profile dialog, shown in Figure 17-10.

Figure 17-27 Create ADF Mobile Feature Dialog

Select ADF Mobile Feature Archive.

Before you begin:

Create the appropriate connections for the application. See the "Naming Considerations for Connections" section in Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework.

How to create a deployment profile for a Feature Archive:

  1. Right-click a view controller project, choose New, then Deploy, and then New Deployment Profile.

    Note:

    You do not need to create a separate, application-level deployment profile.

  2. Select ADF Mobile Feature Archive in the Create Deployment Profile dialog.

  3. Enter a profile name, or accept the default, and then click OK.

    Note:

    Name the profile appropriately. Otherwise, you may encounter problems if you upload more than one application feature with the same archive name. For more information, see Section 5.13.3, "What You May Need to Know About Enabling the Reuse of Feature Archive Resources."

  4. Select the connections that you want to include in the Feature Archive JAR file, as shown in Figure 17-28.

    Figure 17-28 Selecting a Connection for the FAR

    Select a connection.

  5. Click Next, review the options, and then click Finish.

17.5.2 How to Deploy the Feature Archive Deployment Profile

The Deployment Actions dialog enables you to deploy the FAR as a JAR file. This dialog, shown in Figure 17-29, includes only one deployment option, Deploy to feature archive JAR file.

Figure 17-29 Deployment Actions

Deployment actions.

How to deploy the Feature Archive deployment profile:

  1. Right-click the view controller project and then select the Feature Archive deployment profile.

  2. Click Finish. The Summary page, shown in Figure 17-30, displays the full path of where the Feature Archive file's JAR path is deployed.

    Figure 17-30 Deployment Summary Page

    Shows the full path of the FAR JAR.

17.5.3 What Happens When You Deploy a Feature Archive File Deployment Profile

After you complete the deployment action dialog, ADF Mobile creates a library JAR in the path shown in the Summary page. To make this JAR available for consumption by other applications, you must first make it available through the Resource Palette, shown in Figure 17-31 (and described in Section 5.13.1, "How to Use FAR Content in an ADF Mobile Application") by creating a connection to the location of the Feature Archive JAR. Figure 17-31 shows Feature Archives that can be made available to an ADF Mobile application through a file system connection. For more information, see "Working with the Resource Palette" in Oracle Fusion Middleware User's Guide for Oracle JDeveloper.

Figure 17-31 Deployed Feature Archive JARs in the Resource Palette

Deployed Featurer Archive JARs in Resource Palette.

17.6 Creating a Mobile Application Archive File

You can create a new ADF Mobile application from an existing ADF Mobile application by first packaging the original ADF Mobile application as a Mobile Application Archive (.maa) file and then by deriving a new ADF Mobile application from this file. An .maa file can be used by third parties, as described in Section 17.7, "Creating Unsigned Deployment Packages."

An .maa file preserves the structure of the ADF Mobile application. Table 17-7 describes the contents of this file.

Table 17-7 Contents of a Mobile Application Archive File

Directory Description

adf

Contains the META-INF directory, which contains the metadata files, including:

  • The adf-config.xml file

  • The adfmf-application.xml file

  • The adfmf-config.xml file

  • Other applicable application-level files, such as the connections.xmlfile

Projects

Contains a JAR file for each project in the workspace. For example, a ViewController.jar file and a ApplicationController.jar file are located in this directory when you deploy a default ADF Mobile application to an .maa file. The Projects directory of the .maa file does not include the .java files from the original project. Instead, the .java files are compiled and the resulting .class files are placed in a separate JAR file that is contained in the project JAR file (such as ApplicationController.JAR/classlib/mobileApplicationArchive.jar).

ExternalLibs

Contains the application-level libraries (including FARs) that are external to the original ADF Mobile application.

META-INF

Includes the cvm.properties and logging.properties files.

resources

Includes the following directories:

  • android—Contains Android-specific image files for application icons and splash screens.

  • ios—Contains iOS-specific image files for application icons and splash screens.

  • security—Includes the cacerts file (the keystore file).

In addition to the artifacts listed in Table 17-7, the .maa file includes any folder containing FARs or JAR files that are internal to the original ADF Mobile application, as well as its control (.jws)file. See also Section 17.7.2, "What Happens When You Import an ADF Mobile Application Archive File."

17.6.1 How to Create a Mobile Application Archive File

JDeveloper creates a default ADF Mobile Application Archive deployment profile after you create an ADF Mobile application. Using the Mobile Application Archive wizard, you can create MAA file.

Tip:

You can also create an .maa file using OJDeploy, as described in Section 17.8, "Deploying ADF Mobile Applications from the Command Line."

To create a Mobile Application Archive file:

  1. Click Application, then Deploy, then New Deployment Profile.

  2. In the Create Deployment Profile dialog, choose ADF Mobile Application Archive and then click OK, as shown in Figure 17-32.

    Figure 17-32 Creating an MAA Deployment Profile

    ADF Mobile Application Archive option.

  3. If needed, enter a name for the Mobile Application Archive in the Application Archives Options page, shown in Figure 17-33, or accept the default name (and path). Click OK.

    Figure 17-33 Entering a Name and Path for the Mobile Application Archive File

    Enter a name or path for the .maa file.

  4. If needed, perform the following:

    1. In the Application Descriptors page, shown in Figure 17-34, enter the file group name (or accept the default name) used for the contents of the META-INF folder (application_workspace\src\META-INF).

      Figure 17-34 Entering a File Group Name for the META-INF Contents

      Enter a name for the META-INF contents.

    2. Select the Contributors sub-page of this Application Descriptors page to edit the list of directories and JAR files that provide the contents for the file group.

      Figure 17-35 Editing Contributors to the Mobile Application Archive File

      Choose the directories and files for the .maa file.

    3. Use the Filters page, shown in Figure 17-36 to edit the files that will be included in the .maa file or set the content inclusion or exclusion rules.

      Figure 17-36 Including (or Excluding) Files and Directories

      Edit content filters.

    4. Use the Profile Dependencies page, shown in Figure 17-37, to specify dependent profiles within the project.

      Figure 17-37 Selecting Deployment Profiles

      Select other deployment profiles.

To package an ADF Mobile Application as a Mobile Application Archive file:

  1. Choose Application, then Deploy and then choose the ADF Mobile Application Archive deployment profile.

  2. In the Deployment Action wizard, select Deploy application to MAA, as shown in Figure 17-38.

    Figure 17-38 Deployment to an ADF Mobile Application Archive File

    Deployment to an .maa file.

  3. Click Next to review the deployment summary, as shown in Figure 17-39.

    Figure 17-39 ADF Mobile Application Archive Deployment Summary

    Deployment summary for an .maa file.

  4. Click Finish.

17.7 Creating Unsigned Deployment Packages

The ADF Mobile Application Archive (.maa) file format enables you to provide third-parties with an unsigned ADF Mobile application. By deriving an ADF Mobile application from an imported .maa file, you enable various customizations, which include:

  • Giving an application a unique application ID (to enable push notifications, for example).

  • Signing an application with a company-specific credential or certificate.

  • Replacing the resources with customized splash screens and application icons.

Note:

Importing an .maa file into an existing application overwrites the workspace and project container files (the.jws and .jpr files, respectively). As a result, all prior changes to ADF Mobile AMX pages and configuration files, such as adfmf-application.xml, adfmf-config.xml, connections.xml, and adf-config.xml, will not be retained.

17.7.1 How to Create an Unsigned Application

You create an unsigned application by importing an .maa file into a new ADF Mobile application.

To create an unsigned application:

  1. Choose File and then New.

  2. In the New Gallery, choose Applications and then Mobile Application from Archive File (ADF).

    Note:

    Alternatively, you can choose File, then Import, and then Mobile Application from Archive File (ADF).

  3. In the Location page, choose Browse in the MAA File field.

  4. In the Select MAA File to Import page, highlight the .maa file, as shown in Figure 17-40, and then click Open.

    Figure 17-40 Selecting the .maa File

    Select the .maa file.

  5. If needed, perform the following, or accept the default values:

    1. Enter a name for the ADF Mobile application derived from the .maa file in the Application File field, as shown in Figure 17-41.

    2. Click Browse to retrieve the directory of the ADF Mobile application.

    Figure 17-41 Entering the Directory Location

    Locations for the .maa file, new application.

  6. Click Next.

  7. Review the import summary information and then click Finish.

    Figure 17-42 Summary of ADF Mobile Application Archive Contents

    The contents of imported .maa file.

17.7.2 What Happens When You Import an ADF Mobile Application Archive File

ADF Mobile performs the following after you import an .maa file:

  1. Creates an application folder.

  2. Unpacks the workspace container (.jws) file from the .maa file to the application file and renames it per the user-specified value.

  3. Unpacks the adf directory and its contents to the application folder. This directory is renamed .adf.

  4. Unpacks the META-INF directory and its contents and places them in a src directory in the application folder.

  5. Unpacks the ExternalLibs directory and its contents to the application folder.

    Note:

    While any of the external resources contained in this directory are available in the ADF Mobile application that has been packaged as an .maa file (and imported into the application), the references to these resources will be invalid for ADF Mobile application derived from the .maa file.

  6. Unpacks the resources directory to the application folder.

  7. Unpacks all folders that contain FARs (or other libraries) that are internal to the original ADF Mobile application. ADF Mobile preserves the original locations of these artifacts.

  8. For each JAR file within the original ADF Mobile application's Projects directory, ADF Mobile performs the following:

    • Creates a project folder under the application directory that corresponds to the name of the JAR file (but without the .jar extension).

    • Unpacks the contents of the JAR files into the appropriate project folder. ADF Mobile includes the following in these project folders:

      • The original .jpr file.

      • The standard directories, such as META-INF, public_html, src, and adfmsrc.

      • The contents of the ExternalLibs directory.

        Note:

        While any of the external resources contained in this directory are available in the ADF Mobile project that has been packaged with the imported .maa file, the references to these resources will be invalid for an existing project, or a project created by importing the .maa file.

      • The classlib directory, which contains any Java classes packaged in a JAR file.

        Note:

        If the .maa file includes a classlib directory, then ADF Mobile adds all of the JAR files from this directory as library dependencies in the newly created ADF Mobile application.

17.8 Deploying ADF Mobile Applications from the Command Line

You can deploy iOS or Android applications from JDeveloper without starting the JDeveloper IDE using the OJDeploy command line tool. Command line deployment can serve as a tool for testing, as well as a means of deploying applications using a script.

After you have created iOS or Android deployment files using Deployment Profile Properties editor, you can use OJDeploy to deploy applications to iOS simulators and iOS-powered devices (through iTunes), or as iOS bundles (.ipa and .app files), or Feature Archive JAR files. Likewise, OJDeploy enables you to deploy applications to both Android emulators and Android-powered devices, or deploy them as an Android application package (.apk) file or as Feature Archive JAR files. For information on OJDeploy, see "Deploying from the Command Line" in Oracle Fusion Middleware User's Guide for Oracle JDeveloper.

Note:

To use OJDeploy on a Mac, add the following line to the ojdeploy.conf file:

SetSkipJ2SDKCheck true

This file is located at: jdev_install/jdeveloper/jdev/bin

17.8.1 Using OJDeploy to Deploy ADF Mobile Applications

The following commands enable you to deploy ADF Mobile deployment profiles:

  • deployToDevice—Deploys an application to iOS- or Android-powered devices. For iOS applications, this command is used in debugging scenarios where the application is deployed to a device using iTunes. For more information, see Section 17.4.5, "How to Distribute an iOS Application to the App Store."

  • deployToSimulator—Deploys an application to an iOS simulator (as an .app file) or Android emulator. You can only deploy an ADF Mobile application to an iOS simulator on an Apple computer.

  • deployToPackage—Deploys an iOS application as an .ipa file or an Android application as an .apk file. You can only package an application as an .ipa file on an Apple computer.

  • deployToFeatureArchive—Deploys a Feature Archive to a JAR file.

  • deployToApplicationArchive—Packages an ADF Mobile application as an ADF Mobile Application Archive (.maa) file.

You use these commands in conjunction with the ojdeploy command line tool, OJDeploy's arguments, and its options as follows:

ojdeploy deployToSimulator -profile <profile name> -workspace <jws file location>

Note:

OJDeploy commands and arguments are case-sensitive.

Table 17-8 lists the OJDeploy arguments that you use to modify the ADF Mobile deployment commands.

Tip:

Using the -help option with any command (such as ojdeploy deployToSimulator -help) retrieves usage and syntax information.

Table 17-8 OJDeploy Arguments for ADF Mobile Deployments

Argument Description

-profile

The name of the Android or iOS deployment profile. For example:

ojdeploy deployToSimulator -profile iosDeployProfile ...

-workspace

The full path to the ADF Mobile application workspace container (.jws) file. For example:

... -workspace /usr/jsmith/mywork/Application1/Application1.jws

To package an ADF Mobile application as an ADF Mobile Application Archive:

ojdeploy deployToApplicationArchive
         -profile applicationArchiveProfile
         -workspace /usr/jdoe/Application1/application1.jws

-project

For the deployToFeatureArchive command, you must provide the name of the project (that is, a view controller project) that contains the Feature Archive deployment profile. For example:

ojdeploy deployToFeatureArchive
         -profile farProfileName
         -project ViewController
         ...

-buildfile

The full path to a build file for batch deploy.

-buildfileschema

Print XML Schema for the build file.

In addition to the arguments listed in Table 17-8, you can also use OJDeploy options described in the "Command Usage" section of Oracle Fusion Middleware User's Guide for Oracle JDeveloper.

Note:

The following options are not supported:

  • -forcerewrite

  • -nocompile

  • -nodatasources

  • -nodepdendents

  • -outputfile

  • -updatewebxmlejbrefs

Table 17-9 provides examples of how to use the OJDeploy options with the ADF Mobile deployment commands.

Table 17-9 OJDeploy Options for ADF Mobile Deployments

Option Description

-clean

Deletes all files from the project output directory before compiling. For example:

ojdeploy deployToSimulator 
         -profile iosDeployProfile
         -workspace /usr/jsmith/jdeveloper/mywork/Application1.jws 
         -clean

-stdout, -stderr

Redirects the standard output and error logging streams to a file for each profile and project. For example:

ojdeploy deployToSimulator -profile iosDeployProfile
         -workspace /usr/jsmith/jdeveloper/mywork/Application1.jws 
         -clean
         -stdout /usr/jsmith/stdout/stdout.log
         -stderr /usr/jsmith/stderr/stderr.log

Table 17-10 lists the macros used with the deployToApplicationArchive command:

Table 17-10 Macros Used with ADF Mobile Application Archive Packaging

Macros Description

workspace.name

The name of the application workspace container file (without the .jws extension).

workspace.dir

The directory of the application workspace container (.jws) file.

profile.name

The name of the profile being deployed.

profile.dir

The default deployment directory for the profile.

base.dir

Override the current OJDeploy directory using this parameter. You can also override the current OJDeploy directory using the basedir attribute in the build script.