Export (0) Print
Expand All

Setup properties reference for Office 2013

 

Applies to: Office 2013

Topic Last Modified: 2013-12-18

Summary: Learn about which Windows Installer properties are available for Office 2013 installations.

Most of the Windows Installer properties that were previously used to customize and control Office installations were replaced in Microsoft Office 2007 by options in the Office Customization Tool (OCT) or elements in the Config.xml file. The following information also applies to Office 2013 and Office 2010.

In versions of Office earlier than Office 2007, you used Windows Installer properties to customize and control the Office installation. The Setup process was redesigned in the Office 2007 release, and most of these functions were replaced by options in the Office Customization Tool or elements in the Config.xml file.

In this article:

The following table summarizes the recognized Windows Installer properties that you might have used in versions of Office earlier than Microsoft Office 2007. The table shows if the functionality of that property is blocked and replaced by options in the OCT or Config.xml, or if the property is available for use. More detail is provided in the following sections.

Windows Installer properties and their use in Office 2013

Property Use in Office 2013

ADDDEFAULT

Replaced

ADDLOCAL

Replaced

ADDSOURCE

Replaced

ADVERTISE

Replaced

ALLUSERS

Blocked

ARPAUTHORIZEDCDFPREFIX

Replaced

ARPCOMMENTS

Replaced

ARPCONTACTS

Replaced

ARPHELPLINK

Replaced

ARPHELPTELEPHONE

Replaced

ARPINSTALLLOCATION

Replaced

ARPNOMODIFY

Replaced

ARPNOREMOVE

Replaced

ARPNOREPAIR

Replaced

ARPPRODUCTICON

Replaced

ARPREADME

Replaced

ARPSIZE

Replaced

ARPSYSTEMCOMPONENT

Replaced

ARPURLINFOABOUT

Replaced

ARPURLUPDATEINFO

Replaced

COMPADDLOCAL

Replaced

COMPADDSOURCE

Replaced

COMPANYNAME

Replaced

DISABLEROLLBACK

Blocked

EXECUTEACTION

Blocked

EXECUTEMODE

Blocked

FILEADDDEFAULT

Replaced

FILEADDLOCAL

Replaced

FILEADDSOURCE

Replaced

HIDEUPDATEUI

Available

INSTALLLEVEL

Blocked

INSTALLLOCATION

Replaced

LIMITUI

Replaced

LOGACTION

Blocked

MEDIAPACKAGEPATH

Blocked

NOCOMPANYNAME

Replaced

NOUSERNAME

Replaced

PIDKEY

Replaced

PRIMARYFOLDER

Available

PROMPTROLLBACKCOST

Blocked

REBOOTPROMPT

Blocked

REINSTALL

Blocked

REMOVE

Replaced

ROOTDRIVE

Available

SEQUENCE

Blocked

SETUP_REBOOT

Available

SOURCELIST

Replaced

TARGETDIR

Replaced

UNINSTALL

Blocked

USERNAME

Replaced

The following properties can be used when you install Office 2013 (and Office 2010 and Office 2007):

  • HIDEUPDATEUI   If set to True, hides the Check for Updates button on the completion dialog box. This property is ignored if the completion dialog box does not appear. The default value is False.

  • PRIMARYFOLDER   Designates a primary folder for the installation.

  • ROOTDRIVE   Specifies the default drive for the destination folder of the installation. The value for this property must end with '\'.

  • SETUP_REBOOT   Determines how Setup restarts the computer after installation. You must use all uppercase letters, SETUP_REBOOT.

    • AutoAlways   Always trigger a restart. Do not prompt the user.

    • Always   Always prompt for a restart at the end of Setup.

    • IfNeeded   Prompt for a restart at the end of Setup, if Setup requires a restart. (Default)

    • AutoIfNeeded   Begin a restart, if Setup requires a restart. Do not prompt the user.

    • Never   Never trigger or prompt for a restart.

You set these properties in the Modify Setup properties page of the OCT, or the Setting element in the Config.xml file for Windows Installer-based installations.

A number of Windows Installer properties are replaced by options in the OCT or in the Config.xml file. Some properties are not applicable in Office 2013 (or in Office 2010 or Office 2007) because of Setup design changes that were introduced in Office 2007. All of these properties are blocked by Setup. That is, if you specify any of these properties in the OCT Modify Setup properties page, or by using the Config.xml Setting element, Setup will end the installation.

The following table lists blocked properties whose functions are replaced by options in the OCT or by elements in the Config.xml file.

Replaced Windows Installer properties

Property Replacement OCT option Replacement Config.xml element

SOURCELIST (in LIS element)

Additional network sources

SOURCELIST attribute in LIS element

COMPANYNAME

Installation location and organization name

COMPANYNAME

INSTALLLOCATION

Installation location and organization name

INSTALLLOCATION

TARGETDIR

Installation location and organization name

INSTALLLOCATION

LIMITUI

Licensing and user interface

Display

PIDKEY

Licensing and user interface

PIDKEY

ARPAUTHORIZEDCDFPREFIX

None

ARP

ARPCOMMENTS

None

ARP

ARPCONTACTS

None

ARP

ARPHELPLINK

None

ARP

ARPHELPTELEPHONE

None

ARP

ARPINSTALLLOCATION

None

ARP

ARPNOMODIFY

None

ARP

ARPNOREMOVE

None

ARP

ARPNOREPAIR

None

ARP

ARPPRODUCTICON

None

ARP

ARPREADME

None

ARP

ARPSIZE

None

ARP

ARPSYSTEMCOMPONENT

None

ARP

ARPURLINFOABOUT

None

ARP

ARPURLUPDATEINFO

None

ARP

NOCOMPANYNAME

None

None

NOUSERNAME

None

None

USERNAME

None

USERNAME

ADDDEFAULT

Set feature installation states

OPTIONSTATE

ADDLOCAL

Set feature installation states

OPTIONSTATE

ADDSOURCE

Set feature installation states

OPTIONSTATE

ADVERTISE

Set feature installation states

OPTIONSTATE

COMPADDLOCAL

Set feature installation states

OPTIONSTATE

COMPADDSOURCE

Set feature installation states

OPTIONSTATE

FILEADDDEFAULT

Set feature installation states

OPTIONSTATE

FILEADDLOCAL

Set feature installation states

OPTIONSTATE

FILEADDSOURCE

Set feature installation states

OPTIONSTATE

REMOVE

Set feature installation states

OPTIONSTATE

The following properties are replaced by Setup command-line options:

  • REINSTALL   Use the Setup /repair command-line option.

  • UNINSTALL   Use the Setup /uninstall command-line option.

The following properties are no longer applicable in Office 2013 (and in Office 2010 and Office 2007). These properties are blocked. That is, if you specify these properties in the OCT Modify Setup properties page, or by using the Config.xml Setting element, Setup will end the installation.

  • ALLUSERS (All installations of Office 2013, Office 2010, and Office 2007 are per-computer.)

  • DISABLEROLLBACK

  • EXECUTEACTION

  • EXECUTEMODE

  • INSTALLLEVEL

  • LOGACTION

  • MEDIAPACKAGEPATH

  • PROMPTROLLBACKCOST

  • REBOOTPROMPT

  • SEQUENCE

The Microsoft policy for Office 2013 requires the activation of all editions of Office 2013. This includes those obtained through a Volume Licensing program. This requirement applies to Office 2013 running on both physical computers and virtual computers. Activation is not required for any Office 2013 server products, such as SharePoint Server 2013, Project Server 2013, or for any version of Microsoft Exchange Server.

Office Activation Technologies provide the following methods for activating products licensed under Microsoft Volume Licensing programs:

  • Key Management Service (KMS)   KMS uses a KMS host key to activate a KMS host computer and establish a local activation service in your environment. Office 2013 connects to the local KMS host for activation.

  • Multiple Activation Key (MAK)   With a MAK, clients activate Office 2013 online by using the Microsoft hosted activation servers or by telephone.

  • Active Directory-Based activation   Similar to KMS activation, which activates all Office volume license clients that are connected to a KMS host, Active Directory-based activation activates all Office volume license clients in an Active Directory domain.

  • A combination of KMS, MAK, and Active Directory-Based activation.

For more information about the licensing options in Office 2013, and instructions for configuring the KMS host and port number, see Plan volume activation of Office 2013 and Volume activation of Office 2013.

NoteNote:
This information applies to volume-licensed editions of Office 2013. It does not apply to either Office Professional Plus for Office 365 or Office 365 ProPlus, both of which are licensed through subscription.

For information about Office 2013 product activation via the Internet or phone for non-volume licensed versions of Office 2013 products, see Activate Microsoft Office 2013 programs on the Office.com website.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft