Setup Settings File

Setup.exe reads the Setup settings file (Setup.ini) and writes tasks to the registry based on the information contained in the settings file. You can customize Setup.ini or create your own custom INI files to help control many aspects of the installation process.

Information on the following Setup settings file sections is included in this section of the chapter:

[MSI]

[Product]

[MST]

[Options]

[Display]

[Logging]

[MinOSRequirement]

[OfficeWebComponents]

[Cache]

[ChainedInstall_n]

For more information about customizing Setup.ini or creating your own custom INI file, see “Methods of Customizing Office” in Chapter 4, “Customizing Office 2003.”

[MSI]

Specify the name of the Windows Installer package (MSI file) to install; equivalent to the /i command-line option. The package must be in the same folder as Setup.exe, and both must be at the root of the installation image.

Example:

[MSI] MSI=Pro11.msi

[Product]

Specify product information. Setup uses this information to determine whether the product is installed. Typically, you do not modify this section of the Setup settings file.

Example:

[Product] ProductCode={12345678-1234-1234-1234-123456789123} ProductName=Microsoft Office 2003 Version=11.0

You can add the SKIPLANGCHECK option to the [Product] section to bypass the default language version check.

SKIPLANGCHECK=[string]

Bypass the check that prevents a particular language version of Office 2003—either a localized product or a Microsoft Office 2003 Multilingual User Interface Pack (MUI Pack)—from being installed on a computer on which the operating system does not support that language; equivalent to including the /skiplangcheck option on the command line. Language groups that require explicit installation on the user’s computer include complex script languages, right-to-left languages, and East Asian languages.

For example, Setup performs this check and does not install a Japanese MUI Pack on the computer unless support for East Asian languages (Microsoft Windows XP or later) or Japanese (Microsoft Windows 2000) has been installed. You can bypass the language check and install the MUI Pack anyway by setting SKIPLANGCHECK to 1. You cannot set the SKIPLANGCHECK option on the command line or in a transform (MST file).

Note

Setting SKIPLANGCHECK does not enable language versions of Office to function properly without the necessary operating system support; bypassing the check merely allows you to install Office products and language support in any order.

If you set SKIPLANGCHECK to 0 (the default), then Setup behaves as described in the following table.

Type of installation	Results
Quiet installation (/q)	Setup performs the language check and terminates if the MUI Pack language version is not supported by the operating system. No error message is displayed, but information is written to the log file.
Advertised installation (/j)	Setup performs the language check and terminates if the MUI Pack language version is not supported by the operating system. No error message is displayed, and no information is written to the log file.
Administrative installation (/a)	No language check is performed.

For more information about installing Office 2003 with MUI Packs, see “Overview of Deploying Office 2003 with the MUI Pack” in Chapter 13, “Preparing for an Office Multilingual Deployment.”

[MST]

Specify the name and path of a transform (MST file) to apply to the installation of the package specified in the [MSI] section; equivalent to setting the TRANSFORMS property on the Setup command line. If the transform is in the same folder as the Windows Installer package (MSI file), you do not need to include the path.

Example:

[MST] MST1=\\marketing\software\Custom1.mst MST2=\\engineering\software\Custom2.mst

Note

You must use the key MST1 in the [MST] section of Setup.ini; do not use MST or TRANSFORMS. You can specify multiple transforms—for example, MST1, MST2, and so on. Note, however, that Setup applies the transforms in the order in which they are listed, regardless of the numbers you assign to them.

[Options]

Define Setup properties to apply to the installation of the package specified in the [MSI] section. Use the format property=value.

Example:

[Options] USERNAME=Customer REBOOT=Suppress COMPANYNAME=Northwind Traders DONOTMIGRATEUSERSETTINGS=1

Note

You specify only public properties in the [Options] section of Setup.ini. For more information about public and private properties, see “Setup Properties” earlier in this appendix.

[Display]

Set the Setup user interface display level; equivalent to the /q command-line option. Settings include the following:

Display=none	Display no user interface.
Display=basic	Display only simple progress indicators and error messages.
Display=reduced	Display all progress indicators and error messages but collect no user information.
Display=full	Display all dialog boxes and messages.
CompletionNotice=yes | no	Add completion message at the end of the installation; use only when the display is set to none or basic.
-	Suppress all modal dialog boxes; use only with basic.
+	Add a completion message at the end of the installation; use with basic or none. For example, basic+.
!	Hide the Cancel button; use only with basic. For example, basic!+.

For more information about display settings, see “Customizing How Setup Runs” in Chapter 4, “Customizing Office 2003.”

Example:

[Display] Display=basic CompletionNotice=yes

[Logging]

Create a log file for Setup and a log file for each Windows Installer task; equivalent to the /l command-line option. In this section you define the name and path of log files and specify logging options by using the following format:

• Type=<options>

• Path=<path>

• Template=<file name>.txt

Type

Specify the data to include in the Windows Installer log file. (You cannot specify options for the Setup log file.) The following options are identical to the options used with the /l command-line option:

a	Start of action notification
c	Initial UI parameters
e	Error messages
i	Information-only messages
m	Out-of-memory messages
o	Out-of-disk-space messages
p	Property table list in form property=value
r	Action data record; contains action-specific information
u	User request messages
v	Verbose; includes debug messages
w	Warning messages
*	Turn on all logging options except v
+	Append to existing log file

Example:

Type=piwaeo 

Path

Specify the folder in which to create log files. The path may contain environment variables. The default setting is %Temp%.

Example:

Path="%Temp%\Office log files"

Note

You must use a fully qualified path to specify the location for log files. If you use a relative path with a drive letter, no log files are created and no error message is displayed.

Template

Specify the name to use for log files. The name may contain environment variables.

You must include the .txt file name extension when you specify a Setup log file name. Appending (*) to the file name results in a unique log file for each installation performed by Setup.exe. The same log file name is used for each Windows Installer log file, with the task number from Setup.ini appended to the file name.

Examples:

Template=OfficeSetup(*).txt Template=Office_%UserName%(*).txt

For more information about logging during the Office installation, see “Customizing How Setup Runs” in Chapter 4, “Customizing Office 2003.” For more information about Windows Installer logging options, see the Platform SDK on the MSDN Web site at http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/roadmap_to_windows_installer_documentation.asp.

[MinOSRequirement]

Specify the minimum supported operating system for Office 2003. Office 2003 requires Microsoft Windows 2000 Service Pack 3 or Windows XP or later; you cannot specify an earlier version. For more information, see the Platform SDK on the MSDN Web site.

Example:

[MinOSRequirement] VersionNT_1=500 WindowsBuild_1=2195 ServicePackLevel_1=3 

[OfficeWebComponents]

Used to specify the MSI file for Office Web Components. This section appears only when you create an administrative installation point for an Office product that includes an Office Web Components package.

[Cache]

Specify options that control the way Office installation files (CAB files) are cached on the local computer during Setup. Because Setup creates the local installation source before applying a transform (MST file), you must set local installation source properties such as CDCACHE and LOCALCACHEDRIVE in the Setup settings file, and not on the Modify Setup Properties page of the Custom Installation Wizard.

Note

These settings are applied only when Office is installed from the CD or an image of the compressed CD on the network. Administrative installation points do not support creation of a local installation source during Setup. When you run Setup with the /a option, Setup extracts the compressed CAB files on the network share. Setup does not install Office Source Engine (Ose.exe) to copy source files to users’ computers; instead, Windows Installer uses the original source.

To customize the local installation source, set the properties defined in the following table.

Option	Value	Description
LOCALCACHEDRIVE	"drive"	Override default Setup behavior and specify a drive for the local cache. After the first Office 2003 product is installed, all subsequent installations use this location for the local installation source.
PURGE	0 | 1	Set to 1 to delete the local installation source after Setup completes. Default is 0.
CDCACHE	auto | 0 | 1 | 2	Set to auto to cache the entire source on the drive with the most space (the default). If insufficient space exists, cache only the features selected for installation. If space is not available for selected features, install from the CD.
		Set to 1 to cache only the features selected for installation; if space is not available, the installation fails.
		Set to 2 to force caching of entire source; if space is not available, the installation fails.
		Set to 0 to disable creation of a local installation source and run the installation directly from the source.
DELETABLECACHE	0 | 1	Set to 0 to hide the option that allows users to delete the local cache at the end of Setup. Bypass-enabled CD default is 1.

When CDCACHE is set to auto (the default), Setup uses the following criteria to determine how and where to create the local installation source. If both an NTFS and a FAT drive meet the disk space requirement, Setup uses the NTFS drive.

• If there is no existing cache and free space is equal to or greater than 2 GB, then cache the entire source on the drive with the most space.

• If there is no existing cache and free space is less than 2 GB but greater than 1.5 GB, then cache installation files for selected features on the drive with the most space.

• If a local cache already exists and free space is less than 2 GB but greater than 1.5 GB, then cache the entire source in that location.

• If a local cache already exists and free space is less than 1.5 GB but greater than 1 GB, then cache installation files for selected features in that location.

• If free space is less than the minimum required for a particular installation, install from the CD.

Note

The PURGE and DELETEABLECACHE properties behave differently then other Windows Installer properties. If you set either of these properties to 0 in Setup.ini or on the command line, then the property is not passed to Windows Installer during the installation. If you set either property to 1 in a transform and later wish to reverse the setting, you cannot do so by resetting the property to 0 on the command line or in Setup.ini. Instead, you must reset the property in the transform.

For more information about caching installation files on the local computer, see “Taking Advantage of a Local Installation Source” in Chapter 3, “Preparing to Deploy Office 2003.”

Example:

[Cache] CDCACHE=1 DELETABLECACHE=0

[ChainedInstall_n]

Install an additional package (MSI file) or other executable file (such as an EXE file or a BAT file) as part of the Office installation. Add a [ChainedInstall_n] section to Setup.ini for each chained installation; replace the placeholder n with a consecutive number. Chained packages are installed in order after the core Office package is successfully installed.

To customize the chained installation, set the following properties:

TaskName	Assign a friendly name to the installation (optional). Setup uses this name in the Setup log file.
Path	Specify the path and file name of the MSI file or an executable file (required).
TaskType	Identify whether the chained installation is an MSI file or EXE file (required).
MST	Specify the path and file name of a transform to apply to the chained package (for MSI files only). You can specify only one transform in this entry; to specify multiple transforms, add the TRANSFORMS property to the Cmdline entry.
Display	Specify a display setting for the chained installation; may differ from global display level set for the core Office package. If this value is not set, Setup uses the display level set for the core Office package.
CmdLine	Add other options to the command line that Setup passes for the chained package. The value of CmdLine is limited to 1239 characters. Setup truncates the command line after it reaches that limit.
	Note that you cannot use CmdLine to override the installation type (/j or /i) set for the primary package; that setting is automatically applied to all chained packages.
Reboot	To restart the computer after a chained installation completes, set this option to 1; Setup restarts and resumes the installation process. The default setting is 0, which suppresses computer restarts prompted by files in use.
IgnoreReturnValue	To continue to install successive chained installations even if this installation fails, set this property to 1.

Note

If you inadvertently enter an incorrect name or path for the MSI file, then Setup halts the installation process and neither the chained package nor any subsequent chained packages are installed. This occurs even if IgnoreReturnValue is set to 1 (this is the only case in which IgnoreReturnValue is ignored). The installation failure is logged, but no error message is displayed.

Setting the Reboot option in this section of Setup.ini allows Setup to control the restart process by adding a task to the registry that directs Setup to restart the computer and then resume the installation process, including any additional chained installations. Set this option to restart the computer in order to complete a chained installation or when a subsequent chained installation requires the restart.

Note

The Reboot option in this section of Setup.ini takes the value 1 or 0. It is not the same as the Windows Installer REBOOT property, which takes the value FORCE, SUPPRESS, or REALLYSUPPRESS. For more information about the Windows Installer property, see REBOOT in “Setup Properties” in Appendix B.

The following example adds the French MUI Pack to the Office 2003 installation. The package is installed silently (regardless of the display setting specified for the Office installation), the customizations in the transform French.mst are applied, and an alternate source is identified for when the primary administrative installation point is unavailable:

[ChainedInstall_1] TaskType=msi Path=\\server\share\admin_install_point\1036\Mui.msi Display=None MST=French.mst Cmdline=SOURCELIST=\\server2\share admin_install_point\1036