Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry AtHoc
  3. Desktop App 6.2.x.280 (Windows), 1.9 (Mac)
  4. Desktop App Installation and Administration Guide
  5. Appendix A: Build settings
  6. Options.xml schema

Options.xml schema

MSI behavior is controlled by the values in the 
options.xml
 schema.
The following are guidelines for creating or updating the 
options.xml
schema:
  1. BaseUrlVpsList element: This element is always updated for a new edition or repackage.
    1. One or more Element nodes must be present. This information is used when running the MSI manually, not when running from a script.
    2. Each element adds another record to the list of providers on the Select Your System dialog.
  2. UpgradeCodes element: This element provides a way to upgrade an existing installation of the desktop app. Do not add this element unless the installation should allow end users to uninstall their existing client before installing the new client. The installer prompts the user and shows their existing clients in a list, and the user must select the client to uninstall.
  3. Editions element: Do not add this element unless you must set DeepCleaning to Yes, and you need the same client edition to be searched and removed during install. This should never be the case, there are other ways to uninstall the client and DeepCleaning causes the MSI to return a failure code.
  4. ProductName, SystemName, ServerProductName nodes:  Do not change these elements.
  5. EditionName: This element is always updated for a new edition but never for a repackage. This element contains the name of the edition.
  6. ConnectionInstructions: Do not include this element unless requested otherwise.
  7. ManualSelection: Enable this element only when requested. This element allows the end user to manually enter the base URL and provider ID.
  8. DeepCleaning: You can enable the DeepCleaning element. However this element was disabled in desktop app release 6.2.269 and later, so DeepCleaning does not occur.
  9. UninstallOption: This element should default to “no” for government and military customers, but should be set to “yes” for other customers unless requested otherwise.
    The value in the 
    run.bat
     file overrides this value.
  10. ScheduleReboot: Do not include this element unless requested otherwise.
  11. BaseUrlVpsListHeaderText: Do not include this element unless requested otherwise.
  12. AcceptableEditions: This list should not include any editions that the customer does not have. Since it is used by DeepCleaning and that has been disabled, the list is irrelevant most of the time.