Modules View

InstallAnywhere 2020 SP1 » Advanced Designer » Organization

Use the Modules view on the Organization page to import merge modules into your project and configure their settings.

Tip • Merge modules are created as a distribution option in the Build Installers view of the Build page.

The Modules view consists of two main areas:

•

The Modules area at the top of this view contains the list of merge modules that have been imported into your project. This area also has buttons that let you import merge modules into or remove merge modules from your project.

•

The customizer area at the bottom of this view contains the settings that are applicable to the merge module that is selected in the Modules area. The settings that are displayed varies, depending on whether the selected merge module is static or dynamic.

The following elements comprise the Modules area at the top of the Modules view:

Modules Area in the Modules View

Option

Description

Imported Merge Module List

List of merge modules that have been imported to this project.

Import Merge Modules

To select a static merge module to merge into the current installer, click this button, and then customize it on the Merge Module customizer.

Note the following details about static merge modules:

•

All of the merge module's features, components, files, actions, and panels (optionally) are combined into the current project, allowing developers to further customize any settings.

•

Static merge modules are recommended if you want import features and components and if you want flexibility for scheduling actions.

•

Changes made to a static merge module are not reflected in the parent project.

Import Dynamic Merge Module

To select a dynamic merge module to merge into the current installer, click this button, and then customize it on the Dynamic Merge Module customizer.

Note the following details about dynamic merge modules:

•

All of the merge module’s files, actions, and panels (optionally) are combined into current project.

•

The dynamic merge module’s actions are imported together as an action group in the Pre-Install and Post-install sequences.

•

Dynamic merge modules are recommended if you have merge modules whose contents frequently change. A parent project automatically refreshes dynamic merge modules when the parent project is loaded and built.

Remove

Select a merge module in the Imported Merge Module List and click Remove to delete the merge module from the project.

Merge Module Customizer

If you add a merge module to the Imported Merge Modules List, first the InstallAnywhere Merge Module Import Assistant dialog box opens, and then the Merge Module customizer opens. The Merge Module customizer includes the following settings:

Merge Module Customizer
Setting	Description
Module Name	This read-only setting identifies the name of the merge module.
Module Path	This read-only setting lists the path to the selected merge module.
Creation Date/Time	This read-only setting shows the date and time when the merge module was created.
Vendor	This read-only setting shows the name of vendor that created the merge module.
Version	This read-only setting shows the version of the selected merge module.
Comments/Notes	Enter any information that you feel is pertinent to the use or maintenance of this merge module within this project.

Dynamic Merge Module Customizer

If you add a dynamic merge module to the Imported Merge Modules List, the Dynamic Merge Module customizer opens. The Dynamic Merge Module customizer includes the following tabs:

•

General Tab

•

Pre-Install Tab

•

Install Tab

•

Post-Install Tab

General Tab

The General tab on the Dynamic Merge Module customizer includes the following settings:

General Tab on the Dynamic Merge Module Customizer
Setting	Description
Module Name	Enter a name to identify the merge module.
Module Path	Lists the path to the selected merge module.
Creation Date/Time	Date and time when merge module was created.
Vendor	Name of vendor that created the merge module.
Version	Version of the selected merge module.
Comments/Notes	Enter any information that you feel is pertinent to the use or maintenance of this merge module within this project.

Pre-Install Tab

The Pre-Install tab on the Dynamic Merge Module customizer includes the following settings:

Pre-Install Tab on the Dynamic Merge Module Customizer
Setting	Description
Import Pre-Install Actions	To import the Pre-Install actions in this merge module into the main project, select this check box.
Input Variables	Listing of the input variables in this merge module that can be set.
Parent Variables	Listing of the parent variables in the main project that are set by this merge module.

Install Tab

The Install tab on the Dynamic Merge Module customizer includes the following settings:

Install Tab on the Dynamic Merge Module Customizer

Setting

Description

Import Install Actions

To import the Install actions in this merge module into the main project, select this check box.

Uninstall Merge Module when parent is uninstalled

If you want this merge module to be uninstalled when the main project is uninstalled, select this check box.

Note • The point at which merge modules are uninstalled can also be configured using the Uninstall Merge Modules action in the Uninstall view on the Sequences page.

Add merge module log to parent log

To append the installation log of this merge module to the main project log, select this check box. By default, this check box is not selected.

Note • For this merged logging functionality to work properly, it is mandatory that logging is enabled for both the parent and the merge module.The same applies for appending the stderr and stdout entries to the log.

To append the merge module logs to the parent log, you must select Plain text format in the Log Format setting, which is available in the General Settings view of the Project page. Adding the merge module log to the parent log is not available for the XML log format.

Show progress dialog

Specify the way you want the merge module’s installation progress to be displayed by selecting or clearing this check box:

•

To display an intermediate progress bar while this merge module is being installed, select this check box.

•

To suppress the intermediate merge module progress bar and integrate and the progress of the merge module installation into the progress bar of the parent installer, clear this check box.

Input Variables

Listing of the input variables in this merge module that can be set.

Parent Variables

Listing of the parent variables in the main project that are set by this merge module.

Send stdout to variable

Send stderr to variable

To set the stderr and stdout of this merge module to InstallAnywhere variables, select these options and enter a variable name in the box. This is useful if you want to debug a merge module.

Post-Install Tab

The Post-Install tab on the Dynamic Merge Module customizer includes the following settings:

Post-Install Tab on the Dynamic Merge Module Customizer
Setting	Description
Import Post-Install Actions	To import the Post-Install actions in this merge module into the main project, select this check box.
Input Variables	Listing of the input variables in this merge module that can be set.
Parent Variables	Listing of the parent variables in the main project that are set by this merge module.

Modules View

InstallAnywhere 2020 SP1 Help Library

January 2020