How to execute conditional custom action on install and modify only?

by

InstallFinalize: Do you write to HKCU or HKLM? Anything sequenced after InstallFinalize will not run elevated in a managed environment and will hence fail during installation if you try to write to HKLM(unless you change the ACL for the key you write to – or you kick the MSI off from a cmd.exe that is elevated already – not recommended, the package is flawed).

MaintenanceMode: That condition looks like it is Installshield-specific: NOT Installed OR MaintenanceMode="Modify". I think Installshield itself sets that MaintenanceMode property in a proprietary fashion. Hence it is not available in WiX at all.

Testing Conditions: Conditions can be hard to test and you need to do real-world testing in many installation modes (install, uninstall, repair, modify, patch, major upgrade, self-repair, etc...) to be sure they fit your particular case and work as expected. A typical scenario where people are surprised at conditioning is major upgrades – the uninstall of your old version and the installation of the new version – it tends to reveal unexpected problems with conditions in my experience. Often due to the complex sequencing issues and the fact that during such an upgrade both the old setup’s uninstall sequence and the new setup’s install sequence run. Hence erronously conditioned custom actions can run several times during the major upgrade process and cause a real mess. Please read this answer for more: Run Wix Custom action only during uninstall and not during Major upgrade and this short version.

Testing Tip: To implement a quick major upgrade you need to change the product code and bump up one of the first 3 digits of the version. And you need to have the MajorUpgrade element in there. You can set the product code to auto-generate by setting it to * (I prefer to change it manually). Compile an MSI, suffix it with "_Version1" then do the updates mentioned and compile "_Version2". Run upgrade sequence. You should also point to the updated files for version 2 by changing the source path, but you can roll without it to test conditions.

Modify: For your case, there is a cheat sheet from the Installshield guys suggesting the following condition in their “MSI Condition Cheat Sheet”:

  • Installed AND NOT REINSTALL AND NOT REMOVE~="ALL"
  • The above condition should enable the custom action to run in modify operations only. If you change it a little it should work for install and modify only:
  • NOT Installed OR ((Installed AND NOT REINSTALL) AND NOT REMOVE~="ALL")

I will have to run an extra check on that last condition tomorrow, but I just post this so you can get testing yourself. I took out PATCH, but maybe I should add it back to cover major upgrade patches. Will you be delivering patches?

Quick Mockup for Light-Weight Condition Testing:

The VBScript:

Note! Make sure the VBScript file is in UTF8 or ANSI. Unicode will not work. Maybe create it in Notepad rather than Visual Studio. I have seen issues when creating the VBScript file as a WiX text file that I then rename to *.vbs format. Don’t do that.

MsgBox "I run, therefore I am conditioned and sequenced"

WiX Markup, Custom Action:

<Binary Id='SayHelloMsgBox.vbs' SourceFile="SayHelloMsgBox.vbs" />
<CustomAction Id='SayHelloMsgBox.vbs' VBScriptCall="" BinaryKey='SayHelloMsgBox.vbs' Execute="immediate" Return='ignore' />

WiX Markup, Sequencing & Conditioning:

<InstallExecuteSequence>
   <Custom Action='SayHelloMsgBox.vbs' After="InstallInitialize">NOT Installed OR ((Installed AND NOT REINSTALL) AND NOT REMOVE~="ALL")</Custom>
</InstallExecuteSequence>

Writing to Log: You can write to the MSI log from VBScript as described in this article: MSI Tip: Writing to the Log File from a Custom Action.

Update: You can eliminate a separate VBScript file for the condition debugging using this approach.

More Related Contents:

  1. Why is it a good idea to limit the use of custom actions in my WiX / MSI setups?
  2. Removing files when uninstalling WiX
  3. How to pass CustomActionData to a CustomAction using WiX?
  4. How to add a WiX custom action that happens only on uninstall (via MSI)?
  5. Interrupt installation when custom action returns error
  6. Failed to get MSI property in UPGRADINGPRODUCTCODE, WIX_UPGRADE_DETECTED
  7. Change my component GUID in wix?
  8. WIX does not uninstall older version
  9. Adding entries to MSI UpgradeTable to remove related products
  10. What do I do when launching an application triggers repeating, endless Windows Installer self-repair?
  11. How do I avoid triggering MSI self-repair with my WiX / MSI package?
  12. Uninstall from Control Panel is different from Remove from .msi
  13. Microsoft Installer command line string parameter not working?
  14. Run Wix Custom action only during uninstall and not during Major upgrade
  15. How to Explicitly Remove dll During Majorupgrade Using Wix Toolset
  16. File of a new component isn’t installed because there was an old component with the same file
  17. I screwed up, how can I uninstall my program?
  18. WIX merge c++ runtime
  19. In WiX files, what does Name=”SourceDir” refer to?
  20. Wix Custom Action – session empty and error on deferred action
  21. One file per component or several files per component?
  22. Unselected Feature Being Installed
  23. How do I avoid distributing sensitive information in my MSI by accident?
  24. Wix burn doesn’t allow to remove file
  25. VersionNT MSI property on Windows 10
  26. how to find out which products are installed – newer product are already installed MSI windows
  27. How to assign path value to Directory in WIX?
  28. How to display a non-blocking warning for the operating system in Wix?
  29. WiX – Doing a major upgrade on a multi instance install
  30. Wix per user installer to detect the Visual C++ 2015 Redistributable

Leave a Comment