Common Tab

InstallShield 2015 » Packages View

Project: This information applies to the following project types:

Advanced UI
Suite/Advanced UI

Project-specific differences are noted where appropriate.

Edition: The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project type is available in the Premier edition of InstallShield. For information about the differences between these two project types, see Advanced UI Projects vs. Suite/Advanced UI Projects.

The Common tab in the Packages view is organized into the following main categories:

General
Operation
Configuration (This is available for Web Deploy packages.)
Events (This is available in Suite/Advanced UI projects.)

General Settings

Use a package’s General settings to specify details such as the display name and the conditions under which the Advanced UI or Suite/Advanced UI installation should launch the package.

Note that some settings are not applicable to all types of Advanced UI or Suite/Advanced UI package files.

General Settings on the Common Tab

Setting

Type of Package File

Description

Package GUID

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Enter a GUID that uniquely identifies this package. To have InstallShield generate a different GUID for you, click the Generate a new GUID button ({...}) in this setting.

Display Name

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Enter the name that you want to be displayed for this package at run time.

When you type a value for this setting, you are creating a string entry and setting its initial value for all of the languages that are currently in the project. As an alternative to typing a new value, you can click the ellipsis button (...) in this setting to select an existing string. For more information, see Using String Entries in InstallShield.

When you type a value for this setting, you can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

Product Configuration

Basic MSI project

Select the product configuration that contains the release in the InstallShield project that you want to associate with the selected package.

When you start a build of a release for a Suite/Advanced UI project that includes one or more InstallShield project packages, InstallShield first builds the designated releases in the associated InstallShield projects, and includes them as packages in the Suite/Advanced UI installation that it generates.

Release

Basic MSI project,
InstallScript project

Select the release in the InstallShield project that you want to associate with the selected package.

When you start a build of a release for a Suite/Advanced UI project that includes one or more InstallShield project packages, InstallShield first builds the designated releases in the associated InstallShield projects, and includes them as packages in the Suite/Advanced UI installation that it generates.

Location

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Specify where the package should be located. Available options are:

Copy From Source Media—Store the package and its files on the source media.

If the Advanced UI or Suite/Advanced UI installation will be run uncompressed from fixed media—such as CD, DVD, or local network—use this option.

Extract From Setup.exe—Compress the package and its files into Setup.exe, to be extracted at run time, if necessary.

If the entire Advanced UI or Suite/Advanced UI installation must be self-contained in Setup.exe, select this option. Note that the Download From The Web option results in smaller installations and shorter download time; however, the Extract From Setup.exe option provides for a completely self-contained installation.

Download From The Web—Download the package and its files (if necessary) from the URL that is specified for the package.

This option is recommended if your installation will be downloaded from the Internet and you want to minimize the Advanced UI or Suite/Advanced UI package size and download time. An Advanced UI or Suite/Advanced UI package is not downloaded if the correct version is already present on the target system.

Note that the option that you select in the Location setting may be overridden in the Releases view.

URL

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Enter the URL for the root folder that will contain the selected package and its folders and files. The package and any accompanying files are downloaded from this location to target systems at run time if the package needs to be launched.

This setting is applicable if Download From The Web is selected in the Location setting.

Package Type

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Project: In Suite/Advanced UI projects, this setting is available for edit. In Advanced UI projects, this setting is read-only, since an Advanced UI project has support for only one primary package.

In a Suite/Advanced UI project: Select the type of package that identifies whether the presence of this package on the target system should influence whether the Suite/Advanced UI installation runs in first-time-installation mode or maintenance mode.

Available options for this setting are:

Primary—The selected package is a main part of the Advanced UI or Suite/Advanced UI installation.

At run time, if all of the primary packages in the installation are absent from the target system, the installation runs as a first-time installation. If any of the primary packages are present on the target system, the installation runs in maintenance mode.

Dependency—The selected package should not be a factor in determining which mode is used to run the Advanced UI or Suite/Advanced UI installation.

For more information, see Primary Packages vs. Dependency Packages in Advanced UI and Suite/Advanced UI Projects.

Cache Path

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Specify where the cached package and other package files should be stored on the end user’s system. You can enter a hard-coded value such as C:\CachedFiles, but it is recommended that you use a destination property value in the list for the path. The default value is as follows:

[LocalAppDataFolder]Downloaded Installations

The Setup.exe tab in the Releases view lets you specify whether you want to cache the packages on target systems for any packages that are run on target systems and that have a cache path defined. If you are building an uncompressed release, you may want to avoid caching packages on the target system.

When you type a value for this setting, you can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

Certificate File

.appx

The versions of Windows that support .appx packages do not install a sideloading package unless they trust the source of the package. If you are using a custom certificate, such as the one that is generated in Visual Studio, the Suite/Advanced UI installation can make Windows trust the source of your package by adding the custom certificate to the certificate store of target systems. The Suite/Advanced UI installation does this if you include the .cer file in your sideloading package, and specify it here.

Require Elevated Privileges

.msi,
.msp,
.exe,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Specify whether the package requires elevation on Windows Vista and later and Windows Server 2008 and later systems.

Minor Upgrade Handling

.msi,
Basic MSI project

Indicate the appropriate behavior that should occur when an earlier version of the package is present on the target system. Available options are:

None—The Advanced UI or Suite/Advanced UI installation launches the package without running it in minor upgrade mode. That is, the Advanced UI or Suite/Advanced UI installation does not set the REINSTALL or REINSTALLMODE properties for the package.
Automatic—The Advanced UI or Suite/Advanced UI installation launches the package in upgrade mode by setting the REINSTALL property to ALL and the REINSTALLMODE property to vomus. It does not inform the end user that the product will be upgraded.
Ask the User—The Advanced UI or Suite/Advanced UI installation displays a secondary window that asks the end user whether they want to continue. If the end user chooses to continue, the Advanced UI or Suite/Advanced UI installation launches the package in upgrade mode. If the end user chooses to not continue, the package does not run.

Status Messages Reported

.msi,
.msp,
Basic MSI project

Specify what sort of status messages you want to be available for displaying in the user interface of the Advanced UI or Suite/Advanced UI installation. Available options are:

Action Text—The Advanced UI or Suite/Advanced UI installation’s status messages include the action text from the standard actions and custom actions in the package.
Action Text and Action Data—The Advanced UI or Suite/Advanced UI installation’s status messages include the action text as well as action data from the standard actions and custom actions in the package.

At run time, the Advanced UI or Suite/Advanced UI installation updates the ISParcelStatus property with the action text and, if applicable, the action data in the ISParcelStatus property, which is displayed on the InstallationProgress wizard page of the Advanced UI or Suite/Advanced UI installation by default.

For example, when the InstallFiles action in an .msi package is executing, the ISParcelStatus property is updated with the action text “Copying new files” to inform end users about the current progress of the installation. If you choose to include action data in the status messages, the ISParcelStatus property may also be updated with action data such as the name, directory, and size of each file as it is being installed on the target system.

Shared

.msi,
.msp,
.exe,
.appx,
InstallScript,
Basic MSI project,
InstallScript project

Specify whether you want to mark this package as shared.

The shared package functionality helps to ensure that if two or more Advanced UI or Suite/Advanced UI installations are sharing a package, the package remains on the target system until all of the Advanced UI and Suite/Advanced UI products are removed.

If you select Yes for this setting, ensure that you also use the same package GUID in all Advanced UI and Suite/Advanced UI projects that are sharing the package.

To learn more, see Sharing Common Packages Among Different Advanced UI and Suite/Advanced UI Installations.

Enable Logging Support

.msi,
.msp,
.exe,
InstallScript,
Basic MSI project,
InstallScript project

Specify whether you want the package to generate a log file if the Advanced UI or Suite/Advanced UI installation is launched from the command line with the /log command-line parameter. Note that if a package does not have support for logging, it is recommended that you do not enable logging support for that package.

If you select Yes, configure each subsetting under this setting as needed.

For more information, see Supporting the Creation of Package Log Files for Command-Line Launching of an Advanced UI or Suite/Advanced UI Installation.

Log File

.msi,
.msp,
Basic MSI project

This setting is enabled if Yes is selected for the Enable Logging Support setting.

Specify a name for the log file. Do not include a path for the file; the Advanced UI or Suite/Advanced UI /log command-line parameter lets end users specify the directory for the package log files.

If you leave this setting blank, the name of the log file that the installation creates is PackageGUID.log, where PackageGUID is the GUID that is assigned to the package in the Package GUID setting in the Packages view.

For more information, see Supporting the Creation of Package Log Files for Command-Line Launching of an Advanced UI or Suite/Advanced UI Installation.

Log Options

.msi,
.msp,
Basic MSI project

This setting is enabled if Yes is selected for the Enable Logging Support setting.

Specify the Windows Installer log /L flags that you want the package to use when generating the log file. For example, to generate a log file that logs everything verbosely, enter the following in this setting:

*v

For additional valid flags, see the /L description.

If you leave this setting blank, the asterisk (*) and v flags are used to generate the log file.

For more information, see Supporting the Creation of Package Log Files for Command-Line Launching of an Advanced UI or Suite/Advanced UI Installation.

Logging Command Line

.exe,
InstallScript,
InstallScript project

This setting is enabled if Yes is selected for the Enable Logging Support setting.

Specify the command line that the Advanced UI or Suite/Advanced UI installation should pass to the .exe package to enable the logging. Include any appropriate supported flags. If the .exe package that you are configuring supports it, include a path that references the Advanced UI or Suite/Advanced UI property ISLogDir, enclosed within square brackets, in place of the path to the directory where the log file should be created.

For example, to generate a log file that logs everything verbosely for an .msi package that is run by a Setup.exe file that InstallShield built, enter the following command line:

/v"/l*v \"[ISLogDir]FileName.log\""

The Advanced UI or Suite/Advanced UI installation replaces [ISLogDir] with the path to the folder that will contain the log file. The Advanced UI or Suite/Advanced UI /log command-line parameter lets end users specify the path to the directory for the package log files.

For more information, see Supporting the Creation of Package Log Files for Command-Line Launching of an Advanced UI or Suite/Advanced UI Installation.

Detection Condition

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

This setting lets you specify one or more conditions that the Advanced UI or Suite/Advanced UI installation should use to evaluate whether the package is already installed on target systems. For example, if the package installs a specific file or registry entry, you can create a condition that specifies the file or registry key that the installation should search for.

To add one or more new detection conditions, click the New Condition button in this setting. InstallShield adds a new row under the Detection Condition setting. Select the appropriate option—All, Any, or None—from the list in this row. Then in this row, click the New Condition button, and select the appropriate option to continue building the conditional statement.

For more information, see Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects.

If one or more conditional statements are configured, the Detection Condition setting says (Condition). If none are configured, the Detection Condition setting says (Empty).

Eligibility Condition

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

This setting lets you specify one or more conditions that the Advanced UI or Suite/Advanced UI installation should use to determine whether the target system meets the requirements that are necessary for the package to be run. For example, if the package should be run only on 64-bit systems, you could set up an x64 platform requirement in a condition; the Advanced UI or Suite/Advanced UI installation would launch the package only on 64-bit systems. You may also want to set up an eligibility condition to prevent end users from being able to install the current package version over a future newer version.

To add one or more new eligibility conditions, click the New Condition button in this setting. InstallShield adds a new row under the Eligibility Condition setting. Select the appropriate option—All, Any, or None—from the list in this row. Then in this row, click the New Condition button, and select the appropriate option to continue building the conditional statement.

For more information, see Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects.

If one or more conditional statements are configured, the Eligibility Condition setting says (Condition). If none are configured, the Eligibility Condition setting says (Empty).

Windows Features

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Project: This setting is available in Suite/Advanced UI projects.

This setting lets you specify one or more Windows roles and features that the selected package requires be enabled on target systems that have Windows Vista or later or Windows Server 2008 or later. At run time, if this package is eligible to be installed and it requires one or more Windows roles and features that are disabled, the Suite/Advanced UI installation enables them before launching the package.

To specify a required Windows role or feature, click the Add New Windows Feature button in this setting, and then click one of the available options. The Custom option lets you specify any Windows role or feature that is not listed as an option in this setting.

When you select an option, InstallShield adds a new Windows Feature row under the Windows Features setting. Configure the Windows Feature setting as needed.

For more information, see Enabling Windows Roles and Features During a Suite/Advanced UI Installation.

Release Flags

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

If you want to use release flags to be able to selectively include and exclude this package from different builds of your Advanced UI or Suite/Advanced UI installation, enter one or more release flags to identify this package. Separate multiple flags with a comma.

Operation Settings

Use a package’s Operation settings to specify information such as the behavior that should occur if the Advanced UI or Suite/Advanced UI installation is installing, removing, repairing, or modifying the package. This includes information such as the command line that should be used when launching the package and the behavior that should occur if the package requires that the target system be rebooted.

Note that some settings are not applicable to all types of Advanced UI and Suite/Advanced UI package formats.

Operation Settings on the Common Tab

Setting

Type of Package File

Description

Install

.msi,
.msp,
.exe,
.appx,
InstallScript,
Basic MSI project,
InstallScript project

If the Advanced UI or Suite/Advanced UI installation runs in first-time installation mode, specify whether you want this package to be launched as a first-time installation. The install operation is applicable if the target system meets the package’s eligibility conditions and if this package’s product is not already installed.

If you select Yes for this setting, configure the subsettings under this setting as needed. If you select No, the subsettings under this setting are disabled.

Remove

.msi,
.exe,
.appx,
InstallScript,
Basic MSI project,
InstallScript project

If the Advanced UI or Suite/Advanced UI installation runs in remove mode, specify whether you want the product that this package installed to be removed. The remove operation is applicable if the target system meets the package’s eligibility conditions and if this package’s product is installed.

If you select Yes for this setting, configure the subsettings under this setting as needed. If you select No, the subsettings under this setting are disabled.

Repair

.msi,
.exe,
InstallScript,
Basic MSI project,
InstallScript project

If the Advanced UI or Suite/Advanced UI installation runs in repair mode, specify whether you want this package to be launched in repair mode to repair the product that is installed by this package. The repair operation is applicable if the target system meets the package’s eligibility conditions and if this package’s product is installed.

If you select Yes for this setting, configure the subsettings under this setting as needed. If you select No, the subsettings under this setting are disabled.

Modify

.msi,
.msp,
.exe,
InstallScript,
Basic MSI project,
InstallScript project

If the Advanced UI or Suite/Advanced UI installation runs in modify mode, specify whether you want this package to be launched in maintenance mode to enable end users to install, remove, or modify the product that is installed by this package. The modify operation is applicable if the target system meets the package’s eligibility conditions and if this package’s product is installed.

If you select Yes for this setting, configure the subsettings under this setting as needed. If you select No, the subsettings under this setting are disabled.

Target

.msi,
.msp,
.exe,
InstallScript

This setting is a subsetting under the Install setting for .msi, .msp, .exe, and InstallScript packages. It is also under the Remove, Repair, and Modify settings for .exe packages.

Select the file in the package—the .msi file, the .msp file, or the executable file setup launcher—that the Advanced UI or Suite/Advanced UI installation should invoke.

EXE Command Line

.exe

This setting is a subsetting under the Install, Remove, Repair, and Modify settings.

If applicable, specify the command line that should be used to launch the target file (that is, the file that is selected in the Target setting) whenever the Advanced UI or Suite/Advanced UI installation is running with a user interface. Do not include the name of the file in this setting.

If all of the customization can be done without end-user intervention, consider including the command-line parameter for running the .exe package silently.

When you type a value for this setting, you can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

For more information, including valid types of entries for this setting, see Passing Command-Line Parameters to a Package in an Advanced UI or Suite/Advanced UI Installation.

MSI Command Line

.msi,
Basic MSI project

This setting is a subsetting under the Install, Remove, Repair, and Modify settings.

If applicable, specify the command line that should be used to launch the target file (that is, the file that is selected in the Target setting) whenever the Advanced UI or Suite/Advanced UI installation is running with a user interface. Do not include the name of the file in this setting.

If you are configuring the Install and Remove operations for an .msi package, the only type of command-line parameters that you should enter are Windows Installer properties. If you are configuring the Repair and Modify operations for an .msi package, the only type of command-line parameters that you should enter are Windows Installer feature properties.

To enter a Windows Installer property, use the following format:

MYPROPERTYNAME=MyPropertyValue

Note that an Advanced UI or Suite/Advanced UI installation always launches .msi packages silently. Therefore, it is not necessary to pass a command-line parameter that hides the user interface of the .msi package.

When you type a value for this setting, you can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

For more information, including valid types of entries for this setting, see Passing Command-Line Parameters to a Package in an Advanced UI or Suite/Advanced UI Installation.

MSP Command Line

.msp

This setting is a subsetting under the Install, Remove, Repair, and Modify settings.

If applicable, specify the command line that should be used to launch the target file (that is, the file that is selected in the Target setting) whenever the Advanced UI or Suite/Advanced UI installation is running with a user interface. Do not include the name of the file in this setting.

To update all of the features through an .msp package, you would enter command-line properties such as the following:

REINSTALLMODE=vomus REINSTALL=ALL

To update only certain features that are included in the .msp package, you would set REINSTALL to a comma-separated list of features that you want to be updated:

REINSTALLMODE=vomus REINSTALL=Feature1,Feature3,Feature5

Note that an Advanced UI or Suite/Advanced UI installation always launches .msp packages silently. Therefore, it is not necessary to pass a command-line parameter that hides the user interface of the .msp package.

When you type a value for this setting, you can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

For more information, including valid types of entries for this setting, see Passing Command-Line Parameters to a Package in an Advanced UI or Suite/Advanced UI Installation.

Command Line

InstallScript,
InstallScript project

This setting is a subsetting under the Install, Remove, Repair, and Modify settings.

If applicable, specify the command line that should be used to launch the InstallScript package that is associated with the selected target file (that is, the data1.hdr file that is selected in the Target setting) whenever the Advanced UI or Suite/Advanced UI installation is running with a user interface. Do not include the name of the file in this setting.

If you are configuring the Install and Modify operations for an InstallScript package, you can use the Advanced UI or Suite/Advanced UI properties ISFeatureInstall and ISFeatureRemove in your command line. Set these properties to a comma-delimited list of feature names as follows:

ISFeatureInstall=Feature1,Feature2 ISFeatureRemove=Feature3

In the above example, Feature1 and Feature2 are selected to be installed; Feature3 is selected to be removed, if it is present.

Note that an Advanced UI or Suite/Advanced UI installation launches InstallScript packages silently by default. Therefore, it is not necessary to pass a command-line parameter that hides the user interface of the InstallScript package.

When you type a value for this setting, you can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

For more information, including valid types of entries for this setting, see Passing Command-Line Parameters to a Package in an Advanced UI or Suite/Advanced UI Installation.

EXE Silent Command Line

.exe

This setting is a subsetting under the Install, Remove, Repair, and Modify settings.

If applicable, specify the command line that should be used to launch the target file (that is, the file that is selected in the Target setting) whenever the Advanced UI or Suite/Advanced UI installation is running silently (that is, without a user interface). Do not include the name of the file in this setting.

If all of the customization can be done without end-user intervention, consider including the command-line parameter for running the .exe package silently.

When you type a value for this setting, you can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

For more information, including valid types of entries for this setting, see Passing Command-Line Parameters to a Package in an Advanced UI or Suite/Advanced UI Installation.

MSI Silent Command Line

.msi,
Basic MSI project

This setting is a subsetting under the Install, Remove, Repair, and Modify settings.

If applicable, specify the command line that should be used to launch the target file (that is, the file that is selected in the Target setting) whenever the Advanced UI or Suite/Advanced UI installation is running silently (that is, without a user interface). Do not include the name of the file in this setting.

If you are configuring the Install and Remove operations for an .msi package, the only type of command-line parameters that you should enter are Windows Installer properties. If you are configuring the Repair and Modify operations for an .msi package, the only type of command-line parameters that you should enter are Windows Installer feature properties.

To enter a Windows Installer property, use the following format:

MYPROPERTYNAME=MyPropertyValue

Note that an Advanced UI or Suite/Advanced UI installation always launches .msi packages silently. Therefore, it is not necessary to pass a command-line parameter that hides the user interface of the .msi package.

When you type a value for this setting, you can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

For more information, including valid types of entries for this setting, see Passing Command-Line Parameters to a Package in an Advanced UI or Suite/Advanced UI Installation.

MSP Silent Command Line

.msp

This setting is a subsetting under the Install, Remove, Repair, and Modify settings.

If applicable, specify the command line that should be used to launch the target file (that is, the file that is selected in the Target setting) whenever the Advanced UI or Suite/Advanced UI installation is running silently (that is, without a user interface). Do not include the name of the file in this setting.

To update all of the features through an .msp package, you would enter command-line properties such as the following:

REINSTALLMODE=vomus REINSTALL=ALL

To update only certain features that are included in the .msp package, you would set REINSTALL to a comma-separated list of features that you want to be updated:

REINSTALLMODE=vomus REINSTALL=Feature1,Feature3,Feature5

Note that an Advanced UI or Suite/Advanced UI installation always launches .msp packages silently. Therefore, it is not necessary to pass a command-line parameter that hides the user interface of the .msp package.

When you type a value for this setting, you can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

For more information, including valid types of entries for this setting, see Passing Command-Line Parameters to a Package in an Advanced UI or Suite/Advanced UI Installation.

Silent Command Line

InstallScript,
InstallScript project

If applicable, specify the command line that should be used to launch the InstallScript package that is associated with the selected target file (that is, the data1.hdr file that is selected in the Target setting) whenever the Advanced UI or Suite/Advanced UI installation is running silently (that is, without a user interface). Do not include the name of the file in this setting.

If you are configuring the Install and Modify operations for an InstallScript package, you can use the Advanced UI or Suite/Advanced UI properties ISFeatureInstall and ISFeatureRemove in your command line. Set these properties to a comma-delimited list of feature names as follows:

ISFeatureInstall=Feature1,Feature2 ISFeatureRemove=Feature3

In the above example, Feature1 and Feature2 are selected to be installed; Feature3 is selected to be removed, if it is present.

Note that an Advanced UI or Suite/Advanced UI installation launches InstallScript packages silently by default. Therefore, it is not necessary to pass a command-line parameter that hides the user interface of the InstallScript package.

When you type a value for this setting, you can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

For more information, including valid types of entries for this setting, see Passing Command-Line Parameters to a Package in an Advanced UI or Suite/Advanced UI Installation.

Exit Behavior

.exe

This setting is a subsetting under the Install, Remove, Repair, and Modify settings.

If a detection condition is still not met on a target system after the package has been run, either one of the following may be true:

The executable file package was not run successfully.
The detection conditions that were specified for the package were not accurate.

For example, a detection condition may indicate that the executable file needs to be launched if a particular file does not exist on the target system. If the file is still missing even after the Advanced UI or Suite/Advanced UI installation has run the executable file package, it is possible that the condition was created erroneously.

Specify the behavior that should occur if one or more of the detection conditions still indicate that the package needs to be launched. Available options are:

Ask whether to continue the setup—If the Advanced UI or Suite/Advanced UI installation should display a message box that prompts the end user to specify whether the Advanced UI or Suite/Advanced UI installation should continue, select this option.
Abort the setup—If the Advanced UI or Suite/Advanced UI installation should end without proceeding further, select this option.
Continue the setup—If the Advanced UI or Suite/Advanced UI installation should essentially ignore the executable file’s unmet condition and proceed to the next package in the installation (if one is required), select this option.

Reboot Request

.msi,
.msp,
.exe,
InstallScript,
Basic MSI project,
InstallScript project

This setting is a subsetting under the Install, Remove, Repair, and Modify settings.

The installation of an Advanced UI or Suite/Advanced UI package may require that the target system be restarted, as described in Restarting a Target System for an Advanced UI or Suite/Advanced UI Package.

Specify the behavior that should occur if the package requires that a target system be restarted. Available options are:

Allow the machine to reboot—If the need for a restart is detected, the Advanced UI or Suite/Advanced UI installation exits and lets the package trigger a restart. If the package restarts the target system, the Advanced UI or Suite/Advanced UI installation continues with the next package in the Advanced UI or Suite/Advanced UI after the restart. If the package does not trigger a restart, the Advanced UI or Suite/Advanced UI installation resumes after the next restart.
Ignore the reboot request—The Advanced UI or Suite/Advanced UI installation continues without restarting the target system. Thus, if it appears that a restart is required but you want the Advanced UI or Suite/Advanced UI installation to try to skip it, select this option. If the package restarts the target system, the Advanced UI or Suite/Advanced UI installation then resumes with the next package in the installation.

Reboot Request (cont.)

 

Delay the prompt, then exit or reboot the machine—If the package requires that the target system be restarted, the restart is postponed until a subsequent package triggers a restart, or until the end of the Advanced UI or Suite/Advanced UI installation, after the last package has completed. If the restart occurs because of a subsequent package, the restart behavior follows the reboot behavior that is configured for that subsequent package. If the restart occurs at the end of the Advanced UI or Suite/Advanced UI installation, the Advanced UI or Suite/Advanced UI installation displays a message box that asks the end user whether to restart. If the end user chooses not to allow the restart, the Advanced UI or Suite/Advanced UI installation exits instead of restarting the target system.
Prompt, then exit or reboot the machine—If the Advanced UI or Suite/Advanced UI installation detects that the package requires that the target system be restarted, the Advanced UI or Suite/Advanced UI installation displays a message box that asks the end user whether to restart. If the end user chooses to allow the restart, the Advanced UI or Suite/Advanced UI installation resumes after the restart. If the end user chooses not to allow the restart, the Advanced UI or Suite/Advanced UI installation exits instead of restarting the target system.

Reboot Request (cont.)

 

Always prompt, then exit or reboot the machine—When the package installation is complete, the Advanced UI or Suite/Advanced UI installation displays a message box that asks the end user whether to proceed with the restart, even if the Advanced UI or Suite/Advanced UI installation has not detected the need for a restart. If the end user chooses to allow the restart, the Advanced UI or Suite/Advanced UI installation resumes after the restart. If the end user chooses not to allow the restart, the Advanced UI or Suite/Advanced UI installation exits instead of restarting the target system.
Always reboot the machine—The Advanced UI or Suite/Advanced UI installation restarts the target system regardless of whether the Advanced UI or Suite/Advanced UI installation detects the need for a restart. The Advanced UI or Suite/Advanced UI installation resumes after the restart.

For details on determining the best option to select, see Specifying the Behavior for an Advanced UI or Suite/Advanced UI Package that Requires a Restart.

Reboot Codes

.exe

This setting is a subsetting under the Install, Remove, Repair, and Modify settings.

If the selected package requires that the target system be restarted after the product is installed, type the return code in this setting.

If multiple return codes exist, list each one separated by a comma.

If you do not know the return codes for the file that you are launching as the Advanced UI or Suite/Advanced UI package, contact the author of the package.

For more information on Advanced UI or Suite/Advanced UI packages that require a restart, see Restarting a Target System for an Advanced UI or Suite/Advanced UI Package.

Force Application Shutdown

.appx

If the selected sideloading app package (or any package that depends on this package) is in use at installation run time, you can require that the processes that are associated with the package are forced to shut down so that registration can proceed. Use this setting to indicate whether you want to force application shutdown in that scenario.

Configuration Settings

Use a Web Deploy package’s Configuration settings to specify the values of various Web Deploy settings. For more information, see Adding a Web Deploy Package to a Suite/Advanced UI Project.

Operation Settings on the Common Tab

Setting

Type of Package File

Description

Computer Name

Web Deploy

Specify the name of the server where the Web Deploy package should be deployed.

You can leave the Suite/Advanced UI property that InstallShield assigns to this setting by default when you add the package to your project, or you can specify your own property (enclosed within square brackets). As an alternative, you can specify a hard-coded value.

For more information, see Adding a Web Deploy Package to a Suite/Advanced UI Project.

User Name

Web Deploy

Specify the user name of the end user who will be deploying the Web Deploy package.

You can leave the Suite/Advanced UI property that InstallShield assigns to this setting by default when you add the package to your project, or you can specify your own property (enclosed within square brackets). As an alternative, you can specify a hard-coded value.

For more information, see Adding a Web Deploy Package to a Suite/Advanced UI Project.

Password

Web Deploy

Specify the password for the user account that will be used to deploy the Web Deploy package.

You can leave the Suite/Advanced UI property that InstallShield assigns to this setting by default when you add the package to your project, or you can specify your own property (enclosed within square brackets). As an alternative, you can specify a hard-coded value.

For more information, see Adding a Web Deploy Package to a Suite/Advanced UI Project.

Site

Web Deploy

Specify the site where the Web Deploy package should be deployed.

You can leave the Suite/Advanced UI property that InstallShield assigns to this setting by default when you add the package to your project, or you can specify your own property (enclosed within square brackets). As an alternative, you can specify a hard-coded value.

For more information, see Adding a Web Deploy Package to a Suite/Advanced UI Project.

Parameters

Web Deploy

If the parameters XML file for the Web Deploy package contains various configurable parameters, the Parameters subsettings let you specify values for those parameters.

You can leave the Suite/Advanced UI properties that InstallShield assigns to these subsettings by default when you add the package to your project, or you can specify your own properties (enclosed within square brackets). As an alternative, you can specify a hard-coded value.

For more information, see Adding a Web Deploy Package to a Suite/Advanced UI Project.

Events Settings

Project: The Events area is available in Suite/Advanced UI projects.

Use a package’s Events settings to schedule run-time actions that you want the Suite/Advanced UI installation to launch when installing, removing, repairing, or modifying the package. For more information, see Using Actions to Extend the Behavior of a Suite/Advanced UI Installation.

Events Settings on the Common Tab

Setting

Type of Package File

Description

Package Configuring

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

This setting lets you specify one or more run-time actions that the Suite/Advanced UI installation should launch before installing, removing, repairing, or modifying the package. The actions must already be added under the Actions explorer in the Events view.

To specify an action, click the Add Events button in this setting, and then click the action. InstallShield adds a new Action setting under the Package Configuring setting, and sets its value to the name of the action that you selected. Use the buttons in the Action setting to specify one or more conditions that the Suite/Advanced UI installation should use to evaluate whether the action should be launched.

Package Configured

.msi,
.msp,
.exe,
.appx,
InstallScript,
Basic MSI project,
InstallScript project

This setting lets you specify one or more run-time actions that the Suite/Advanced UI installation should launch after installing, removing, repairing, or modifying the package. The actions must already be added under the Actions explorer in the Events view.

To specify an action, click the Add Events button in this setting, and then click the action. InstallShield adds a new Action setting under the Package Configuring setting, and sets its value to the name of the action that you selected. Use the buttons in the Action setting to specify one or more conditions that the Suite/Advanced UI installation should use to evaluate whether the action should be launched.

Action

.msi,
.msp,
.exe,
.appx,
InstallScript,
Basic MSI project,
InstallScript project

This read-only setting shows the name of an action that is associated with the selected package and defined in the Events view. To define a condition that determines whether this action is run for this package, configure the subsettings under the Action setting as needed.

If you associate more than one action with the package, list the actions from top to bottom in chronological order, according to when they are launched at run time. To change the order of the actions, point to the Move Condition button in the setting of an action that you want to move, and the click the appropriate direction (Move Up or Move Down).

Condition

.msi,
.msp,
.exe,
.appx,
InstallScript,
Basic MSI project,
InstallScript project

This setting lets you specify one or more conditions that the Suite/Advanced UI installation should use to evaluate whether the installation should run an action for the selected package.

To add one or more new action conditions, click the New Condition button in this setting. InstallShield adds a new row under the Condition setting. Select the appropriate option—All, Any, or None—from the list in this row. Then in this row, click the New Condition button, and select the appropriate option to continue building the conditional statement.

For more information, see Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects.

If one or more conditional statements are configured, the Condition setting says (Condition). If none are configured, the Condition setting says (Empty).

Display Text

.msi,
.msp,
.exe,
.appx,
InstallScript,
Basic MSI project,
InstallScript project

Enter text that describes the selected action. For example, if the action is running a script that configures the target system, you could enter the following string:

Configuring the system

If the installation launches the action when the InstallationProgress wizard page is displayed, the text that you enter is displayed on the wizard page.

When you type a value for this setting, you are creating a string entry and setting its initial value for all of the languages that are currently in the project. As an alternative to typing a new value, you can click the ellipsis button (...) in this setting to select an existing string. For more information, see Using String Entries in InstallShield.

When you type a value for this setting, you can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

See Also