Package with Ripple

Using the Ripple emulator, you can build and package your web application. You can also sign and launch it in the BlackBerry 10 Device Simulator, BlackBerry Tablet Simulator, or BlackBerry Smartphone Simulator.

Before the Ripple emulator came along, you had to use the command line tools included with the BlackBerry WebWorks SDK to build, package, and sign your application. Now, all those actions can be in done in the Ripple emulator without having to open a command prompt.

The Ripple emulator uses the BlackBerry WebWorks SDK behind the scenes, so you'll still need to download and install the BlackBerry WebWorks SDK.

There are three versions of the BlackBerry WebWorks SDK: one for developing BlackBerry 10 apps, one for developing BlackBerry PlayBook apps, and one for smartphone apps for BlackBerry 7 and earlier. Download and install the SDK for the platform that you are developing for. If you are developing apps for more than one platform, download and install the SDK for each one. You can find the BlackBerry WebWorks SDKs on the Downloads page.

If your operating system is Windows 7 or Windows Vista, you may need to ensure that bbwp and java are running with administrator access. Otherwise, these executables will not have access to run, and you will encounter errors when you try to build your BlackBerry WebWorks application.

Packaging options in Ripple


This image displays the available packaging options.

Option

Description

Package

This option builds and packages your application.

For smartphone applications developed for the BlackBerry OS, this option creates the .zip and .cod files for the application.

For BlackBerry PlayBook OS applications and BlackBerry 10 OS applications, this option creates the .zip and .bar files for the application.

Package & Sign

This option builds, packages, and signs your application.

For smartphone applications developed for the BlackBerry OS, this option creates the .zip and signed .cod files for the application.

For BlackBerry PlayBook OS applications and BlackBerry 10 OS applications, this option creates the .zip and signed .bar files for the application.

Package & Launch

This option builds, packages, and launches your application on the specified simulator.

For smartphone applications developed for the BlackBerry OS, this option creates the .zip and .cod files for the application.

For BlackBerry PlayBook OS applications and BlackBerry 10 OS applications, this option creates the .zip and .bar files for the application.

To use any of these packaging options, you must configure the settings for the platform you are using:

  • For BlackBerry 10 OS apps, choose BlackBerry 10 WebWorks.
  • For BlackBerry PlayBook OS apps, choose WebWorks-TabletOS.
  • For BlackBerry OS apps, choose WebWorks.

Available platforms in Ripple

Set your build settings

  • Ripple settings for BlackBerry 10 OS applications

    To access the package settings in the Ripple emulator, select the Build panel and then select Settings.

    Setting

    Description

    SDK Path

    The path to where the BlackBerry 10 WebWorks SDK is installed. The following are the default SDK paths:

    Windows XP: C:\Program Files\Research In Motion\BlackBerry 10 WebWorks SDK <version>

    Windows 7: C:\Program Files (x86)\Research In Motion\BlackBerry 10 WebWorks SDK <version>

    Mac OS: /Developer/SDKs/Research In Motion/BlackBerry 10 WebWorks SDK <version>

    Required: This setting is required to package your application.

    Project Root

    The location of your project.

    Required: This setting is required to package your application.

    Archive Name

    The name you want the archive file to be (for example, HelloWorld).

    Required: This setting is required to package your application.

    Output Folder

    The location where you want the output to reside. This cannot be the same location as the Project Root.

    Required: This setting is required to package your application.

    Signing Password

    The private key password you used when you registered your signing key.

    Conditional: This setting is required only if you are signing your application.

    Bundle Number

    The bundle number for your application (for example, 1.0.0.x, where x is the bundle number). After you successfully sign the application, this number automatically increases by 1.

    Conditional: This setting is required only if you are signing your application.

    Device IP

    The IP address of your BlackBerry 10 Device Simulator.

    Conditional: This setting is required only if you are launching your application in a simulator.

    Device Password

    The password for your BlackBerry 10 Device Simulator.

    Conditional: This setting is required only if you are launching your application in a simulator.

  • Ripple settings for BlackBerry PlayBook OS applications

    To access the package settings in the Ripple emulator, select the Build panel and then select Settings.

    This image display the settings window for webworks for tablets.

    Setting

    Description

    SDK Path

    The path to where the BlackBerry WebWorks SDK is installed. The following are the default SDK paths:

    Windows XP: C:\Program Files\Research In Motion\BlackBerry WebWorks SDK for TabletOS <version #>

    Windows 7: C:\Program Files (x86)\Research In Motion\BlackBerry WebWorks SDK for TabletOS <version #>

    Mac OS: /Developer/SDKs/Research In Motion/BlackBerry WebWorks SDK for TabletOS <version #>

    Required: This setting is required to package your application.

    Project Root

    The location of your project.

    Required: This setting is required to package your application.

    Archive Name

    The name you want the archive file to be (for example, HelloWorld).

    Required: This setting is required to package your application.

    Output Folder

    The location where you want the output to reside. This cannot be the same location as the Project Root.

    Required: This setting is required to package your application.

    Enable Remote Web Inspector

    This setting specifies whether to enable or disable the remote web inspector. When you package your application with this setting enabled, you can use the remote web inspector to debug and profile your application on a device.

    Note: You should disable the remote web inspector when you are packaging your application for distribution to the BlackBerry World storefront.

    Conditional: This setting is required only if you are testing your application with the remote web inspector.

    CSK Password

    The password you specified for your keystore (when you registered with the RIM Signing Authority).

    Conditional: This setting is required only if you are signing your application.

    P12 Password

    The password you specified when you created your developer certificate. Otherwise, this is your keystore password.

    Conditional: This setting is required only if you are signing your application.

    Bundle Number

    The bundle number for your application (for example, 1.0.0.x, where x is the bundle number). After you successfully sign the application, this number automatically increases by 1.

    Conditional: This setting is required only if you are signing your application.

    PlayBook IP

    The IP address of your BlackBerry Tablet Simulator.

    Conditional: This setting is required only if you are launching your application in a simulator.

    PlayBook Password

    The password for your BlackBerry Tablet Simulator.

    Conditional: This setting is required only if you are launching your application in a simulator.

  • Ripple settings for BlackBerry 7 and earlier applications

    To access the package settings in the Ripple emulator, select the Build panel and then select Settings.

    Setting

    Description

    SDK Path

    The path to where the BlackBerry WebWorks SDK is installed. The following are the default SDK paths:

    Windows XP: C:\Program Files\Research In Motion\BlackBerry WebWorks SDK <version #>

    Windows 7: C:\Program Files (x86)\Research In Motion\BlackBerry WebWorks SDK <version #>

    Mac OS: /Developer/SDKs/Research In Motion/BlackBerry WebWorks SDK <version #>

    Required: This setting is required to package your application.

    Project Root

    The location of your project.

    Required: This setting is required to package your application.

    Archive Name

    The name you want the archive file to be (for example, HelloWorld).

    Required: This setting is required to package your application.

    Output Folder

    The location where you want the output to reside. This cannot be the same location as the Project Root.

    Required: This setting is required to package your application.

    Password

    The private key password you used when you registered your signing key.

    Conditional: This setting is required only if you are signing your application.

    Simulator

    Select a simulator from the list. The Ripple emulator detects the available simulators, including simulators that were installed with the BlackBerry WebWorks SDK and any standalone simulators that you may have installed.

    Conditional: This setting is required only if you are launching your application in a simulator.

    This image shows the settings dialog window for WebWorks for smartphones.

Package your app

Before you begin:
  • Make sure that you configure the "Build" settings in the Ripple emulator.
  • Make sure that you store the configuration document (config.xml) file in the project root. For more information about configuration documents, see Create your config.xml file.
  1. Select the Build panel.
  2. If the build and deploy services are not currently running, click Start Services.
  3. Select Package.

The Ripple emulator builds your application. If the build and package completes successfully, the message "Build succeeded!" is displayed.

For smartphone applications developed for the BlackBerry OS, the .zip and .cod files for the application are stored in the specified output folder. For BlackBerry PlayBook OS applications and BlackBerry 10 OS applications, the .zip and .bar files for the application are stored in the specified output folder.

Last modified: 2013-05-02