Build Tab for a Release

InstallShield 2016 » Releases View » Release

Project • The Build tab is available in the following project types:

Advanced UI
Basic MSI
InstallScript
InstallScript MSI
InstallScript Object
Merge Module
Suite/Advanced UI

The Build tab is where you configure how InstallShield should package your release.

Settings on the Build Tab

Setting

Project Type

Description

Release Location

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

Enter the path to the top-level directory where your release will start to be built, or click the ellipsis button (...) to browse to the location.

Build Location

Advanced UI, Suite/Advanced UI

Enter the path to the top-level directory where your release will start to be built, or click the ellipsis button (...) to browse to the location.

Product Name

Advanced UI, Suite/Advanced UI

To override the product name that was specified in the General Information view with a new value for the selected release, enter the appropriate name.

For information on how the product name is used, see Specifying a Product Name.

Product Version

Advanced UI, Suite/Advanced UI

To override the product version that was specified in the General Information view with a new value for the selected release, enter the appropriate version number. The version must contain only numbers. It is typically in the format aaa.bbb.ccccc or aaa.bbb.ccccc.ddddd, where aaa represents the major version number, bbb represents the minor version number, ccccc represents the build number, and ddddd represents the revision number. The maximum value for the aaa and bbb portions is 255. The maximum value for ccccc and ddddd is 65,535.

Note that although you can include the fourth field (ddddd), the installation does not use this part of the product version to distinguish between different product versions. To learn more, see Specifying the Product Version.

The product version that you specify is displayed on the Properties dialog box for Setup.exe. For more information, see Customizing File Properties for the Setup Launcher.

Suite GUID

Advanced UI, Suite/Advanced UI

To override the GUID that was specified in the General Information view with a new value for the selected release, enter the appropriate GUID. The Suite GUID uniquely identifies the Advanced UI or Suite/Advanced UI installation. To have InstallShield generate a different GUID for you, click the Generate a new GUID button ({...}) in this setting.

Since this code uniquely identifies your Advanced UI or Suite/Advanced UI installation, changing the Suite GUID after you have already distributed your release is not recommended.

Media Format

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

This read-only setting enables you to view the type of media selected for this release. You can set the media type only through the Release Wizard's Media Type panel; for InstallScript object projects, you cannot set the media type.

Compression

Basic MSI, InstallScript MSI, Merge Module

Specify whether the release should be compressed:

CompressedInstallShield compresses all of your product’s data files into .cab files.
UncompressedInstallShield does not compress your product’s files into .cab files.

As an alternative, you can use a custom compression method, which enables you to compress only the files that are associated with one or more features into .cab files. To set custom compression options, you must use the Release Configuration panel and the Custom Compression Settings panel in the Release Wizard.

Note that when you use the Release Wizard to configure custom compression, InstallShield changes the Compression setting in the Releases view to a read-only value of Custom (One Cab per Feature) or Custom (One Cab per Component). To change the compression from a custom method to the standard compressed method or the uncompressed method, you must use the Release Wizard again; you cannot do this from the Compression setting in the Releases view.

Note • The output of the build process depends on the media type that you are building (such as CD-ROM, DVD-5, or Network Image), whether compression is used (as specified in the Compression setting), whether you are including a setup launcher (as specified in the Setup Launcher setting on the Setup.exe tab), and whether you are using disk spanning (as specified in the Disk Spanning setting, which is applicable to CD-ROM, DVD, and Custom media types).

For example, if you select Compressed for the Compression setting, you select Yes for the Setup Launcher setting, and you are building a Network Image release, your data files are compressed into .cab files, and the .cab files are streamed into your Setup.exe file. If you select Uncompressed for the Compression setting, you select No for the Setup Launcher setting, and you are building a CD-ROM release that fits on one CD-ROM and uses automatic disk spanning, your data files are left uncompressed in a subfolder of the folder that contains the .msi file.

Cab Optimization Type

Basic MSI, InstallScript MSI, Merge Module

If Compressed or one of the custom options is selected for the Compression setting, specify the type of compression that InstallShield should use when building this release’s .cab files. Available options are:

LZXInstallShield uses LZX compression to compress your product’s data files into .cab files. This option results in the smallest .cab files; however, it also takes the most time to extract the data from these .cab files at run time.
MSZIPInstallShield uses MSZIP compression to compress your product’s data files into .cab files. This is the default option.
NoneInstallShield does not use any compression when creating the .cab files.

Important • Using compression generally decreases the size of your compressed files, but the build process may take more time to complete. Depending on the number and size of the files being compressed, the LZX compression and the build may take hours to complete. Therefore, if you select the LZX option, it is recommended that your build machine have the latest hardware to minimize the time that it takes for the build to complete.

Compress Script

InstallScript, InstallScript Object

Specify whether the compiled script file (.inx file) is placed in a cabinet file (Yes), or it is placed uncompressed in the Disk1 disk image folder (No).

Compiler Preprocessor Defines

InstallScript, InstallScript Object, Suite/Advanced UI

Optionally specify any preprocessor variable definitions. Preprocessor variable definitions that are specified here apply only to the current release; they are not used when compiling the script for other releases. Use the following format, with no spaces before or after equals signs or commas:

MYVARIABLE1=123,MYVARIABLE2

Such variables can be tested in the script by #if and #ifdef statements that control the flow of the script. If you are creating an InstallScript object, enter IFX_OBJECTS.

Entering the name of a preprocessor variable for this setting defines the variable. For example if you enter MYVARIABLE for this setting, the script commands in the following #ifdef loop are executed:

#ifdef MYVARIABLE

   // Commands

#endif

After you add or change a preprocessor variable definition for this setting, you must compile your installation for the addition or change to take effect.

Disk Spanning

Basic MSI, InstallScript MSI

This read-only setting indicates how your installation is spread across different disks. You can select a different option through the Disk Spanning Options panel in the Release Wizard. Available options are:

AutomaticInstallShield automatically splits your release files over as many disks as necessary.
Custom - Enforce disk sizeInstallShield displays a warning and aborts the build if any feature’s files are larger than the disk size.
Custom - Do not enforce disk sizeInstallShield builds the release to span as many disks as necessary.

This setting applies to the CD-ROM, DVD, and Custom media types.

Important • Multi-disk installations cannot be run from a non-removable media (for example, from a hard drive). If you want to test an installation that spans disks, you need to put the installation on your target media. If you do not, the installation will fail because of a limitation of the Windows Installer.

File Name Format

Basic MSI, InstallScript MSI, Merge Module

Select the file name format that should be used to determine how the paths of your files are stored in the .msi package. InstallShield stores the option that you specify in your .msi package’s Summary Information Stream.

If your installation will be distributed on media that does not support long file names, such as a UNIX server, select the Short File Names option.

Platform(s)

InstallScript, InstallScript Object

If the release is specific to one or more platforms, use this setting to indicate the platforms: click the value of this setting, and then click the ellipsis (...) button to specify the appropriate platforms.

If the platform specified for a component does not match one of the platforms that is selected for this setting, the component is not included in the release.

The default value for this setting is Use Project Settings. This value indicates that the release supports the platforms that are specified at the project level.

Layout

InstallScript

This read-only setting indicates whether the project’s files are stored in cabinet files or placed uncompressed in the disk image. You can modify this setting through the Media Layout panel in the Release Wizard. Available options are:

Cabinet File(s)InstallShield places all data files in one or more data cabinet files at build time.
CD-ROM Folder(s)InstallShield places all data files in one or more CDROM folders at build time.
CustomInstallShield places some data files in one or more CD-ROM folders and some in one or more data cabinet files at build time.

Data Languages

Basic MSI, InstallScript MSI, Merge Module

If you want to include certain components and exclude others based on the language that is selected for each component, click the ellipsis button (...) in this setting and specify the appropriate languages. If the language specified for a component does not match one of the languages that is selected for this setting, InstallShield does not include the component in the release.

By default, releases are language independent; that is, none of the project’s components are excluded from the release.

UI Languages

Advanced UI, Basic MSI, InstallScript MSI, Merge Module, Suite/Advanced UI

This setting lets you specify which user interface languages you want to include in a release. To select the appropriate languages, click the ellipsis button (...) in this setting.

Note that if a language is not selected in the Setup Languages setting in the General Information view of the project, it is not listed as one of the available languages for the UI Languages setting.

Language(s)

InstallScript, InstallScript Object

Use this setting if you want to include certain components and exclude others based on the language that is selected for each component. This setting also lets you specify which user interface languages you want to include in a release. If the language specified for a component does not match one of the languages that is selected for this setting, InstallShield does not include the component in the release. In addition, if a UI language that is included in the project does not match one of the languages that is selected for this setting, InstallShield does not include the UI strings in the release.

By default, releases are language independent; that is, none of the project’s components or UI strings are excluded from the release.

Note that if a language is not selected in the General Information view of a project, it is not listed as one of the available languages for the Language(s) setting.

Default Language

Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Suite/Advanced UI

To override the release’s default project language that is configured in the General Information view or the String Editor view, select the appropriate default user interface language for your installation.

For more information, see Setting the Default Project Language.

Languages Dialog

Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Suite/Advanced UI

Specify whether you want your installation to display the language selection dialog when the installation is run with a full user interface.

Tip • For Basic MSI projects—If you want the language selection dialog to be displayed, a Setup.exe setup launcher is required. To learn more, see Creating a Setup Launcher.

Build UTF-8 Database

Basic MSI, InstallScript MSI, Merge Module

Specify whether you want the Windows Installer database, along with any instance or language transforms, to be built using the UTF-8 encoding.

The UTF-8 encoding supports characters from all languages simultaneously, enabling you to mix and match, for example, Japanese and German, or Russian and Polish, both in text shown to end users and in file names and registry keys. These mixed languages work correctly regardless of the current language of the target system.

Important • As documented in Microsoft KB 979849 the Windows Installer does not fully support UTF-8 databases; therefore, some scenarios result in user interface issues. For example, if an end user runs the installation with a basic user interface (by using the /qb command-line option) or uninstalls the product from Add or Remove Programs, the Windows Installer uses very small fonts to display the user interface text in a UTF-8 database.

If you specify No, InstallShield creates an ANSI database when you build your release. This option does not let you mix characters from languages in different code pages.

The default value for this setting is No.

Previous Package

Basic MSI, InstallScript MSI, Merge Module

Enter the fully qualified path to a previous release (.msi file for an installation project, or .msm file for a merge module project) to minimize the size of future patch packages.

This setting corresponds to the Patch Optimization setting in the Release Wizard.

Note • If your package uses dynamic file linking, it is recommended that you specify a previous package in this setting so that the file keys are consistent across releases.

For more information, see Upgrade Considerations.

Generate File Hash Values

Basic MSI, InstallScript MSI, Merge Module

Indicate whether you want InstallShield to populate the MsiFileHash table for every unversioned file in your build. Available options are:

YesInstallShield populates the MsiFileHash table for every unversioned file in your build.
NoInstallShield does not populate the MsiFileHash table. If you select No, InstallShield builds any entries that are found in the project's MsiFileHash table (populated using the Direct Editor).

If you have already populated the MsiFileHash table for a particular file, the build uses that information instead of generating the information at build time.

For more information, see MsiFileHash Table in the Windows Installer Help Library.

Shallow Folder Structure

Basic MSI, InstallScript MSI

If you want InstallShield to create the .msi file and related files directly in the location that is specified in the Release Location setting, without any of the subfolders, select Yes.

To build the release if the release location is in <ISProjectDataFolder> or <ISProjectFolder>, click Build Tables & Refresh Files on the Build menu.

Generate Autorun.inf

Basic MSI, InstallScript MSI

Select Yes if you are distributing your installation on a CD-ROM or DVD-ROM and you want to support the AutoPlay feature. InstallShield creates a text file called Autorun.inf, which contains the instructions to autoplay your installation, in the root of your disk images folder.

You can edit this file to add additional AutoPlay options or to pass command-line parameters to MsiExec.exe, Setup.exe, or Update.exe.

Release Flags

Advanced UI Basic MSI, InstallScript MSI, Suite/Advanced UI

Release flags enable you to customize your installation by including or excluding certain items in each release. Enter the flags that you would like to include in this release. Separate multiple flags with a comma.

Project • For Basic MSI and InstallScript MSI projects—Once you have assigned release flags to your features, InstallShield prerequisites, and chained .msi packages, you can create a release that includes features, InstallShield prerequisites, and chained .msi packages based on those flags. By default, all features, InstallShield prerequisites, and chained .msi packages are included in a release. Once you specify a flag in either the Releases view or the Release Wizard, only unflagged items and items that contain the specified release flag are included in your installation.

For Advanced UI and Suite/Advanced UI projects—Once you have assigned release flags to features and packages in the Advanced UI or Suite/Advanced UI project, you can create a release that includes features and packages based on those flags. By default, all features and packages are included in a release. Once you specify a flag in the Releases view, only unflagged items and items that contain the specified release flag are included in your installation.

Note • If a release does not have release flags, it will include all applicable items that have release flags. To include only unflagged items, specify a flag that does not exist. For example, you might use NoFlags. This way, only unflagged items are built into a release.

For Basic MSI and InstallScript MSI projects—Note that you can also specify release flags at the product configuration level. For more information, see Product Configuration Flags vs. Release Flags.

Use Path Variable Test Values

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

If you used test values for any of your path variables, select Yes to set those variables to their actual values at this time.

Path Variable Overrides

Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module, Suite/Advanced UI

To override a path variable in your project at build time for the selected release, click the ellipsis button (...) in this setting, which launches the Path Variable Overrides dialog box. This dialog box lets you select one or more path variables that you want to override. InstallShield adds a new path variable setting for each path variable that you select. Configure each path variable setting as necessary.

Note that you can override user-defined path variables, environment variables, and registry variables that are configured in the Path Variables view; however, you cannot override predefined path variables such as <WindowsFolder>.

To learn more, see:

Overriding the Value of a Custom Path Variable for a Release
Using Path Variables

Path Variable Overrides Item

Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module, Suite/Advanced UI

Specify the new value of the path variable that you want InstallShield to use at build time for the selected release. The default value is the setting that is configured in the Path Variables view. InstallShield uses the new value that you specify in this setting to override the value that is set in the Path Variables view.

To delete the path variable override, click the Delete button in this setting.

Tip • You can refer to other path variables in the defined value by enclosing the referenced path variable name in angled brackets. For example, if you have a path variable called MyRoot with a value of C:\, you can refer to it in a path variable definition for another variable, such as Games. The actual path for the Games variable might be C:\Programs\GameFiles, but you can define Games as <MyRoot>\Programs\GameFiles. However, if you attempt to self-reference a path variable, the literal string is used instead. For example, defining Games as <MyRoot>\Programs\<Games> actually results in Games defined as C:\Programs\<Games>.

To learn more, see:

Overriding the Value of a Custom Path Variable for a Release
Using Path Variables

Features

InstallScript, InstallScript Object

This read-only setting indicates which features are included in the built release. You can modify the value of this setting from the Features panel in the Release Wizard.

Use the “Include in Build” feature property—If this option is selected, each feature whose Include In Build setting is set to Yes is included in the built release, and each feature whose Include In Build setting is set to No is not included.
Specify the features to be included directly—Specify for each feature whether the feature is included in the built release.

Specify Skin

InstallScript

Select the dialog skin that is applied to this release. The default value, <Use Project Setting>, uses the skin that is selected in the Skins folder of the Dialogs view; selecting any other value for this setting overrides the Skins folder selection.

Differential Media

InstallScript

Specify whether the current release (the release that is selected in the Releases view) is a differential release—that is, a release that contains only those files that were absent from one or more of a specified set of existing releases—or a full release, which contains all your product’s files, so that your product can be installed on a system on which no version of your product is currently installed.

For more information, see Differential vs. Full Releases.

Support Version(s)

InstallScript

This setting is applicable only if No is selected for the Differential Media setting.

Optionally enter a semicolon-delimited list of version numbers (for example, 1.2.3;1.2.4) of the earlier versions of your product to which this release can be applied as an update. If you leave this setting blank, the installation can be run on a system on which any earlier version, or no version, of your product is currently installed.

Object Difference

InstallScript

This setting is applicable only if Yes is selected for the Differential Media setting. Select the conditions for including InstallShield objects in your differential release.

Include All—The differential release includes all objects that would be included in the equivalent full update release.
Exclude All—The differential release does not include any objects.
Include If Changed—The differential release includes those objects that would be included in the equivalent full update release and that are not found in, or are different from, the corresponding object in at least one of the comparison releases.

Keep Unused Directories

Basic MSI, InstallScript MSI, Merge Module

Specify whether you want InstallShield to remove unused directories from the Directory table of the .msi file when you build this release. Available options are:

No—If a directory that is listed in the Directory column of the Directory table is not referenced in any known location in the .msi file, InstallShield removes it from the Directory table of the .msi file that it creates at build time. For Basic MSI and InstallScript MSI projects, this occurs after any merge modules are merged, but only directories that are present in the .msi file are removed; therefore, if a merge module contains new unused directories in its Directory table, the new unused directories are added to the installation.
YesInstallShield does not remove any directories from the Directory table of the .msi file that it creates at build time.

The default value is No.

Note • Under some conditions, predefined directories cannot be resolved, causing an installation to fail. Removing unused directories from the Directory table enables you to avoid unnecessary failures. Therefore, it is recommended that you select No for this setting.

Hide Add/Remove Panel Entry

InstallScript MSI

Specify whether you want to hide your product’s entry in Add or Remove Programs in the Control Panel:

No—Your product’s entry is displayed on the target machine in Add or Remove Programs.
Yes—Your product’s entry is not displayed on the target machine in Add or Remove Programs. The end user cannot use Add or Remove Programs to remove, modify, or view support information for your product.

To learn about how to indicate which information should be displayed for your product—including how to hide buttons in the Add or Remove Programs—see General Information View Settings.

See Also