Help screen of Windows Installer 5.0 running on Windows 7
|Initial release||31 August 1999|
5.0 / 22 July 2009
|Operating system||Microsoft Windows 2000 and later|
|Platform||IA-32, x86-64, Itanium|
|Internet media type||
|Type of format||Archive|
|Container for||Installation information and an optional .cab file payload|
|Extended from||COM Structured Storage|
Windows Installer (previously known as Microsoft Installer, codename Darwin) is a software component and application programming interface (API) of Microsoft Windows used for the installation, maintenance, and removal of software. The installation information, and optionally the files themselves, are packaged in installation packages, loosely relational databases structured as COM Structured Storages and commonly known as "MSI files", from their default filename extensions. Windows Installer contains significant changes from its predecessor, Setup API. New features include a GUI framework and automatic generation of the uninstallation sequence. Windows Installer is positioned as an alternative to stand-alone executable installer frameworks such as older versions of InstallShield and NSIS.
Before the introduction of Windows Store, Microsoft encouraged third parties to use Windows Installer as the basis for installation frameworks, so that they synchronize correctly with other installers and keep the internal database of installed products consistent. Important features such as rollback and versioning depend on a consistent internal database for reliable operation. Furthermore, Windows Installer facilitates the principle of least privilege by performing software installations by proxy for unprivileged users.
- 1 Logical structure of packages
- 2 Setup phases
- 3 Other features
- 4 Developing installer packages
- 5 Versions
- 6 Tools
- 7 See also
- 8 References
- 9 External links
Logical structure of packages
A package describes the installation of one or more full products and is universally identified by a GUID. A product is made up of components, grouped into features. Windows Installer does not handle dependencies between products.
A single, installed, working program (or set of programs) is a product. A product is identified by a unique GUID (the ProductCode property) providing an authoritative identity throughout the world. The GUID, in combination with the version number (ProductVersion property), allows for release management of the product's files and registry keys.
A package includes the package logic and other metadata that relates to how the package executes when running. For example, changing an EXE file in the product may require the ProductCode or ProductVersion to be changed for the release management. However, merely changing or adding a launch condition (with the product remaining exactly the same as the previous version) would still require the PackageCode to change for release management of the MSI file itself.
A feature is a hierarchical group of components. A feature may contain any number of components and other sub-features. Smaller packages can consist of a single feature. More complex installers may display a "custom setup" dialog box, from which the user can select which features to install or remove.
The package author defines the product features. A word processor, for example, might place the program's core file into one feature, and the program's help files, optional spelling checker and stationery modules into additional features.
A component is the basic unit of a product. Each component is treated by Windows Installer as a unit. The installer cannot install just part of a component. Components can contain program files, folders, COM components, registry keys, and shortcuts. The user does not directly interact with components.
Components are identified globally by GUIDs; thus the same component can be shared among several features of the same package or multiple packages, ideally through the use of Merge Modules.
A key path is a specific file, registry key, or ODBC data source that the package author specifies as critical for a given component. Because a file is the most common type of key path, the term key file is commonly used. A component can contain at most one key path; if a component has no explicit key path, the component's destination folder is taken to be the key path. When an MSI-based program is launched, Windows Installer checks the existence of key paths. If there is a mismatch between the current system state and the value specified in the MSI package (e.g., a key file is missing), the related feature is re-installed. This process is known as self-healing or self-repair. No two components should use the same key path.
However, the user interface sequence should not make any changes to the system, for the following reasons:
- A user may install or uninstall an MSI package in passive mode or silent mode, bypassing this phase entirely. (Passive mode bypasses the user interface phase but shows a graphical progress bar. Silent mode shows nothing.) During installation, information gathered in this phase may be supplied beforehand through the command-line interface.
- The user interface sequence runs with user privileges, and not with the elevated privileges required during installation.
When the user clicks the "Install" button in a typical MSI installation wizard, installation proceeds to the Execute phase, in which software components are actually installed. The Execute phase makes system changes, but it does not display any user interface elements.
The Execute phase happens in two steps:[clarification needed Two mode or two steps? Do both run?]
- Immediate mode. In this phase, Windows Installer receives instructions, either from a user or an application, to install or uninstall features of a product. The requests cause the execution of sequences of actions, which query the installation database to build an internal script describing the execution phase in detail.
- Deferred mode. In this phase, the script built in immediate mode is executed in the context of the privileged Windows Installer service. The script must be executed by a privileged account because of the heterogeneity of the scenarios in which a setup operation is initiated. For example, elevated privileges are necessary to serve on-demand installation requests from non-privileged users. (To run with elevated privileges, however, the package must be deployed by a local administrator or advertised by a system administrator using Group Policy.)
All installation operations are transactional. In other words, for each operation that Windows Installer performs, it generates an equivalent undo operation that would revert the change made to the system. In case any script action fails during deferred execution, or the operation is cancelled by the user, all the actions performed until that point are rolled back, restoring the system to its original state. Standard Windows Installer actions automatically write information into a rollback script; package authors who create custom actions that change the target system should also create corresponding rollback actions (as well as uninstall actions and uninstallation-rollback actions). As a design feature, if applied correctly this mechanism will also roll back a failed uninstall of an application to a good working state.
Windows Installer can advertise a product rather than actually install it. The product will appear installed to the user, but it will not actually be installed until it is run for the first time by triggering an entry point (by means of a Start menu shortcut, by opening a document that the product is configured to handle, or by invoking an advertised COM class). A package can be advertised by an administrator using Group Policy or other deployment mechanism, or by running the msiexec executable with the /jm (for per-machine advertisement) or /ju (for per-user advertisement) switch. Some MSI packages authored in InstallShield may prevent the use of these and other native MSI features.
The user must have administrator privileges to complete the advertised installation.
Installation on demand
Similar to advertising, it installs a feature as soon as the user tries to use it.
An administrative installation creates an uncompressed source image for a product, typically to be used for installing or running an application from a network location. An administrative installation is not a typical installation, in that it does not create any shortcuts, register COM servers, create an Add or Remove Programs entry, and so on. Often an administrative installation enables a user to install the product in such a way that its features run from the uncompressed installation source.
Administrative installations are also useful when creating a Windows Installer patch, as this requires uncompressed images of the earlier and current versions of a product in order to compute binary file differences. An administrative installation is performed by running the msiexec executable with the /a switch.
Msiexec provides a way to break after loading a specified custom action DLL but before invoking the action.
Merge modules and nested executables
A Windows Installer package may contain another package to be installed at the same time. These are ideally provided as a .msm file component, but may also be a separate executable program which will be unpacked from the installer package during the InstallExecuteSequence and can be run immediately. The file can then optionally be deleted before the end of the InstallExecuteSequence, and so is ideal for using with older installers. .msm file component is called Microsoft Merge Module and is utilized to single out and integrate common components. It contains images of all tables, which have relevant information regarding the common components. Ready-made merge modules are supplied with Visual Studio or can be downloaded from the alternative sources.
Interoperability with Windows features
Windows Installer 4.0, which was shipped with Windows Vista, incorporates capabilities to take advantage of the User Account Control feature. If an application can install without elevated privileges, its MSI package can be marked as such, thus allowing install without prompting the user for Administrator credentials. Windows Installer also works in conjunction with the Restart Manager; when installing or updating an application or system component with "full" user interface mode, the user will be displayed a list of affected applications that can be shut down, and then restarted after files have been updated. Installer actions running in silent mode perform these application restarts automatically. System services and tray applications can also be restarted in this manner.
Developing installer packages
Creating an installer package for a new application is not trivial. It is necessary to specify which files must be installed, to where and with what registry keys. Any non-standard operations can be done using Custom Actions, which are typically developed in DLLs. There are a number of commercial and freeware products to assist in creating MSI packages, including Visual Studio (up to VS 2010), InstallShield and WiX. To varying degrees, the user interface and behavior may be configured for use in less common situations such as unattended installation. Once prepared, an installer package is "compiled" by reading the instructions and files from the developer's local machine, and creating the .msi file.
The user interface (dialog boxes) presented at the start of installation can be changed or configured by the setup engineer developing a new installer. There is a limited language of buttons, text fields and labels which can be arranged in a sequence of dialogue boxes. An installer package should be capable of running without any UI, for what is called "unattended installation".
Microsoft provides a set of Internal Consistency Evaluators (ICE) that can be used to detect potential problems with an MSI database. The ICE rules are combined into CUB files, which are stripped-down MSI files containing custom actions that test the target MSI database's contents for validation warnings and errors. ICE validation can be performed with the Platform SDK tools Orca and msival2, or with validation tools that ship with the various authoring environments.
For example, some of the ICE rules are:
- ICE09: Validates that any component destined for the System folder is marked as being permanent.
- ICE24: Validates that the product code, product version, and product language have appropriate formats.
- ICE33: Validates that the Registry table is not used for data better suited for another table (Class, Extension, Verb, and so on).
Addressing ICE validation warnings and errors is an important step in the release process.
|Version||Included with||Also available for|
|1.1||Windows 2000 RTM, SP1, SP2||Windows 95, Windows 98|
Windows NT 4.0
|2.0||Windows XP RTM, SP1
Windows 2000 SP3, SP4
Windows Server 2003 RTM
Windows NT 4.0
|3.0||Windows XP SP2||Windows 2000|
Windows Server 2003
|3.1||Windows XP SP3
Windows Server 2003 SP1, SP2
Windows XP Professional x64 Edition
Windows Server 2003
|4.0||Windows Vista RTM, SP1
Windows Server 2008 RTM
|4.5||Windows Vista SP2
Windows Server 2008 SP2
Windows Server 2003
Windows XP Professional x64 Edition
Windows Server 2008
|5.0||Windows 7 and later
Windows Server 2008 R2 and later
|7-Zip||Igor Pavlov||7-Zip is an open source file archiver utility, and can extract the contents of MSI files.||GNU Lesser General Public License|
|EMCO MSI Package Builder||EMCO Software||An installation editor that allows creating new MSI packages and converting non-silent EXE setups to silent MSI packages for unattended remote installation.||Shareware|
|InstallShield||Flexera Software||InstallShield is a software tool for creating installers or software packages primarily used for installing software for Microsoft Windows desktop and server platforms.||Shareware|
|Orca||Microsoft||Orca is a database table editor for creating and editing Windows Installer packages and merge modules.||Freeware|
|Visual Studio||Microsoft||Visual Studio 2002 through 2010 is capable of building Windows Installer Deployment projects that can create installer packages. Microsoft has dropped support for deployment projects in 2012 and recommends using WiX instead.||Shareware|
|WiX||Outercurve Foundation (Microsoft)||WiX (Windows Installer XML) is a free and open-source set of tools that helps build a Windows Installer packages from an XML document. It can be either used from command-line or integrated into Microsoft Visual Studio. SharpDevelop, a free and open-source alternative to Visual Studio, has adopted WiX.||Common Public License|
- List of installation software
- Package management system
- Windows Installer CleanUp Utility
- ZAP File – a way to perform an Application Installation when no MSI File exists.
- "Released Versions of Windows Installer". Microsoft Developer Network. Microsoft. Retrieved 3 November 2012.
- "File Extension .MSI Details". Filext.com. Retrieved 2013-04-24.
- Mensching, Rob (2003-11-25). "Inside the MSI file format". MSDN Blogs. Archived from the original on 2009-01-15. Retrieved 2017-02-15.
- Mensching, Rob (2003-10-11). "The story of Orca". MSDN Blogs. Archived from the original on 2008-12-23. Retrieved 2017-02-15.
- Smith, Chris (2005-07-01). "Windows Installer, The .NET Framework, The Bootstrapper, and You". MSDN Blogs. Retrieved 2017-02-15.
- "Windows Installer Components". MSDN Library. Microsoft Corporation. 2012-11-30. Retrieved 2013-04-08.
- Rollback Installation
- Administrative Installation
- "Debugging Custom Actions (Windows)". Msdn.microsoft.com. 2012-11-30. Retrieved 2013-04-24.
- "Types of Packages: Non-Virtual Packages – Microsoft Windows Installer (MSI)". itninja.com. 2016-12-28. Retrieved 2017-06-15.
- Buck Hodges (2011-03-17). "Visual Studio setup projects (vdproj) will not ship with future versions of VS". MSDN Blogs.
- Internal Consistency Evaluators – ICEs
- What's New in Windows Installer 4.5
- "Released Versions of Windows Installer (Windows)". Msdn.microsoft.com. 2012-11-30. Retrieved 2013-04-24.
- "Windows Installer Tools & Tips". InstallSite Stefan Krueger. Retrieved 19 November 2009.
- "Windows Installer Deployment". Microsoft Developers Network (MSDN) Library. Microsoft Corporation. August 2008. Retrieved 1 October 2009.
Windows Installer deployment enables you to create installer packages to be distributed to users; the user runs the setup file and steps through a wizard to install the application.
- "SharpDevelop Features". IC#Code. Retrieved 31 March 2012.