InstallShield 2012 Spring » 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 |
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.
|
Setting |
Type of Package File |
Description |
|||||||||
|
Package GUID |
.appx, .exe, .msi, .msp, InstallScript |
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 |
.appx, .exe, .msi, .msp, InstallScript |
Enter the name that you want to be displayed for this package at run time. |
|||||||||
|
Location |
.appx, .exe, .msi, .msp, InstallScript |
Specify where the package should be located. Available options are:
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.
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.
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 |
.appx, .exe, .msi, .msp, InstallScript |
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 |
.appx, .exe, .msi, .msp, InstallScript |
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:
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.
For more information, see Primary Packages vs. Dependency Packages in Advanced UI and Suite/Advanced UI Projects. |
|||||||||
|
Cache Path |
.appx, .exe, .msi, .msp, InstallScript |
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. |
|||||||||
|
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 |
.exe, .msi, .msp, InstallScript |
Specify whether the package requires elevation on Windows Vista and later and Windows Server 2008 and later systems. |
|||||||||
|
Minor Upgrade Handling |
.msi |
Indicate the appropriate behavior that should occur when an earlier version of the package is present on the target system. Available options are:
|
|||||||||
|
Status Messages Reported |
.msi, .msp |
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:
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. |
|||||||||
|
Enable Logging Support |
.exe, .msi, .msp, InstallScript |
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 |
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 |
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 |
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 |
.appx, .exe, .msi, .msp, InstallScript |
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 Group 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 |
.appx, .exe, .msi, .msp, InstallScript |
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). |
|||||||||
|
Release Flags |
.appx, .exe, .msi, .msp, InstallScript |
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. |
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.
|
Setting |
Type of Package File |
Description |
|||||||||||||||
|
Install |
.appx, .exe, .msi, .msp, InstallScript |
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 |
.appx, .exe, .msi, InstallScript |
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 |
.exe, .msi, InstallScript |
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 |
.exe, .msi, InstallScript |
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 |
.exe, .msi, .msp, InstallScript |
This setting is a subsetting under the Install, Remove, Repair, and Modify settings. 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. 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 |
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. 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. 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 |
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. 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 |
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. 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. 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. 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 |
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. 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:
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:
|
|||||||||||||||
|
Reboot Request |
.exe, .msi, .msp, InstallScript |
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:
|
|||||||||||||||
|
Reboot Request (cont.) |
|
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, the processes that are associated with the package are forced to shut down so that registration can proceed. |
See Also
InstallShield 2012 Spring Help LibraryMay 2012 |
Copyright Information | Contact Us |