Summary

This article explains how to add a custom Merge Module to a Basic MSI, InstallScript MSI or InstallScript project.

Discussion

The process to add a custom Merge Module to a project is a three step process:

1. Creating the Custom Merge Module
2. Setting the Merge Module Location: Placing the Merge Module in a location that can be found by the project.
3. Adding the Merge Module to a Project

Creating the Custom Merge Module

To create a custom merge module:

1. Create a new InstallShield project of type Merge Module by clicking the New Project button on the tool bar or on the InstallShield Start Page and selecting the Merge Module project type from the available project templates.
2. Under the Installation Designer tab, go to the Installation Information > General Information view.
3. Under the Summary Information Stream section, enter a meaningful name in the Subject property. This name is the value that will be listed in the consuming InstallShield project's Redistributables view.
4. Add the resources (such as files, registry entries, shortcuts, etc.) to the Merge Module project.
5. Build the Merge Module project. During the build process, the built .msm file will be copied to the <InstallShield Projects Folder>\MergeModules folder.

Setting the Merge Module Location

To set the Merge Module location:

1. Go to the InstallShield Main Menu and select Tools > Options.
2. Select the Merge Modules tab.
3. Verify the Merge Modules Location text field contains the directory path where the custom merge module .msm file was copied to (such as the <InstallShield Projects Folder>\MergeModules folder). If the location is not in the list of directories, do one of the following:
   • Move the Merge Module to one of the locations listed.
   • Add the directory where the Merge Module resides to the list.

Adding the Merge Module to a Project

To add the Merge Module to a Basic MSI or InstallScript MSI project:

1. Open the consuming InstallShield project.
2. Under the Installation Designer tab, go to the Organization > Features view. Right click on Features and select New Feature from the pop-up menu. This will be the feature used to install the Merge Module.
3. Give the feature a meaningful name.
4. Go to the Application Data > Redistributables view.
5. On the top right panel, set the Search Grid field to Merge Module.
6. Scroll down the list until you find the Merge Module with the same subject name of the custom Merge Module.
7. Check the box to the left of the Merge Module name. This will enable the lower part of the right hand panel labeled Conditional Installation.
8. In the Condition Installation panel, check the box of the Feature created in Step 2.

To add a Merge Module to an InstallScript project:

1. Open the InstallScript project.
2. Under the Installation Designer tab, go to the Organization > Features view and add a new Feature for holding the Merge Modules.
3. Go to the Application Data > Objects view.
4. In the top middle pane labeled InstallShield Objects/Merge Modules, scroll down the list until you find the Merge Module with the same subject name of the custom Merge Module.
5. The lower middle pane shows all the project's features. Using the mouse, drag the custom merge module over the feature created in Step 2. This will pop-up the Merge Module Holder Object dialog.
6. Using the tabs, configure the Merge Module Holder Object.

Additional Information

• Merge Module Projects
• Merge Module Locations
• Adding Merge Modules to Projects
• Browse for a Merge Module