Create a .zip file for an app release

As an alternative to uploading all of the file bundles for an app manually when you add a release for an app, you can create a .zip file to collect all of the files and data that are required, and you can upload the .zip file.
  1. On your computer, create and name a folder for the release (for example, Sales_App_1.0). Any naming scheme can be used to name the folder.
  2. In this folder, create and name a subfolder for each bundle that you want to upload (for example, Bundle_6.0.0 and Bundle_7.0.0). Refer to the naming conventions for more information. Each bundle contains the files for a different variant of the app. You could have separate bundles for different BlackBerry devices, software versions, or device platforms (BlackBerry smartphone or BlackBerry PlayBook tablet).
  3. In each bundle subfolder, add the .cod files or .bar files that are required to run the app.
  4. In each bundle subfolder, create a text file named devices.txt file. In each devices.txt, specify the BlackBerry device models that the bundle supports. Specify the devices by listing the device model numbers in a comma-separated list (for example, 8900,8800,9530,9500), or include the model numbers on separate lines. For more information about how to format each devices.txt file, see Contents of a .zip file for a release.
  5. In the release folder, create an .xml file named release.xml. In release.xml, specify the release version, release notes, and localization data for each bundle. For more information, see Contents of a .zip file for a release.
  6. Convert the release folder to a .zip file using file compression software.

Contents of a .zip file for an app release

Item

Description

File name

Any naming scheme can be used to name the .zip file.

File structure

The .zip file for a release must contain the following:
  • A release.xml file, specifiying the version of the release, release notes, and localization data for each bundle.
  • Bundle subfolders, with application files for each different variant of the app in separate subfolders.

If you do not need to upload multiple bundles for different variants of an app, then bundle subfolders are not required.

Bundle subfolders

Each bundle subfolder must contain the following:
  • The .cod files or .bar files that are required to run the application on devices
  • A devices.txt file to specify the device models that the bundle supports

The application files in each bundle can be designed for different devices, different software versions, or different device platforms. You must create separate subfolders for .cod files and for .bar files.

The name of the bundle subfolder specifies the earliest version of the operating system that the bundle supports. The name must use the following format: bundle_name_x.x.x.x, where x.x.x.x represents the version of the BlackBerry Device Software, BlackBerry PlayBook OS, or BlackBerry 10 OS.

If the bundle name does not use this format, the earliest version of the BlackBerry Device Software that the bundle can support is 4.2.0. The earliest version of the BlackBerry PlayBook OS that the bundle can support is 1.0.

If multiple bundles support the same device, the bundles should not also support the same minimum version of device software. If multiple bundles support the same device and the same minimum version of device software, BlackBerry World storefront users can receive either bundle when they download the app.

release.xml file

The release.xml file specifies the version of the release and any relevant release notes, and can also be used to specify localization data for each bundle. Save the release.xml file in UTF-8 format, and use the following format in the release.xml file:

<?xml version="1.0" encoding="utf-8"?>
<Release version="x.x.x.x">
       <ReleaseNotes>Release note text</ReleaseNotes>
       <filebundle name="Bundle1_x.x.x.x">
            <language>language_code</language>
       </filebundle>
       <filebundle name="Bundle2_x.x.x.x">
            <language>language_code</language>
       </filebundle>
</Release>
The following example specifies language support for two different bundles:
<?xml version="1.0" encoding="utf-8"?>
<Release version="2.0.0.0">
       <ReleaseNotes>This release introduces support for Canadian French.</ReleaseNotes>
       <filebundle name="EnglishBundle_5.0.0.0">
            <language>en_ca</language>
       </filebundle>
       <filebundle name="FrenchBundle_4.6.1.0">
            <language>fr_ca</language>
       </filebundle>
</Release>

The bundle EnglishBundle_5.0.0.0 supports Canadian English, and FrenchBundle_4.6.1.0 supports Canadian French. If you specify language support at the bundle level, every .cod file or .bar file in the bundle must support the language that the release.xml file specifies.

The release version number must not exceed four octets. BlackBerry World truncates additional numbers.

devices.txt file

The devices.txt file specifies the device models that a bundle supports. A devices.txt file must contain the smartphone model numbers or tablet model numbers in a comma-separated (,) list, or the model numbers must appear on separate lines. BlackBerry World does not process values that are not valid. The following text is an example of the contents of a devices.txt file: 8900,8800,9530,9500 8707h,8707v,8707g,8705g.

If you do not create a devices.txt file, you must manually specify the platform and devices that each bundle supports when you upload the .zip file to the vendor portal. Do this when adding a file bundle on the vendor portal by clicking the Edit icon under Device Support. A selectable list of supported device models appears.

.cod files or .bar files

These file types contain the application binary for an app. .cod files are designed for smartphones that support BlackBerry device software earlier than BlackBerry 10, and .bar files are designed for tablets and smartphones that support BlackBerry 10 and later. The .cod files or .bar files can be located in bundle subfolders, or if you do not need to upload multiple bundles, in the root of the release folder. Any .cod files or .bar files that are located in the root of the release folder are assigned to a bundle that is named New Bundle when you upload the files to the vendor portal.

You can specify language support for a .cod file or .bar file in the file name. For example, a .cod file with the name CodName_fr_ca.cod supports Canadian French. Language support at the bundle level takes precedence over language support at the file level.

comments powered by Disqus