Installer Options (Tarma)

Reference information
Objects on this page none
Related topics Working with project pages

Introduction

The Installer Options page contains various options that control the behavior of the Tarma native installer. They are used when you build a Tarma Installer configuration on the Build Configurations page.

Installation levels

The installation level determines which access checks the installer performs and which, if any, folders and registry keys are redirected:

Note: Windows 95, 98, and Me have little or no conception of security or access privileges, so Installation level has little effect on these platforms beyond some folder and registry key redirection. You should choose the desired option based on its effect on NT-based platforms (Windows NT4, 2000, XP, 2003, and later).

The installation level can also be set with the /a Setup command line option and is accessible through the TsuInstallLevel variable.

The following installation levels are available:

Installation level Description
Not checked

Does not perform any access checks and always installs as All Users. However, because no access checks take place, the installation may fail without prior warning if the installing user account does not hold the privileges that are required to perform the installation.

This option is NOT recommended.

Current User

Always perform a Current User installation. This will redirect any common folders and registry keys to their Current User equivalent. As a result, your product will only be accessible to the user who performed the installation, and any shortcuts will only be visible to that user.

Tip: With this option, multiple users can install and remove independent copies of your product. Do not install any files in the Windows folder or below, because this folder tree is not redirected and ordinary users cannot set or modify the SharedDLLs reference count for those files. Any attempt to install files with the Shared file attribute will therefore fail.

If the project contains installation items that require elevated privileges (for example, service installation) and the installing user account does not hold these privileges, the installer will display a warning prior to installation and will refuse to install.

All Users, else Current User

Perform an All Users installation if possible, or fall back automatically to a Current User installation if the installing user account does not hold the required privileges.

If the project contains installation items that require elevated privileges (for example, service installation) and the installing user account does not hold these privileges, the installer will display a warning prior to installation and will refuse to install.

All Users, query Current User

Perform an All Users installation if possible, or ask the user if he/she wants to perform a Current User installation instead if the installing user account does not hold the required privileges. If the user declines, the installer will refuse to install.

If the project contains installation items that require elevated privileges (for example, service installation) and the installing user account does not hold these privileges, the installer will display a warning prior to installation and will refuse to install.

Note: During silent installs (/q or /q2 Setup command line option), the installation will fail if an All Users installation is not possible.

All Users

Always perform an All Users installation. No redirection of folders or registry keys takes place and your product will be accessible to all users on the system.

If the installing user does not hold the privileges for an All Users installation (the user must be a member of the Power Users or the Administrators group for an All Users installation), or if the project contains installation items that require elevated privileges (for example, service installation) and the installing user account does not hold these privileges, the installer will display a warning prior to installation and will refuse to install.

Note: Members of the Power Users group cannot register files for delayed copying. You must therefore ensure that the installer will not encounter any in-use files that must be replaced, for example by specifying the appropriate Process check (see below).

Administrator

Always perform an All Users installation, and in addition require that the installing user account is a member of the Administrators group. If the user is not, the installer will refuse to install.

This option is mainly useful if you want to perform additional installation actions that you know require Administrator privileges. For any standard actions that require Administrator privileges (for example, service installation), the installer automatically checks if the installing user holds the required privileges.

Administrator rights are also required to register files for delayed copying if the installer encounters in-use files that must be replaced. You can therefore use this option to handle in-use files as well. However, the preferred approach is to prevent in-use files in the first place by performing the appropriate Process check (see below).

Attributes and options

The following attributes and options are available on the Installer options page.

Attribute Description
Installation level Select the desired installation level for your product from the drop-down list. See Installation levels above for an explanation of the available options.
Suppress in-use warnings

Check this box to suppress any warnings about in-use files during installation; clear it to warn the user if in-use files are encountered. In the latter case, the user has the opportunity to close any other applications in an attempt to make the files available for replacement.

If the problem cannot be cleared up, or if the warnings are suppressed, the in-use files will be prepared for delayed (post-boot) copying and a reboot will be scheduled.

Error handling... Click this button to open the Setup Error Handling dialog box that allows you to specify how the installer deals with errors during installation.
Reboot policy

Select the desired reboot policy from the drop-down list. The following choices are available:

Reboot policy Description
Never reboot Never reboot after installation. Any reboot requests, for example for delayed file copying, are ignored.
Reboot if required

Reboot the system if required, for example because one or more in-use files were encountered that must be replaced by delayed file copying.

The user is prompted at the end of the installation to allow the reboot, and may still suppress it.

Always reboot

Always schedule a reboot.

The user is prompted at the end of the installation to allow the reboot, and may still suppress it.

Allow reboot in quiet mode Check this box to allow the installer to reboot the system in quiet mode; clear it to suppress reboots in quiet mode. If this option is checked and a reboot is required in quiet mode, the installer will reboot the system without warning to the user.
Clean up log

Check this box to let the installer delete its log file at the end of a successful installation, or clear it to keep the log under all circumstances. If the installation fails, the log file is always retained.

Tip: The installer's log file is written to the Temp folder of the installing user, which is usually one of the following (or their localized equivalents):

  • C:\Temp
  • C:\Windows\Temp
  • C:\Documents and Settings\<user name>\Local Settings\Temp (Please note that the Local Settings folder is by default hidden in Windows Explorer; you might have to change the Windows Explorer folder settings to show hidden files and folders.)

The name of the installation log file is is TSU-xxxx.log (with xxxx being a hexadecimal number) during a new installation; it is Setup.log during subsequent Change, Modify or Repair runs, and during uninstallation.

Process check

Select the desired running process check option from the drop-down list. The following choices are available:

Process check Description
Don't check Don't perform any running process checks.
Advisory check Check that the processes listed under Processes are not running. If they are, warn the user but allow the installation to continue anyway. This may lead to problems with in-use files during installation or removal.
Blocking check Check that the processes listed under Processes are not running. If they are, then block the installation until the processes are no longer running, or the user cancels the installation.
Processes Enter the list of process names to check for, separated by semicolons (';'). You must specify the file name and extension of the process, but not its path. Example: tin.exe;notepad.exe
Uninstaller

Select the desired uninstaller registration option from the drop-down list. The following choices are available:

Uninstaller Description
Don't register Don't register the uninstaller. This is NOT recommended, because it makes it difficult for the user to remove your product.
Hidden uninstaller

Register only a hidden uninstaller, using the QuietUninstallString. The uninstaller will not appear in the Windows Add/Remove Programs control panel, but can still be uninstalled during an upgrade or as part of an Add-on/Update installation.

This is the recommended option for update installers.

Normal uninstaller

Register both a normal and a hidden uninstaller through UninstallString and QuietUninstallString. The uninstaller will appear in the Windows Add/Remove Programs control panel, but can also be automatically uninstalled during an upgrade or as part of an Add-on/Update installation.

This is the recommended option for most products, including add-on installers.

Display name Enter the display name for the uninstaller, i.e., the name under which your product will be listed in the Windows Add/Remove Programs control panel.
Include extension DLL Check this box to add an extension DLL to the installer; clear it for no extension DLL. If you check this box, you must specify the extension DLL's path in the next two fields.
ANSI path Enter the path to the ANSI version of the extension DLL, or click ... (browse) to open the standard Open dialog box that allows you to browse for one. You will need to include an ANSI version of the extension DLL if your installer uses an ANSI Setup stub; see TSU Configuration for details.
Unicode path

Enter the path to the Unicode version of the extension DLL, or click ... (browse) to open the standard Open dialog box that allows you to browse for one. You will need to include a Unicode version of the extension DLL if your installer uses a Unicode Setup stub; see TSU Configuration for details.