Options.xml schema elements

The following sections describe the elements found in the 

Options.xml

 schema file.

This element creates the list of organizations that appear in the System selection window of the MSI.

baseUrl

: The full Base URL of the server where the Provider is: “http[s]://[server_name]/config/baseurl.asp.”

providerId

: The number of the organization.

label

: The value that appears in the MSI window.

Optional. The UpgradeCodes element is used when upgrading an existing installation of the desktop app.

The UpgradeGUID (or UpgradeCode) of the installed client to upgrade.

Note the difference between this node and EditionName (described below under SystemName.)

Deprecated. See the EditionName element.

This element is a child of the Editions element. Each EditionName element will be searched for and uninstalled if present.

This element is displayed in the MSI window. This element is number 2 in the following image.

This element is displayed in the MSI window. This element is numbers 3 and 4 in the following image.

The application name of the desktop app. For example, 

AtHoc

Gov. This element is item 1 in the image above.

This element is displayed in the MSI window. This element is always displayed as “

BlackBerry AtHoc

."

This element provides the user interface that allows the user to input the Base URL and Provider ID. Valid values are " yes" or "no." These values are case insensitive. The default is "no." 

This element determines whether or not deep cleaning of existing client installations is performed.

Valid values are "no" and "NO." These values are case sensitive. Any value other than “NO” or “no” will enable Deep Cleaning.

There are two custom actions involved in Deep Cleaning, both perform identical operations to search for remnants of existing clients:

Optional. This element provides a way to specify whether or not users can uninstall the client from the standard Windows UI. Valid values are "yes" and "no." These values are case insensitive. The default is "yes."

Optional. This element provides a mechanism to cause the machine to reboot after installing the client. Valid values are "yes" and "no." These values are case insensitive. The default value is "no."

Optional. Default: none. The text to display above the list of organizations instead of the default “Select Your System.” This element is item 5 in the MSI image below.

This element provides a way to modify the text. This element is item 6 in the image below.

 

This element provides a list of 

AtHoc

 desktop client names that the code will look for and attempt to uninstall if Deep Cleaning is enabled. The code performs Deep Cleaning on each edition in this list.

If this node is empty, then a default list of edition names in 

CallUninstaller.cpp

 is used to perform the uninstallalation and deep cleaning operations (acceptableEditionNameSet).

(Subnode of AcceptableEditions.) This element specifies the names of different editions of the 

BlackBerry AtHoc

 desktop app. There are no spaces in the names.