Monday, 29 August 2011
Sunday, 28 August 2011
What is Active Setup
Active setup provides a solution when the aim is to deliver user based components when no advertised entry points exist in an MSI package.
Most packages will contain some kind on entry point; commonly an advertised shortcut. When launching this kind of shortcut Windows Installer will check the keypath of the component the shortcut belongs to and verifies that the component is installed. If it is found to be missing Windows Install will kick off a repair.
This provides a great solution for installing current user data when the package is not installed in the user context. It is also a very good reason why you should never mix machine and user data in the same feature.
Most packages will contain some kind on entry point; commonly an advertised shortcut. When launching this kind of shortcut Windows Installer will check the keypath of the component the shortcut belongs to and verifies that the component is installed. If it is found to be missing Windows Install will kick off a repair.
This provides a great solution for installing current user data when the package is not installed in the user context. It is also a very good reason why you should never mix machine and user data in the same feature.
| On logon the following registry keys are compared: |
| HKLM\Software\Microsoft\Active Setup\Installed Components\<UID> HKCU\Software\Microsoft\Active Setup\Installed Components\<UID> |
| <UID> has to unique; it is good practise to use a GUID. If the HKCU key is not found the contents of the string value StubPath is executed. The HKLM key is then copied to HKCU. The executable in StubPath can be anything (a VBS script, a regsvr32.exe call, etc), but our aim, in this example, is to deliver missing current user data from a previously installed MSI. To do this we need to force the package to repair so Msiexec.exe will be used: Msiexec.exe /fpu /qn /f - Repair /p - only if file is missing /u - all required user-specific registry entriesIf you choose to, the entire installation can be repaired: Msiexec.exe /fomus /qn |
| [HKLM\SOFTWARE\Microsoft\Active Setup\Installed Components\{44CCA842-CC51-11CF-AAFA-00AA00B6015B}] "Version"="1" "StubPath"="Msiexec.exe /fpu {44CCA842-CC51-11CF-AAFA-00AA00B6015B}" |
| Where a version is included; StubPath will only execute if the version of HKCU is less than the version of HKLM. When a new user logs on Windows will find the HKCU active setup key missing, run Msiexec.exe with the repair arguments from StubPath and copy the HKLM key to HKCU. Next time this user logs in the repair won't run as the key already exists in HKCU. |
Advantages of MSI Application Packaging
- Customize Applications to suit the user needs.
- Simplify the Installation and Un-installation Procedures.
- Saves Time in both Installation and Un-installation.
- Once packaged, applications can be quickly installed on a range of desktops in multiple locations, saving administrative costs, simplifying the manage of licensing fees and minimizing support and repair expenditures.
- Saves Space of the product by doing apt modifications to applications.
- Has a great flexibility of obtaining the lost files through a phenomenon called Self Heal, this reduces the down time of application. If a critical file (a .DLL or .EXE file, for example) that is part of the distribution is corrupt or is deleted, the user can be prompted to repair the installation by presenting the original .MSI distribution. Additionally, if the installation media is available (for example, on a network share), the repair simply happens automatically.
- Can be advertised. So that on demand installation could take place.
- Upgrading of the application can be done with ease.
- Clean installation and Un-Installation is achieved by a process called Roll-Back.
- Simplifies management of new user set-up along with the revision and distribution of software repairs and new applications to existing users. Application recovery can also be improved.
- Helps eliminate uncontrolled software downloads and installation, enables applications to be safely removed and reduces non-business traffic on a corporate network.
- Using .MSI format, can automate software distribution process and ensure that the installation doesn't break other applications that have already been installed.
- Application is installed via an OS service.
- State management is maintained. In the past, it's been difficult to know whether an application is installed on a machine. You would have to query for a .DLL with a specific version number or determine whether an .EXE file with a specific name was present. Windows Installer provides an application programming interface (API) that lets programmers and administrators see whether a specific application is installed on a machine.
- Scriptable API. This whips together a VBScript to help us with the MSI file manipulations. The API to manipulate MSI files is so powerful that it can create, validate and update packages, trigger installs and uninstalls, examine the MSI repository data on computers, and perform some custom actions.
- Served installs. Because MSI files can be housed in a share point and delivered via a server, we can keep our installation files all in one place or move them around -- closer to the users if necessary.
Custom Action Conditions in MSI
You can execute a custom action or make the component install using conditions as per the requirement.
- Action run only during Install
Condition: NOT Installed - Action only runs during removal of MSI
Condition: REMOVE="ALL" - Action runs during Install and repair
Condition: NOT REMOVE
Difference Between Self Heal and Repair
Self Heal and Repair are two different concepts in Windows Installer which people many times consider to be the same thing, however there is difference in these two.
Self Heal is triggered by advertised shortcuts, or other advertising information in the package which eventually Repairs the application.
When the application is launched by advertised shortcut, it checks for all the key paths of the Current Feature, if any of the key paths is missing it will launch Repair.
Note that if there are multiple features then it will not check the missing key paths of the other features, but only the feature of which the advertised shortcut is launched.
Repair of an MSI can be triggered by
Self Heal is triggered by advertised shortcuts, or other advertising information in the package which eventually Repairs the application.
When the application is launched by advertised shortcut, it checks for all the key paths of the Current Feature, if any of the key paths is missing it will launch Repair.
Note that if there are multiple features then it will not check the missing key paths of the other features, but only the feature of which the advertised shortcut is launched.
Repair of an MSI can be triggered by
- Repair from Add/Remove programs
- Command - msiexec /f{other option} {MSI path}
- Self Heal by advertised shortcut or other advertising information.
- Active setup
A Guide to MSI Healing
This describes several methods of MSI healing (repair) techniques to populate HKCU keys for other users.
The best methods are documented first with other alternative ways following later.
Active Setup Method:
This is one of the best practices in MSI Packaging which uses the native Active Setup behavior of Windows XP and Windows Installer HKCU keys repair techniques.
One should follow these specific steps while using this method:
Make sure all HKCU keys in the MSI Package that we are creating are under structured component names like CurrentUser, CurrentUser1, etc.
The Package author should be able to judge and set the key path for that Component properly.
As per Microsoft Component guidelines, make sure the components containing HKCU keys are as few in count as possible, for example only one component (CurrentUser) with all HKCU keys with best key path set is the best practice.
Create the following registry keys under the main hive:
HKLM\Software\Microsoft\Active Setup\Installed Components\{GUID of the MSI}
ComponentID=PackageName_ComponentName
StubPath=[SystemFolder]msiexec.exe /fu {Product Code of the MSI} /q
Version=ProductVersion
The principle of Active Setup behavior is when a new user logs on for the first time, then the Active Setup will perform a checksum between HKLM\Software\Microsoft\Active Setup\Installed Components\{GUID of the MSI} and
HKCU\Software\Microsoft\Active Setup\Installed Components\{GUID of the MSI};
and if the GUID is not present under HKCU, then it performs all actions which are under that main hive (StubPath, Version) and populates the GUID under HKCU. The main Advantage of Active Setup is it performs an action only once per User with the Checksum behavior by matching the entries under HKLM and HKCU.
Active Setup Method:
This method can be used for both MSIs and Non-MSIs (SMS or WSE Script executables).
Create a silent SMS script or Wise Script (for eg:-Script.exe) which will create the needed HKCU registry entries for the application. Then place that EXE in the Application [INSTALLDIR] in your MSI Pkg or Executable binary memory.
Then create the following additional registry entries in the MSI Package or within the Script whichever is applicable:
HKLM\Software\Microsoft\Active Setup\Installed Components\{GUID or AppName}
ComponentID=PackageName_ComponentName
StubPath="[INSTALLDIR]Script.exe"
Version=ProductVersion
The Active Setup performs the regular checksum (comparison of entries under) HKLM and HKCU and if the respective unique GUID or AppName is not present under HKCU hive, then it will perform all actions (StubPath, Version) and populates the GUID or AppName under HKCU hive too. This is only once per user -- for the first time -- to populate HKCU hive.
Method I and method II use the Active Setup feature, and One should understand the advantages of one over the other. Method I requires source resiliency to populate HKCU keys, where as method II does not require this as the Script.exe does everything.
Method I and method II can be used in any scenarios like if Advertised entry points are present or NOT present.
Windows Installer repair method with SMS or Wise Script:
Typically the body of the script will be;
Check for the existence of a Flag key under
HKCU\Software\Company Name\Applications\{ProductName][productversion]
Installed=True
If the key exists then quit else initiate the Windows Installer repair to populate HKCU keys:
Msiexec /fu {Product Code of the MSI} /q
And edit and create registry key (Basically a Flag Key which can be any key which your firm adopts)
HKCU\Software\XYZ*\Applications\{ProductName][productversion]
Installed=True
End
* XYZ= Name of the organization \ Company
And keep this script exe in HKLM\Software\Microsoft\Windows\CurrentVersion\Run.
One should keep in mind that the /p switch can also be used to repair files (populate) user-specific data (Profile data) with the following syntax:
Msiexec /fup {Product Code Of the MSI) /q
Silent empty exe with valid shortcut:
Create a silent empty exe and its Advertised shortcut and place both of them in the Application [INSTALLDIR]. And use them as entry points to trigger healing to populate HKCU keys.
The best methods are documented first with other alternative ways following later.
Method I
Active Setup Method:
This is one of the best practices in MSI Packaging which uses the native Active Setup behavior of Windows XP and Windows Installer HKCU keys repair techniques.
One should follow these specific steps while using this method:
Make sure all HKCU keys in the MSI Package that we are creating are under structured component names like CurrentUser, CurrentUser1, etc.
The Package author should be able to judge and set the key path for that Component properly.
As per Microsoft Component guidelines, make sure the components containing HKCU keys are as few in count as possible, for example only one component (CurrentUser) with all HKCU keys with best key path set is the best practice.
Create the following registry keys under the main hive:
HKLM\Software\Microsoft\Active Setup\Installed Components\{GUID of the MSI}
ComponentID=PackageName_ComponentName
StubPath=[SystemFolder]msiexec.exe /fu {Product Code of the MSI} /q
Version=ProductVersion
The principle of Active Setup behavior is when a new user logs on for the first time, then the Active Setup will perform a checksum between HKLM\Software\Microsoft\Active Setup\Installed Components\{GUID of the MSI} and
HKCU\Software\Microsoft\Active Setup\Installed Components\{GUID of the MSI};
and if the GUID is not present under HKCU, then it performs all actions which are under that main hive (StubPath, Version) and populates the GUID under HKCU. The main Advantage of Active Setup is it performs an action only once per User with the Checksum behavior by matching the entries under HKLM and HKCU.
Method II
Active Setup Method:
This method can be used for both MSIs and Non-MSIs (SMS or WSE Script executables).
Create a silent SMS script or Wise Script (for eg:-Script.exe) which will create the needed HKCU registry entries for the application. Then place that EXE in the Application [INSTALLDIR] in your MSI Pkg or Executable binary memory.
Then create the following additional registry entries in the MSI Package or within the Script whichever is applicable:
HKLM\Software\Microsoft\Active Setup\Installed Components\{GUID or AppName}
ComponentID=PackageName_ComponentName
StubPath="[INSTALLDIR]Script.exe"
Version=ProductVersion
The Active Setup performs the regular checksum (comparison of entries under) HKLM and HKCU and if the respective unique GUID or AppName is not present under HKCU hive, then it will perform all actions (StubPath, Version) and populates the GUID or AppName under HKCU hive too. This is only once per user -- for the first time -- to populate HKCU hive.
Method I and method II use the Active Setup feature, and One should understand the advantages of one over the other. Method I requires source resiliency to populate HKCU keys, where as method II does not require this as the Script.exe does everything.
Method I and method II can be used in any scenarios like if Advertised entry points are present or NOT present.
Method III
Windows Installer repair method with SMS or Wise Script:
Typically the body of the script will be;
Check for the existence of a Flag key under
HKCU\Software\Company Name\Applications\{ProductName][productversion]
Installed=True
If the key exists then quit else initiate the Windows Installer repair to populate HKCU keys:
Msiexec /fu {Product Code of the MSI} /q
And edit and create registry key (Basically a Flag Key which can be any key which your firm adopts)
HKCU\Software\XYZ*\Applications\{ProductName][productversion]
Installed=True
End
* XYZ= Name of the organization \ Company
And keep this script exe in HKLM\Software\Microsoft\Windows\CurrentVersion\Run.
One should keep in mind that the /p switch can also be used to repair files (populate) user-specific data (Profile data) with the following syntax:
Msiexec /fup {Product Code Of the MSI) /q
Method IV
Silent empty exe with valid shortcut:
Create a silent empty exe and its Advertised shortcut and place both of them in the Application [INSTALLDIR]. And use them as entry points to trigger healing to populate HKCU keys.
Tuesday, 9 August 2011
Application Packaging Training - September Batch
New batch of Application Packaging Classroom training is starting at Hyderabad on 3rd September. If you are interested contact me at 91-9963678795 or Virtual.App.Packager@gmail.com
For training details please visit www.AppRepack.in
For training details please visit www.AppRepack.in
Subscribe to:
Posts (Atom)