Release Flags
InstallShield 2020
Project:The following project types include support for release flags:
| • | Basic MSI |
| • | InstallScript MSI |
| • | Suite/Advanced UI |
When you build your release, you can include and exclude features, InstallShield prerequisites, and chained .msi packages depending on the type of release. For example, if you are creating a trial version of your product and do not want to include all the features in the build, you can flag features and then specify those flagged features under the product configuration or the release.
To filter features, InstallShield prerequisites, and chained .msi packages based on release flags:
| 1. | Assign release flags to the features, InstallShield prerequisites, and chained .msi packages. |
For detailed information on how, see Assigning Release Flags to Features, Assigning Release Flags to InstallShield Prerequisites, or Assigning Release Flags to a Chained .msi Package.
| 2. | Specify which flags to include in the release if appropriate. |
The scenario of a trial version versus a full version is a good example of why you might use release flags. The table below gives an example of four different features that may be available in a product, depending on which version the end user receives.
In this example, the full version comes with the application’s executable file, help files, a spellchecker, and an add-on pack that is included as a chained .msi package. The trial version does not include the add-on pack, but it does include an upgrade pack. Rather than having to create two separate installation projects for what is essentially one product, you can flag those features that are specific to certain versions. For example, the add-on feature is flagged as Full and the upgrade feature as Trial.
|
Feature, InstallShield Prerequisite, or Chained .msi Package |
Version |
Release Flag |
|
Windows Installer 4.5 Redistributable (InstallShield prerequisite) |
All Versions |
Not applicable |
|
Program_Executable (feature) |
All Versions |
Not applicable |
|
Help_Files (feature) |
All Versions |
Not applicable |
|
Spellchecker (feature) |
Full Version |
Full |
|
Add_Ons (chained .msi package) |
Full Version |
Full |
|
Upgrade_Pack (feature) |
Trial Version |
Trial |
If you build your release through the Release Wizard, you are given the option of including any flagged features, flagged InstallShield prerequisites, and flagged chained .msi packages into your release. By default, the release contains all features, InstallShield prerequisites, and chained .msi packages. If you specify the release flag Full in the Filtering Settings panel of the Release Wizard, only the Spellchecker feature and the Add_Ons chained .msi package—along with all features and InstallShield prerequisites without release flags—are built into your release. The upgrade pack is not included in the installation.
Tip:By default, all features, InstallShield prerequisites, and chained .msi packages are included in a release. When you specify a release flag in either the Releases view or the Release Wizard, only the unflagged features, the unflagged InstallShield prerequisites, the unflagged chained .msi packages, the features that contain the specified flag, the InstallShield prerequisites that contain the specified flag, and the chained .msi packages that contain the specified flag are included in your installation. InstallShield does not include in the release any features, InstallShield prerequisites, or chained .msi packages that have a release flag that you did not include in the Releases view or Release Wizard.
See Also
Conditionally Launching Custom Actions Based on Release Flags