Package with the Ripple emulator

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.

Before the Ripple emulator came along, you had to use the command line tools included with the BlackBerry 10 WebWorks SDK to build, package, and sign your app. 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 10 WebWorks SDK behind the scenes, so you still need to download and install the BlackBerry 10 WebWorks SDK.

You can find the BlackBerry 10 WebWorks SDK on the Downloads page.

For some versions of Windows, you may need to be logged into an account with administrator privileges to successfully build your BlackBerry WebWorks app.

Packaging options in Ripple

Packaging options are listed on the Build panel in the Ripple emulator.

This image shows the packaging options available in the Ripple emulator.

Option

Description

Package

This option builds and packages your app.

It creates the .zip and .bar files for the app.

Package & Sign

This option builds, packages, and signs your app.

It creates the .zip and signed .bar files for the app.

Package & Launch

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

It creates the .zip and .bar files for the app.

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.

Ripple platform selection

Set your build settings

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

This image shows the Package settings in the Ripple emulator.

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 app.

Project Root

The location of your project.

Required: This setting is required to package your app.

Archive Name

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

Required: This setting is required to package your app.

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 app.

Enable Remote Web Inspector

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

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

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

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 app.

Bundle Number

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

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

Target

Choose Simulator to launch your app on a BlackBerry 10 Device Simulator or Target to launch your app on a BlackBerry 10 device.

Conditional: This setting is required only if you are launching your app.

Device IP

The IP address of your BlackBerry 10 Device Simulator or BlackBerry 10 device.

Conditional: This setting is required only if you are launching your app.

Device Password

The password for your BlackBerry 10 Device Simulator or BlackBerry 10 device.

Conditional: This setting is required only if you are launching your app.

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 file (config.xml) file in the project root. For more information about config.xml files, 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.

The .zip and .bar files for the app are stored in the specified output folder.

Last modified: 2014-03-10

comments powered by Disqus