General Information View Settings
Project:The General Information view is available in the following project types:
• | Advanced UI |
• | Basic MSI |
• | DIM |
• | InstallScript |
• | InstallScript MSI |
• | InstallScript Object |
• | Merge Module |
• | MSI Database |
• | MSM Database |
• | Suite/Advanced UI |
• | Transform |
The General Information view settings are organized into the following main categories:
• | General Settings |
• | Summary Information Stream |
• | Add or Remove Programs |
• | Software Identification Tag |
Use the General area of the General Information view to specify details such as product name and product version. The following settings are available in this area.
Setting |
Project Type |
Description |
||||||||||||||||||
Project File Name |
Advanced UI, Basic MSI, DIM, InstallScript, InstallScript MSI, InstallScript Object, Merge Module, Suite/Advanced UI, MSIX |
This read-only setting displays the path and name of the InstallShield project file. It also shows the type of project. The extension of the project file varies, depending on the project type:
To learn more, see Project Types. |
||||||||||||||||||
Project File Format |
Basic MSI, DIM, InstallScript, InstallScript MSI, InstallScript Object, MSIX, Merge Module |
Select the file format that you want to use for your project file (.ism or .dim). Available options are:
This is the default format for Basic MSI, DIM, InstallScript MSI, MSIX, and Merge Module projects. If you select this project file format for these project types, you can modify the .ism file in a Windows Installer database editor. You can also modify the .ism file by using the Windows Installer API or its automation interface.
This is the default format for InstallScript and InstallScript Object projects. Note:Both project file formats let you build releases from the command line. |
||||||||||||||||||
Suite GUID |
Advanced UI, Suite/Advanced UI |
Enter a GUID that 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. |
||||||||||||||||||
Advanced UI, Basic MSI, DIM, InstallScript, InstallScript MSI, InstallScript Object, Merge Module, Suite/Advanced UI |
Project:The behavior of this setting varies, depending on the project type. In Basic MSI, InstallScript MSI, Merge Module, and Suite/Advanced UI projects, the Setup Languages setting lets you specify the languages that you want to be listed in the UI Languages setting in the Releases view. If a language is not listed for this Setup Languages setting at the project level, you cannot include that particular UI language in your project’s releases. Advanced UI projects, which are available in the InstallShield, have support for only one language. Therefore, the Setup Languages setting in this project type is read-only. In InstallScript and InstallScript Object projects, the Setup Languages setting lets you specify the languages that you want to be listed in the Languages setting in the Components and Releases views in your project. In general, if a language is not listed for this setting at the project level, you cannot designate that a particular component in your project is targeted for that language; in addition, you cannot designate that the components and UI strings for a particular language are included in your project’s releases. When you add a supported language to an Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module, or Suite/Advanced UI project through this setting, InstallShield adds string entries for that language to your project. The string entries include the built-in user-interface string resources that are already translated. In DIM projects, the Setup Languages setting lets you specify the languages that you want the project to support. When you add a language to your project through this setting, InstallShield adds string entries for that language to your project. The string entries include string resources that you would need to have translated. For more information, see Selecting the Installation Languages. |
|||||||||||||||||||
Default Language |
Advanced UI, Basic MSI, DIM, InstallScript, InstallScript MSI, InstallScript Object, Merge Module, Suite/Advanced UI, MSIX |
To override the default project language that is configured in the General Information view or the String Editor view, select the appropriate default user interface language for the selected release. For more information, see Setting the Default Project Language. |
||||||||||||||||||
Platform Filtering |
InstallScript, InstallScript Object |
This setting lets you specify the platforms that you want to be available when you select operating for components or releases in your project. In general, if a platform is not listed for this setting at the project level, you cannot designate that a particular component or release in your project is targeted for that platform. To change the platforms for your project, click the ellipsis button (...) in this setting. The Platforms dialog box opens, enabling you to select the platforms for your project. Note:Specifying platforms at the project level does not create target for running the installation. If you want to create target in an InstallScript or InstallScript Object project, use the SYSINFO structure to identify the operating platform of the target system. |
||||||||||||||||||
Maintenance Experience |
InstallScript |
Select the behavior that occurs when a target machine already has your product installed and the end user reruns your installation. Valid options are:
To learn more, see Running an InstallScript Installation Multiple Times. |
||||||||||||||||||
Enable Maintenance |
InstallScript MSI |
Indicate whether you want to display the full maintenance user interface (UI) or the uninstallation UI when end users rerun the installation on a system on which the product is already present. Available options are:
To learn more, see Configuring the Enable Maintenance Setting. |
||||||||||||||||||
InstallScript User Interface Type |
InstallScript MSI |
Specify the type of InstallScript user interface (UI) that you want to use for your installation. Valid options are:
This is the default option for this setting.
This option requires Windows Installer 4.5 on the target machine. This option also has some limitations that require careful planning if you decide to use this style. For detailed information about these two styles, see Using the InstallScript Engine as an External vs. Embedded UI Handler for InstallScript MSI Installations. |
||||||||||||||||||
Advanced UI, Basic MSI, DIM, InstallScript, InstallScript MSI, InstallScript Object, Merge Module, MSI Database, MSM Database, Suite/Advanced UI, Transform |
Enter the name of the product, DIM, merge module, or object. For information on how the product name is used, see Specifying a Product Name. Project:For InstallScript and InstallScript Object projects—Instead of hard-coding a value, you can use a path variable that is defined in the Path Variables view. At build time, InstallShield replaces the path variable with the appropriate value. (To use a path variable: On the Project menu, click Settings. Then select the appropriate path variable on the Application tab.) The product name is stored in the InstallScript system variable IFX_PRODUCT_NAME. For DIM projects—The value in this setting is not displayed or used at run time. You can use this setting in DIM projects as a reference for internally identifying different versions of the project. |
|||||||||||||||||||
Advanced UI, Basic MSI, DIM, InstallScript, InstallScript MSI, InstallScript Object, Merge Module, MSI Database, MSM Database, Suite/Advanced UI, Transform |
Enter the version number for your product. 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. Project:For Basic MSI, InstallScript, and InstallScript MSI projects—If your release includes a Setup.exe file, 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. For InstallScript and InstallScript Object projects—Instead of hard-coding a value, you can use a path variable that is defined in the Path Variables view. At build time, InstallShield replaces the path variable with the appropriate value. (To use a path variable: On the Project menu, click Settings. Then select the appropriate path variable on the Application tab.) For DIM projects—The value in this setting is not displayed or used at run time. You can use this setting in DIM projects as a reference for internally identifying different versions of the project. The value that you enter is displayed in the DIM References view of the project that contains this DIM. |
|||||||||||||||||||
Product Code |
Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, MSI Database, Transform |
Enter a GUID that uniquely identifies this product. 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 product, changing the product code after you have already distributed your release is not recommended. For more information, see Setting the Product Code in a Windows Installer–Based Project or Setting the Product Code in an InstallScript-Based Project. |
||||||||||||||||||
Upgrade Code |
Basic MSI, InstallScript MSI, MSI Database, Transform |
Enter a GUID that can be used for your product’s upgrade code. To have InstallShield generate a different GUID for you, click the Generate a new GUID button ({...}) in this setting. The upgrade code is a GUID that uniquely identifies the product family to which the product belongs. The upgrade code should be consistent across different versions and languages of a family of related products so that Windows Installer can use it to search for related versions of the product that are already installed. For more information, see Setting the Upgrade Code. |
||||||||||||||||||
Install Condition |
Basic MSI, InstallScript MSI, MSI Database, Transform |
This setting lets you specify one or more conditions that must be true in order for your installation to run. For example, you can test for a specific operating system or minimum . If the conditions do not evaluate to True at run time, an error message is displayed and the product is not installed. To specify one or more conditions, click the ellipsis button (...) in this setting. For more information, see Setting Product Conditions. When you add a condition, InstallShield adds two new settings under the Install Condition setting:
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. |
||||||||||||||||||
Exit Conditions |
Advanced UI, Suite/Advanced UI |
This setting lets you specify one or more exit error messages that you want the Advanced UI or Suite/Advanced UI installation to display under various conditions before ending the installation. For example, if your Advanced UI or Suite/Advanced UI installation requires Windows Vista or later, you could use the Exit Condition setting and its subsettings to specify an error message that you want to be displayed when end users launch your Advanced UI or Suite/Advanced UI installation on earlier versions of Windows. When end users dismiss the error message, the Advanced UI or Suite/Advanced UI installation ends. To specify an error message and one or more conditions, click the ellipsis button (...) in this setting. |
||||||||||||||||||
Exit Conditions (continued) |
|
When you add a condition, InstallShield adds two new settings under the Exit Conditions setting:
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.
For more information, see Defining Exit Conditions for an Advanced UI or Suite/Advanced UI Installation. |
||||||||||||||||||
Module Language |
DIM, Merge Module, MSM Database |
Select the language of the DIM or merge module, or select Language Independent. |
||||||||||||||||||
Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform |
Specify the value of the Windows Installer property INSTALLDIR, which indicates the destination directory where most of the files of the product, DIM, or merge module will be installed at run time. Instead of hard-coding a path, you can enter a directory property as part of the path. To select a directory property, click the ellipsis button (...) in this setting. This enables you to select the appropriate directory from a list, or to create a new directory within a predefined directory. Separate further levels of subdirectories with a backslash—for example, [ProgramFilesFolder]MyApp\Bin. Windows Logo Guideline:To comply with the Windows logo program, your product's default destination should be a subfolder of the Program Files folder ([ProgramFilesFolder]), which can vary depending on the system’s locale and user settings. Project:In Basic MSI, InstallScript MSI, MSI Database, and Transform projects, the default value is as follows: [ProgramFilesFolder]My Company Name\My Product Name The value that you enter in this setting is assigned to the property INSTALLDIR, which is the default destination folder for all of your product’s features and components. For more information, see Setting the Default Product Destination Folder (INSTALLDIR). In DIM, Merge Module, and MSM Database projects, the default value is as follows: [TARGETDIR] In DIM, Merge Module, and MSM Database projects, if you would like to let the users of this DIM or module override the default destination directory, leave that default value in this setting. For more information, see Specifying the Default Destination Folder for a Merge Module. |
|||||||||||||||||||
TARGETDIR |
InstallScript, InstallScript Object |
Specify the default value for the main target directory for your product. Typically this value is set to a value such as the following one: <FOLDER_APPLICATIONS>\<IFX_COMPANY_NAME>\<IFX_PRODUCT_NAME> For more information, see TARGETDIR. |
||||||||||||||||||
Module ID GUID |
Merge Module, MSM Database |
This read-only setting displays a GUID that uniquely identifies the merge module. Whenever you create a new merge module, InstallShield generates a new GUID for it. The module ID GUID is appended to all merge module GUID foreign keys. For example, if you create a component in a merge module project, that component is listed in the Direct Editor and in the built .msm file as ComponentName.MergeModuleGUID. If you want to change this GUID, you can use the Direct Editor view to edit the ModuleID field of the ModuleSignature table. Note that if you change this value, you must also update the value in all of the tables in your project; you can do this from within the Direct Editor view. |
||||||||||||||||||
Module Dependencies |
Merge Module, MSM Database |
This setting lets you specify one or more merge modules that are required for your merge module. To add one or more dependencies that are available in your redistributables gallery, click the ellipsis button (...) in this setting. The Module Dependencies dialog box opens, enabling you to select the modules that your merge module requires. To add a dependency that is not present on your machine, click the Add a new module dependency button, and then specify its version, language, and module GUID. |
||||||||||||||||||
Name |
Merge Module, MSM Database |
This read-only setting shows one of the following values:
This setting is displayed only if you have added a merge module dependency to your project. If you want to remove this dependency from your project, you can click the Delete this module dependency button in this setting. |
||||||||||||||||||
Version |
Merge Module, MSM Database |
If the merge module that you are creating requires a particular version of the dependency, specify the version number. If any version of the dependency is acceptable, you can leave the Version setting blank. This setting is displayed only if you have added a merge module dependency to your project. |
||||||||||||||||||
Language |
Merge Module, MSM Database |
If the merge module that you are creating requires a dependency of a particular language, specify the language. If any language of the dependency is acceptable, select Language Independent. This setting is displayed only if you have added a merge module dependency to your project. |
||||||||||||||||||
Module ID |
Merge Module, MSM Database |
If you selected a dependency that is available in your redistributables gallery, this setting indicates the module ID of that dependency. If you chose to add a dependency that is not present on your machine, enter the module ID of the dependency. The module ID must be in the following format: ModuleName.ModuleGUID For example, if the name of the merge module is MyDependency and the GUID is {2560C1ED-E2F7-4FE6-A0E6-15A9DA4CE9B9}, enter the following in this setting: MyDependency.2560C1ED-E2F7-4FE6-A0E6-15A9DA4CE9B9 This setting is displayed only if you have added a merge module dependency to your project. |
||||||||||||||||||
Module Exclusions |
Merge Module, MSM Database |
This setting lets you specify one or more merge modules that are incompatible with the merge module that you are creating. This may be necessary, for example, if an earlier version of your merge module is not compatible with your new module. To add one or more exclusions that are available in your redistributables gallery, click the ellipsis button (...) in this setting. The Module Exclusions dialog box opens, enabling you to select the modules that are incompatible with your merge module. To add an exclusion that is not present on your machine, click the Add a new module exclusion button, and then specify the requirements for the version, language, and module GUID. |
||||||||||||||||||
Name |
Merge Module, MSM Database |
This read-only setting shows one of the following values:
This setting is displayed only if you have added a merge module exclusion to your project. If you want to remove this exclusion from your project, you can click the Delete this module exclusion button in this setting. |
||||||||||||||||||
Max. Version |
Merge Module, MSM Database |
Specify the maximum version number of the merge module that should be excluded. If you leave this setting blank, all versions after the value that you specify in the Min. Version setting are excluded. If you leave both the Max. Version and Min. Version settings blank, there is no exclusion based on version. This setting is displayed only if you have added a merge module exclusion to your project. |
||||||||||||||||||
Min. Version |
Merge Module, MSM Database |
Specify the minimum version number of the merge module that should be excluded. If you leave this setting blank, all versions before the value that you specify in the Max. Version setting are excluded. If you leave both the Max. Version and Min. Version settings blank, there is no exclusion based on version. This setting is displayed only if you have added a merge module exclusion to your project. |
||||||||||||||||||
Language |
Merge Module, MSM Database |
If you want to exclude merge modules that have a specific language or change the current value of this setting, click the ellipsis button (...) in this setting. The Exclusion Languages dialog box opens, enabling you to specify whether you want to exclude a particular language or all of the languages except a particular language. This dialog box also lets you select Language Independent, which indicates that the language should not be used to exclude a merge module. This setting is displayed only if you have added a merge module exclusion to your project. |
||||||||||||||||||
Module ID |
Merge Module, MSM Database |
If you selected an exclusion that is available in your redistributables gallery, this setting indicates the module ID of that exclusion. If you chose to add an exclusion that is not present on your machine, enter the module ID of the exclusion. The module ID must be in the following format: ModuleName.ModuleGUID For example, if the name of the merge module is MyExclusion and the GUID is {2560C1ED-E2F7-4FE6-A0E6-15A9DA4CE9B9}, enter the following in this setting: MyExclusion.2560C1ED-E2F7-4FE6-A0E6-15A9DA4CE9B9 This setting is displayed only if you have added a merge module exclusion to your project. |
||||||||||||||||||
DIM GUID |
DIM |
This read-only setting displays a GUID that uniquely identifies the DIM. Whenever you create a new DIM, InstallShield generates a new GUID for it. The DIM GUID is appended to all DIM GUID foreign keys. For example, if you create a component in a DIM project, that component is listed in the Direct Editor as ComponentName.DIM_GUID. If you want to change this GUID, you can use the Direct Editor view to edit the ModuleID field of the ModuleSignature table. Note that if you change this value, you must also update the value in all of the tables in your project; you can do this from within the Direct Editor view. |
||||||||||||||||||
Build Instructions |
DIM |
Enter any special instructions or comments about this project that may be helpful for the release engineers who are responsible for including this DIM in installation projects. These instructions are displayed in the DIM References view of the project that contains this DIM. The build instructions are not displayed to the end user. |
||||||||||||||||||
Locked-Down Permissions |
Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform |
Select the type of permissions that you want to use for securing files, folders, and registry keys for end users who run your product in a locked-down environment. Available options are:
It is often more advantageous to use the custom InstallShield handling than the traditional Windows Installer handling. For example:
This is a project-wide setting that affects all new permissions that you set for files, folders, and registry keys in your project. If you have already configured some permissions in your project and then you change the value of this setting, InstallShield lets you specify whether you want to use the alternate handling method for those already-existing permissions. For more information about configuring this setting, as well as information about InstallScript support for setting permissions, see Securing Files, Folders, Registry Keys, and Windows Services in a Locked-Down Environment. |
||||||||||||||||||
Show Per-User Option |
Basic MSI |
Specify whether you want to give end users the option of installing your product for all users or for only the current user. This run-time option is available only on Windows 7 and later systems, and on Windows Server 2008 R2 and later systems. Available options are:
If the target system has Windows Vista or earlier, or Windows Server 2008 or earlier, the ReadyToInstall dialog does not show the buttons that let end users specify how they want to install the product. The default value is No. Note:Selecting No does not prevent end users from setting MSIINSTALLPERUSER from the command line when they run your installation. If your installation does not support this, you may want to add a launch condition or other run-time check to prevent this from occurring. To learn more, see Per-User vs. Per-Machine Installations. |
||||||||||||||||||
Create MSI Logs |
Basic MSI, InstallScript MSI, MSI Database, Transform |
To specify whether Windows Installer 4.0 or later should log your installation, click the ellipsis button (...) in this setting, which launches the Logging Options for Windows Installer 4.0 and Later dialog box. This dialog box is where you specify whether Windows Installer should log your installation. You can also use this dialog box to customize the types of messages that are logged. There are three possible values for this setting:
If the value of this setting is Yes or Custom, and if the installation is run with Windows Installer 4.0 or later, as well as Windows Vista or later or Windows Server 2008 or later, the following occurs:
|
||||||||||||||||||
Create MSI Logs (continued) |
|
The Create MSI Logs setting applies to installations that are run with Windows Installer 4.0 or later on Windows Vista and later systems or Windows Server 2008 and later systems. The Show the Windows Installer log check box is not visible in run-time dialogs that are displayed on earlier systems that are running earlier versions of Windows Installer. Note:If the value of this setting is Custom and you change it to Yes, any custom parameters that you defined for the MsiLogging property in the Property Manager will be overwritten with the default value. If you change it to No, InstallShield deletes any custom parameters from the MsiLogging property. For more information, including details on how to customize the types of messages that are logged, see Specifying Whether Windows Installer Installations Should Be Logged. |
||||||||||||||||||
Basic MSI, InstallScript MSI, MSI Database, Transform |
If you want to reduce the time that is required to install a large Windows Installer package, consider selecting the check boxes for one or more of the following options:
This setting configures the Windows Installer property MSIFASTINSTALL, which can be set at the command line. Windows Installer 5 includes support for this setting. Earlier versions of Windows Installer ignore it. |
|||||||||||||||||||
Company Name |
InstallScript, InstallScript Object |
Enter the name of your company. This value is used in the default script to set TARGETDIR (if the string entry COMPANY_NAME does not exist); it can be retrieved at run time by calling the MediaGetData function. Tip:Instead of hard-coding a value, you can use a path variable that is defined in the Path Variables view. At build time, InstallShield replaces the path variable with the appropriate value. (To use a path variable: On the Project menu, click Settings. Then select the appropriate path variable on the Application tab.) |
||||||||||||||||||
Executable File |
InstallScript, InstallScript Object |
Enter the name of the application’s main executable file. This value can be retrieved at run time by calling the MediaGetData function. Tip:Instead of hard-coding a value, you can use a path variable that is defined in the Path Variables view. At build time, InstallShield replaces the path variable with the appropriate value. (To use a path variable: On the Project menu, click Settings. Then select the appropriate path variable on the Application tab.) |
||||||||||||||||||
URL |
InstallScript, InstallScript Object |
Enter a product URL. This information is stored in the project file and is for your reference only. It is never displayed to the end user. Tip:Instead of hard-coding a value, you can use a path variable that is defined in the Path Variables view. At build time, InstallShield replaces the path variable with the appropriate value. (To use a path variable: On the Project menu, click Settings. Then select the appropriate path variable on the Application tab.) |
||||||||||||||||||
Server Locations |
Transform |
If you are storing the installation package and its related files for the product on a network server or Web site, click the ellipsis button (...) in this setting to specify the server or Web site locations. The locations should have the .msi package, as well as all of the files that might be required to, for example, repair the product or advertise a feature. The validity of the server location that you specify is determined when the installation needs to access the server remotely. That is, if a server is not available, or if you added an invalid server, the entry will be ignored if the resource is needed, and errors might be generated. Each location that is specified must have the complete source for the installation. The entire directory tree at each source location must be the same and must include all of the required source files, including any .cab files. Each location must have an .msi file with the same file name and product code. Tip:Server paths can contain environment variables that are identified with a percent sign (%). For example, the following path uses the Home environment variable: \\Server1\%Home%\Office The paths that you specify are stored in the SOURCELIST property. Windows Installer appends this list to the end of an end user’s existing source list for the product at run time. |
||||||||||||||||||
Register Object |
InstallScript Object |
Specify whether you want the InstallScript object to be registered on your machine when you build a release for it. Registering an object on your development machine enables you to include the object in InstallScript projects that you create on that machine. Tip:If the object is not registered when you build it, you can register it from within an InstallScript project. To learn more, see Registering Objects in InstallScript Projects. |
||||||||||||||||||
Object Wizard |
InstallScript Object |
Select the type of wizard, if any, that you would like to use for your object’s default language. Available options are:
As an alternative, you can click the ellipsis button (...) in this setting if you want to select a custom wizard that you created for your object. To learn more about creating a custom wizard and using the InstallShield stock wizard, see Designing an Object’s Wizard. |
||||||||||||||||||
Register Custom Wizard |
InstallScript Object |
Specify whether you want InstallShield to register the custom object wizard for this object when you build a release for the object. Note:This setting is applicable only if you specify a custom wizard in the Object Wizard setting. |
||||||||||||||||||
Font Registration |
InstallScript, InstallScript Object |
If you want all of the font files in your project to be registered on the target system at run time, select Enabled. Static file links have an individual setting for font registration as well. This setting must be used to set the behavior for dynamically linked font files. |
||||||||||||||||||
DIFx Support (for 32-bit platforms) |
InstallScript, InstallScript Object |
To enable DIFx support in your project for installing device drivers on 32-bit systems, select Enabled. If you select Enabled, InstallShield adds the DIFxAPI libraries to your project when you build a release. For more information, see Installing Device Drivers. |
||||||||||||||||||
DIFx Support (for 64-bit Itanium platforms) |
InstallScript, InstallScript Object |
To enable DIFx support in your project for installing device drivers on 64-bit Itanium systems, select Enabled. If you select Enabled, InstallShield adds the DIFxAPI libraries to your project when you build a release. For more information, see Installing Device Drivers. |
||||||||||||||||||
DIFx Support (for 64-bit AMD platforms) |
InstallScript, InstallScript Object |
To enable DIFx support in your project for installing device drivers on 64-bit AMD systems, select Enabled. If you select Enabled, InstallShield adds the DIFxAPI libraries to your project when you build a release. For more information, see Installing Device Drivers. |
Windows Installer databases are implemented as COM structured storage, and COM structured storage files usually contain a Summary Information Stream. The Summary Information Stream contains information about your company and the product that is being installed.
The following settings are available in the Summary Information Stream area in the General Information view.
Setting |
Project Type |
Description |
|||||||||
Title |
Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform |
Specify the type of database that you are creating. For a product installation, the default value is Installation Database, which is the recommended value. Project: Basic MSI, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects—The value that you enter is used on the Summary tab of the Properties dialog box that is displayed if you right-click the Windows Installer database and then click Properties. For DIM projects—The value in this setting is not displayed or used at run time. You can use this setting in DIM projects as a reference for internally identifying the project. 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. |
|||||||||
Subject |
Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform |
Enter the name of the product. Project:In Basic MSI, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects—The value that you enter is used on the Summary tab of the Properties dialog box that is displayed if you right-click the Windows Installer database and then click Properties. For DIM projects—The value in this setting is not displayed or used at run time. You can use this setting in DIM projects as a reference for internally identifying the project. The value that you enter is displayed in the DIM References view of the project that contains this DIM. 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. |
|||||||||
Author |
Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform |
Specify your company name. Project:In Basic MSI, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects—The value that you enter is used on the Summary tab of the Properties dialog box that is displayed if you right-click the Windows Installer database and then click Properties. For DIM projects—The value in this setting is not displayed or used at run time. You can use this setting in DIM projects as a reference for internally identifying the project. The value that you enter is displayed in the DIM References view of the project that contains this DIM. 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. |
|||||||||
Keywords |
Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform |
Specify keywords that describe the Windows Installer database for your product. Project:In Basic MSI, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects—The value that you enter is used on the Summary tab of the Properties dialog box that is displayed if you right-click the Windows Installer database and then click Properties. For DIM projects—The value in this setting is not displayed or used at run time. You can use this setting in DIM projects as a reference for internally identifying the project. |
|||||||||
Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database |
This setting identifies the package code, which is the GUID for your installation package, DIM, or merge module. To have InstallShield generate a different GUID for you, click the Generate a new GUID button ({...}) in this setting. Project:In Basic MSI, InstallScript MSI, Merge Module, MSI Database, and MSM Database projects—Because Windows Installer requires that any two .msi databases with identical package codes to have identical contents, you should change the package code before releasing a modified package. In the Releases view, you can use the Generate Package Code setting for a product configuration to specify whether you want InstallShield to generate a new package code every time that you build a release. The default value for this setting is Yes. For DIM projects—The value in this setting is not displayed or used at run time. You can use this setting in DIM projects as a reference for internally identifying the project. The value that you enter is displayed in the DIM References view of the project that contains this DIM. |
||||||||||
Template Summary |
Basic MSI, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform |
Specify the processor type and default language that your installation supports. List the processor type first, followed by your installation’s default language, and separate them with a semicolon. If you have multiple entries in the language category, separate them with a comma. For example, if your installation runs only on Intel processors and English-based systems, enter Intel;1033. If your product runs on x64 processors and supports English and German, enter x64;1033,1031. For the language portion of this setting, use the number 0 if your installation is language neutral. Valid processor values include:
Note that you can specify only one processor value. For more information, see Using the Template Summary Property. If the target machine does not meet the requirements that you specify for this setting, an error message is displayed and the installation exits. |
|||||||||
Summary Information Stream Comments |
Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform |
Enter any comments about your product. A typical value for this setting is as follows: This installer database contains the logic and data required to install MyProduct. Project:In Basic MSI, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects—The value that you enter is used on the Summary tab of the Properties dialog box that is displayed if you right-click the Windows Installer database and then click Properties. For DIM projects—The value in this setting is not displayed or used at run time. You can use this setting in DIM projects as a reference for internally identifying the project. 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. |
|||||||||
Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform |
This setting lets you specify the integer that identifies the minimum Windows Installer version that is required for your installation package or DIM. For a minimum of Windows Installer 2.0, enter 200. For a minimum of Windows Installer 3.0, enter 300. For a minimum of Windows Installer 3.1, enter 301. For a minimum of Windows Installer 4.5, enter 405. If the end user’s system has a Windows Installer version earlier than the minimum requirement that you specify for the Schema setting—for example, if you specify a schema value of 405 because your installation uses Windows Installer 4.5 features, but an end user has Windows Installer 3.1—the installation displays an error message and exits. The value that you enter for the Schema setting is used for the Page Count Summary property of your Windows Installer database. Note:You can override this value for all of the releases that are associated with a particular product configuration in your project by setting the Schema setting for the product configuration in the Releases view. |
||||||||||
Require Administrative Privileges |
Basic MSI, MSI Database |
Specify whether your .msi package requires administrative privileges for the execute sequence of your installation. The default is Yes. If you set this to No, InstallShield sets bit 3 in the Word Count Summary property to indicate that elevated privileges are not required to install the .msi package. Note that if you select No but your .msi package tries to perform a task for which it does not have adequate privileges, Windows Installer may display a run-time error. This setting applies to installations that are run with Windows Installer 4.0 or later on Windows Vista and later systems or Windows Server 2008 and later systems. Earlier versions of Windows Installer and Windows ignore this setting. Note that an end user’s installation experience is more secure when installations are run with only the permissions that they need. Unless an application is designed to be run only by system administrators, it should be run with the least privilege. To learn how this setting and other InstallShield settings affect whether Windows Vista and later display a User Account Control prompt to elevate privileges, see Minimizing the Number of User Account Control Prompts During Installation. |
Add or Remove Programs (which is called Programs in the latest versions of Windows) in the Control Panel provides end users with technical support links and telephone numbers, product update information, and information about a product’s manufacturer. Depending on how the installation is configured, the end user may have the option of removing, repairing, or changing the installation with the click of a button. You can specify this information in your project by configuring the Add or Remove Programs settings in the General Information view.
Project:In a Basic MSI project—To prevent your product from appearing in Add or Remove Programs, you can set the Windows Installer property ARPSYSTEMCOMPONENT to 1 in the Property Manager. Note that setting this property simply suppresses the display of your product in Add or Remove Programs. An end user can still remove your product by running the installation in maintenance mode or from the command line.
In an InstallScript MSI project—To prevent your product from appearing in the Add or Remove Programs, select Yes for the Hide Add/Remove Panel Entry setting in the Releases view.
Setting |
Project Type |
Description |
||||||
Show Add or Remove Programs Entry |
Advanced UI, Suite/Advanced UI |
Indicate whether you want to show your Advanced UI or Suite/Advanced UI product’s entry in Add or Remove Programs in the Control Panel. Available options are:
|
||||||
Display Icon |
Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, MSI Database, Suite/Advanced UI, Transform |
Project:The value that you should enter for this setting depends on what project type you are using. In Basic MSI, InstallScript MSI, MSI Database, and Transform projects: Enter the path on your development system to the .ico, .exe or .dll file that contains the icon resource that you want to be used for your product’s entry in Add or Remove Programs. Instead of manually typing the path and file name, you can click the ellipsis button (...) in this setting to browse to the file. For InstallScript and InstallScript Object projects: Enter the path on the target system to the .ico or .exe file that contains the icon resource that you want to be used for your product’s entry in Add or Remove Programs. You can specify a path relative to a system variable that is enclosed by angle brackets—for example: <TARGETDIR>\icon.ico In Advanced UI and Suite/Advanced UI projects: Enter the path on your development system to the .ico, .exe or .dll file that contains the icon resource that you want to be used for your product’s entry in Add or Remove Programs. Instead of manually typing the path and file name, you can click the ellipsis button (...) in this setting to browse to the file. If you want to use the icon in a file that is present on target systems (for example, in a file that is installed by one of the packages in the Advanced UI or Suite/Advanced UI installation), select a directory property from the list in this setting, and then enter the rest of the path for the icon file. If you leave this setting blank, InstallShield uses the icon that is specified in the Setup.exe Icon File setting on the Setup.exe tab in the Releases view. |
||||||
Display Icon Index |
Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Suite/Advanced UI |
If the icon file that you specify contains more than one icon resource, specify the index in this setting.
|
||||||
Disable Change Button |
Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, MSI Database, Suite/Advanced UI, Transform |
Specify whether you want to disable the Change button for your product’s entry in Add or Remove Programs. The Change button enables end users to change installation options after the product has been installed. End users can remove or add features as needed. Project:In an InstallScript project, the OnMoveData event handler writes the data for this setting to the target system's registry. Also in an InstallScript project, you can specify a combined Change/Remove button by setting the Disable Change Button and Disable Remove Button settings to Yes and setting the system variable ADDREMOVE_COMBINEDBUTTON to TRUE in your script before the MaintenanceStart function is called. (MaintenanceStart is called by the default code for the OnMoveData event handler.) |
||||||
Disable Remove Button |
Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, MSI Database, Suite/Advanced UI, Transform |
Specify whether you want to disable the Remove button for your product’s entry in Add or Remove Programs. The Remove button enables end users to remove the product by clicking one button, which runs your uninstaller with a reduced user interface. Project:For Basic MSI, InstallScript MSI, MSI Database, and Transform projects—If the end user clicks the Remove button to remove your product, actions in the User Interface sequence of the project are executed. In an InstallScript project, the OnMoveData event handler writes the data for this setting to the target system's registry. |
||||||
Disable Repair Button |
Basic MSI, MSI Database, Transform |
Specify whether you want to disable the Repair button for your product’s entry in Add or Remove Programs. The Repair button enables end users to run the Windows Installer repair option if any files have been deleted or corrupted. |
||||||
Publisher |
Advanced UI, Basic MSI, InstallScript MSI, MSI Database, Suite/Advanced UI, Transform |
Specify the name of the company that created the product. This information is displayed for your product’s entry in Add or Remove Programs. The value that you enter is stored in the Windows Installer Manufacturer property. 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. Windows Logo Guideline:If you want to meet the requirements of the Windows logo program, you must specify the publisher. |
||||||
Publisher/Product URL |
Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, MSI Database, Suite/Advanced UI, Transform |
Enter a general URL for your company or product—for example, http://www.installshield.com. On some versions of Windows, the publisher name on the Support Info dialog box is a hyperlink to this URL. The Support Info dialog box is displayed when an end user clicks the support information hyperlink for your product’s entry in Add or Remove Programs. 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. Project:In an InstallScript project, the OnMoveData event handler writes the data for this setting to the target system’s registry. |
||||||
Support Contact |
Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, MSI Database, Transform |
Enter the name of the person or department that end users should contact for technical support. On some versions of Windows, this information is displayed on the Support Info dialog box for your product’s entry in Add or Remove Programs. 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. Project:In an InstallScript project, the OnMoveData event handler writes the data for this setting to the target system’s registry. |
||||||
Support URL |
Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, MSI Database, Transform |
Enter the URL that you would like end users to visit for technical support information for your product. This URL is displayed for your product’s entry in Add or Remove Programs. 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. Windows Logo Guideline:If you want to meet the requirements of the Windows logo program, you must enter a valid URL. Project:In an InstallScript project, the OnMoveData event handler writes the data for this setting to the target system’s registry. |
||||||
Support Phone Number |
Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, MSI Database, Suite/Advanced UI, Transform |
Enter the technical support phone number for your product. On some versions of Windows, this information is displayed on the Support Info dialog box for your product’s entry in Add or Remove Programs. 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. Project:In an InstallScript project, the OnMoveData event handler writes the data for this setting to the target system’s registry. |
||||||
Read Me |
Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, MSI Database, Suite/Advanced UI, Transform |
Enter the name or path of the Readme file for your product. As an alternative, you can link to a Readme file located on the Internet by specifying a valid URL. For more information, see Specifying a Readme File. On some versions of Windows, this information is displayed on the Support Info dialog box for your product's entry in Add or Remove Programs. 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. Project:In an InstallScript project, the OnMoveData event handler writes the data for this setting to the target system’s registry. |
||||||
Product Update URL |
Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, MSI Database, Suite/Advanced UI, Transform |
Specify a URL where end users can get information about product updates or download the latest version. On some versions of Windows, this information is displayed on the Support Info dialog box for your product's entry in Add or Remove Programs. 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. Project:In an InstallScript project, the OnMoveData event handler writes the data for this setting to the target system’s registry. |
||||||
Add or Remove Programs Comments |
Advanced UI, Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, MSI Database, Suite/Advanced UI, Transform |
Enter comments about your product. This information is displayed for your product's entry in Add or Remove Programs. 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. Project:In an InstallScript project, the OnMoveData event handler writes the data for this setting to the target system’s registry. |
||||||
English or Japanese IDE Settings |
InstallScript Object |
These areas—English IDE Settings and Japanese IDE Settings—let you specify information that should be available to InstallShield users when they view your object in the Objects view of the English and Japanese versions of InstallShield. |
||||||
Use Default |
InstallScript Object |
If this setting is for a language other than the default language, specify whether you want to use the default language settings’ values for this language. If you select Yes, the other settings under the Use Default setting become disabled. If you select No, the other settings under the Use Default setting become enabled so that you can specify language-specific values. This setting is disabled for the default language. |
||||||
Display Name |
InstallScript Object |
Enter the name of your object as you would like it to appear in the Objects view. |
||||||
Short Name |
InstallScript Object |
Enter a shortened version of your object’s name, if desired. You can enter the same name that you entered for the Display Name setting. |
||||||
HTML Help |
InstallScript Object |
Specify the object’s help file, which must consist of a single Web file; this file is displayed in the right pane when the object is selected in the Objects view. Type an explicit path or path variable. |
||||||
Icon File |
InstallScript Object |
The icon is displayed next to your object in the Objects view. The icon must be 16 pixels by 16 pixels with a maximum of 16 colors. The icon can be loaded from a DLL, .exe, or .ico file. When the file is a DLL or .exe, the icon index or resource ID can be specified after the path and file name separated by a comma. If a resource ID is specified rather than an index, it must be preceded by a dash (-). If no index is specified, the number 0 is assumed. |
Use the Software Identification Tag area of the General Information view to specify whether you want to include an ISO/IEC 19770-2 software identification tag in your installation. If a tag is included, this area also lets you specify the identification information that is not already specified in other areas of the General Information view. For more information, see Including a Software Identification Tag for Your Product.
If you include a software identification tag, you can include application model data for Microsoft System Center Configuration Manager in the tag. For more information, see Including Microsoft System Center Configuration Manager Application Model Data About Your Product.
Setting |
Project Type |
Description |
||||||||||||
Use Software Identification Tag |
Basic MSI |
Specify whether you want to include an ISO/IEC 19770-2 software identification tag in your installation. If you select Yes, use the other tag-related settings in this area of the General Information view to specify the identification information that is not already specified in other areas of the General Information view. |
||||||||||||
Require Software Entitlement |
Basic MSI |
Specify whether you want to require your product to have a corresponding software entitlement in order for software reconciliation to be considered successful. In general, if the software must be purchased, Yes should be selected for this setting; if the software is free, No should be selected for this setting. |
||||||||||||
Unique ID |
Basic MSI |
Enter a unique ID that identifies the specific version of this specific product. To have InstallShield generate a different GUID for you, click the Generate a new GUID button (...) in this setting. Note that InstallShield uses the value that you enter as part of the name of the tag file (TagCreatorID_UniqueID.swidtag). Therefore, the ID that you enter must not contain any characters that are invalid for file names. |
||||||||||||
Tag Creator |
Basic MSI |
Enter the name of the organization that created the tag. |
||||||||||||
Tag Creator ID |
Basic MSI |
Enter the registration ID of the organization that created the tag. This ID helps to differentiate between different legal organizations that have the same creator name but are in different countries. The convention for the registration ID is as follows: regid.YYYY-MM.ReversedDomainName,division The registration ID consists of the following parts:
Note that InstallShield uses the value that you enter as part of the name of the tag file (TagCreatorID_UniqueID.swidtag). Therefore, the ID that you enter must not contain any characters that are invalid for file names. |
||||||||||||
Software Creator |
Basic MSI |
Enter the name of the organization that created the software. This setting is optional. If you leave this setting blank, InstallShield uses the value of the Tag Creator setting for the name of the software creator. |
||||||||||||
Software Creator ID |
Basic MSI |
Enter the registration ID of the organization that created the software. This ID helps to differentiate between different legal organizations that have the same creator name but are in different countries. This setting is optional. If you leave this setting blank, InstallShield uses the value of the Tag Creator ID setting for the software creator ID. The convention for the registration ID is as follows: regid.YYYY-MM.ReversedDomainName,division The registration ID consists of the following parts:
|
||||||||||||
Software Licensor |
Basic MSI |
Enter the name of the organization that owns the copyright for the software. This setting is optional. If you leave this setting blank, InstallShield uses the value of the Tag Creator setting for the name of the software licensor. |
||||||||||||
Software Licensor ID |
Basic MSI |
Enter the registration ID of the organization that owns the copyright for the software. This ID helps to differentiate between different legal organizations that have the same licensor name but are in different countries. This setting is optional. If you leave this setting blank, InstallShield uses the value of the Tag Creator ID setting for the software licensor ID. The convention for the registration ID is as follows: regid.YYYY-MM.ReversedDomainName,division The registration ID consists of the following parts:
|
||||||||||||
Add SCCM App Model Data |
Basic MSI |
Specify whether you want to include application model data for Microsoft System Center Configuration Manager in the software identification tag in your installation. If you select Yes, configure this setting’s subsettings as needed. For more information, see Including Microsoft System Center Configuration Manager Application Model Data About Your Product. |
||||||||||||
Application Type |
Basic MSI |
Select the type of application that your installation installs. |
||||||||||||
Supersedence |
Basic MSI |
If you want the installation that you are creating to supersede other installations, click the ellipsis button (...) in this setting. The Supersedence dialog box opens, enabling you to browse to the Windows Installer packages (.msi) that you want to be superseded. |
||||||||||||
Uninstall Superseded Applications |
Basic MSI |
Specify whether the applications that are being superseded should be uninstalled before installing the application via the current installation. |