Previous Topic: Feature SelectionNext Topic: MSI Value


Properties

Select additional properties of the procedure:

Properties are values used during the installation process. The properties may be public or private. A property is specified as Property=Value.

Public Properties:

A public property name contains only capital letters. It can be set by the user to be passed on to the Windows Installer setup process, for example, INSTALLDIR="c:\program files\my product".

Private Properties:

Private properties are only used internally in the install package. It cannot be set by the user. The properties can be standard Windows Installer properties or package specific properties.

The properties you may select among belong to either configuration properties, SD properties, or feature installation options properties.

You may select one of the following:

ADDEFAULT:

Belongs to feature installation options properties. This property has as value a list of features, delimited by commas, that are to be installed in their default configuration.

The only software delivery-provided value is ALL, which means that all features are installed in their default configuration.

ADDLOCAL:

Belongs to feature installation options properties. This property has as value a list of features, delimited by commas, that are to be installed locally.

The Feature dialog adds feature indices for features to be added to run from the local hard disk.

The software delivery-provided value ALL means that all features are installed locally on disk.

ADDSOURCE:

Belongs to feature installation options properties. This property has as value a list of features, delimited by commas, that are to be installed to run from source.

The Feature dialog adds feature indices for features to be added to run from the source.

The software delivery-provided value ALL means that all features are to be installed to run from source.

ADVERTISE:

Belongs to feature installation options properties. This property has as value a list of features, delimited by commas, that are to be advertised.

The Feature dialog adds feature indices for features to be added to run advertised.

The software Delivery-provided value ALL means that all features are advertised.

ALLUSERS:

Belongs to configuration properties. This property determines where the configuration information of the installed application is stored.

The software delivery-provided values to select among are 1 and 2.

The interpretation of the selected value depends on if a machine or a user (local user, domain user) is the target, and, in the user case, the presence of administrative privileges.

If a computer or a user with administrative privileges is the target, for both values (1, 2) the installation uses folders in "All Users" profile.

If a user without administrative privileges is the target, 1 is invalid and 2 means that the per-user installation uses folders in the user's personal profile.

If this property is not set (ALLUSERS=NULL), a per-user installation using folders in the user's personal profile is performed.

ARPNOMODIFY:

Belongs to configuration properties. If the value of this property is 1, then the Add/Remove functionality in Control Panel used to modify the product is disabled.

ARPNOREMOVE:

Belongs to configuration properties. If the value of this property is 1, then the Add/Remove functionality in Control Panel used to remove the product is disabled.

For Windows 2000/XP, this property disables the Remove button for the product from the Add/Remove Programs in Control Panel.

For earlier operating systems, this property has the effect of removing the product from the list of installed products on the Add/Remove Programs in Control Panel.

ARPSYSTEMCOMPONENT:

Belongs to configuration properties. If the value of this property is set to 1, using the command line or a transform, this prevents the application from being displayed in the Add/Remove programs list.

For operating systems prior to Windows 2000/XP, this property has no effect.

If this functionality should be achieved for multiple platforms, use ARPNOREMOVE as well.

DISABLEMEDIA:

Belongs to configuration properties. If the value of this property is 1, the installer is prevented from registering any media source, such as a CD-ROM, as a valid source for the product.

DISABLEROLLBACK:

Belongs to configuration properties. If the value of this property is 1, the installer is prevented from generating a rollback script and saving deleted files during the installation.

sdprop_installelevated:

This is a software delivery property. The only software delivery-provided value is 1, which means that software delivery temporarily changes the Windows Installer policy to always install with elevated privileges, when using the procedure for which this property is set.

This property may be automatically set for the install, uninstall, and configure procedures registered for a software item, if the box "Do not install with elevated privileges" is not checked at software item registration time.

PIDKEY:

Belongs to user information properties. The property denotes the part of the Product ID that is entered by a user.

For example, Microsoft products use a licensing scheme, where a Product ID key can be entered as an MSI property (register when installing).

There are three ways a software delivery administrator can enter this key value for a procedure that is to be used for an unattended installation:

  1. Register the MSI package without checking the Seal package box on the Customize dialog, and then add this property for the install procedure that is to be used for the unattended installation before sealing the package in the Software Library.
  2. Register the MSI package as sealed, then unseal it and add the property as in 1.
  3. Register the MSI package as sealed, then create a new procedure based on an existing one, add the property for the new procedure as in 1. and use the new procedure for the unattended installation.
PRODUCTLANGUAGE:

Belongs to installation status properties. The ProductLanguage property specifies the language the installer should use for any strings in the user interface that are not authored in the database.

This property must be a numeric lanuage identifier (LANGID).

The operating system and the package must support the LANGID.

If a transform changes the language of the user interface in the database, it should also change the value of this property to reflect the new language.

REBOOT:

Belongs to configuration properties. This property suppresses certain prompts for reboot of the system. The property may be used by an administrator with a series of installations to install several products at the same time with only one reboot at the end.

The software delivery-provided values to select among are:

Force:

always prompt for a reboot at the end of the installation

Suppress:

suppress prompts for a reboot at the end of the installation until all jobs have finished.

ReallySuppress:

suppress prompts for a reboot even if the reboot is required. This value should be used with caution.

REBOOTPROMPT:

Belongs to configuration properties. If the value of this property is Suppress, this prevents the "Reboot now YES/NO dialog" from appearing, even if the installation is performed with user interface turned on. However, the Software Delivery reboot/postpone dialog will appear, since it is not affected by the Suppress setting.

The only software delivery-provided value is Suppress.

REMOVE:

Belongs to feature installation options properties. The value of this property is a list of features, delimited by commas, that are to be removed.

The Feature dialog adds feature indices for features to be removed.

The software delivery-provided value ALL means that all features are uninstalled.

ROOTDRIVE:

Belongs to configuration properties. Specifies the default drive for the destination directory of the installation.

No software delivery-provided values are given.

sdprop_macroexpand:

This is a software delivery property. It enables macros to be expanded before execution of the MSI package. The property will not be passed on to the Windows installer engine.

The following parameter macros are included as values: $#bg and $#ec. You can define additional values.

Example (no spaces are allowed):

If you set the value $#ec:0$#ec:1605$#bg of the sdprop_macroexpand property for an uninstall procedure, you will make the procedure execute successfully and delete the installation record on software delivery, even if the user has uninstalled the item.

1605 is an MSI return code for the case when an item is ordered to be uninstalled, but an installation cannot be found.

SHORTFILENAMES:

Belongs to configuration properties. The setting of this property causes short file names to be used for the names of target files, rather than long file names.

You may need to use this property for some administrative installations.

The only possible software delivery-provided value is 1.

TARGETDIR

Belongs to component location properties. Provides the location into which the installation package is copied during an administrative installation.

The value of the TARGETDIR property is typically set at the command line or through a user interface.

The only possible software delivery-provided value is $msi

TRANSFORMS:

Belongs to configuration properties. Provides a list of the transforms, as specified by one or more transform files (.MST), that the installer applies when installing the package. The installer applies the transforms in the same order as they are listed in the property.

Transforms can be specified by their file name or full path. To specify multiple transforms, separate each file name or full path with a semicolon (;).

By prefixing the filename with a colon (:), you can indicate that a transform file is embedded in a storage of the .msi file, rather than as a stand-alone file.

The installer requires the transforms listed in TRANSFORMS at every installation, advertisement, installation-on-demand, or maintenance installation of the package.

The default location of these files is in the same directory as the .MSI file. However, it is possible to specify a relative path to the MSI-file or an absolute path or UNC path on the target system.

USERLOGGEDON:

This is a software delivery property. The only software delivery-provided value is 1, which means that a user must be logged on before the installation can be started.

Special Software Delivery properties

If you are working with a package that is driven by an executable, for example, an InstallShield 7.x generated package, click here to see the added special software delivery properties.

You would normally not want to use any of the ADDEFAULT, ADDLOCAL, ADDSOURCE, ADVERTISE or REMOVE properties when using a transform, since the features selected in the transform will be overridden by the features specified by the properties.

If you add a transform to a procedure of type "Local install", you manually have to remove the ADDLOCAL=ALL property. The "Local install" procedure will always have the ADDLOCAL=ALL property set to ensure that no features will run from source or being installed on demand.

Note: Microsoft installer properties, like ARPHELPLINK, INSTALLLEVEL, and PROMPTROLLBACKCOST, are documented in the Microsoft Windows Installer Guide (Property Reference) available at msdn.microsoft.com.