Advertising Merge Module Installer Variables
InstallAnywhere 2021
Advertised variables are used to inform the parent installer of settings required for a merge module’s configuration, and to return information—such as status or return codes—back to the parent installer.
When you are configuring a merge module installer, you need to specify which variables in the merge module can be set by the parent installer and which variables in the parent installer can be set by the merge module. You do this in the Variables view on the Project page.
To advertise merge module installer variables:
| 1. | In the Advanced Designer, on the Project page, click Variables. The Variables view opens. |
| 2. | In the Advertise Variables area, click the Advertise Variables button.The Advertise Variables dialog box opens. |
| 3. | Select the appropriate tab to indicate the sequence for which you want to advertise variables. |
Note:Advertised variables are defined by sequence: variables that are advertised in the Pre-Install sequence affect the dynamic merge module in the Pre-Install sequence; the Install Merge Module action uses advertised variables that set in the Install sequence only.
| 4. | To advertise an input variable so that it is visible in the parent project (the project that is going to install this merge module), click the Add button next to the input variables list, and then enter the appropriate information. |
| 5. | To advertise a variable in the parent project (the project that is going to install this merge module) so that it will be visible in this project, click the Add button next to the parent variables list, and then enter the appropriate information. |
Variable Propagation from Merge Module to Parent Installer
Variables usually do not propagate from the merge module to the parent automatically. For this to occur, the variables have to be advertised in the respective sequences of installation.
In general, $INSTALL_SUCCESS$ and $RESTART_NEEDED$ are two status variables that are used in the Install Complete panel.
| • | $INSTALL_SUCCESS$—The $INSTALL_SUCCESS$ variable cannot be set externally because it is a read-only variable, and therefore it cannot be advertised. But InstallAnywhere supports the automatic propagation of this variable from the Pre-Install sequence to the Post-Install sequence (but not from the Install sequence to the Post-Install sequence) for a dynamic merge module. |
| • | $RESTART_NEEDED$—The $RESTART_NEEDED$ variable must be advertised in the Post-Install sequence in order for it to be propagated from the merge module to the parent. |
| • | $IA_ROLLBACK$—The $IA_ROLLBACK$ variable is passed from merge module to parent automatically. |
See Also