Creating a BlackBerry WebWorks archive file

A BlackBerry WebWorks archive is a .zip file you can create with any zip archiving tool, which you then package using the BlackBerry WebWorks Packager command line tool (bbwp) to create an app. The BlackBerry WebWorks Packager is included in the BlackBerry 10 WebWorks SDK. If you are using the Ripple emulator to package your app, you don't need to create an archive file because the Ripple emulator automatically creates one during the packaging process.

With the BlackBerry 10 SDK, you can package your app by using a .zip file as input or by specifying a folder location. For more information, see Package your app.

Limit the name of your .zip file to no more than 20 characters (not including the .zip extension). If you have previously submitted the app to BlackBerry World, you cannot change the .zip file name for subsequent releases; it must remain the same. If the .zip file name has been changed, an attempt to upgrade the app will not succeed.

When you create a .zip file to use as your BlackBerry WebWorks archive file, include the following:
  • configuration file (config.xml)
  • start page (index.html)
  • app icons
  • other resources and objects that are referenced in your web pages

Reserved file names and folder names

The file names that are reserved by the BlackBerry WebWorks Packager are case insensitive.

The bin and src folders in an app archive are not reserved, but you should be aware of the consequences of using them when compiling your app with the command line tool. If you build your app with the command line tool without specifying an output directory, the default output directory is a "bin" directory in the same folder as the zip archive passed into the command line tool. If your app's "bin" directory is at this location, it will be overwritten with the output of the command line tool. This same side effect will hold true if you have a "src" directory at the same location as your zip archive and you use the command line flags to generate the raw source code for your app. The simple way to avoid this issue is to specify an output directory for your app that is not the same as the directory that contains your "bin" and "src" directories.

Reserved name Description
config.xml This file name is reserved for the configuration file.
signature[0..9].xml These file names are reserved for the BlackBerry Signature Tool configuration file for use in BlackBerry smartphone apps running on BlackBerry 7 or earlier.
icon.gif, icon.jpg, icon.png These file names are reserved for the default icon image for BlackBerry smartphone apps running on BlackBerry 7 or earlier. The icon.png file is reserved for the default icon image for BlackBerry tablet and BlackBerry 10 apps.
Thumbnail.gif, Thumbnail.png These file names are reserved for thumbnail graphics for BlackBerry smartphone apps running on BlackBerry 7 or earlier.

Last modified: 2014-03-10



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus