Types of Events in a Suite/Advanced UI Installation

InstallShield 2015

Project: This information applies to Suite/Advanced UI projects.

Edition: The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project type is available in the Premier edition of InstallShield. For information about the differences between these two project types, see Advanced UI Projects vs. Suite/Advanced UI Projects.

Suite/Advanced UI installations are driven by the Suite/Advanced UI installation, which manages a series of events in a specific order. These events run actions that you have added to your project.

The following table describes each of the events that are listed in the Events view of a Suite/Advanced UI installation:

Events That Are Listed in the Events View

Event Name

Description

OnBegin

The OnBegin event is the first event in a Suite/Advanced UI installation. Actions that are scheduled for this event are executed during all modes (install, maintenance, repair, etc.) unless the conditional statement that is defined for the action evaluates as false.

To indicate that an action should run only during certain modes, use the Suite/Advanced UI property ISInstallMode in a Property Comparison condition. For more information on this and other built-in properties, see Advanced UI and Suite/Advanced UI Property Reference.

Actions that are scheduled during OnBegin run before the Suite/Advanced UI installation displays the wizard interface. A long-running action during this event could result in a long delay between the moment when an end user launches the installation and the point at which the wizard interface is first shown. This could lead the end user to think that the installation was not launched properly. Thus, you may want to avoid scheduling long-running actions during OnBegin.

Note that you also may want to avoid using an action that displays its own user interface when launched. The wizard interface of the Suite/Advanced UI installation can appear behind other open windows in this scenario, possibly confusing an end user.

OnResuming

The OnResuming event launches its actions when a Suite/Advanced UI installation is resuming after the target machine has been restarted.

OnStaging

The OnStaging event launches its actions immediately before the Suite/Advanced UI installation is staged; that is, before the Suite/Advanced UI installation downloads its package (if applicable), extracts its packages from the Setup.exe file (if applicable), and copies its packages to a directory that the end user specifies on the BrowseStageFolder wizard page or by setting the ISRootStagePath property through the command line.

OnStaged

The OnStaged event launches its actions after the Suite/Advanced UI installation has downloaded its packages (if applicable), extracted them from the Setup.exe file, and copied them to the staging directory.

OnPackagesConfiguring

The PackagesConfiguring event launches its actions immediately before the packages in the Suite/Advanced UI installation are being installed, modified, repaired, or removed.

OnPackagesConfigured

The OnPackagesConfigured event launches its actions when the packages in the Suite/Advanced UI installation have been installed, modified, repaired, or removed.

OnRebooting

The OnRebooting event launches its actions immediately before the Suite/Advanced UI installation triggers a restart of the machine.

Note that actions that are scheduled during OnRebooting should run for a brief period of time. Otherwise, the actions may fail to complete if a reboot is initiated by some prior action and Windows shuts down the Suite/Advanced UI process before the reboot events complete.

OnEnd

The OnEnd event launches its actions immediately before the end of a successful Suite/Advanced UI installation. If the end user cancels the Suite/Advanced UI installation or the installation encounters an error, the OnEnd event does not run.

Note that the Suite/Advanced UI engine does not maintain states to track which events have run or not run. Therefore, you may need to define Property Comparison conditions for actions to prevent the actions from being rerun after the Suite/Advanced UI installation resumes because of a reboot. You can use the ISOnRebooted property in these conditions; if the Suite/Advanced UI installation is resuming after a reboot, this property is set to True.

If you define a Feature Operation condition or a Package Operation condition for an action, the earliest event for which you can schedule the action is OnStaging.

See Also