This page gives you the possibility to configure the update. At build time, these settings will be saved in an Updates Configuration File.
Update Properties
Display Name
This is the name for the update that will be displayed to the user and corresponds with the "Name" key from the Updates Configuration File. This string can be localized.
Download URL
The URL from where the update file should be downloaded from and corresponds with the "URL" key from the Updates Configuration File.
The file can also be placed in a location on the local network or local machine. This can be specified with the following syntax: file://location of the file.
Examples:
- Local network: file://computername\path\filename.ext
- Local computer: file://c:\updates\file.exe
Updates from local network are not downloaded on the local
machine, but are installed from their network location.
Product Version
This field contains the product version number of the current patch or upgrade package. The product version number written here should be equal with the value from the ProductVersion property of the patch or upgrade package that will be installed. This field is important only for upgrade packages which will be downloaded and installed if the generated INI file (from the current project) is being used with the Check for a newer version of the installation package before installing the current one option available from the "Prerequisites Page" for an installation project .
This option should be used along with This update is a patch and not a full
package option for patch packages. If the
later option is not enabled for a patch package then the EXE
bootstrapper will download and try to install the patch which will
fail since a full installation package is required to install the
application.
Release Date
The date on which this update was released. It corresponds with the "ReleaseDate" key from the Updates Configuration File. This entry is necessary if you plan to use the license validity check feature in the Advanced Functionality.
Critical Update
Marks the update as critical. It corresponds with the "Flags" key from the Updates Configuration File. It is used for automatically download and install of some types of updates.
Delete the downloaded update package file after installation
If this option is checked then the downloaded update package is deleted after the update is installed no matter if the update was installed successfully or not. It corresponds with the "Flags" key from the Updates Configuration File.
Update Installer
File Path
Specify the location of the update file on the disk.
Command Line
Command line parameters to be used when installing this update. It corresponds with the "CommandLine" key from the Updates Configuration File. For example, using the "/qn" parameter for a MSI update will make it install silently, without any UI.
Compute MD5 signature from file.
Specify whether you want to use the MD5 signature to check the update file integrity. It corresponds with the "MD5" key from the Updates Configuration File.
Attempt to suppress GUI or console
The update will be installed without user interface. This flag is to be used for console applications. It corresponds with the "Flags" key from the Updates Configuration File.
In order to achieve this behavior for MSI update files you can
launch them with the "/qn" command line parameter.
This update is a patch and not a full package
This option will mark the update as a patch ensuring that it will be skipped when using the generated INI file (from the current project) in combination with the Check for a newer version of the installation package before installing the current one option available from the "Prerequisites Page" for an installation project.
If this generated INI file is used in combination with Advanced
Updater this options will not prevent the patch from
being installed.
Installed Detection
In this section you can specify the detection method for the updates. It is used by the Updater to determine whether an update is installed or not. If the comparison condition is true, the update is considered installed and its download is stopped.
The "Detect if the update is already installed by running a" combobox allows you to select between four possible options, each detailed below.
Registry Value Search
By selecting this option, the install detection will be performed by running a registry value search.
Registry Value - The location in the registry where the version is stored. It corresponds with the "RegistryKey" key from the Updates Configuration File. You can either specify it directly or use the button to select it.
The default search uses HKUD registry hive which
makes the Updater check both HKEY_CURRENT_USER and
HKEY_LOCAL_MACHINE. If you want to check only a specific hive you
can use HKCU for HKEY_CURRENT_USER and
HKLM for HKEY_LOCAL_MACHINE.
The recommended installed detection criteria is this:
- in the original installation package you create a registry entry which contains the version of the package (you can use the ProductVersion property).
- in the "Installed Detection" section of the Updates configuration project use this registry value as a detection criteria.
- you set the version of the update package as the additional criteria.
This way the Updater will verify which version of the package is installed.
If you are using a 64-bit registry entry, make sure you enable
the 64-bit option. Otherwise only 32-bit registry
entries will be checked on a 64-bit machine.
Expected value( Version ) - The version used for comparison. It can be directly specified or you can get it from a file. Use the button to select the file.
64-Bit - This checkbox enables the Update to use a 64-bit installation package. The Updater will detect if the update is installed using the 64-bit registry on a 64-bit OS.
File Version Search
By selecting this option, the install detection will be performed by running a file version search.
File Path - The location of the file that must be present in order for the update process to be considered successful. It corresponds with the "FilePath" key from the Updates Configuration File. This string can contain the following references:
- [APPDIR] - The default path where the application is installed. This detection criteria might fail if the user will change the install default location.
- Environment Variables - Enclose the environment variable name in "%".
- ProductCode and ComponentId - If the update is a MSI file, you
can use the component ID associate with a resource to detect
whether if the resource is installed. The string should have the
following format:
[{ProductCodeGUID}{ComponentIdGUID}].
Example: [{A1D0B7F7-12EE-4CCC-97DC-3F045B47523E}{D87552E1-C3AF-401D-83ED-00C73207A336}]
Expected value( Version ) - The file version used for comparison. It can be directly specified or you can get it from a file. Use the button to select the file.
File Size Search
By selecting this option, the install detection will be performed by running a file size search.
File Path - This field has the same format as its correspondent from the File Version Search section above.
Expected value( File Size ) - The size of the file used for comparison. It can be directly specified or you can get it from a file. Use the button to select the file. A match in the file size means that the update is installed.
Because a mismatch in the file size is automatically viewed
as a missing update, you should always use the “Add Update >
Replaces” context menu or toolbar
button option for the newer updates. This way you'll avoid older
updates being installed just because the file size was different
after installing a newer update.
Custom EXE
By selecting this option, the install detection will be performed using your own custom EXE file. It corresponds with the "CustomDetection" key from the Updates Configuration File. The custom .EXE must set the exit code to be different from zero if the update is already installed, otherwise set to zero. This way, the Updater will run the executable and use its exit code to determine if the update is installed or not.
EXE Path - Location of the executable file. String has the same format as the "File Path" field from the File Version Search section above.
Arguments - Command line parameters used when running the custom detection executable.