Professional Documents
Culture Documents
Altiris
Altiris
Altiris
Reference
Notice
Wise for Windows Installer, Version 6.2
© 1994-2005 Wise Solutions, Inc. All Rights Reserved.
This documentation and the accompanying software are copyrighted materials. Making unauthorized copies is prohibited by law. No part of
the software or documentation may be reproduced, transmitted, transcribed, stored in a retrieval system or translated into any human or
computer language without prior written permission of Wise Solutions, Inc. Wise Solutions, Inc. asserts its “Moral Right” to be identified as
the author of this work, in all jurisdictions which recognize the “Moral Right.”
Unless otherwise provided by written agreement with Wise Solutions, Inc., this publication, and the software sold with this publication, are
provided “as is” without warranty of any kind either express or implied, including but not limited to the implied warranties of merchantability
and fitness for a particular purpose. The entire risk arising out of the use or performance of this publication and software remains with you.
In no event will Wise Solutions, Inc., or any of its suppliers, be liable for any lost profits, lost savings, direct, incidental or indirect damages or
other economic or consequential damages, even if Wise Solutions, Inc., or its suppliers, have been advised of the possibility of such damages.
Wise Solutions, Inc. reserves the right to modify this document at any time without obligation to notify anyone. In no event shall Wise
Solutions, Inc.’s or its suppliers’ liability under this agreement exceed the sum of any amounts paid hereunder by the customer to Wise or the
supplier.
Wise Solutions, Inc. owns a number of trademarks and service marks (the “Marks”). These Marks are extremely valuable to Wise Solutions,
Inc. and shall not be used by you, or any other person, without Wise Solutions, Inc.’s express written permission. The Marks include, but are
not necessarily limited to the following: Application Isolation Wizard™; ApplicationWatch™; ConflictManager®; ExpressBuild™; Installation
Development Life Cycle™; InstallBuilder®; InstallMaker®; InstallManager®; InstallTailor™; MSI Debugger™; MSI Script™;
PackageManager™; Preflight Deployment™; SetupCapture®; SmartMonitor™; SmartPatch™; Software Distribution Made Easy™; Software
Installations Made Easy®; Unwise™; Virtual Capture™; Visual MSIDiff™; WebDeploy®; Wise Installation System®; Wise MSI Editor™; Wise
Package Studio®; Wise Software Repository™; Wise Solutions®; WiseScript™; WiseScript Express™; WiseUpdate®; WiseUser®; and the
Wise Solutions® logo.
In addition to Wise Solutions, Inc.’s Marks, some Wise Products may include Trademarks or Service Marks owned by other corporations.
These other Marks include, but are not necessarily limited to Microsoft® Windows® and Microsoft® Visual Studio® .NET, which are
registered Trademarks of Microsoft Corporation.
You shall not use any of the Trademarks or Service Marks of Wise Solutions, Inc., Microsoft Corporation, or any other entity, without the
express written permission of such Trademark or Service Mark owner.
Wise Solutions, Inc., a wholly owned subsidiary of Altiris, Inc.
47911 Halyard Drive; Plymouth, Michigan 48170 USA
Phone: +1 734 456 2100 • Fax: +1 734 456 2456 • www.wise.com
Chapter 1: Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Documentation Roadmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Getting Help and Product Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Getting Updates Over the Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Chapter 2: Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Product Editions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
About Visual Studio .NET Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Using Installation Expert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
About Page Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Customizing Page Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Using the Current Feature Drop-Down List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Using the Current Release Drop-Down List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
About the Product Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Using the Task List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Filtering the Task List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Finding Table Errors From the Task List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Adding User-Defined Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Where are Installation Resources Stored? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Using the Enterprise Edition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Sharing Installation Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
About the Share Point Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
How Source Files Are Indexed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Generating Package Contents Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Generating Shared Resource Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Downloading Redistributable Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Downloading Redistributables From the Wise Web Site or Product CD . . . . . . . . . . . . . . . . . . . 35
Downloading Redistributables From Other Vendors’ Web Sites . . . . . . . . . . . . . . . . . . . . . . . . 36
Chapter 3: Setting Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Setting Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Setting General Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Setting .NET Assembly Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Setting Advertising Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Setting Digital Signature Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Setting ExpressBuild Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
How ExpressBuild Groups Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Requirements for Using ExpressBuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Setting Installation Expert Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Setting Merge Module Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Activating Suppressed Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Setting Repository Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Setting Source Control Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Setting the Default Target Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Setting Visual Studio Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Setting Wildcard Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Creating and Editing Installation Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Component Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Wise for Windows Installer is an installation development system for creating and
editing Windows® Installer (.MSI) installation packages. It is a complete and user-
friendly front end for generating Windows Installer database files, which are executed by
the Windows Installer engine.
z Create installations that are compliant with Microsoft’s Windows 2000 logo program.
z Edit and refine installations that you’ve converted from other formats.
Through its Visual Studio integrated editor, Wise for Windows Installer offers a complete,
seamless integration of the entire installation authoring environment directly into the
Microsoft® Visual Studio® .NET development environment. This tight integration allows
for automatic synchronization of your development project with your installation, saving
you time and significantly improving the quality of your installations.
Topics include:
z Documentation Roadmap.
Documentation Roadmap
The Wise for Windows Installer documentation assumes that you are proficient in the
use of the Windows operating system. If you need help using the operating system,
consult its user documentation.
Online Help
The online help contains detailed technical information and step-by-step instructions for
performing common tasks. For details on using help, see Check Online Help on page 15.
Reference Manual
All the material in the online help is also available in .PDF-format reference manuals.
Reference manual .PDFs are provided for Wise for Windows Installer and WiseScript
Express. The Enterprise Edition also includes a Software Manager reference manual. To
access the .PDF reference manuals, select Help menu > Reference Manual from within
each product. (In Visual Studio: Help menu > Wise Help > Reference Manual.)
The installation and repository management sections of the Getting Started Guide are
also available as online help. In the Wise Repository Manager, select Help menu > Help
Topics.
Release Notes
A release notes document, in .HTM format, covers new features, enhancements, bug
fixes, and known issues for the current version of this product. It also contains links to
release notes for other versions. Access the release notes in the following ways:
z Select Help menu > Release Notes. (In Visual Studio: Help menu > Wise Help >
Release Notes.)
z To display context-sensitive help for the active page or dialog, press F1.
z To select a help topic from a table of contents, index, or search, select Help menu >
Help Topics. (In Visual Studio: Help menu > Wise Help > Help Topics.)
Select other commands from the Help menu to view the Windows Installer SDK Help, to
view the .PDF-format reference manual or getting started guide, to view Wise resources
on the Web, or to check for upgrades.
If you need help and cannot find the answer in the documentation, explore our technical
support options below.
Subscribe to TechInfo
TechInfo is a free e-mail newsletter that contains technical tips, product updates, and
other important technical information. To subscribe or to read back issues, visit
www.wise.com/techinfo.asp.
z Serial number and product version, which you can find by selecting Help menu >
About.
To upgrade your installation and packaging skills, consider training. Our certified
instructors draw from practical experience to provide relevant course content. Visit
www.wise.com/training.asp for course descriptions and schedules.
E-mail: wisesales@altiris.com
2. In Wise for Windows Installer, select Help menu > Check for Updates.
A confirmation prompt appears, and then you are connected to the Technical
Support Center Web site.
If you have not registered this product, follow the screen prompts to create a
user account and register. You will need a valid product serial number. After you
complete the registration, click the link to enter the Technical Support Center.
If you have registered this product, log on and then click the link to enter the
Technical Support Center.
3. Click the Downloads link. Follow the instructions on the Web page to download the
appropriate update.
Note
Wise for Windows Installer can remind you to check for updates. Select an option in the
Check for Updates drop-down list in Wise Options. This sets the frequency at which
you will be reminded to check for updates.
Read this overview before creating your first installation. It contains information on
getting started with Wise for Windows Installer.
Topics include:
z Product Editions.
Product Editions
Wise for Windows Installer is available in 3 editions, each designed to fulfill the needs of
a particular type of user. The edition you purchase determines what features are
available to you.
z Professional Edition is a Windows Installer® and .NET installation authoring tool for
professional software developers who want to create installations for the next
generation of applications, including desktop, server, Web, and mobile devices.
z Standard Edition is a Windows Installer® and .NET installation authoring tool for
professional software developers who want basic but robust support for creating
Windows Installer® and .NET installations.
The following table, which does not include all features, summarizes the differences
between each edition. If a feature is not listed, it is included in all product editions. For a
more comprehensive list of features, visit the Products section of the Wise Web site
(www.wise.com). For new features and enhancements in the current release, see the
Release Notes, available from the Help menu. (In Visual Studio: select Help menu >
Wise Help.)
There are several differences between the Wise editor and the Visual Studio integrated
editor that are inherent in the Visual Studio .NET development environment.
Examples:
z In the Visual Studio integrated editor, you have different choices about how to start
a new project, and you can set source paths to update automatically according to
Visual Studio’s build configuration.
When you double-click an installation file in Windows Explorer, you are prompted to
select which editor to open the file in. You can set an option on this dialog to always
open that file in a specific editor.
If you create an installation project in the Visual Studio integrated editor, and then
uninstall Microsoft Visual Studio .NET, you can continue working on the installation
project in the Wise editor. However, if you right-click a .WSI or .MSI, an option still exists
to edit in the Visual Studio integrated editor, which is no longer possible. Initiate a repair
on Wise for Windows Installer to remove options that have to do with the Visual Studio
integrated editor.
Page Views
Page Views
Use the Page Views drop-down list to select a page view, which is a set of Installation
Expert page groups and pages. See About Page Views on page 22 and Customizing Page
Views on page 23.
Page Groups
When you select a page view, its pages are organized into page groups. Click the group
name to expand or collapse its pages. Click a page name to display that page.
Page Area
When you click a page name in a page group, this area displays the page’s options. Each
page lets you define a specific aspect of the installation. (Examples: On the Files page,
you define what files are included in the installation. On the Registry page, you define
what registry keys and values are created on the destination computer.) Complete just
the pages that are pertinent to your particular installation, in any order. If required
information is missing, Wise for Windows Installer alerts you to the problem during
compile.
To display help for the current page, press F1. To return an Installation Expert page to
its last saved state, select Edit menu > Reset Page.
View Navigation
Click these tabs to change views. (In Visual Studio: these are buttons instead of tabs.)
Also see:
z Predefined page views that display the groups and pages most frequently used for a
particular type of installation. The All page view displays all page groups and pages.
The Merge Module page view appears for all merge modules. You cannot edit or
delete predefined page views.
z Custom page views that you create to meet your specific needs. See Customizing
Page Views on page 23.
z Page views that are created when you create an installation template. You cannot
delete these page views. See Creating and Editing Installation Templates on
page 55.
The page views are arranged alphabetically in the Page Views drop-down list with the
exception of the All page view, which is always first. The list also includes <New
View...> and <Customize Page Views...>, which are at the end of the list and are
used to create or customize page views.
(Enterprise Edition only.) You can share page views that are associated with an
installation template because the page view is stored in the template, which is located in
the share point directory.
z The All page view is used when you open an installation file that does not have an
associated page view. An .MSI does not have an associated page view.
When you customize a page view, you can specify how many page groups appear, what
the group names are, and what pages appear under each group.
To create an access key for the name, type & before a letter in the name. The page
view access keys appear only in the page group’s right-click menu accessed by
using the context menu key (the key next to the right Ctrl key).
3. Click OK.
On the Customized Page Views dialog, the new page view is selected in Page View
Name, but it has no page groups or page names.
You can now customize the page view by changing its page groups and pages.
2. Select the page view from Page View Name, and do any of the following:
To add a new page group, click the Page Groups Add button and enter a name.
To rename a page group, select the page group and click Rename.
To add a page to a page group, select the page group and click the Add button
to the right of Page Names. In the Select Pages to Add dialog, select one or
more pages and click OK.
To delete a page group or a page name, select it and click its Delete button.
To delete a page view, select it from Page View Name and click the top Delete button.
Example: Suppose you have 3 features, and each feature requires different registry
entries. On the Registry page, you select the first feature from Current Feature, create
its registry entries, select the second feature in the list, create its registry entries, and
so on. Follow the same steps on the Files, Web Files, or Visual Studio Solution page:
select a feature from Current Feature, then add files for that feature.
During installation, files, registry entries, and other system changes are installed only if
the feature they belong to is installed. The same applies to conditions; add files, registry
entries, and other changes to a condition, and during installation, those files and
registry entries are installed only if the condition is true and the feature is installed.
folders and files for all features.) Add and New buttons are disabled while all features
are displayed; you must select a single feature to add items.
Also see:
Also see:
The Product Home page appears by default when you start Wise for Windows Installer.
To prevent the Home page from appearing by default, clear Display Home page at
startup on Wise Options > General tab. To go to the Product Home page, click Home at
the lower left of the Wise for Windows Installer main window.
z A static page that is installed with Wise for Windows Installer. This appears if you do
not have an Internet connection, or if you disable the dynamic Home page.
z A dynamic page that is downloaded from the Wise Web site if you are connected to
the Internet when you start Wise for Windows Installer. To prevent a dynamic page
from being downloaded from the Internet, mark Don’t get Home page from
Internet on Wise Options > General tab.
The contents of the page vary depending on the edition of Wise for Windows Installer
that you are using. Typical contents are:
z Shortcut links for creating a new installation project or opening an existing one.
The Task List gathers all installation issues into one place, and makes it easy to analyze
their causes. If the issue is caused by an error in a table, you can quickly jump from the
Task List to the row in the table that caused the error. See Finding Table Errors From the
Task List on page 27.
When you resolve the issue that corresponds to a task, the task is deleted the next time
you run the procedure that generated the task. Example: If a task was added to the
Task List because of a compile error and you resolve that error, the next time you
compile the installation that task is removed from the list.
z Package Validation
When you run Package Validation, validation issues appear in the View / Correct
dialog. If you mark the Add to Task List checkbox on the View / Correct dialog,
each issue becomes a task in the Task List when you click Finish. If Package
Validation encounters save or compile errors, the package validation process ends
and the errors are added to the Task List. See Package Validation on page 369.
z Check Tables
When you check tables, the installation is searched for component and table errors
and results are placed in the Task List. To check tables, select Setup Editor > Tables
tab, right-click in the left pane and select Check Tables. See Finding Validation
Errors on page 401.
z User-Defined
(Enterprise Edition only.) You can add user-defined tasks to the task list. See Adding
User-Defined Tasks on page 28. (Not available in the Visual Studio integrated
editor.)
z Meta Data
(Enterprise Edition only.) When you create an .MSI or .WSI, a task is added to
remind you to add the package meta data to the Software Manager database by
filling in the Application and Package fields on the Product Details page.
Note
When you close an installation, all tasks, except user-defined tasks, are removed from
the Task List. (In the Visual Studio integrated editor, user-defined tasks are not
available.)
A task you created. In the Enterprise Edition, this icon also appears
with a task that reminds you to add the package meta data to the
Software Manager database.
z Find table errors. See Finding Table Errors From the Task List on page 27.
2. Select a filter. (In Visual Studio: right-click in the Visual Studio .NET Task List and
select Show Tasks.)
Save/Compile
(In Visual Studio: this is called Build Errors.) Tasks that correspond to errors
generated when you save or compile.
Validation
Tasks that correspond to issues generated during Package Validation.
Component
Tasks that correspond to component errors generated when you check tables.
For information on how to check tables, see Using the Task List on page 26.
Table
Tasks that correspond to table validation errors generated when you check
tables. For information on how to check tables, see Using the Task List on
page 26.
User-Defined
Tasks that you have created. (Enterprise Edition only).
When you set a filter, it is in effect until you change it. However, when you encounter
installation issues, the filter is reset to All so installation issues can be displayed.
Example: If a source file for the installation was moved or deleted at its source, a
WiseSourcePath table error appears during compile. When you double-click this task,
the WiseSourcePath table appears in Setup Editor, and the row in the table that is the
cause of the problem is highlighted. Use the source path information in the row to
ascertain and resolve the problem.
Caution
Deleting, adding, or editing table data directly is not recommended unless you are an
experienced Windows Installer developer with a clear understanding of Windows
Installer database technology. Editing table data might cause unexpected, undesirable
behavior, including damage to the installation. We cannot provide technical support for
problems arising from table editing.
If you need more information, check the task’s description or press F1 to display the
help topic for the selected table in the Windows Installer SDK Help.
Also see:
1. On the first line of the Task List, click Click here to add a new item twice and type
the task.
If Click here to add a new item does not appear in the Task List, save the
installation file and it will appear.
2. Click anywhere outside the box that contains the new task.
The task is added to the Task List and appears in the Description column. User-
defined tasks do not use the Tables column.
Editions, these resources are stored in subdirectories of the Wise application directory.
In the Enterprise Edition, they are stored in subdirectories of the share point directory.
(Enterprise Edition only.) You can specify alternate locations for storing resources. See
Setting Repository Options on page 49.
Directory Contents
000, 001, and so on (Enterprise Edition only.) Contains source files associated with each package’s
installation. The subdirectories are numbered sequentially, such as 000\001,
000\002, and so on. They are created when someone uses Package Distribution to
distribute to the share point. For details, see How Source Files Are Indexed on
page 32.
Custom Actions (Enterprise Edition only.) Provides a shared location in which you can place files used
in custom actions, such as WiseScripts, VBScripts, .DLLs, and so on, that you use in
Windows Installer installations.
Languages Contains the language resource files used to change the language of installations.
Merge Modules (Enterprise Edition only.) This is the default target location for downloading merge
modules, and the default directory from which you select merge modules to add to an
installation. In the Standard and Professional Editions, the default merge modules
directory is Program Files\Common Files\Merge Modules\Wise Solutions.
Reports (Enterprise Edition only.) Contains the predefined reports (.RPT) that are used in
Software Manager. Also contains the Report.ini file, which stores information about
the predefined reports and about any report customizations.
Projects (Enterprise Edition only.) The default location for new installations you create.
Resources Contains installation resources such as bitmap and icon files.
Scripts (Enterprise Edition only.) Contains temporary files (.QUE) representing packages that
have been distributed to but not yet imported into the Software Manager database.
For details, see About .QUE Files in the Software Manager Help.
Directory Contents
Validation Contains the predefined validation modules (.CUB files) that are used by Package
Validation.
Virtual OS (Enterprise Edition only.) Provides a shared location in which you can place Virtual OS
files (.WOS) that are used by the Universal Import feature of Software Manager.
The Enterprise Edition lets you share commonly used templates, dialog themes,
translations, and other installation resources within a single development team or
among multiple development teams. This lets developers throughout the organization
create installations with common settings and a consistent look and feel. See Sharing
Installation Resources.
The Enterprise Edition also helps organizations that use Wise Package Studio. It
eliminates the need to repackage internally developed applications, because the
organization’s developers can create installations that adhere to corporate standards. It
also reduces rework of internally developed installations by the development team and
reduces end-user downtime, because the developers who create installations can be
sure to use the correct versions of files and other resources before giving installations to
the IT deployment team. See Sharing the Software Manager Database With Wise
Package Studio in the Software Manager Help.
Also see:
In Wise Options, you can specify the directories that contain shared resources you will
use in installations. See Setting Repository Options on page 49.
z Component rules ensure that every installation will be organized the same way,
which greatly simplifies the management of multiple product installations.
z Custom actions, such as .DLL files, JScript files, and VBScript files, that can be
added to installations.
z Merge modules ensure that developers always access approved versions of merge
modules by storing merge modules in a central location, or by using merge modules
that are in the Software Manager database.
z Validation modules (.CUB files) simplify the quality assurance process by ensuring
every installation passes the same validation tests.
z Reports let you share customized report menus and custom reports.
Sharing installation resources is accomplished through the share point directory, the
Software Manager database, and the Software Manager tool.
z The share point directory is typically installed on a shared network drive. Use the
share point directory to store resources, such as templates, dialogs, and themes,
used to create installations as well as the source files used in the application itself.
The share point directory can also contain information about applications that are
waiting to be imported into the Software Manager database and the source files
used by those applications. See About the Share Point Directory on page 32 and
Where are Installation Resources Stored? on page 28.
z The Software Manager database contains information about every resource used by
every application your organization develops. This lets developers see what
resources are used by other applications and select source files from the Wise
Software Repository, to ensure that they use the correct versions of file resources in
applications they develop. Geographically dispersed development teams can
maintain multiple Software Manager databases and use a publish/subscribe model
to pass information between repositories. See About the Wise Software Repository
in the Software Manager Help, and How Source Files Are Indexed on page 32.
z Software Manager lets you manage the information in the Software Manager
database. Use it to import applications into the database, subscribe to applications
in other Software Manager databases, and view information about the resources
used by applications in the database.
In addition to importing Windows Installer installations and merge modules,
Software Manager can import other installation formats such as WiseScripts, SMS
Installer files, InstallShield® Developer executables, and any other installation
format. This lets you import legacy installations without converting them to
Windows Installer format.
Also see Sharing the Software Manager Database With Wise Package Studio in the
Software Manager Help.
For recommendations on where to locate the share point directory, see Choosing the
Location for the Share Point Directory in the Wise for Windows Installer Getting Started
Guide. You can change the share point directory in Wise Options. See Setting Repository
Options on page 49.
The Software Manager database is associated with a specific share point directory. When
you change the default share point directory, you also change the default database.
z Predefined reports.
z Temporary .QUE files representing packages that have been distributed but not
imported into the Software Manager database.
z Source files of installations you import into the Software Manager database.
If your organization uses Wise Package Studio, the share point directory might contain
additional information that is unique to that product.
For a list of the share point subdirectories and their contents, see Where are Installation
Resources Stored? on page 28.
A common question is “Can I clean up the share point by deleting unused source files?”
The answer is no. It is too difficult to know which files are safe to delete.
The only recommended way to delete files from the share point directory is to delete the
entire package from the Software Manager database. When you do so, you can delete
the package’s source files from the share point subdirectories (000, 001, and so on), if
those files are not referenced by any other application. See Deleting a Package in the
Software Manager Help.
An index file named wamdb.idx, located in the share point directory, records the location
of the source files. Because files are indexed, distributing source files to the share point
eliminates storage of duplicate files and results in smaller storage requirements than if
you distribute to a network directory.
Example:
Suppose you have 3 packages, each containing a version of report.dll. The first time you
distribute a package containing report.dll, the file is placed in the share point’s 000\001
directory. If you distribute another package containing the same version of report.dll,
the file is not saved a second time, but a counter is set for that file in wamdb.idx. If you
distribute a third package that uses a different version of report.dll, the file is stored in a
second directory, 000\002. The result is a set of all the unique source files used by all
the packages in the Software Manager database.
Also see:
Use a report’s table of contents to quickly access information about a specific type of
resource. You can print the report or save it as an HTML or XML file.
Shared resource reports provide a quick way to review the resources that are shared by
the current installation and other packages in the Software Manager database. Two
reports are available:
In order to generate the shared resources reports, you must be connected to a share
point directory that is associated with a Software Manager database. Typically, this
connection is made during installation. To use a different share point directory and
Software Manager database, see Setting Repository Options on page 49.
The reports are displayed in HTML format. The .XSL templates used to format these
reports are located in the Templates\Reports subdirectory of the share point directory.
You can customize the .XSL templates to supply branding information, to filter data, or
to transform the data to another format.
You also can generate resource reports in Software Manager. The Software Manager
reports contain similar information. See Predefined Software Manager Reports in the
Software Manager Help.
2. In Data Source, specify the Software Manager database that contains the
resources you want to review. If the Software Manager database you want is not
listed, click Open to select it.
3. From Group, select the group that contains the packages to compare this
installation to.
4. Click Next.
The report is generated and displayed in the Shared Files Report or Shared Registry
Report dialog.
You can save the or print the table report from this dialog. Saving to HTML is
available only on computers that contain MSXML.DLL, which is included in Internet
Explorer 5.x and higher.
5. When you finish reviewing, saving, or printing the report, click Finish.
Note
This wizard appears any time Wise for Windows Installer detects a dependency on other
merge modules or other redistributables. Example: If you run ApplicationWatch and a
file gets added that must be installed with a certain merge module, the Download
Redistributables wizard appears and prompts you to download the necessary merge
module. This wizard might also appear if you install runtimes with the installation, or if
you add files to the installation that are part of a merge module.
Note
If you need to go through a firewall or proxy server to get to the Internet, click the
Advanced button near the bottom of the Source Location dialog to modify your Internet
connection settings; the Source Location dialog is the first dialog that appears when you
use the Download Redistributables wizard. An Advanced Settings dialog appears, where
you can specify information for your proxy server. For help with these options, ask your
network administrator.
z Product CD
Select and download one or more redistributables from the CD that was used to
install the product. See Downloading Redistributables From the Wise Web Site or
Product CD on page 35.
1. Select Help menu > Download Redistributables. (In Visual Studio: Help menu >
Wise Help > Download Redistributables.)
3. If you marked Product CD, specify the location of the CD in the Product CD
Location dialog. Then click Next.
A Download Files dialog appears while all available redistributable files are retrieved.
The Available Redistributable Files dialog then appears.
6. Click Next.
If you chose to download any merge modules, the Target Location dialog appears,
where you specify merge modules’ download location; otherwise the download
starts and you can skip the next step. Runtimes are downloaded to private
directories where they are accessed as needed by Wise for Windows Installer.
7. From Target Location, select the directory to download the selected merge
modules to, then click Next.
The drop-down list shows all merge module directories specified in Wise Options.
See Setting Merge Module Directories on page 48.
The merge modules you selected are now in the directory you specified as the target
location. If any merge modules had dependencies on other merge modules, those merge
modules were also downloaded. Other runtimes are located in their required directories.
1. Select Help menu > Download Redistributables. (In Visual Studio: Help menu >
Wise Help > Download Redistributables.)
When all available redistributables are retrieved, the Available Redistributable Files
dialog appears.
3. In the list box, select the redistributable to download and then click Download to
connect to the vendor’s Web site.
4. Follow the links and prompts on the Web site to download the redistributable. Be
sure to download merge modules to a directory specified in Wise Options. See
Setting Merge Module Directories on page 48.
5. When the download is complete, return to the Available Redistributable Files dialog
and click Finish.
The merge modules and other runtimes you selected are now in the directory you
specified as the target location. If any merge modules had dependencies on other merge
modules, those merge modules were also downloaded.
Before you create and edit installations, set up Wise for Windows Installer to reflect your
company’s standards:
z Set options that control the installations you create and determine the installation
resources you use.
z Decide whether you need to customize the templates that installations are based
on.
z Decide which rule set to use to help you manage the creation of components in
installations. You can edit the predefined rule sets or create new rule sets. If the
predefined rule sets do not meed your needs, you can duplicate them and modify
the copies as needed, or you can create new rule sets.
Topics include:
z Setting Options.
z Component Rules.
Setting Options
You can set options that control the installations you create and determine the
installation resources you use. Some of the options are global; they are set for all files
you open with Wise for Windows Installer, including files you created previously. Other
options provide defaults for new files and do not affect existing files.
You set options on the Options dialog, which you access by selecting Tools menu >
Options. In Visual Studio: select Tools menu > Options and click Wise Options in the list
at the left of the dialog.
The Options dialog contains several tabs. (In the Visual Studio integrated editor they are
called pages.) See:
Note
(Visual Studio integrated editor.) To display context-sentitive help, click the Wise Help
link on this dialog.
Automatic Options
z Create backup copy during save
Mark this to create a new backup file every time you save. The backup file name
consists of the current file name plus a number. (Example: if the current file name is
Sample.wsi, the backups are named Sample1.wsi, Sample2.wsi, and so on.) Only
the file you are working on is backed up. (Example: if you open a .WSI and save it,
the corresponding .MSI is not backed up.) Use caution with this option if you are
working with large installation files; if you save often, your disk space will quickly
become depleted.
Compiler Options
The following options are default settings for all new compiles. Changing these settings
does not affect installations that have already been compiled.
Note
Wise for Windows Installer has its own code for merging a module into an .MSI, but
this checkbox causes your merge to follow the Microsoft conventions for merging.
Microsoft’s merging code adds a custom action to the installation for each
predefined directory referenced in each included merge module. The custom action
uses a Set Property action to set the predefined directory name, whereas the Wise
for Windows Installer code sets the predefined directory name by adding an item to
the Directory table of the Windows Installer database.
Startup Options
z Display Home page at startup
Mark this to have the Product Home page appear by default when you start Wise for
Windows Installer.
If you don’t want to be reminded to check for updates, select Never. This reduces
the possibility of a user upgrading their version of Wise for Windows Installer to a
version that is not yet supported by your organization.
z Preferred Editor
This option appears only if Microsoft Visual Studio .NET is installed. It determines
which editor is launched when you double-click a Windows Installer file. Always
Prompt always shows a dialog that prompts you to choose the editor. Last Saved
In uses the editor in which the installation file was last saved.
You can specify whether you create standard Win32 or .NET installations, and customize
how Wise for Windows Installer handles the .NET assemblies. Select Tools menu >
Options and click the .NET Assemblies tab. (In Visual Studio: Tools menu > Options >
Wise Options > Assemblies.)
Note
(Visual Studio integrated editor.) To display context-sentitive help, click the Wise Help
link on this dialog.
Note
If the options on the .NET Assemblies tab are disabled, install the .NET Framework and
run a manual repair of the Wise for Windows Installer .MSI from Add/Remove Programs.
(Not applicable in the Visual Studio integrated editor.)
.NET Application
Select this if you typically create .NET installations with only .NET elements.
z Scan Dependencies
Specify how dependency assemblies are added to an installation. You can add them
manually or have Wise for Windows Installer scan the assembly manifest for
dependencies and add them automatically. Changing this option does not affect
assemblies that have already been added to installations.
Note
On .NET Framework versions earlier than 1.1, scanning does not occur when you add an
assembly from a UNC or mapped network drive (example: the share point directory). To
enable scanning of such assemblies, either upgrade to .NET Framework version 1.1 or
later, or change your .NET security so that the share point directory is fully trusted.
To set advertising options, select Tools menu > Options and click the Advertising tab. (In
Visual Studio: Tools menu > Options > Wise Options > Advertising.)
Note
(Visual Studio integrated editor.) To display context-sentitive help, click the Wise Help
link on this dialog.
The following options are default settings for all new components. Changing these
settings will not affect existing components.
z Advertising Setting
Select one of the “scan” options to have Wise for Windows Installer inspect your
computer’s registry and the files in the installation and automatically add Windows
Installer advertising information for the files that you add to the installation.
The different scan options let you determine whether the advertising information is
added to the advertising tables (AppId, Class, Extension, Mime, ProgId, TypeLib,
Verb), to the registry, or both. The scan options also cause AppPath registry
information to be added to the installation automatically, although it is not related to
advertising. Only AppPath information at
HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\App Paths\ is
added.
This system of registration is more robust than letting the file self-register at
installation time because it does not depend on the presence of other files on the
destination computer, nor does it depend on how well the .OCX or .DLL file adheres
to self-registration conventions. However, the .OCX or .DLL files must already be
registered correctly on your computer. If you prefer not to register installation files
on your computer, you can run the scan routine as a stand-alone utility on a
different computer. See Using WiseComCapture.exe on page 140.
Caution
When registry entries are created for any information that cannot be placed in the
advertising tables, the installation is more accurate because no information is lost.
However, this might cause an error or warning when you run the Application
Specification Logo test in Package Validation.
This field sets the default for new components; if you change it, existing
components are not affected. The Rescan advertising information during
compile checkbox on the Component Details dialog can override this setting for
individual components.
z Create a package containing the code, the encrypted hash, and the publisher’s
certificate.
To set global options for digital signatures, select Tools menu > Options and click the
Digital Signature tab. (In Visual Studio: Tools menu > Options > Wise Options > Digital
Signature.)
Note
(Visual Studio integrated editor.) To display context-sentitive help, click the Wise Help
link on this dialog.
The following options apply to all future installations. They do not affect installations you
created previously.
z Signcode.exe Location
Enter the pathname of the signcode.EXE that performs the signing tasks. For
details, refer to the ActiveX SDK.
z Credentials File
Enter the pathname of the credentials file that contains your Digital ID; the path can
be relative to the .WSI you’re compiling. Your credentials file is provided by Verisign
or another certificate authority. You must use the same computer to apply for and
obtain your Digital ID. You can then use the private key and Digital ID to sign files
on a different computer.
With ExpressBuild™, you can use multiple processors to speed compile time for large
builds. Use multiple processors on the local computer, and use the main processor of
multiple distributed computers (called a build group). The processors on the local
computer can be physical or virtual processors. You can also set up your own computer
to provide processing power for another build computer.
If you turn ExpressBuild on, it is turned on globally; that is, it is in effect for all
installation files you open, regardless of when they were created.
Note
(Visual Studio integrated editor.) To display context-sentitive help, click the Wise Help
link on this dialog.
You can mark any combination of the 3 checkboxes below. After you mark either of the
first 2 checkboxes, compiles will attempt to use multi-processor compile unless
prevented from doing so. If you mark Allow My Computer to Build for Others, your
computer is immediately available to assist in compiles being performed on other
computers.
See Requirements for Using ExpressBuild on page 46 for requirements for using the
following options, and for reasons why multi-processor compile does not take place.
You can specify a build group of computers within the same NT domain or workgroup to
share processing of compiles. To specify a build group, first you select an arbitrary name
for the build group. Then, on those computers that will be part of a build group, you do
one of 2 things:
z If Wise for Windows Installer is not installed, then run WiseExpressBuild.exe, which
is located in the share point directory. The Wise ExpressBuild dialog opens. Specify
the group name and whether the WiseExpressBuild.exe should open at system
startup. WiseExpressBuild.exe runs in the background and responds to and
manages compile requests from the build computer. You can open it and edit its
properties by double-clicking on its icon in the Windows taskbar.
z If Wise for Windows Installer is installed, open it on that computer. Select Tools
menu > Options, click the ExpressBuild tab, and mark the Allow My Computer to
Build for Others checkbox. (In Visual Studio: Tools menu > Options > Wise
Options > Prompts.) Then enter the group name of the build group your computer
will build for. Do this on each computer that will share processing as part of a single
build group. When you click OK on the Options dialog, the WiseExpressBuild.exe
immediately begins running on your computer, with its icon showing in the system
tray area of your taskbar.
Note
Performance slowdowns will occur on computers in build groups when they are called
upon to help process compiles.
z If you use a computer running Windows 9.x or Me to share compile processing, the
workgroup name of the 9.x/Me computer must match its domain name. Also, the
build group name must be in 8.3 file name format.
If you select One Cab in the Cab Options field on the Media page, or if the
.MSI contains only one .CAB for some other reason.
If you select any size other than zero in the Max Media Size field on the Media
page.
z Because each processor compresses .CAB files, using multiple processors is more
efficient if files are arranged into multiple, moderately-sized .CAB files. To achieve
this, select One Cab per feature or One Cab per component in the Cab Options
field on the Media page.
z The paths to all installation source files must be in UNC notation. Change paths to
UNC notation using Tools menu > Convert Source Paths. (In Visual Studio: select
Project menu > Convert Source Paths.) If any source files have paths to the local
drive (Example: C:\MyFiles\file.jpg) then multi-processor compile does not occur.
For information on using this tool, see Source Paths in an Installation on page 324.
z The path to the installation file must be referenced in UNC notation. When you open
the installation file, open it in such a way that it is referenced by a UNC path.
Example: When opening a file, browse to the installation underneath the My
Network Places icon or type the entire UNC path in the File Name field. If you
browse under the My Computer icon, the path will not be referenced in UNC
notation.
Note
(Visual Studio integrated editor.) To display context-sentitive help, click the Wise Help
link on this dialog.
Clear this to display only the directories that were created for the current feature
(the feature selected in the Current Feature drop-down list.) Example: If you
create a directory for FeatureA, and then use the Current Feature drop-down list
to go to FeatureB, you no longer see the directory you made for FeatureA. This does
not apply to the Web Files page.
z Display the page view associated with a project when a project is opened.
Mark this to display an installation project’s default page view when the installation
opens. If you clear this checkbox, the page view in Installation Expert does not
change when you open a project regardless of its associated page view.
Note
(Visual Studio integrated editor.) To display context-sentitive help, click the Wise Help
link on this dialog.
You can store merge modules on a local drive or a shared network drive. When you add
a merge module to an installation, you can select from the merge modules in the
directories you specify here. When you use the Download Redistributables wizard, you
can download merge modules to directories you specify here.
In the Enterprise Edition, you can use merge modules that are in the Software Manager
database, which helps ensure that developers always access approved versions of
merge modules.
To exclude the merge modules in the default directory from the list, mark Do not
show merge modules from the Default Merge Module Directory.
z Directory
Enter additional directories where merge modules are stored. Merge modules in
these directories are listed on the Select Merge Modules dialog. Example: If you
save your company’s user-created merge modules in the shared network directory
V:\Modules, and you add V:\Modules to the Directory list, the merge modules in
that directory will appear on the Select Merge Module dialog.
To add a directory to the list, click Add, browse for the directory, and click OK. To
include subdirectories in the search, mark the checkbox in the Include Subdirs
column. The next time you click the Add button on the Merge Modules page,
modules in that directory appear on the Select Merge Module dialog.
To delete a directory from the list, click the directory and click Delete. Merge
modules in that directory will no longer appear on the Select Merge Module dialog.
The dialog lists the prompts you have suppressed and shows your last response to
each prompt. If you have not suppressed any Wise for Windows Installer prompts,
nothing is listed.
The prompt is removed from the list. The next time you encounter a situation in
which that prompt applies, the prompt will appear.
Note
(Visual Studio integrated editor.) To display context-sentitive help, click the Wise Help
link on this dialog.
Note
(Visual Studio integrated editor.) To display context-sentitive help, click the Wise Help
link on this dialog.
For information about sharing resources, see Sharing Installation Resources on page 30.
Note
Changing the share point directory or a specific path does not copy resources to the new
location. The new location you specify must already contain resources. Typically, you will
specify a share point or path that is already in use by another team.
z Share Point
(Read-only.) This displays the share point directory that contains the shared
resources. You cannot edit this field, however, you can click Configure to connect to
a different share point directory. When you click Configure, the Share Point
Directory dialog appears. Browse to an existing share point directory and click Next.
If the share point you selected was created in an older version of Wise software,
then you might also be prompted to enter the Software Manager database name
and the server where it resides. When the share point has been changed, click
Finish to end the wizard.
Note
(Visual Studio integrated editor only.) You must restart Visual Studio .NET for the
share point change to take effect.
Default locations are set for specific types of resources based on the share point
directory above. Typically, you will use the default locations. If you want to set individual
share locations for specific resources, click Advanced. The Repository Advanced Settings
dialog appears. To change a default location, double-click one of the following items in
the list box and browse to a new path.
You can use the variable [WiseSharePoint] to represent the share point directory in the
following paths. You also can use the predefined variables that appear on the Path
Variables page. However, you cannot use other user-defined path variables because they
are specific to a single installation and the following paths are global options.
z Component Rules
Specify the location of ComponentRules.ini, which contains the rules that govern
how components are created in installations.
Caution
If you are sharing component rules in the Enterprise Edition, be careful when editing
existing rule sets because your changes will overwrite rule sets used by other
members of the development team.
z Custom Actions
Specify the location in which you will save files used in custom actions (examples:
WiseScripts, .DLL files, JScript files, and VBScript files) that can be added to
installations. This is the default location whenever you browse for a file in a custom
action dialog.
Note
Changes in this field do not take effect until you exit and restart the product.
z Dialogs
Specify the location of the Wise Standard.MSI that contains information used by the
New Dialog Wizard to add a new dialog to an installation.
z Languages
Specify the location of language resource files.
z Resources
Specify the location of the icon and bitmap resources that are used in installations.
z Templates
Specify the location of installation templates and WfWI macros.
z Themes
Specify the location of the themes that are used to customize installation dialogs.
z Validation Modules
Specify the location of the validation modules (.CUB files) and settings used in
Package Validation.
The following global options set the levels of interaction Wise for Windows Installer has
with your source code control system (SCCS). For details, see Using Source Control on
page 314.
The following options apply to the current installation and all future installations.
Changing these options does not affect installations you created previously.
Note
If the following options do not appear on the Source Control tab, you probably don’t
have a source code control system on your computer. It could also be that your SCCS is
unrecognized or that there are communications problems between the SCCS server and
your computer.
Enabling the source control options above does not implement source control in the
installation. It merely enables you to add and remove files from the source code control
system, and to check them in and out. Use the options on the Source Control menu to
perform these tasks.
Note
(Visual Studio integrated editor.) To display context-sentitive help, click the Wise Help
link on this dialog.
Note
64-bit installations are supported only by Windows Installer 2.0 or later.
Note
(Visual Studio integrated editor only.) The Setup Wizard contains options that let
you change the target platform for a particular project.
Caution
If you mark this checkbox but not the next 2 checkboxes, then every 32-bit
installation file you open is converted to and saved as 64-bit.
When you mark this checkbox, the following checkboxes are available:
original file name with “(64-bit)” appended to the end. Example: If your original
file is named MyApp.wsi, the file name for the new 64-bit installation file will be
MyApp (64-bit).wsi.
Note
You cannot convert 64-bit installations to 32-bit.
Also see:
Note
(Visual Studio integrated editor.) To display context-sentitive help, click the Wise Help
link on this dialog.
Projects Options
To override these defaults for individual installations, or to change them for existing
installations, edit the Projects page of the installation project settings. See Entering
Project Settings on page 77.
z Scan Method
Each time you load, save, or build an installation project or change its settings, Wise
for Windows Installer can scan the other projects in the solution for new files to add
to the installation. See Scanning the Solution for New Files on page 82.
Specify the default level of scanning that will occur for new installations.
z Create Shortcut
Mark this to add a shortcut for the main target file to each installation.
On the Files and Web Files pages in Installation Expert, you use the wildcard groups
when you add directory contents. Wildcard groups on the Wildcard Groups tab appear in
the Include Wildcards list on the Add Contents and Wildcard Details dialogs. Select a
wildcard group to add just a subset of the files in the directory whose contents you are
adding.
Several wildcard groups are predefined, which you can edit. If you delete them, they are
recreated on application launch. Also, wildcards that you enter in any Include
Wildcards field are added to the list of wildcard groups.
Note
(Visual Studio integrated editor.) To display context-sentitive help, click the Wise Help
link on this dialog.
Group Name
Enter a name to precede the wildcards in the Include Wildcards list. This is a
visual identifier to help you quickly find the wildcards in the list.
Wildcards
Enter semi-colon delimited wildcards. (Example: Enter *.EXE;*.DLL for all .EXE
and .DLL files. A ? represents any one character.)
Later, when you add contents or set automatic updating on the Files or Web Files page,
this wildcard group is available from the Include Wildcards list.
z In the Standard and Professional Editions, the Templates directory is under the Wise
for Windows Installer application directory.
z In the Enterprise Edition, the Templates directory is under the share point directory.
This lets all developers in your organization access the same templates.
For details, see Sharing Installation Resources on page 30 and Where are Installation
Resources Stored? on page 28.
Caution
Editing predefined templates is not recommended, because they might be overwritten
during upgrades. Instead, save customized templates with different names, or make
copies of the predefined templates and edit the copies.
Example: Suppose that all the installations you create have the same system
configuration requirements and the same dialogs. You can create a custom template
that has those changes preconfigured. To do this, you would create a new installation,
make the necessary changes to the System Requirements and Dialogs pages, and then
save the installation in a specific location. Thereafter, every time you create a new
installation, the template you saved is available to base new installations on.
2. Select a template file on which to base the new template and click OK. Only icons
that have a corresponding file in the Templates directory are templates; other icons
cannot be used to create or edit templates.
3. Make all the changes that should appear in installations created with this template.
4. To include a description that will appear in the New Installation File dialog when you
click this template:
5. When you finish editing the installation, select File menu > Save As. In the Save As
dialog, name the file and save it in the Templates directory as a .WSI, .MSI, WSM,
or .MSM.
When you save the installation template, a page view is created with the same
name and is listed in the Page Views drop-down list. However, when you use the
template to create an installation, the default page view is the page view that was
displayed when the template was created. If the template’s default page view is a
custom page view, you can customize it. See Customizing Page Views on page 23.
The New Installation File dialog appears and the file you just created appears in the
Custom Templates category. If the New Installation File dialog does not contain
the new template, verify that you saved it as a .WSI, or .WSM in the Templates
directory.
8. Verify that the changes you made in the template are present in this new installation
file.
4. In the Templates list, select an icon on which to base the new template. Some
icons are not templates, but instead invoke an import process or prompt to create a
new transform.
To create a template in .WSI or .WSM format, select a project icon (name ends
with “Project”).
To create a template in .MSI or .MSM format, select a file icon (name ends with
“File”).
5. Click Open.
6. Make all the changes that should appear in installations created with this template.
7. When you finish editing the installation, select File menu > Save As. Name the file,
and save it in either:
displayed when the template was created. If the template’s default page view is a
custom page view, you can customize it. See Customizing Page Views on page 23.
If you saved the template in the Templates\Project directory, select File menu >
New > Project. On the New Project dialog, click Wise Setup and Deployment
Projects in the Project Types list. Your new template should appear in the
Templates list.
If you saved the template in the Templates\File directory, select File menu >
New > File. On the New File dialog, click Wise Files in the Categories list. Your
new template should appear in the Templates list.
10. To test the template, verify that the changes you made in the installation template
are present in this new installation file.
Component Rules
You can select or create rules that help you manage the creation of components in an
installation. Using component rules eliminates the need to specify component
information for every individual resource you add to an installation and ensures that
components are created consistently across all installations. Component rules can also
help you align component GUIDs in an upgrade with component GUIDs in previous
versions of the installation.
When you first create an installation, you select a component rule set to manage
components you add to that installation. Then, whenever you add a resource, such as a
file, registry key, shortcut, or anything else that can be installed, components are
created for those resources in accordance with the rule set you selected. Example: You
can always create a new component for each new file added to the installation, or you
can group related resources, such as help files, into one component.
Two predefined rule sets are provided. You might find that they manage your
components satisfactorily and no customization is necessary. If the predefined rule sets
do not meed your needs, you can duplicate them and modify the copies as needed, or
you can create new rule sets to reflect your company’s standards. For descriptions of the
predefined rule sets, see Microsoft Best Practices Component Rule Set on page 63 and
One File Per Component Rule Set on page 64. For instructions on creating new rule sets,
see Customizing Component Rules on page 60.
(Enterprise Edition only.) You can share component rules with others in your
organization via a share point directory. Sharing component rules ensures that you
always use the most current set of rules and that your installations always adhere to
company standards for creating components. To share component rules, select Tools
menu > Options, click the Repository tab, and click the Advanced button. (In Visual
Studio: Tools menu > Options > Wise Options > Repository.) Make sure a shared
directory is specified for the Component Rules path. See Setting Repository Options on
page 49.
z A condition determines the criteria that a resource must meet in order for an action
to be performed. Example: If you select the condition Added resource is a Shortcut,
the action is only performed for shortcut resources.
In the Standard and Professional Editions, rule sets are stored in the registry. In the
Enterprise Edition, rule sets are stored in an .INI file located in the share point directory.
You can change the location; see Setting Repository Options on page 49. Do not attempt
to edit the .INI file outside of the Component Rules dialogs.
Caution
If you are sharing component rules, when you edit existing rule sets your changes will
overwrite rule sets used by other members of your team.
The component key values you enter on the Component Rule Selection dialog can be
overridden by specific rules. Example: If you use a rule set that contains rules for
naming certain types of components, then only the components that do not meet the
conditions in the rule set will be named using the component key value options you
specify here.
2. From Rule Set Name, select the rule set to use for this installation.
3. To make the specified rule set the default for all future installations, mark Make
this the default rule set for all Windows Installer files.
4. In the Component Key Values section, select an option from the Default list to
determine the naming convention for new components. If the rule set you use
specifies the component naming under certain conditions, the naming convention
you specify here will be overridden when those conditions are met.
base for the component name (example: Component). Component names will
be incremented from this base (example: Component1, Component2, and so
on).
If the resource is a file, registry key, or ODBC data source, give the
component the same name as the key of the keypath.
For any other type of resource, give the component the same name as the
key of the first resource in the component.
5. From Files, you can select a different naming convention for components that are
based on file resources. You can use the long file name of the keypath file, the short
file name of the keypath file, or the naming convention specified in the Default field
above.
6. To make the options in the Component Key Values section the defaults for all
future installations, mark Make this the default key naming convention for all
installations.
All resources that you add to this installation from this time forward will be organized
into components according to the rule set and other conventions you specified.
If you are working on an upgrade installation, you specify the previous versions of the
installation on the Previous Installation Versions dialog. Then, make sure you use a
component rule set that contains a rule for aligning component GUIDs with previous
versions. Example: The 2 predefined rule sets contain a rule in which, if the keypath
resource matches a resource in the previous .MSI list, the component layout of the
previous .MSI is matched and the component key is set to match the previous version.
All new resources you add to the upgrade installation will be checked against the
previous installations.
To ensure that all resources you add to an upgrade installation are aligned with previous
versions, specify the previous installation versions before adding any resources to the
installation. If you have already added resources to the installation, as is the case when
you use a copy of a previous .WSI as a starting point for creating an upgrade
installation, you must run UpgradeSync to align GUIDs for existing components.
2. If you have already added resources to the upgrade installation, run UpgradeSync to
align GUIDs for existing components. See UpgradeSync on page 300.
3. Select a rule set to use for this upgrade. See Selecting a Component Rule Set on
page 58. Make sure the rule set you select contains a rule for aligning component
GUIDs with previous versions; this should be the first rule in the rule set.
For best results, use the same rule set, if any, that was used in the previous
versions. That way, component creation in the upgrade will be consistent with the
previous versions.
4. Select Component Rules menu > Previous Versions. (In Visual Studio: Project menu
> Component Rules > Previous Versions.)
5. On the Previous Installation Versions dialog, specify the previous versions of this
installation.
To add a previous version .MSI to the list, click Add, click to browse to the
.MSI, and click Open. The .MSI is added to the list.
The previous versions will be checked in the order they appear in this list.
All new resources you add to the upgrade installation will be checked against and
aligned with the previous installations you specified.
When creating new rules, refer to Microsoft’s rules for creating components; see
Organizing Applications into Components and Changing the Component Code in the
Windows Installer SDK Help.
Caution
If you are sharing component rules, when you edit existing rule sets your changes will
overwrite rule sets used by other members of your team.
The Component Rules Manager dialog appears, listing the predefined rule sets and
custom rule sets you have created.
2. Click New.
3. Enter a unique Rule Set Name to identify this rule set and click OK.
The new rule set name appears and is selected in the Component Rules Manager
dialog.
4. Click Modify.
5. In the Customize Component Rules dialog, click Add to add the first rule for this rule
set.
This starts the Component Rule Wizard, which you step through to add the
conditions and actions that comprise the rule. For details on using the Component
Rule Wizard, see Adding and Editing Component Rules on page 61.
6. When you have finished adding rules to the rule set, click OK in the Customize
Component Rules dialog and then click OK in the Component Rules Manager dialog.
The new rule set is added to the list of available rule sets. To use the new rule set for the
current installation or to make it the default for all future installations, you must select it
as described in Selecting a Component Rule Set on page 58.
The Component Rules Manager dialog appears, listing the predefined rule sets and
any custom rule sets you have created.
To copy the rule set, click Copy, type the new name on the Enter Rule Set Name
dialog, and click OK.
To modify the rule set, click Modify. The Customize Component Rules dialog
appears, where you can add, edit, and delete rules. For details, see Adding and
Editing Component Rules on page 61.
Note
If you selected a predefined rule set, all the buttons on the Customize
Components Rules dialog are disabled because the predefined rule sets are
read-only. However, you can use this dialog to view the rules in a predefined
rule set.
To rename the rule set, click Rename, type the new name on the Enter Rule Set
Name dialog, and click OK.
To delete the rule set, click the Delete button to the right of the rule set name.
The predefined rule sets, Microsoft Best Practices and One file per component, are read-
only and cannot be modified.
Caution
If you are sharing component rules, when you edit existing rule sets your changes will
overwrite rule sets used by other members of your team.
The Component Rules Manager dialog appears, listing the predefined rule sets and
any custom rule sets you have created.
To add a rule, click Add. This starts the Component Rule Wizard, which lets you
define component rules. For details, see the procedure below.
To edit a rule, click the rule in the rules list and click Details. This starts the
Component Rule Wizard, which you can step through to change the rule name
or change any of the conditions or actions. For details, see the procedure below.
4. Click OK.
2. In the Which condition(s) do you want to check? list, mark the checkbox next
to each condition to check.
When there are no conditions for performing the action(s) in this rule, select the
condition Always perform associated action.
As you mark checkboxes, the conditions appear in the Rule description list. If you
select a condition that is incompatible with a condition you’ve already selected, the
first condition you selected is removed from the list.
3. If a condition contains underlined text, click the underlined text to open a Rule
Details dialog. There you can select a value for the underlined text.
Example: If you selected the condition Added resource is a file with name any,
you would click the word any and enter a specific file name. Wildcards are allowed.
4. When you’ve added all conditions that comprise the rule, click Next on the
Conditions dialog.
5. In the Which action(s) do you want to perform? list, mark the checkbox next to
the action or actions to perform.
The actions you mark appear in the Rule description list. If you select an action
that is incompatible with an action you’ve already selected, the first action you
selected is removed from the list.
6. If an action contains underlined text, click the underlined text to open a Rule Details
dialog. There you can specify a value for the underlined text.
Example: If you selected the action Set component key to Component, you
would click the word Component and enter specific text.
7. When you’ve added all actions to the rule, click Finish on the Actions dialog.
The Customize Component Rules dialog reappears. The rule is displayed in the
upper list box and its details are displayed in the Rule description list.
8. You can continue to add and edit rules. When you finish, click OK on the Customize
Component Rules dialog.
The new rules are added to the rule set and the Component Rules Manager dialog
reappears.
9. Click OK.
If an added resource does not meet the conditions in a rule, the next rule is evaluated
for that resource. If the resource does not meet the conditions in any of the rules, the
component is created according to the final rule.
If an added resource does not meet the conditions in a rule, the next rule is evaluated
for that resource. If the resource does not meet the conditions in any of the rules, the
component is created according to the final rule.
This section describes the basic procedures for working with installation files.
Topics include:
z File Types.
z All the files to install on the destination computer. This includes program files, files
necessary for optional features, related .DLLs, drivers, and other support files.
(Visual Studio integrated editor only.) Some of these files (examples: .DLLs, .OCXs,
and .EXEs) might be added automatically when you create the installation project.
z Any third-party installations that the installation will provide. Example: Adobe
Acrobat Reader.
z Which files and other system changes comprise which features. (In Windows
Installer, a feature is a distinct part of your application’s functionality. Examples: a
spell-checker, a thesaurus, or a collection of clip art.) If the installation will let end
users select optional components, you must organize files into features when you
create the installation.
z A list of the changes that must be made to system information files (examples: .INI
files, the registry, and so on) for your application to run properly.
z Any changes that should be made to the dialogs that will be displayed during
installation. See Using the Dialogs Page on page 430 for a list of dialogs.
File Types
In Wise for Windows Installer, you can create and edit different types of Windows
Installer database files. You can work in the Windows Installer database file or in a
project file that contains instructions for compiling the Windows Installer database file.
See Project Files and Database Files on page 68. Each extension is described below.
Extension Description
.MSI Windows Installer database, which is a distributable installation. The .MSI extension is
associated with the Windows Installer executable, MSIExec.EXE. When an .MSI is
opened, Windows Installer executes it, thereby installing the application.You can open
and edit an .MSI in Wise for Windows Installer; however, options that have to do with
creating an .MSI, such as those on the Releases, Release Settings, and Media page,
are disabled. To convert an .MSI to a project file (.WSI), see MSI to WSI Conversion on
page 364.
.WSI Windows Installer project file, which describes an .MSI but does not store contents. It
is in the same format as an .MSI. You edit a .WSI in Wise for Windows Installer and
compile it to the corresponding .MSI. The .WSI is smaller in size and you can set
multiple options for the output of the .MSI.
.WSPROJ (Visual Studio integrated editor only.) Visual Studio project file for a Windows Installer
installation. When you create an installation project in Visual Studio .NET, a
corresponding .WSPROJ file is created in the same location. The .WSPROJ file points to
the .WSI.
.MSM Windows Installer merge module, which is a pre-compiled library of components (files,
registry changes, and other system changes) that installs a discrete part of your
application. It cannot be run alone, but must be merged with an .MSI during the .MSI
compile. Merge modules provide flexibility in developing installations because you can
break the installation into logical parts and share merge modules between
installations. See About Merge Modules on page 329.
.WSM Windows Installer merge module project, which describes an .MSM, but does not store
merge module contents. You edit a .WSM in Wise for Windows Installer and compile it
to the corresponding .MSM. See About Merge Modules on page 329.
.MST Windows Installer transform, which changes a Windows Installer package at runtime
and must be applied from the command line. See About Transforms on page 348.
.MSP Windows Installer patch, which updates an existing installed application. Patches
contain only the differences between the old and new versions of an application.
Create a patch with the Patch Creation tool, which creates an .MSP file to distribute to
end users. See Patches on page 302.
Extension Description
.PCP Windows Installer patch project, which describes and compiles to a Windows Installer
patch. A .PCP file is created from the Patch Creation tool. See Patches on page 302.
.EXE You can compile an .EXE that encapsulates the .MSI or that calls an external .MSI.
Doing so gives you the option of pre-installing Windows Installer software before
performing your own installation, which ensures the installation will run. For details,
see Setting Build Options for a Release on page 185 and Adding Prerequisites to a
Release on page 186.
On the Build Options page (see Setting Build Options for a Release on page 185) or on
the Media page (see Setting Up Media for Distribution on page 201), you can specify to
output an installation in different ways:
If you to output an .EXE, you can then pre-install Windows Installer or other runtimes.
When you create an installation, you can work either in a .WSI (project) file or an .MSI.
The same applies to merge modules; work in an .MSM file or a .WSM (project) file.
Note
Do not confuse the Wise installation project file (.WSI) with the Visual Studio project file
(.WSPROJ).
The New Installation File dialog appears. If it doesn’t appear, select File menu >
New. For details on options in the New Installation File dialog, see:
5. Select a target platform if necessary: 32-bit or 64-bit. For details, see Specifying the
Target Platform in an Installation on page 76.
The Target Platform section appears only if Select platform in New Installation
File dialog is marked in Wise Options.
Each Visual Studio installation project contains settings that control how it interacts with
other projects in the solution. You can enter project settings when you create a new
installation, or you can create an installation with default settings. You can edit project
settings at any time. See Entering Project Settings on page 77.
To create a stand-alone installation that is not integrated with a Visual Studio .NET
solution, see Creating a Stand-alone Installation on page 72.
Note
For best results, build the solution before creating the installation. This ensures that the
target files are available for integration into the installation. If the main project’s target
file does not exist when you create the installation, project information might not appear
on the Product Details page as expected. The data will be included in the compiled .MSI,
and will appear on the Projects page the next time you compile the installation project.
3. In the Project Types list, select Wise Setup and Deployment Projects.
(Professional and Enterprise Editions.) Select the Setup Wizard icon to create a
new Windows Application installation and enter its project settings.
(Standard Edition.) Select the Windows Application icon, which creates a new
installation with default settings, which you can change later.
A Windows Application installation is a standard installation intended for a Windows
computer or server.
Merge Module icon: Available Tabs and Pages in Merge Modules on page 330.
5. In Name, enter a name for the installation file. In Location, specify the directory in
which to save the project.
7. Click OK.
If you selected the Windows Application icon, an installation project is created in the
location you specified and is listed in Solution Explorer. Skip to the last step.
If you selected the Setup Wizard icon, the Wise Setup Wizard appears.
b. On the wizard’s Project Type page, select the Windows Application option.
c. For information on other settings in this wizard, see Entering Project Settings on
page 77.
d. Click Finish.
An installation project is created in the location you specified and is listed in Solution
Explorer. A corresponding .WSPROJ file (Visual Studio project) is created in the
same location.
Also see:
To create an installation that is part of a Visual Studio .NET solution, see Creating an
Installation Within a Solution on page 70.
For information on .MSI and .WSI files, see File Types on page 67 and Project Files
and Database Files on page 68.
5. Click Open.
Also see:
You can create an installation that supports Microsoft’s Driver Install Frameworks
(DIFx). Microsoft created the Driver Install Frameworks to significantly improve the
quality of device driver installations. For information on DIFx, search for “DIFx” in the
MSDN Library (msdn.microsoft.com/library/).
The Microsoft DIFxApp merge module simplifies the process of creating installations that
install device drivers. This merge module adds custom actions to the installation that are
needed to install and uninstall the driver package using Driver Install Frameworks for
Applications (DIFxApp). After you add the merge module, you add the files that make up
the driver package and specify the DIFxApp options for installing the driver.
1. Make sure the device driver you are installing meets Microsoft’s DIFx driver
requirements.
2. Do one of the following to add the Microsoft DIFxApp merge module to the
installation.
Start a new installation and select the Device Driver icon on the New
Installation File dialog. See Starting a New Installation on page 69. (In Visual
Studio: start a new stand-alone installation and select the Device Driver icon on
the New File dialog. See Creating a Stand-alone Installation on page 72.)
For an existing installation, add the merge module on the Merge Modules page.
See Adding a Merge Module to an Installation on page 345.
Note
Early versions of this merge module might be named “Binaries.”
a. Add a feature for the installation’s driver package. See a Adding a New Feature
on page 103.
b. Add the condition “VersionNT>=500” to the feature. This condition ensures that
the driver package is installed only on systems running Windows 2000 or later.
See Using Conditions With Features on page 108.
4. On the Files page, do the following. For details, see Adding Files to an Installation on
page 117.
c. Add the driver package’s .INF file to the directory you created.
d. The driver package’s .INF file must be the first file added to this directory so
that it becomes the key path of the component.
e. Add the other files that make up the driver package to the same directory that
contains the .INF file.
h. Click the Driver tab and edit the DIFxAPP options. See Editing DIFxApp Options
on page 138.
5. To add additional driver packages repeat the preceding steps, except for adding the
DIFxApp merge module.
You can create new files either in Windows Installer database format (.MSI, .MSM) or in
Wise’s project format (.WSI, .WSM). See Project Files and Database Files on page 68.
Some options let you start a new installation by using a tool (example: Palm Application)
and some let you create different kinds of Windows Installer installations from
templates. You can create custom templates, which appear as additional options for new
installations. See Creating and Editing Installation Templates on page 55.
Tips
z In the Wise editor, templates are organized in category subfolders. Examples:
Predefined Templates, Custom Templates, and so on.
z In the Visual Studio integrated editor, templates are organized by integrated project
and stand-alone files:
Select File menu > New > Project > Wise Setup and Deployment Projects for
new projects that are integrated with a solution.
Select File menu > New > File > Wise Files for stand-alone files.
z Setup Wizard
(Visual Studio integrated editor only. Not available in Standard edition.) Runs a
wizard that creates a Windows Application, Web Application, Server Application, or
Merge Module installation. With this wizard, you can customize the settings rather
than accepting the defaults of the standard templates. See Creating an Installation
Within a Solution on page 70.
z Windows Application
Creates a standard installation with default settings. See Starting a New Installation
on page 69. (In the Visual Studio integrated editor, see Creating an Installation
Within a Solution on page 70. If this name ends with “File”, it creates a stand-alone
file that’s not part of a solution; see Creating a Stand-alone Installation on
page 72.)
z Web Application
(Professional and Enterprise editions only.) Creates an installation intended to be
run on Microsoft Internet Information Server (IIS). See About Web Installations on
page 222.
z Server Application
(Professional and Enterprise editions only.) Creates an installation intended to be
run on Microsoft IIS, with an additional dialog for recording logon information. See
Obtaining Logon Information From a Dialog on page 450. Installations created from
this template work only on Windows NT, 2000, XP, or Server 2003.
z Device Driver
Creates an installation that installs a device driver. This template supports
Microsoft’s Driver Install Frameworks (DIFx). It includes the DIFxApp merge module
that adds custom actions to the installation that are needed to install and uninstall
the device driver package using Driver Install Frameworks for Applications
(DIFxApp). See Creating a Device Driver Installation on page 72.
z Merge Module
See Creating a Merge Module As a New Installation on page 334. (In Visual Studio:
see Creating a Merge Module Within a Solution on page 336. If this name ends with
“File”, it creates a stand-alone file that’s not part of a solution; see Creating a Merge
Module As a New Installation on page 334.)
z Transform
See Creating a Transform Based on an Existing .MSI on page 349.
Pocket PC Application
See Creating a Pocket PC or Smartphone Installation on page 246.
Palm Application
See Palm OS Installations on page 255.
Smartphone Application
See Creating a Pocket PC or Smartphone Installation on page 246.
z Conversion Tools
The following tools convert an existing installation from another format to Windows
Installer format.
InstallShield Professional
See Convert InstallShield Professional on page 357.
z Import Tools
The following tools open an import wizard, where you select a development project
file to import. Target file information is extracted from the project file and added to
the installation. See Import Visual Studio Projects on page 360.
Visual Basic
(In Visual Studio: this is named Import Visual Basic.)
Visual C#
(Not available in the Visual Studio integrated editor.)
Visual J#
(Not available in the Visual Studio integrated editor.)
Create standard .MSI or .MSM file that contains all binary and cabinet
files
Mark this to create a new Windows Installer database file. Because the
installation file generally encapsulates all the files of the installation, an .MSI is
usually larger in size and takes longer to save. Also, some options that
determine the output of an .MSI are not available if you work with the .MSI
itself.
Create .WSI or .WSM project file that can be compiled into an .MSI or
.MSM
Mark this to create a project file instead of a installation file. Unlike .MSIs,
project files are not distributable installation files; they describe and compile a
distributable file. They do not contain installation files. This option lets you edit
and save the .WSI quickly and has more options for outputting the .MSI. A .WSI
compiles to an .MSI, and a .WSM compiles to an .MSM (merge module).
(Visual Studio only.) When you create a project with the Setup Wizard, you can override
the default target platform for that particular project. You do this on the Main Project
page of the Setup Wizard. See Entering Project Settings on page 77.
(Wise editor only.) If you specify Select platform in New Installation File dialog in
Wise Options, a Target Platform section appears on the New Installation File dialog when
you select File menu > New. In this section, you can change the default platform when
you create a new installation.
Note
64-bit installations are supported only by Windows Installer 2.0 or later.
z The minimum version of Windows Installer is set to 2.00 in the Installer Version
field on the General Information page. Do not override this setting in a 64-bit
Note
Installations with an Installer Version of 2.0 or later cannot run on Windows NT
4.0, Service Pack 5 or earlier. This is a Microsoft restriction.
z The value Intel64 is added to the Template Summary summary item, which
indicates the platform and language versions supported by the installation. To
display this value, select Setup Editor > Product tab > Summary icon. Do not
change this value in a 64-bit installation, however, you can change the language ID.
z The Directory table contains additional folders with “64” appended to their names.
z The Files and Visual Studio Solution pages contain an additional predefined
directory, Program Files (x86).
z The Read Registry Value dialog contains a checkbox that lets you include 64-bit
components in a registry value search. See Searching For a Registry Value on
page 173.
z When you create a custom action that calls a JScript or VBScript file, a checkbox lets
you call a 64-bit script.
z The Target Platform field on the Product Details page provides a quick way to
determine for which platform an installation is enabled. See Product Details Page on
page 92.
Stand-alone installations that are not integrated with a Visual Studio .NET solution do
not have project settings.
z While creating a new installation project, select Setup Wizard on the New Project
dialog. (Professional and Enterprise Editions only.) See Creating an Installation
Within a Solution on page 70.
The Wise Setup Wizard dialog appears. Available pages are: Overview, Project Type,
Projects, and Main Project.
The Property Pages dialog appears. Available pages are: Projects, Project Outputs,
Main Project, Pre-build Event, and Post-build Event.
Note
The Property Pages dialog contains a link to the Configuration Properties page,
however, configuration properties do not apply to Wise editor installation projects.
Also see:
Overview Page
¾ Visual Studio integrated editor only.
The Overview page summarizes the project settings for the project you are creating.
Review the settings to make sure they are correct. To change these settings, click the
links at the left to access the Project Type, Projects, or Main Project pages.
Also see:
z Windows Application
Create a standard Windows Installer installation (.WSI). This is intended for
installation to Windows computers or servers. See Creating an Installation Within a
Solution.
z Server Application
Create a standard Windows Installer installation (.WSI). This is the same as the Web
Application above except that it also prompts the end user to enter valid NT logon
information. See Obtaining Logon Information From a Dialog on page 450.
z Merge Module
Create a standard merge module project (.WSM). See Creating a Merge Module
Within a Solution on page 336.
Also see:
Projects Page
¾ Visual Studio integrated editor only.
On the Projects page, you select projects to add to the installation you are creating.
Access this page either from the Wise Setup Wizard when you create a new installation,
or by right-clicking a project in a solution and selecting Properties.
If you add a project to this solution later, it will be added to the project list and
selected for inclusion.
z Scan Method
Each time you load, save, or build an installation project or change its settings, Wise
for Windows Installer can scan projects in the solution for new files to add to the
installation. See Scanning the Solution for New Files on page 82.
Specify the level of scanning that will occur for this installation. The default is
determined by the Scan Method option in Wise Options.
Also see:
z Main Project
Select the project that generates the main target, or executable file, for your
application. (Example: If the main executable for the project is Sample.exe, you
would select the project that generates Sample.exe.) When you select a project, a
shortcut is generated for the main target and the version number in the Wise
project is updated from the main target.
If you select <None>, or if you are in a merge module, shortcut generation and
version updating does not occur.
z Create Shortcut
Mark this to add a shortcut for the main target file to the installation. The default is
determined by a checkbox in Wise Options. This is disabled if you select <None> in
Main Project.
z Target Platform
(Wise Setup Wizard only.) This defaults to the Target Platform Selection in Wise
Options. You can change the target platform for this particular installation project.
Because you cannot change the target platform after the project is created, this
option does not appear on the Property Pages dialog.
Also see:
Pre-build Event
¾ Visual Studio integrated editor only.
The Pre-build Event page lets you add to a project anything that is needed before the
build occurs. Example: You can copy something to a source where you need it.
Access this page by right-clicking a project in Solution Explorer and selecting Properties.
You can use any DOS command to create command lines for this build event. You can
add as many command lines as needed.
Post-build Event
¾ Visual Studio integrated editor only.
The Post-build Event page lets you add to a project anything that is needed after the
build occurs. Example: You can copy an .MSI to the network.
Access this page by right-clicking a project in Solution Explorer and selecting Properties.
You can use any DOS command to create command lines for this build event. You can
add as many command lines as needed.
This page is accessible only on the Project Properties dialog. Right-click a project in a
solution and select Properties.
z Project
Select the project to specify additional outputs for.
z Output Groups
Select one or more types of output files to include in the installation:
Debug Symbols
Include the project’s debugging (.PDB) files.
Localized Resources
Include files marked as resources for the project. Example: additional files for a
specific language.
Source Files
Include all source code files in the project.
Content Files
Include all files marked as content within the project, that is, files that are not
compiled but are meant to be distributed with the application. Examples: HTML,
ASP, and ASPX files.
Primary Output
Include the .DLL or .EXE built by the project.
Also see:
When you add an installation to a Visual Studio .NET solution, as described in Creating
an Installation Within a Solution on page 70, the following items are added to the
installation project:
z All primary outputs (.EXEs and .DLLs) of the projects in the solution, and all content
files in the solution. (Content files are not compiled but are meant to be distributed
with the application. Examples: HTML, ASP, and ASPX files.) When a project consists
only of a .DLL or .OCX, has no additional content, and is a dependent of another
project, it is not added to the installation by default.
To add other outputs to the installation, select them on the Project Outputs page in
the project settings.
Wise for Windows Installer can scan for files you add or delete after you’ve created
the installation project, and can add them to or delete them from the project. See
Scanning the Solution for New Files on page 82.
z Assembly dependencies, if you have selected one of the rescan assembly options in
Wise Options.
View these in Installation Expert > Files page or Visual Studio Solution page.
z The application name, version, and manufacturer from the main project in the
solution.
View these in Installation Expert > Product Details page. The default directory is
filled in with the same name as the main project. You can change the main project
on the Main Project page in the project settings.
Note
Except for the product version, once the information on the Product Details page is
set, it does not change if you change the information in the main project.
When you add a new project to the solution, its outputs are added to the installation.
To exclude a project from the installation, or to change how the installation project
integrates with the solution, edit the installation’s project settings. See Entering Project
Settings on page 77.
Note
Only files that reside in the directory where the solution (.sln) file resides and its
subdirectories can be managed with source control. Files that reside in system
directories or other locations outside the solution directory are not managed by source
control, and therefore do not appear in the Other Files or Source Files folders under the
installation project in Solution Explorer.
How and when the solution is scanned is determined by the Scan Method option. The
default is set in Wise Options and can be changed for specific installations on the
Projects page in the project settings. See Setting Visual Studio Options on page 53 and
Projects Page on page 79.
z If you add an existing .WSI to a solution, the .WSI project’s original scan method
setting is preserved.
z If you add an existing .WSI project to a solution and no scan method setting is
found, the default scan method is used.
You can specify the level of scanning that should occur for each installation. See Projects
Page on page 79.
z Edit the destination feature and target directory by clicking a file and editing the
appropriate cell.
z Add and edit multiple files at once by selecting them and clicking the Properties
button. On the Project Output Properties dialog that appears, you can add a new
feature and add a new directory for all of the selected files.
Note
In a Web installation, you can only change the destination feature.
You might want to change an installation’s scan method at various stages of the
development cycle. Example:
z At the beginning of a development project when you are continually creating new
projects and files, you would want to add all new files automatically.
z As development continues and you become more discriminating about the files you
add to the installation, you might want to be prompted to add files.
z At the end of the development cycle, you can turn the scanning off altogether so
you don’t introduce any new files into the installation.
Also see How the Installation Integrates With the Solution on page 81.
Open dialogs show different tabs according to which edition you have and what tool you
are using. The Open dialog might contain two or more tabs that let you open different
items:
The package opens from its location in the repository. Typically, this is the
Scripts directory or your default project directory.
If the package status is Available, you are prompted to change the status to
Under Development.
Caution
Use caution when changing available packages, because they might have been
deployed to end users.
If you try to save the package, a prompt asks if you want to overwrite the file
that is in the repository.
z Groups tab: Opens a group from the Wise Software Repository. This is only available
for some tools.
Packages are displayed in the list box if they have a valid path to an installation file
(.MSI, .WSI, and so on). If a package’s path to its installation file is missing or
broken, or is not accessible by the current computer, that package is not listed. Also,
subscription packages are not listed.
The Select Data Source dialog appears. This is a standard Windows ODBC
connection wizard, which lets you connect to a database via an ODBC data source.
3. Specify criteria for filtering the packages that are displayed above:
Groups
This lists the groups defined in Software Manager.
Status
This lists the possible package statuses.
Package Type
This lists the available package types.
If you change an installation that you opened from the repository, re-import it into the
Software Manager database. Otherwise, changes will not be reflected in the repository.
2. Database displays the current Software Manager database. To select a group from
a different database, click .
The Select Data Source dialog appears. This is a standard Windows ODBC
connection wizard, which lets you connect to a database via an ODBC data source.
z Compare any 2 files. (Not available in the Visual Studio integrated editor.)
z Compare a transform to its base .MSI, to see the items that the transform changes
in the .MSI.
2. Select Tools menu > Visual MSIDiff and then select an option. (In Visual Studio:
Project menu > Visual MSIDiff.)
You are taken to Setup Editor > Tables tab and the Visual MSIDiff Key dialog
appears, which describes icons that indicate changes. Changes are shown in the
tables and rows where they occur.
3. On the Visual MSIDiff Key dialog, take note of the symbols and colors that indicate
changes and click OK.
If the Visual MSIDiff Key dialog does not appear, you might have marked its Do not
show this dialog again checkbox. You can reactivate this prompt in Wise Options.
4. Scroll through tables on the Tables tab, looking for the symbols for changed tables.
Click on changed tables to view differences in rows, which are indicated by symbols
and colors.
As you work in the installation file, the symbols indicating changed items are
updated dynamically. The compare stays on until you end it.
5. To end the compare, select Tools menu > Visual MSIDiff > End Current Compare.
(In Visual Studio: Project menu > Visual MSIDiff > End Current Compare.) This
turns off compare symbols and closes the comparison file.
You can also launch Wise for Windows Installer in the Visual MSIDiff mode from a
command line. See Command Line Options For WFWI.EXE on page 217.
You can set a global option in Wise Options to create an XML copy every time you save
an installation file, or you can export to an XML file on an as-needed basis. Depending
on the size of the installation file, creating an XML copy can take several minutes.
1. Select Tools menu > Options and click the General tab. (In Visual Studio: Tools >
Options > Wise Options > General.)
This global option causes an XML copy to be created every time you save an installation
file. The copy has the same name as the installation file with the extension .XML
appended, and it is saved in the same directory. (Example: If the current file name is
Application.wsi, the XML copy is named Application.wsi.xml.)
1. Select File menu > Export to XML. (In Visual Studio: Project > Export to XML.)
2. In the Save As dialog that appears, specify a file name with the extension .XML and
click Save.
If you have not named the installation file yet, name and save the installation file on
the Save As dialog. When the Save As dialog reappears, specify the .XML file.
If you edit the installation’s meta data, the meta data in the database is updated when
you save the installation. If you change the installation, re-import it to the Software
Manager database to update its resources.
Example: You want to create a patch for an installation that is in the Software Manager
database. You open a copy of the installation file to change it. Before you save the
installation, you change its package name on the Product Details page. When you save
the installation, a new package with the same application name, and its meta data, are
added to the database.
z Work Disconnected
Mark this to keep the installation file disconnected from the Software Manager
database. When you save the installation, its meta data is not added to the
database.
To connect the installation file to the Software Manager database, change the
application or package name on the Product Details page and save the installation.
A new package and its meta data are added to the database.
z Test the installation, which appears to run but does not make any modifications on
your system. See Testing An Installation on page 89.
z Debug the installation in an .MSI debugger, which lets you step through the
installation while viewing the property values and other table data. This actually
runs the installation, and lets you see exactly what it is doing at any time. See
Running the Debugger on page 463. The Debugger for Windows Installer is available
in the Professional and Enterprise Editions only.
z Run the compiled installation, which is either an .MSI or an .EXE. See Running An
Installation on page 90.
Note
When working in a .WSI, you can set the installation to generate more than one
installation program by adding releases to the Releases page. If you test, debug, or run
an installation that contains multiple releases, you are prompted to select a release.
Compiling An Installation
Compiling an installation compresses its files, builds .CABs if necessary, and creates the
installation .MSI. Depending on the .EXE option you select on the Build Options page,
compiling can also create an installation .EXE. (In Visual Studio: compiling and building
do the same thing.)
The number and type of files generated depend on the settings you select on the Build
Options and Media pages. If the installation contains multiple releases, all releases in
the installation are compiled. To compile a specific release, go to the Releases page,
select one or more releases, and click the Compile button at the right of the Releases
page.
If you are working in a .WSI or .WSM file, you can speed the compile process by
marking the Enable Quick Compile checkbox in Wise Options. Quick Compile
compresses only previously uncompressed or changed files. If a file or media entry has
changed, a full compile occurs instead. You can also speed compile time by using
ExpressBuild, a multi-processor compile feature in the Professional and Enterprise
Editions. See the description of Quick Compile in Setting General Options on page 39
and see Setting ExpressBuild Options on page 44.
z Build Solution
Compiles all projects in the current solution. If quick compile is enabled and you
have already built this solution, this command compiles only what has changed
since the last build.
z Rebuild Solution
Compiles all files in all projects in the solution.
z Compile
Compiles the current project or installation file. This is the only command available
for installations that are not part of a Visual Studio .NET installation.
Compile Results
If you are working in an .MSI or .MSM, compiling saves the file. If file paths are stored in
the .MSI, compiling first refreshes the files with the latest version. If files cannot be
read, or other errors occur, errors are listed in the Task List. (In Visual Studio: errors
appear in the Visual Studio .NET Output window as they are encountered and then, at
the end of the compile, they are listed in the Task List.) Use the Task List to determine
the source of the errors; see Using the Task List on page 26.
If you see messages that files are missing, you can suppress the file refresh by marking
the Don’t update or recompress files when saving checkbox on the Product Details
page. If merge modules are missing, you can download them using Help menu >
Download Redistributables. (In Visual Studio: Help menu > Wise Help > Download
Redistributables.)
Also see:
Testing An Installation
You can compile and test an installation in test mode, which does not install or modify
files or change the system. This lets you run through the UI and logic of an installation
without making changes. Click Test at the lower right of the main window. (In Visual
Studio: select Project menu > Start in Test Mode.)
If you have added command lines to the Command Line page, when you click Test, a
menu appears with further options. The menu contains the names of all command lines
you’ve created. You can test with a command line by selecting its name. To avoid having
to select from the button menu, press Ctrl+T to test with no command line.
If this installation contains multiple releases, you are prompted to select one.
You cannot test a transform or a merge module by itself. It can only be run in
conjunction with an .MSI. To run a transform or merge module, run the base .MSI from
the command line with the appropriate command line options, which are documented in
the Windows Installer SDK Help.
Note
If you change the installation and then test it, but the change is not apparent, exit the
installation and compile it. Then test it again.
Also see:
Running An Installation
To install an installation on your computer, click Run at the lower right of the main
window. (In Visual Studio: in Solution Explorer, right-click the installation project icon
and select Set as StartUp Project. Then, select Debug menu > Start Without Debugging.
The additional options below are not available.) Then choose the type of installation
from the button menu:
z Force Reinstall
Normally, if an application is installed and you attempt to install it again, Windows
Installer prompts you to remove it. This option uses command lines to bypass the
uninstall. Existing resources are replaced, and new resources are laid down. (The
command line msiexec.exe /FAMSUV [MSIFILENAME] is used. See Command Line
Options in the Windows Installer SDK Help.)
z Run
Runs the installation normally. If the application is already installed, you are
prompted to uninstall it.
If this installation contains multiple releases, you are prompted to select one.
The installation is compiled and then runs as it would on the destination computer,
actually installing files and modifying the system.
You cannot run a transform or a merge module by itself. It can only be run in
conjunction with an .MSI. To run a transform or merge module, run the base .MSI from
the command line with the appropriate command line options, which are documented in
the Windows Installer SDK Help.
Note
If you change the installation and then run it, but the change is not apparent, exit the
installation and compile it. Then run it again.
Also see:
When you start a new installation, you enter information about the installation and the
application, and define the structure of the installation.
Topics include:
z Features Page.
z Links to Installation Expert pages that have content in the current installation and,
where appropriate, the number of items defined on each page. Examples: how
many features are defined on the Features page, how many files have been added
to the Files page, and so on.
z Installation package meta data (read-only). To edit the meta data, see Product
Details Page on page 92.
A checkbox in Wise Options determines whether the Project Summary page appears
when an installation is opened.
Note
The meta data that appears when you create a transform comes from the base .MSI. If
you change a transform’s meta data, it is set when the transform is applied.
(Enterprise Edition only.) If you define meta data fields in Software Manager, they
appear on the Product Details page unless the Software Manager database cannot be
found. You can edit these meta data fields on the Product Details page or in Software
Manager. In Software Manager, you can also change the order in which the meta data
fields appear on the Product Details page. See Defining Custom Meta Data Fields in the
Software Manager Help.
(Enterprise Edition only.) For an .MSI or .WSI, you can add the meta data that appears
on the Product Details page to the Software Manager database. This lets you add
package information to the Software Manager database early in the development
process. It also eliminates the need to enter the meta data manually in Software
Manager and ensures that every package in the database has meta data that meets
your corporate standards. See Adding Meta Data to the Software Manager Database on
page 95. Also see How to Get Packages Into the Software Manager Database in the
Software Manager Help.
Note
(Visual Studio integrated editor only.) Except for the product version, once the
information on the Product Details page is set, it does not change if you change the
information in the main project.
z Application
(Enterprise Edition only.) Enter the name to use for this application in the Software
Manager database. This can be the same as the Product Name meta data field.
This field appears in an .MSI or .WSI only.
z Package
(Enterprise Edition only.) Enter a unique name to identify this package in the
Software Manager database. Typically, you use the Application name plus specific
version information. (Example: If the Application name is Product, the Package
name might be Product 5.05.) This field appears in an .MSI or .WSI only.
z Product Type
(Read-only.) This displays Windows Installer for installations and Transform for
transforms.
z Product Name
Enter the name of the application, which by default is the name of the first directory
you create on the Files or Web Files page. The end user sees this name during
installation and in the Add/Remove Programs dialog.
(Visual Studio integrated editor only.) If this installation is part of a Visual Studio
.NET solution, this is pre-filled.
z Manufacturer
Enter the manufacturer or publisher of the application.
(Visual Studio integrated editor only.) If this installation is part of a Visual Studio
.NET solution, this is pre-filled.
z Version
Enter the version number of the application. Windows Installer uses this to identify
this application when subsequent patches or upgrades are applied. The version
should be in the format AA.BB.CCCC.DDDD, where AA is the major version, BB is
the minor version, CCCC is the build version, and DDDD is optional and ignored. It is
stored as a string data type. See Incrementing the Version on page 96.
(Visual Studio integrated editor only.) If this installation is part of a Visual Studio
.NET solution, this is pre-filled. You can have the version number updated
automatically.
Caution
If you are releasing a newer version of your application but are not using an
upgrade or patch, it is very important to enter a new version on the Product Details
page. Not doing so can cause the installation to open in maintenance mode instead
of in normal installation mode. This can result in an invalid installation that is a
mixture of old and new files, which can cause errors in your application. The only
exception is if the installation contains no new files, no deletion of files, and no other
system changes, which means that only the contents of files are changed.
z Default Directory
During installation, this directory is displayed to the end user on the Destination
Folder dialog, and the end user can change the default location for the application.
(The Destination Folder dialog is called the Single Feature Destination dialog in Wise
for Windows Installer.) This defaults to the first directory you create on the Files or
Web Files page. To change the default directory, select its value, click the Change
button, and select a new directory. See Setting the Default Installation Directory on
page 97.
(Visual Studio integrated editor only.) If this installation is part of a Visual Studio
.NET solution, this is pre-filled.
z Package Path
(Read-only.) This displays the installation file’s location.
z Repository ID
(Enterprise Edition only) (Read-only.) This displays the package’s unique identifier in
the Wise Software Repository, which Wise for Windows Installer generates in the
form of a GUID. This ID is generated when you save or compile an installation after
entering the application and package names. It is also generated when you import a
package in Software Manager, if it does not already exist.
z Product Code
Every Windows Installer installation must have a unique product code, which is used
as the principal identification for the application. Wise for Windows Installer
generates a product code in the form of a GUID, which ensures that no 2
applications ever have the same product code. To change the product code:
On the dialog that appears, click Yes to change the product code and the
upgrade code, or click No to change just the product code. If the installation is
an upgrade of an existing installation, then change the product code only. For
information on the upgrade code, see Upgrades on page 311.
Changing the product code also changes the package code. For information on
the product and package codes, see ProductCode Property, Package Codes, and
Product Codes in the Windows Installer SDK Help. Also see About GUIDs on
page 524.
z Target Platform
(Professional and Enterprise Editions only.) This read-only field displays the platform
for which this installation is enabled, 64-bit or 32-bit.The platform is set when you
create the installation. To change the target platform for future installations, see
Setting the Default Target Platform on page 52.
z Application Type
(Professional and Enterprise Editions only.) Specify whether this is a standard Win32
or a .NET installation. This also determines how Wise for Windows Installer handles
The ability to create .NET installations is supported only by Windows Installer 2.0 or
later.
.NET Application
Select this if this is a .NET installation with only .NET elements.
When the .NET Application or Mixed option is selected, entries are created in the
MsiAssembly and MsiAssemblyName tables for each assembly you add to the
installation. The Global Assembly Cache directory also appears on the Files page.
z Installation Target
(Professional and Enterprise Editions only.) This value is for meta data purposes
only. It does not change the installation.
Windows-based desktop/server PC
Mark this if the installation does not install a Web service to an IIS server. This
is the default except for Web and server applications.
z Description
Describe the package. In the Enterprise edition, this becomes part of the package
meta data when the package is imported into the Software Manager database.
If you clear this checkbox, files that are set to be compressed are not re-
compressed when you save or compile. (Compression options are on the Media
page.)
2. Enter the Application and Package names. These fields appear in an .MSI or .WSI
only. See Product Details Page on page 92.
If this is the first time you’ve saved the installation, the Save As dialog appears. (In
Visual Studio: the Save File As dialog appears.) Enter a name for the file and click
Save.
4. If a package with the same application and package name is already in the Software
Manager database, a warning message appears. Click OK and change either the
application or package name to create a new package in Software Manager.
When you save the installation, its meta data is added to the Software Manager
database and the Repository ID field is populated.
What happens when you add meta data to the Software Manager
database?
z The meta data appears in Software Manager on the Package pane and the Package
Attributes dialog. See About the Software Manager Window and Viewing and Editing
Package Attributes in the Software Manager Help.
This only adds the package’s meta data to the Software Manager database. It does
not import the package’s resources. To import the package’s resources, see Package
Import in the Software Manager Help.
z The package is assigned a status of New in Software Manager. You cannot change to
or from this status manually. A New package is changed to Under Development only
when you use the Import Wizard to import its resource information.
z The package is assigned a repository ID in the form of a GUID. If you make a copy
of the installation and change the copies application or package name, it is assigned
a new repository ID.
z The Application and Package fields on the Product Details page are disabled. You
can edit them on the Package Attributes dialog in Software Manager. See Viewing
and Editing Package Attributes in the Software Manager Help.
If you open an installation file that is a copy of the package in the Software Manager
database, the Application and Package fields are populated and enabled. Change
one or both of these fields before saving the installation to avoid overwriting the
package in the database. See Working With Installations in the Software Manager
Database on page 87.
z If you edit meta data on the Product Details page, the meta data in the Software
Manager database is updated when you save the installation. If you edit meta data
in Software Manager, your edits appear on the Product Details page the next time
you open the installation.
Also see How to Get Packages Into the Software Manager Database in the Software
Manager Help.
(Visual Studio integrated editor only.) If an installation is part of a Visual Studio .NET
solution, you can have the version number updated whenever the version number of the
main target file changes. To enable version updating, mark the Automatically Update
The Version Number checkbox on the Main Project page of the Property Pages dialog.
See Main Project Page on page 80.
z When you create, remove, or edit any other items besides files. Examples: services,
ODBC, runtimes, registry, and so on.
z If you plan to create a patch that updates earlier versions to this version.
z When you include upgrade entries on the Upgrades page of versions that this
installation will upgrade.
On the Product Details page, you can change the default installation directory and reset
the default directories for features that use this directory. You can also create a new
directory as a child, or subdirectory, of an existing directory.
Note
When end users install your application, sometimes the installation directory defaults to
the C:\ drive, and other times it defaults to another drive. This happens because
Windows Installer automatically determines which drive has the most free space.
1. In Installation Expert > Product Details page, select the Default Directory value and
click the Change button.
The Set Default Install Directory dialog appears. The Default Directory drop-down
list contains all the directories accessed by this installation, including Windows
predefined directories.
If the directory you want is not listed, add it in Installation Expert > Files page.
4. Click OK.
For information on summary items, see Summary Property Descriptions in the Windows
Installer SDK Help.
z Title
Enter the name of the application. This field often includes a version number.
z Subject
Enter a brief description of the application.
z Author
Enter the author or publisher of the application. This field often includes a copyright
notice.
z Keywords
Enter a list of keywords that the end user can use to search for this installation in
Windows Explorer.
z Installer Version
(Read-only.) This displays the minimum Windows Installer version required on the
destination computer to run this installation. This is not the version of the
application. If the destination computer has an earlier version of Windows Installer,
the installation fails.
To change this version, select Setup Editor > Product tab, click the Summary icon in
the left pane, and double-click Minimum Installer Version in the upper right pane.
Microsoft Restrictions:
Installations with a Windows Installer version of 3.0 cannot run on Windows 95,
98, Me, or NT 4.0.
Windows Installer version 3.0 requires Windows 2000 Service Pack 3 or later,
Windows XP, or Windows Server 2003.
z Comments
Enter comments about the application that this installation installs.
Display Icon
Specify an icon to appear next to the application name in Add/Remove
Programs. If you leave this blank, a generic icon is used. Click Browse to select
a file from the installation. If the file exists on disk, you also see an icon
selection dialog where you select the icon.
Icon Number
Enter the icon resource ID (preceded by -) or the icon number for the specified
icon. Because a file can contain multiple icons, icons in a file are numbered,
starting from zero. This is pre-filled if you selected an icon from the icon
selection dialog.
Contact Person
Enter the name of a person or department that end users can contact if they
have questions. Examples: a support technician or the support department.
Phone Number
Enter the phone number for the contact person specified above.
Help URL
Enter the path to a help file that will be installed on the destination computer.
Comments
Enter any additional comments for the end user.
Features Page
Use Installation Expert > Features page to create the structure of an installation by
defining:
z How those features are presented to the end user during installation.
Determine your application’s features and conditions before configuring other aspects of
the installation, because many of the pages in Installation Expert have a Current
Feature drop-down list that lets you set options on a per-feature and per-condition
basis.
For information on what features are and how they are used, see Working With
Components and Features on page 523.
Note
The Wise Installation System and WiseScript Editor refer to features as “components.”
To see a tree structure that lists all components, merge modules, files, registry entries,
and other installation items associated with each feature, use Setup Editor > Features
tab.
To specify which features are installed by default if the end user selects a Complete,
Typical, or Custom installation type on the Installation Type Dialog, use the Installation
Types page. See Setting Features for Installation Types on page 175.
In an installation with multiple releases, you can deselect certain features for certain
releases on the Release Settings page. See Defining a Feature Set for a Release on
page 183.
z To add a new feature, click its parent feature and click the Add button at the right of
the page. See Adding a New Feature on page 103.
z To configure installation options for a feature, click its icon ( ) and select an
option from its drop-down list. See Configuring a Feature Using Its Drop-Down List.
z To configure all items for a feature, click its name and click Details at the right of the
Features page. See Configuring a Feature Using the Feature Details Dialog on
page 105.
z To delete a feature or condition, click its name and click Delete at the right of the
page. When you delete a feature, all its child features and conditions are deleted
also.
z To rearrange features, click Move Up and Move Down at the right of the page. You
can move features within their current level only, in their current sibling group. You
cannot move features to their parent or child levels.
z To add a condition to a feature, click its name and click Add Condition at the right of
the page. See Using Conditions With Features on page 108 and Adding and Deleting
Feature Conditions on page 109.
z Display the features’ titles as they appear on the Select Feature dialog during
installation rather than the features’ names, which are used by Windows Installer.
Any display option you select from the right-click menu overrides the corresponding
setting in Wise Options.
2. On the Files page, add a file to each feature. Select the feature from the Current
Feature drop-down list before adding the file.
3. On the Dialogs page, clear the checkbox for Installation Type Dialog, and mark
the checkbox for Select Feature Dialog.
4. Click Test in the lower right corner of the main window. (In Visual Studio: select
Project menu > Start in Test mode.)
The Select Feature dialog in the installation program reflects the options that you set on
the Features page.
Features in an installation appear in a tree structure, which lets you place features in
hierarchical relationships. You can add a feature at the same level as another feature
(sibling level) or as a child of another feature. Sibling features can be installed
independently of each other, while child features can be installed only if their parent
feature is installed.
The core resources for an application should always be in a top-level feature. The core
feature should install a functioning version of your application; it should have no
dependencies on resources that are in optional features.
Conditions.
In Installation Expert > Features page, click the feature name under which the
new feature should appear. Then click Add at the right of the Features page.
To add the new feature at the top level, click Installation Features; to add the
new feature under a feature, click the feature’s name.
In Setup Editor > Features tab, right-click the feature under which the new
feature should appear, and select New > Feature.
To add the new feature at the top level, right-click the Features icon; to add the
new feature under a feature, right-click the feature’s name.
2. Complete the dialog. See Configuring a Feature Using the Feature Details Dialog on
page 105.
4. The order in which features appear on the Features page determines the order of
the features on the Select Features dialog that appears during installation. To
rearrange the order, select a feature name and click Move Up or Move Down at the
right of the Features page.
To edit a feature’s settings, double-click its name. To rename a feature, right-click its
name, select Rename, and enter a new name. To delete a feature and its child features,
right-click its name and select Delete.
Also see:
The drop-down list options are a subset of the options available in the Feature Details
dialog, which you access by clicking the Details button at the right of the Features page.
Note
The first 4 options in the feature’s drop-down list set the default only; the end user can
change the default during installation. To prevent the end user from being able to
change the defaults you set here, you can turn off the Select Feature dialog on the
Dialogs page, use the Feature Details dialog to set features to be required, or set
features to be hidden from the end user.
If a feature is advertised, it is available to the application and visible to the end user,
but is not actually installed on the hard drive. If the installation source, such as a
CD-ROM or shared network directory, is available to the destination computer, the
feature is installed when the end user invokes the feature. If the installation source
is not available, the end user is prompted for the installation source.
Also see:
(Visual Studio integrated editor only.) The Feature Details dialog also appears when you
click the Add New Feature button on the Add Project Outputs to Installation dialog. This
dialog appears during save, build, or compile when the scan method is set to prompt.
See Scanning the Solution for New Files on page 82.
For technical information on the fields in this dialog, see Feature Table in the Windows
Installer SDK Help.
Note
Some options in this dialog set the default only; the end user can change the default
during installation. To prevent the end user from being able to change the defaults you
set, you can turn off the Select Feature dialog on the Dialogs page, set features to be
required, or set features to be hidden.
z Name
Enter the name of the feature, which is used internally by Windows Installer.
z Title
Enter text to identify the feature. This text appears on the Select Features dialog
during installation.
z Parent
This list contains all features in the installation. To change the feature’s parent, and
therefore the feature tree, select from this list. This lets you change the feature tree
in Installation Expert or Setup Editor instead of editing tables.
z Description
Enter a multi-line description of the feature. This appears if the end user selects a
feature on the Select Features dialog during installation. This text must fit in the
Feature Description area of the Select Features dialog.
z Level
If you are using the Installation Types page to determine which features to install for
a Typical or Complete installation, you can skip this field. If not, specify whether this
feature is installed for a Typical or Complete installation. The end user chooses
Typical, Complete, or Custom in the Installation Type dialog (also called Select
Installation Type). During a Custom installation, the end user can turn features on
or off individually.
Normal
Set the feature’s level value to 3, which means that it gets installed by default
for either Typical or Complete.
Custom
Set the feature’s installation level value yourself. Example: if you want a feature
to be installed for a Complete installation, but not for a Typical installation, set a
custom level value that’s greater than 3 and less than or equal to 1000. The
Custom Value field becomes available.
z Custom Value
If Custom is selected in Level above, enter the level value for the feature in this
field. For details, read the description of Level, above.
Note
The end user’s action in the Installation Type dialog determines the INSTALLLEVEL
property. To see how this works, go to Setup Editor > Dialogs tab and click the
Installation Type Dialog in the list. Double-click the Typical/Complete/Custom radio
button, and you see that the end user’s choice in this radio group sets the property
InstallMode. If you then double-click Next on the Installation Type dialog and view
the Events tab, you see that, based on the InstallMode value, the installation
property INSTALLLEVEL is set to either 3 or 1000.
z Display
Specify if and how the feature is displayed to the end user in the Select Feature
dialog during installation.
Invisible
Do not display the feature.
z Attributes
Specify the default for the feature in the installation. The end user can change the
default.
Favor Local
The feature should be installed on the destination computer.
Favor Source
The feature should be run from the source CD or network directory. This means
the feature is available to the application, but is not installed on the local hard
drive. When the feature is invoked, your application must call Windows Installer
functions (example: MsiGetComponentPath) to locate and read the necessary
files from the installation source, which might be a CD or shared network
directory. A typical use of this option would be to specify a clip art library to run
from the source. Then you must code your application to attempt to read from
the installation source when the end user tries to use the clip art library.
Favor Parent
The feature should use the same attribute setting as its parent feature. If you
select this option, you must also set the installation to generate uncompressed
external files that can run from the source. See the description of Media Type
in Adding a Media Item on page 202.
z Advertising
Specify the default setting for how this feature supports advertising. If a feature is
advertised, it is not installed, but it appears to be installed to the end user. Example:
The end user might see shortcuts or menu options for an advertised feature, or the
system might have certain entry points to the feature, such as a registered file
extension, that can initiate installation-on-demand of an advertised feature.
None
By default, the feature is set to be installed, not advertised.
Favor Advertising
By default, the feature is set to be advertised.
Disallow Advertising
The feature is set to be installed, not advertised, and the end user cannot
change the default.
Note
Advertising is only supported on certain platforms. To suppress advertising on
unsupported platforms, mark Disable advertising if not supported by OS below.
See Platform Support of Advertisement in the Windows Installer SDK Help.
z Directory
To let end users select the directory for this feature, select a directory from this list.
When the end user selects this feature in the Select Feature dialog during
installation, the Browse button becomes enabled so that they can select a new
directory. Child features of this feature inherit the new directory selected by the end
user. If you leave the directory set to <none>, then the files for this feature are
installed in the directory structure specified on the Files page.
To ensure that two features always get installed to the same directory, select the
same option in Directory for both features.
If you let end users select directories for individual features, you must code your
application in such a way that it can locate the features wherever they might be
placed by the end user. To do this, you can call Windows Installer functions, such as
MsiGetComponentPath.
Note
Only the files that are in the directory you select or in its child directories will be
installed in the new directory that the end user selects. Example: Suppose FeatureA
installs File1 in the Sample\FeatureA\ directory and File2 in the Windows directory.
During installation, the end user specifies Sample\A\ for the new directory. Only
File1, which was originally in the FeatureA\ directory, is actually installed in the A\
directory. File2 is still installed in the Windows directory.
z Required Feature
Mark this if the feature is required for installation. During installation, end users
cannot deactivate installation of a required feature. If you select Never install this
feature in Level (above), it overrides this option.
Also see Configuring a Feature Using Its Drop-Down List on page 104.
Example:
Suppose your core application files are stored in a feature named Application. If your
application is installed on Windows 95, 98, or Me, you want to also install
Application9x.dll, but if your application is installed on Windows NT, 2000, XP, or Server
2003, you want to install ApplicationNT.dll. You do not want to install both .DLLs, but
instead want to install one or the other based on the version of the operating system. To
do this, you:
z On the Files page, select the VersionNT condition from the Current Feature drop-
down list, then add the ApplicationNT.dll file.
z On the Files page, select the Version9X condition from the Current Feature drop-
down list, then add the Application9x.dll file.
During installation, the files contained within the conditions are installed only if the
condition is true.
Version9X and VersionNT are properties that are set by Windows Installer. See
VersionNT Property and Version9X Property in the Windows Installer SDK Help.
Also see:
4. Click Build, and create your condition in the Condition Builder dialog.
The Condition Builder dialog lets you construct a conditional expression and check
its syntax. For details, see Creating Conditions With Condition Builder on page 411.
Note
If you add a component condition that checks the installed state of a component or
feature, add the merge module CondFix.msm to the installation. This merge module
fixes a Windows Installer limitation. For details, see WiseFixConditions on page 411.
The condition appears in the Current Feature drop-down list. If you want to make file
changes or other system changes on the destination computer only if this condition is
true, you first select this condition from the Current Feature drop-down list.
To delete a condition:
1. Select Installation Expert > Features page
2. Select a condition.
You are prompted to choose what to do with the components that are associated
with the condition. Conditions can contain files, registry entries, and so on, all of
which make up components. When you delete a condition, one of 2 things can
happen:
You can delete all the components that have been added to the condition.
You can move all the components associated with the condition to the
condition’s parent feature. If you choose to move the components, they are
placed under the parent feature, and are installed unconditionally.
edit and update peripheral files. (Examples: graphics you might have added for an
installation dialog or .DLLs you might call with a custom action.) Any changes you make
here are reflected in the Binary table that you can access in Setup Editor > Tables tab.
The Resources page also lets you link binary data to its source files, by marking binary
resources to be refreshed. As a result, the binary data is updated during compile with
any modification that might have been made to the source file.
Note
The Resources page might contain entries you did not add, such as images, icons, and
Wise .DLL files. The images and icons appear on wizard dialogs during installation. If you
are using the default installation wizard, do not delete these resource entries; otherwise
you might encounter errors during compile. The Wise .DLL files support advanced
functionality that you add to an installation (example: custom actions). Removing or
refreshing these files can result in advanced functionality ceasing to work correctly.
z File Name
Path to the source file that contains the binary data. <Unspecified> in this column
indicates that the source file is not known. (Example: This is the case when an
installation includes a third-party .MSI.) Unspecified entries are stored in the .MSI
and cannot be updated during compile.
z Refresh
Mark this to update the binary data during compile, to reflect any changes made in
the source file. See Refreshing Binary Resources on page 111.
z To add binary resources to an installation, click Add at the right of the page. See
Adding Binary Resources on page 111.
z To delete a selected binary resource from the installation, click Delete at the right of
the page.
z To edit a selected source file, click Edit at the right of the page. The file opens in an
appropriate application or you are prompted to select an application. Make the
changes and save the file.
z To copy binary data into a new source file, click Save As at the right of the page. You
might do this to extract a file stored in an .MSI (with an <Unspecified> file name) to
your disk.
Note
If you’ve saved a resource with an unspecified source file to a new file, don’t save
the installation until you verify that you selected the appropriate file extension. To
do this, select the resource on the Resources page and click the Edit button at the
right of the page. The file should open in an appropriate application. If it doesn’t,
select Edit menu > Reset Page and save the resource again, using a different
extension.
Name
Enter a descriptive name for the data you’re adding. This name appears on the
Resources page and in the Binary table. If you leave this blank, the name of the
source file is used instead.
File Name
Specify the file that contains the binary data.
Note
You can create or remove this link later, by marking or clearing the checkbox in
the Refresh column on the Resources page.
3. Click OK.
z Mark the corresponding checkbox in the Refresh column on the Resources page.
z Mark the Create/update link to refresh data when file changes checkbox on
the Resource Details dialog.
You can only refresh binary resources with known source files. If you try to mark the
Refresh checkbox for a resource whose source file is shown as unspecified, you are
prompted to export the data to a new source file.
z Use the Resource Details dialog to update the pathname for the source file.
z Clear the Refresh checkbox and use the existing entry for the resource in the Binary
table.
If an error message appears when you try to clear the Refresh checkbox, it means
that the Binary table does not have an entry for this resource. Example: This can
happen if you’re working with a .WSI and the source file was changed while the
project file was closed. In this case, you must use the Resource Details dialog and
set a source file for the binary resource, if you don’t want to delete it.
The Feature Details page group of Installation Expert lets you add files and other system
changes to an installation. For information on Installation Expert, see Using Installation
Expert on page 20.
Topics include:
z Registry Page.
z Shortcuts Page.
z Services Page.
On the Web Files page, you also can add Web sites, virtual directories, and Web folders,
and set their options. The Web Files page displays items to be installed to a Microsoft
Internet Information Services Web server, while the Files page displays all items to be
installed. For a summary of differences between the two pages, as well as links to Web-
related functionality, see About Web Installations on page 222.
(Visual Studio integrated editor only.) If an installation is part of a Visual Studio .NET
solution, all primary outputs (.EXEs and .DLLs) of the projects in the solution are added
to the Files page when you create the installation. To add other outputs to the
installation, select them on the Project Outputs page in the project settings. Files you
add to the solution later can also be added automatically. (See Scanning the Solution for
New Files on page 82.) Use the Files page to organize files into features and to add any
files that are not added automatically. For an alternate view of the files in the solution,
use the Visual Studio Solution Page (page 141).
Also see When to Use the File-Related Installation Expert Pages on page 115.
Current Feature
drop-down list.
Directories
available to Files in the
your computer. directory selected
on the left.
Directories to
be installed on
the destination Files or
computer. operations to be
installed on the
destination
computer.
z Use the right-click menu to expand or collapse folders, to hide or show empty
folders, and to rename folders.
z Drag and drop folders and files to the page and from Windows Explorer, or use the
following buttons:
Add Contents
Add an entire directory to the installation, filter the directory using wildcards,
and link the directory so that the installation’s contents change dynamically as
the directory’s contents change. See Adding Contents of Directories to the
Installation on page 122.
Add File
Add files to the installation. See Adding Files to an Installation on page 117.
New
Create directories to be installed on the destination computer. You also can
create directories in Setup Editor; see Creating a Folder in Setup Editor on
page 389.
Wildcards
Update settings of a directory in the installation; see Editing Settings for
Automatic Updating on page 125.
Operation
Add operations to the installation. See:
To learn about Web-specific functionality of the Web Files page, see About Web
Installations on page 222.
Also see:
Installation Directories
A new installation contains several predefined directories. They appear in the lower left
list box of the Files page, and in the left pane of the Components and Features tabs in
Setup Editor.
z Program Files. Represents the Program Files directory on the destination computer.
z Windows. Represents the system directory (regardless of its actual name) on the
destination computer. Some standard directories are already created under
Windows, such as System32 and Fonts. To create a subdirectory of the system
directory, create it under the Windows directory.
z Program Files (x86). (64-bit installations only.) A 64-bit system has 2 directories for
program files: Program Files, in which 64-bit applications and components are
installed; and Program Files (x86), in which 32-bit applications and components are
installed. See Setting the Default Target Platform on page 52.
z Global Assembly Cache. (.NET installation only.) This is used for assemblies that will
be shared by many applications on the destination computer. It appears only if you
select either .NET Application or Mixed (.NET and Win32) as the application
type on the Product Details page.
z wwwroot. Represents the root of the Web server on the destination computer, which
is typically C:\InetPub\wwwroot\. See About Web Installations on page 222.
You can add new directories on the Files page, the Web Files page, the Components tab,
and the Features tab.
If the directory structure on your computer changes while you are assembling an
installation, change the source directories in the installation, or convert them to relative
or UNC-based source paths. See Source Paths in an Installation on page 324.
Also see:
Icon Represents
Installation file
Web site. These cannot be deleted or renamed from the Files page.
Use the Web Files page instead.
Virtual directory. These cannot be deleted or renamed from the Files
page. Use the Web Files page instead.
Also see:
(Enterprise Edition only.) When you add files to a package that has already been
distributed to the share point directory and imported, you are prompted to add the new
files to the share point directory. If you do so, the .QUE file for that package is reset and
you must re-import the package in Software Manager.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
Items that you add to a feature are installed on the destination computer only if the
feature is installed. Items that you add to a condition are installed only if the feature
is installed and the condition is true.
3. If the directory where the file is to be added is not listed in the lower left list box:
a. Select the directory under which the new directory should be created.
The directory you specify will be created on the destination computer if it does not
exist.
Note
When you add a directory, you might not see it when you select another feature
from Current Feature. To display directories for all features, mark the View
directories for all features on Files page checkbox in Wise Options.
4. In the lower left list box, select the directory to which the file will be added.
5. In the upper list boxes, navigate to a file and double-click it or drag it to the lower
right list box. You can select multiple files.
If you attempt to add files to the Destination Computer icon or the Program Files
directory, you are prompted to first create a folder to hold the files.
The file is added to the selected folder and appears in the lower right list box. If other
dialogs appear, see Additional Dialogs below.
If the Files icon does not appear, right-click and select Hide Empty Folders/Items.
3. To add a new directory, right-click a directory and select New > folder.
The file is added to the selected folder and appears in the upper right pane. If other
dialogs appear, see Additional Dialogs below.
If the Files icon does not appear, right-click and select Hide Empty Folders/Items.
The file is added to the component’s installation directory and appears in the upper right
pane. If other dialogs appear, see Additional Dialogs below.
Additional Dialogs
z If you add a .NET assembly, and if Scan Dependencies in Wise Options is set to
Prompt to scan dependencies, then Wise for Windows Installer:
Displays the Assembly Dependencies dialog, which prompts you to select the
dependencies to add to the installation.
See Adding Assembly Dependencies on page 119.
z If a file that is part of a merge module is added, the Files in Merge Modules dialog
appears. It prompts you to add the merge module and, if necessary, download it.
See Adding Merge Modules Instead of Files on page 120.
z If a file that is used by a package in the Wise Software Repository is added, the Files
in Repository dialog appears and prompts you to add a version of the file that is in
the repository. See Adding Files From the Wise Software Repository on page 121.
(Enterprise Edition only.)
z A File Details dialog appears if you double-click a file. It also appears if you select
multiple files and click Details (Files or Web Files page) or right-click and select
Details (Components and Features tabs). See Editing File Details on page 129.
Also see:
z You use the Import Visual Basic, C#, or J# tool, and you clear the Automatically
add Assembly Dependencies without prompting checkbox on the Select
Configuration dialog. (Not available in the Visual Studio integrated editor.)
If a file that is part of a merge module is added, the Files in Merge Modules dialog
appears. It prompts you to add the merge module and, if necessary, download it. See
Adding Merge Modules Instead of Files.
If a file that is used by a package in the Wise Software Repository is added, the Files in
Repository dialog appears and prompts you to add a version of the file that is in the
repository. See Adding Files From the Wise Software Repository on page 121.
(Enterprise Edition only.)
Note
On .NET Framework versions earlier than 1.1, scanning does not occur when you add an
assembly from a UNC or mapped network drive (example: the share point directory). To
enable scanning of such assemblies, either upgrade to .NET Framework version 1.1 or
later, or change your .NET security so that the share point directory is fully trusted.
If dependencies are found, the Assembly Dependencies dialog appears and lists
dependencies for all added files. To add dependencies to the installation, mark their
checkboxes and click OK.
Example:
The file olepro32.dll is part of a merge module named oleaut32.msm (Microsoft OLE
2.40). Because the file olepro32.dll is meant to function as part of a more
comprehensive merge module, it is better to add the merge module instead of the
individual file.
The merge module might contain other files, registry keys, and dependencies on other
merge modules. If it contains dependencies, the dependent merge modules are added
also. Other files and registry keys that are in the merge module are removed from the
installation to avoid duplication.
If the merge modules or their dependencies are not found, the Download
Redistributables Wizard opens with the appropriate merge modules selected. When you
finish the download, the merge modules are added to the installation.
To make the dialog appear again, click the Prompts tab in Wise Options and activate the
dialog.
Also see:
Example: An approved version of the file Sample.dll is stored in the Wise Software
Repository and is used by several packages in the Software Manager database. When
you add Sample.dll to an installation, you can select the version in the repository as the
source for the file.
The file’s source path is set to the same location as the version in the Wise Software
Repository. You can see the source path on the File Details dialog > General tab.
Caution
If you are working in a Visual Studio solution, selecting a file outside the solution breaks
the integration of the installation with the solution. When you build the solution, the
outside file will not be built. Also, a source file outside the solution cannot be added to
source control.
To make the dialog appear again, click the Prompts tab in Wise Options and activate the
dialog.
Also see:
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
Items that you add to a feature are installed on the destination computer only if the
feature is installed. Items that you add to a condition are installed only if the feature
is installed and the condition is true.
3. In the upper left list box, select a directory whose contents you want to add.
4. In the lower left list box, select a directory where you want to add the contents.
Dest. Directory
Enter the name of the installation directory that will hold the contents of the
directory you’re adding. If you don’t enter a directory name, the contents are
added to the directory that’s selected in the lower list box.
Include Subdirectories
Mark this to add all the subdirectories within the directory you’re adding. The
wildcard settings and update installation settings apply to the subdirectories
also.
Note
If you link a directory using this checkbox and if files originally added by the
wildcard are now missing, a Wildcard Deleted Files dialog appears when you
save the installation. Click No to leave temporarily missing files in the
installation.
If you mark this checkbox, each time you save the installation, it is
synchronized with the current contents of the directory. If you specified
wildcards, the installation is synchronized based on the wildcard criteria. If you
included subdirectories, those directories are updated also. If you don’t mark
this checkbox, you can turn automatic updating on later by using the Wildcard
Details dialog; see Editing Settings for Automatic Updating on page 125.
7. Click OK.
The contents of the directory in the upper left list box are added to the directory you
selected in the lower left list box or to the directory you specified in the Dest.
Directory field. If you marked the Update installation as selected files are
added or removed from source directory checkbox, the linked folder displays
with a small magnifying glass ( ).
Note
When you add a directory, you might not see it when you select another feature
from Current Feature. To display directories for all features, mark the View
directories for all features on Files page checkbox in Wise Options.
Also see:
The Copy Source Files dialog, which appears the first time you save or build a solution
after adding files from outside the solution, lets you copy the source files to the solution
directory. If you click Cancel on the Copy Source Files dialog, that file is not copied and
the dialog will not appear again for that file. If you do not copy source files with the Copy
Source Files dialog, you can use Convert Source Paths instead. See Source Paths in an
Installation on page 324.
Note
Files that you add to the installation from the Wise Software Repository do not appear
on the Copy Source Files dialog, even though they are outside the solution, because you
cannot copy those files to a different directory.
All files that are listed in the dialog are copied to the default solution directory, which is
listed in the Copy To column, and their source paths are changed in the installation.
When the files are successfully copied, they appear in the Source Files tree in Solution
Explorer.
The Change Selected path dialog appears. Current Directory displays the current
location of the file.
Change to
Specify the directory.
Change Sub-Directories
Mark this to copy files in all subdirectories of the current directory.
4. Click OK.
On the Copy Source Files dialog, the new directory path is listed in the Copy To
column.
The files are copied to the locations you specified, and their source paths are
changed in the installation.
Also see:
When you create a .NET installation, you can use the Files or Web Files page to add .NET
assemblies. In the Visual Studio integrated editor, you also can use the Visual Studio
Solution page. When you add a file that is a .NET assembly to an installation, the
MsiAssembly and MsiAssemblyName tables are updated.
If the .NET Framework is installed on your computer, the following tasks are performed
automatically when you add a .NET assembly. If the .NET Framework is not installed,
you must perform these tasks manually; see Creating a .NET Installation Without the
.NET Framework on page 221.
z Files contained in a multifile assembly are added when the main assembly file
(containing the manifest) is added.
z Depending on the Scan Dependencies option in Wise Options, you either enter
assembly dependencies manually, or they are scanned and added automatically, or
they are scanned and you are prompted to add them.
z Assembly attributes are added to the Assembly tab of the File Details dialog.
z In a mixed installation (.NET and Win32), registry keys are added to register .NET
assemblies so that they can be called as though they were COM components.
You can install assemblies into the Global Assembly Cache, the WinSxS directory, or a
private directory. Each of these directories is used in a different way:
WinSxS
To enable side-by-side sharing of a Win32 assembly, install it into the WinSxS directory,
which is under the Windows directory on Windows XP or later. Assemblies installed into
WinSxS must be strongly named. On Windows XP or later, shared assemblies are
installed as side-by-side assemblies. See Side-by-Side Assemblies in the Windows
Installer SDK Help.
Private directory
If an assembly is private, used by only one application, install it into any installation
directory, provided its path contains a maximum of 256 characters. See Private
Assemblies in the Windows Installer SDK Help.
Also see:
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
3. Click the directory name in the lower left list box and click Wildcards at the lower left
of the Files or Web Files page.
The Wildcard Details dialog appears. If the directory is currently linked to directories
on your computer, those directories appear in the Source Directory list.
4. To link the contents of a source directory to this installation directory, click Add,
select a directory from your computer, and click OK.
Whenever the contents of directories in the Source Directory list change, the
installation directory is updated, based on the wildcard settings. Example: Suppose
you link the directory C:\Directory and enter *.exe in Include Wildcards. Later
you add Editor.exe to C:\Directory and remove Paint.exe from C:\Directory. This
installation is updated so that it contains Editor.exe and does not contain Paint.exe.
If you also added Paint.dll to the source directory, it is not added to the installation
directory because it does not match the wildcard criteria.
5. To turn off automatic updating for this installation directory, select each directory in
the Source Directory list and click Delete.
6. To configure a particular source directory, select it in the Source Directory list and
complete the Wildcard Details dialog:
Include Subdirectories
Mark this to add all the subdirectories within the directory you’re adding. The
wildcard settings and update installation settings apply to the subdirectories
also.
Run location
Specify whether new components are installed on the local hard drive (Run
Locally), not installed on the local hard drive (Run From Source), or either.
Change this option only if you plan to integrate Windows Installer function calls
into your application to determine the installed location.
7. Click OK.
8. If a change in the wildcards causes files to be deleted, the Wildcard Deleted Files
dialog appears. Click Yes to remove the listed files from the installation.
The files in the installation directory are updated immediately according to the changes
you made on the Wildcard Details dialog.
Also see:
You can use this operation to remove unneeded files on the destination computer to
keep it in a cleaner state. You also can use it to work around Windows Installer version
rules. Example: If the latest release of an installation uses an older version of a .DLL
than was used in the previous release, the version rules will not allow you to install the
older .DLL. If the installation first removes the newer .DLL from the destination
computer, then the version rules will not prevent the installation of the older .DLL.
Caution
Be very careful when removing files from the destination computer. Do not remove files
unless you are sure that they are not used by another application.
Items that you add to a feature are installed on the destination computer only if
the feature is installed. Items that you add to a condition are installed only if
the feature is installed and the condition is true.
Click Operation below the lower right list box and select Remove File.
Directory
Specify the directory on the destination computer where the file is located or
create a new subdirectory. To create a new subdirectory, select a directory and
click New Folder.
File Name
Specify the name of the file to be removed. You can use wildcards to select
multiple files or you can mark All Files to select all files in the selected
directory.
Remove During
Specify when the file should be removed: during install, uninstall, or both install
and uninstall.
3. Click OK.
The operation to remove a file from the destination computer appears, preceded by .
On the Files or Web Files page, the entry’s Type column contains “Remove.”
To edit it, double-click its name. To delete it, use the right-click menu.
Also see:
You might copy or move files on the destination computer to reorganize the location of
the installation files in a new release. Example: Your application installed graphic files to
C:\Program Files\Application\Graphics, but your latest release installs them to C:\My
Documents\Application. You can add an operation to copy or move the existing graphic
files from the old directory to the new directory.
Caution
Be very careful when moving files on the destination computer. Do not move files unless
you are sure that they are not used by another application.
Items that you add to a feature are installed on the destination computer only if
the feature is installed. Items that you add to a condition are installed only if
the feature is installed and the condition is true.
Click Operation below the lower right list box and select Copy File or Move File.
Source Directory
Specify the directory on the destination computer where the file is located or
create a new subdirectory. To create a new subdirectory, select a directory and
click New Folder.
Dest. Directory
Specify the directory on the destination computer to copy or move the file to or
create a new subdirectory. To create a new subdirectory, select a directory and
click New Folder.
To rename files on the destination computer, make the source and destination
directory the same.
To leave the file name unchanged when it is copied or moved, leave this field
blank. This also works when you use wildcards in the Source File Name field to
select multiple files.
3. Click OK.
The operation to copy or move a file on the destination computer appears, preceded by
the copy icon ( ) or move icon ( ). On the Files or Web Files page, the entry’s Type
column contains “Copy to” or “Move to” followed by the directory to which the file will be
copied or moved.
To edit it, double-click its name. To delete it, use the right-click menu.
Also see:
Note
When you add an operation to remove, move, or copy a file on the destination computer,
an entry for that operation appears on the Files or Web Files page in the lower right list
box. Because the entry is an operation to be performed on a file on the destination
computer, you cannot edit its attributes. However, you can edit the details of the
operation.
(Visual Studio integrated editor only.) On the Visual Studio Solution page, double-click a
file in the lower right list box.
The File Details dialog for multiple files appears. Only a subset of the editing options are
available. You cannot edit permissions, self-registration settings, assembly settings, or
view shared resources. For details, see Editing General File Details on page 130.
Note
If you add a file to an installation, then add it again to a different directory, the second
instance is added as a duplicate file. If you double-click the second file, the Duplicate
File Details dialog appears instead of the File Details dialog. (Also see Creating Duplicate
File Entries on page 389.) With .NET assemblies, if you add the same file to the
application directory and the Global Assembly Cache, a duplicate file is not created
because they are treated as separate components.
Also see:
In Installation Expert: On the Files or Web Files page, double-click a file. In the
Visual Studio integrated editor, you also can use the Visual Studio Solution
page.
Long Filename
The name of the file as displayed on computers running Windows 95 and later.
Short Filename
The 8.3 file name as displayed in DOS or under older versions of Windows.
Specify the short name your application will look for if it is installed on a shared
network directory that doesn’t support long file names.
Source Pathname
The full pathname of the file on your computer. If this is blank, or if it is just a
file name with no path, you might be working in an .MSI, which encapsulates
the file itself.
Font Name
The name of the font contained in the file, if it is a font file.
Read Only
Make the file read-only on the destination computer.
Hidden
Make the file hidden on the destination computer.
System
Designate this file as a system file on the destination computer.
Vital
Mark this if this file must be installed correctly for the installation to succeed. If
the file cannot be installed for any reason, the installation fails.
Self-Register OCX/DLL
(Multiple Files dialog only.) Many files support self-registration (examples:
many .OCXs and some .DLLs). Mark this to self-register these files during the
installation with an unordered registration method.
Duplicate Files
This appears only if this file was added to the installation more than once. The
duplicates are listed here for informational purposes only. You can view and edit
duplicate file entries on the Components and Features tabs in Setup Editor. See
Creating Duplicate File Entries on page 389.
4. Click OK.
Note
With .NET assemblies, if you add the same file to the application directory and the
Global Assembly Cache, a duplicate file is not created because they are treated as
separate components.
Note
Permissions require an NTFS partition and therefore work only under Windows NT, 2000,
XP, and Server 2003. The Permissions tab does not set Web-based security. To set Web-
based security, go to Installation Expert > Web Files, select the directory or virtual
directory, and click the Details button. The Directory Security tab lets you set options for
Microsoft Internet Information Server. See IIS documentation for details on options.
In Installation Expert: On the Files page, select a file or folder and click the
corresponding Details button. In the Visual Studio integrated editor, you also
can use the Visual Studio Solution page. (On the Web Files page, you can set
Web server security, not NTFS security.)
2. On the Permissions tab, click Add, which lets you add a user and specify permissions
for that user.
4. The domain and user names appear in the upper list box, and the list of permissions
is enabled.
Caution
If you set permissions for a folder that is written to by this installation, be sure that the
user installing this application has privileges to write to the folder. Example: Suppose
you give write privileges to ASPNET_USER for Program Files\SampleFolder, which later
in this installation has files written to it. The current user profile running this installation
is ADMINISTRATOR. Therefore installation will fail to write to SampleFolder, because
only ASPNET_USER has write permissions to SampleFolder. ASPNET_USER is
automatically set; see Runtime Properties on page 424.
When you set permissions for a file, the file appears preceded by .
In Installation Expert: On the Files or Web Files page, double-click a file. In the
Visual Studio integrated editor, you also can use the Visual Studio Solution
page.
Registration Method
Do not register
Registration Order
This section lists files you’ve selected for self-registration with the Use order
specified below method. Arrange files in the order in which they need to self-
register. You can only move the file for which you are viewing details.
This checkbox is enabled only if you have the .NET Framework installed on your
computer, and if the file you are viewing is an assembly that was written to
allow COM interop. When the Application Type on the Product Details page is
Mixed (.NET and Win32), this checkbox is marked by default.
4. Click OK.
z For a .NET assembly, use the Assembly tab to enter the assembly attributes. If the
.NET Framework is installed on your computer, this information is filled in from the
assembly manifest and you should not have to change it. Also use the Assembly tab
to specify whether to display the .NET assembly as a reference in Visual Studio .NET
on the destination computer.
z For a Win32 assembly, use the Assembly tab to create and edit a manifest. See
Creating a Win32 Assembly on page 135.
The Assembly tab only appears for files that are keypaths to their components.
3. Complete the dialog. If you have .NET installed on this computer, some of these
options may be preconfigured. If you don’t have .NET, enable options below by
selecting .NET in Assembly Type.
Assembly Type
Specify whether this file is a .NET assembly, a Win32 assembly, or neither.
Manifest
.NET and Win32 assemblies require a manifest. Select the file that contains the
manifest for this assembly. For .NET assemblies, this often is the same as the
file you are editing, because most manifests are embedded in the assembly file
or in one of the files in a multifile assembly. For Win32 files, the manifest is
often an external file with the same name plus “.manifest”. (Example: The
manifest for My.exe would be named My.exe.manifest.) For information on
creating a Win32 assembly and manifest, see Creating a Win32 Assembly on
page 135.
Assembly Attributes
This displays the assembly’s name, publicKeyToken, and version attributes.
If this information has not been pre-filled, click Add to enter it. Enter the Name
and Value for each of the assembly’s attributes. For information on obtaining
assembly attributes, see Creating a .NET Installation Without the .NET
Framework on page 221.
4. Click OK.
You isolate a Win32 assembly by means of a manifest file, which describes the assembly
and any resources it depends on. Options for adding a Win32 assembly and its manifest
to an installation are:
z Create a manifest for a Win32 assembly outside of Wise for Windows Installer, then
add the assembly and its manifest to the installation as you would any other files.
On the Assembly tab of the File Details dialog, mark it as a Win32 assembly and
specify the manifest file.
z Use the procedure below to create a Win32 assembly and manifest on the Manifest
File Details dialog. This populates the MsiAssembly and MsiAssemblyName tables.
Caution
Isolation does not work on all applications. Applications must be written according to
Microsoft programming guidelines to work with operating system isolation methods.
(Example: If an application hard-codes paths to support files, isolation might not work.)
For details, see the following topics in the Windows Installer SDK Help: Isolated
Components, Installation of Win32 Assemblies, Side-by-Side Assemblies. Also, search
for “assembly manifest” and “isolated applications” in the MSDN Library
(msdn.microsoft.com).
2. In Installation Expert > Files or Web Files page, double-click the application file in
the lower-right list box. In the Visual Studio integrated editor, you also can use the
Visual Studio Solution page.
Attributes are read from the file and displayed in the Assembly Attributes list, and
a manifest file name is entered in Manifest.
Installed File
Adds a dependency to a file that is in the installation. On the Select File dialog
that appears, select the dependency file and click OK. The dependency file is
External Manifest
Adds the attributes of an external manifest file as a dependency. Specify a
manifest file and click OK. The manifest you specify and the file it points to must
be present on the destination computer or in the installation. They must also be
located in the application’s directory structure or the WinSxS directory. See
Private Assemblies in the Windows Installer SDK Help.
For details, search for “Windows XP visual style” in the MSDN Library
(msdn.microsoft.com).
The manifest file is created in XML format and added to the installation with the same
name as the dependent file plus “.manifest”. (Example: The manifest for My.exe would
be named My.exe.manifest.) The manifest is also added to your computer with the
extension .XML. (Example: If you add C:\Program Files\My.exe and make it a Win32
assembly, the file C:\Program Files\My.exe.xml is created.)
Also see:
z Determine the correct version of the file to use in your application. If you are
connected to the Software Manager database used with your organization’s
installation of Wise Package Studio, you can see if the file is used by packages that
have already been deployed.
z Resolve potential file conflicts during the development cycle. When the file in the
current installation conflicts with a file in the Wise Software Repository, you can
replace the current file with the correct version from the repository.
You also can view shared file resources in a report format. See Generating Shared
Resource Reports on page 33.
To view shared resources, you must be connected to a Software Manager database data
source. For information on the Software Manager database, see About the Software
Manager Database in the Software Manager Help.
In Installation Expert: On the Files or Web Files page, double-click a file. In the
Visual Studio integrated editor, you also can use the Visual Studio Solution
page.
In the Visual Studio integrated editor, “Output from current solution” in the
Application column indicates a file that is in the current Visual Studio solution.
A white exclamation point to the left of the package indicates that the current file is
already in the Wise Software Repository and it does not conflict with the file used by
that package.
A red exclamation point to the left of the package indicates that the current file
conflicts with the file used by that package. Examples: The files have a different
version, date/time, or size; the files are installed to the same directory, but
component GUIDs do not match.
1. On the Shared Resources tab of the File Details dialog, select the application that
contains the version of the file you want to use.
(Visual Studio integrated editor only.) If you previously sourced the file from outside
the solution, you can rebind the file to the solution by selecting the version labeled
“Output from current solution.”
This button is disabled when: the application you selected above is the one that is
currently open; there is no conflict; or the source file listed in the Wise Software
Repository cannot be found (example: the file has been deleted).
3. Click OK.
The current file is replaced with the version of the file in the Wise Software
Repository. If a conflict existed, the exclamation point to the left of the package
changes from red to white.
The purpose of the Dynamic Content tab is to let you modify the XML file by inserting
system-specific information such as local directory paths and user names. Because this
information is different for each server, you use Windows Installer properties to specify
dynamic items.
Note
If you add an XML file, but the Dynamic Content tab does not appear in the file’s details
dialog, the file was not recognized as a well-formed XML file. Check the file for
irregularities and verify it adheres to XML and Microsoft authoring standards.
2. Double-click the XML file and select the Dynamic Content tab.
The Edit button becomes enabled for editable lines only after you mark Enable
Dynamic Content.
Not all lines are editable, only lines that have name-value attributes. (Example:
<compilation defaultLanguage=”c#” />.) The Attribute Editor dialog appears.
b. In Dynamic Value, type a new value to replace the current value at runtime.
You can enter bracketed Windows Installer property names. You must have
added a mechanism elsewhere in the installation to populate the property.
(Example: Use the Custom Property Dialog; see Adding the Custom Property
Dialog on page 455. Or use properties defined in Runtime Properties on
page 424.)
c. Alternatively, you can select a property name from Property and click the
Insert into Dynamic Value button.
During runtime, the attribute is replaced with the dynamic value you specified. Windows
Installer properties are resolved to their value.
You edit the DIFxApp options on the Driver tab of the File Details dialog. This tab
appears only if all of the following are true:
Note
Early versions of this merge module might be named “Binaries.”
4. Click OK.
to the advertising tables (AppId, Class, Extension, Mime, ProgId, TypeLib, Verb), to
the registry, or both. See Setting General Options on page 39.
z A more powerful scanning method captures information not available in the type
library, such as extensions, keys in hives other than HKEY_CLASSES_ROOT, and
keys in sections other than CLSID, Interface, Mime, Typelib, or ProgIds. To use this
method, do one of the following:
On the Component Details dialog, mark Self-register the key path file
before compile. Each time you compile, files in the component are re-
registered, the registration information is rescanned, and any new information
is added to the installation. See Adding and Editing a Component on page 392.
Using WiseComCapture.exe
To scan a file’s self-registration information and add it to an installation, the file must be
registered on your computer. If you prefer not to register files on your computer, you
can run the scan routine as a stand-alone utility on a different computer. This utility,
WiseComCapture.exe, is in the Wise for Windows Installer application directory. It
extracts the registration information to a .REG file, from which you can import registry
keys into the installation.
1. Copy or install the files to self-register onto a computer other than your build
computer.
2. Copy WiseComCapture.exe to a location you can access from the other computer.
3. Run WiseComCapture.exe from the command line, using the following syntax:
where:
Output_REG_pathname is the path and file name of the .REG file to which the
registry information will be extracted. This file must be accessible to anyone
who will be working on the installation.
The files are registered and the registry information is extracted to the .REG file you
specified.
4. On the build computer, do one of the following to import the .REG file:
On the Registry page, import the .REG file you created. This method imports
the information once but does not update it if the file’s registration information
changes. See Importing and Exporting Registry Entries on page 147.
In Setup Editor > Components tab, display the Component Details dialog for the
component containing the file. In Import .REG File, specify the .REG file you
created. Mark Extract advertising information from registry file. See
Adding and Editing a Component on page 392. If you rerun
The Visual Studio Solution page is similar to the Files page, except that it provides an
alternate view of the files in the Visual Studio solution. The upper-left list box displays a
solution node, similar to the view in Solution Explorer, that represents the projects in
the solution and lists the files that they contain. This is useful when you are working with
a solution that has an extensive folder structure (example: a Web project).
All primary outputs (.EXEs and .DLLs) of the projects in the solution are added to the
Visual Studio Solution page when you create the installation. To add other outputs to the
installation, select them on the Project Outputs page in the project settings. Files you
add to the solution later can also be added automatically. (See Scanning the Solution for
New Files on page 82.) Use the Visual Studio Solution page to organize files into
features, to move a file to a different installation directory, or to change file details.
Also see When to Use the File-Related Installation Expert Pages on page 115.
If an External Files folder appears in the upper-left list box, it contains files that are in
the project but are in a directory that’s outside of the project directory.
If Wise for Windows Installer cannot locate the solution file, the upper-left list box of the
Visual Studio Solution page will be empty.
z Use the right-click menu to expand or collapse folders, to hide or show empty
folders, and to rename folders.
z Drag and drop folders and files to the page and from Windows Explorer, or use the
following buttons:
Add Contents
Add the contents of a Visual Studio .NET project to the installation. See Adding
Contents of Visual Studio Projects to the Installation on page 142.
Add File
Add files to the installation. See Adding Files to an Installation on page 117.
New
Create directories to be installed on the destination computer. You also can
create directories in Setup Editor; see Creating a Folder in Setup Editor on
page 389.
Also see:
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
Items that you add to a feature are installed on the destination computer only if the
feature is installed. Items that you add to a condition are installed only if the feature
is installed and the condition is true.
3. In the upper left list box, select a Visual Studio project whose contents you want to
add.
If Wise for Windows Installer cannot locate the solution file, the upper-left list box
will be empty.
4. In the lower left list box, select a directory where you want to add the contents.
The Add Contents dialog appears, listing the files in the selected project.
The selected files are added to the directory you selected in the lower left list box.
Also see:
Registry Page
Use the Registry page to specify the registry entries to be installed, removed, or edited
on the destination computer. You can either add registry entries manually or import a
registry file (.REG). If you import a Visual Basic .VBR file, it will import the registry
settings, but will not automatically set up for the installation of either a remote
automation or DCOM™ server. You also can export to a registry file.
When you import a registry entry that points to a standard directory, such as Win32 or
Program Files, Wise for Windows Installer replaces the path to the directory with
formatted text in brackets. As a result, the registry entry automatically points to the
correct directory, no matter where it is located. Example: References to c:\Program
Files\ are replaced with [ProgramFilesFolder].
In addition, if the registry key points to a file in the installation, it will be replaced by
[#filekey]. Example: If you have c:\program files\myapp\myapp.exe in your install, and
you add a registry key that refers to that file, its value becomes [#myapp.exe],
assuming myapp.exe is the key to the file in the File table. See Formatted in the
Windows Installer SDK Help.
Registry keys
on your Registry values
computer. in the key
selected on the
left.
z Use the right-click menu to expand or collapse directories and to hide or show
empty directories.
z Drag and drop keys and values on the Registry page, or use the following buttons:
Add Keys
Copy a registry key, including all its subkeys and values, from your computer to
the installation.
Add Values
Copy values from your computer to the installation.
Add
Create a new key or import a registry file into the installation.
Details
Edit registry key settings.
Also see:
In Installation Expert, the Registry page displays only the registry keys for the feature in
the Current Feature drop-down list. To display registry keys for all features, mark
View registry keys for all features on Registry page in Wise Options.
In Setup Editor, the Registry icon displays the registry keys and values that are included
in the selected feature or component.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
Items that you add to a feature are installed on the destination computer only if the
feature is installed. Items that you add to a condition are installed only if the feature
is installed and the condition is true.
3. In the lower left list box, select the location for the key.
6. In Key, click at the end of the existing text, and add a backslash and the name of
the new key.
7. Click OK.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
Items that you add to a feature are installed on the destination computer only if the
feature is installed. Items that you add to a condition are installed only if the feature
is installed and the condition is true.
3. In the lower left list box, select the key to contain the value you’re adding.
5. Complete the dialog and click OK. For details, see Configuring General Registry
Settings on page 148.
On the Features tab, expand a feature and then expand its Combined folder.
If the Registry icon does not appear, right-click and select Hide Empty Folders/
Items.
3. To add a new folder, right-click a folder and select New > Folder. Rename the new
folder.
5. Complete the dialog and click OK. For details, see Configuring General Registry
Settings on page 148.
The registry value is added to the selected feature or component and appears in the
upper right pane. To edit it, double-click its name. To delete it, use the right-click menu.
In Installation Expert, the Registry page displays only the registry keys for the feature in
the Current Feature drop-down list. To display registry keys for all features, mark
View registry keys for all features on Registry page in Wise Options.
Caution
Be very careful when removing registry entries from the destination computer. Do not
remove registry entries unless you are sure that they are not used by another
application.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
3. Add the registry key and value to the installation. See Adding Registry Keys on
page 144.
4. In the lower left list box, select the key that contains the value to remove.
8. Click OK.
A red exclamation point appears over the icon of the registry value you selected to
indicate that this value will be removed during installation.
On the Features tab, expand a feature and then expand its Combined folder.
If the Remove Registry icon does not appear, right-click and select Hide Empty
Folders/Items.
Root
The top-level key from which the key will be removed. Example:
HKEY_CURRENT_USER.
Key
The name of the key to remove. To create an entire key path, separate key
names with backslashes (\). Example: NewDocument\Protocol\StdFileEditing.
Value Name
The value to remove. You can enter a formatted text string. For information
about formatted text strings, see Formatted and Registry Table in the Windows
Installer SDK Help.
5. Click OK.
The remove registry operation appears in the upper right pane. To edit it, double-click
its name. To delete it, use the right-click menu.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
3. Add the registry keys and values to the installation. See Adding Registry Keys on
page 144.
4. In the lower left list box, right-click the key that contains the subkeys and values to
remove, and select Remove all subkeys and values on install.
A red exclamation point appears over the folder icon of the registry key you selected to
indicate that all the subkeys and values of this registry key will be removed during
installation.
Items that you add to a feature are installed on the destination computer only if
the feature is installed. Items that you add to a condition are installed only if
the feature is installed and the condition is true.
Click Add at the lower left of the Registry page and select Import.
2. In the dialog that appears, specify a .REG file and click Open.
The contents of the selected registry file, along with all corresponding folders, are placed
in the appropriate root folder.
2. In File Name, specify the pathname of the registry file you are creating.
3. In Export As, select the version of RegEdit that the registry file should be
compatible with.
4. Click OK.
The .REG file is saved in the location you specified. If the registry key you exported had
a property name surrounded by brackets, and that property is defined in the Property
table in the Windows Installer database, then the bracketed property name is replaced
with the local computer value of the property in the exported .REG file.
Operation
Specify what operation will be applied to the key and its associated value.
Root
The top-level key in which the new key will be added. (Example:
HKEY_CURRENT_USER.) This is enabled only when you access the Registry
Details dialog from the Add button on the Registry page.
Key
The name of the new key. Create an entire key path by separating key names
with backslashes (\). (Example: Entering NewDocument\Protocol\StdFileEditing
creates the StdFileEditing key inside the Protocol key, which is created inside
the NewDocument key.) Any keys in the path that do not already exist on the
destination computer are created. This is enabled only when you access the
Registry Details dialog from the Add button on the Registry page.
Value Name
The name of a new named value. You can enter a formatted text string. For
information about formatted text strings, see Formatted and Registry Table in
the Windows Installer SDK Help.
Data Value
The data for the value. You can enter a formatted text string. (Example: To
return the directory that contains MyApp.exe, enter a value of [$component],
where component is MyApp.exe; to return the directory and the file name, enter
a value of [#MyApp.exe].) For information about formatted text strings, see
Formatted and Registry Table in the Windows Installer SDK Help.
Data Type
Select the type of data contained in the named value. The associated Windows
API data types are in parentheses below.
String
A piece of alphanumeric text. You can enter properties by enclosing the
property name in square brackets. (REG_SZ)
Unexpanded string
Variable names, such as %WIN%, are not expanded, allowing Windows NT
system variables to be embedded. (REG_EXPAND_SZ)
Double word
A 32-bit value in decimal notation. (REG_DWORD)
Binary / Hex
A series of bytes in hexadecimal notation. The bytes should be entered
without separating spaces or commas. (REG_BINARY) Example:
AD30C0A94020A8FC4C0008.
4. Click OK.
Note
These permissions require an NTFS partition and therefore work only under Windows
NT, 2000, XP, and Server 2003.
The permissions you set are applied to the domain and user you specify, so you can set
different permissions for the same registry key for different users. Set permissions only
if you know your users and their domains. Example: If you are a system administrator
and want to set permissions for registry keys in an .MSI as appropriate for your
network.
4. The domain and user names appear in the upper list box, and the list of permissions
is enabled.
You also can view shared registry resources in a report format. See Generating Shared
Resource Reports on page 33.
Windows Installer itself also provides registry keys with special functionality. (Example:
You can install a key named AlwaysInstallElevated to force Windows Installer
installations to always install with elevated privileges.) For a list of these special keys,
see User Policies and Machine Policies in the Windows Installer SDK Help.
You cannot use this page to delete part or all of an .INI file.
The left list box on this page represents the directory tree of the destination computer,
and the right list box contains .INI entries you add to the installation. Use the right-click
menu to expand or collapse folders and to hide or show empty folders.
Note
To see the same directory structure that exists on the Files page, mark the View
directories for all features on Files page checkbox in Wise Options.
z When you edit an existing .INI file, new .INI file settings are merged into the
existing settings. If you enter a section name that already exists, its new parameter
assignment lines are added to the existing section. If a section and its variable
already exist, the variable’s value is overwritten.
z You can use formatted text strings to resolve special substrings in the Section,
Key, or Value fields in the INI File table, entering the formatted text directly on the
INI File Details dialog. You also can edit the IniFile table in Setup Editor. For
information on formatted text strings, see Formatted in the Windows Installer SDK
Help. For information on editing tables, see Editing Existing Tables on page 400.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
Items that you add to a feature are installed on the destination computer only if the
feature is installed. Items that you add to a condition are installed only if the feature
is installed and the condition is true.
3. To create a new folder for the INI file, click New Folder, enter a folder name, and
click OK.
6. Click OK.
The INI File entry appears in the right list box. To edit it, double-click its name. To
delete it, use the right-click menu.
8. To create a new folder for the INI file, right-click the INI Files icon or one of its
subfolders and select New > Folder. Rename the folder.
Note
Add the .INI file immediately after creating the folder, because if you create the
folder, but fail to put an .INI file entry inside it, the folder is deleted from the
installation the next time you save it.
The INI File entry is added to the selected feature or component and appears in the
upper right pane. To edit it, double-click its name. To delete it, use the right-click menu.
Note
Because Windows Installer does not support writing comments to .INI files,
comments are removed from .INI files you import.
z INI Settings
Enter the information to add or change in the .INI file. The text must be in the
correct syntax. Section names must be in brackets and contents must be in the
form variable=value. Example:
[SECTIONNAME]
Color=Red
You can enter Windows Installer property names (surrounded by brackets) for both
the variable and value. Example: To set a variable named MyAppLocation to the
installation directory and add it to the APPLICATIONPATH section, enter:
[APPLICATIONPATH]
MyAppLocation=[PRIMARYFOLDER]
Shortcuts Page
The Shortcuts page lets you add, edit, and delete shortcuts for files in the installation,
and add icons for shortcuts you will install. You also can create a shortcut for a file on
the destination computer that’s not in the installation. Shortcuts for files that have
associated shortcuts are created automatically if you select one of the scan advertising
options from the Advertising Setting drop-down list in Wise Options.
(Visual Studio integrated editor only.) If the installation is part of a Visual Studio .NET
solution, an advertised shortcut for the application is created by default. The Project
Outputs page in the project settings contains an option that lets you specify not to
create a shortcut automatically. See Entering Project Settings on page 77.
Items that you add to a feature are installed on the destination computer only if
the feature is installed. Items that you add to a condition are installed only if
the feature is installed and the condition is true.
Advertised
This is marked by default, which means this shortcut appears on the destination
computer regardless of whether its target is installed or advertised. When the
end user opens an advertised shortcut, installation of the target .EXE file is
initiated. If you clear this checkbox, the shortcut appears only if its target is
installed, but not if its target is advertised.
Note
If you designate a shortcut as advertised, and the shortcut’s target gets
deleted, selecting that shortcut initiates self-repair. Self-repair is not initiated
for non-advertised shortcuts.
Command Line
Mark this to have the shortcut execute a command line statement. Use this
option to open a file that’s not part of the installation, but only if you’re sure the
file exists on the destination computer.
Command Line
Enter the entire command line statement, including arguments and other
command line options; see Arguments in Editing a Shortcut Configuration
on page 154. Enclose the statement in quotation marks if it contains spaces.
Shortcut Name
Enter a name for the shortcut.
3. Click Next.
If you created a shortcut for a file in the installation, the Shortcut File Selection
dialog appears.
4. Select the installation file to create a shortcut for and click Next.
Note
Files added under the Duplicate Files icon in the Features or Components tabs of
Setup Editor do not appear because you cannot add shortcuts for duplicate files.
6. Click Finish.
The Shortcut Details dialog appears, where you can specify further details for the
shortcut. See Editing a Shortcut Configuration on page 154. When the end user
installs your application, this shortcut will appear in the location you specified.
The shortcut appears. To edit it, double-click its name. To delete it, use the right-click
menu.
Name
The name of the shortcut. If the name is longer than 8.3 characters, the short
(8.3) file name appears first, followed by a pipe character (|) and the long
(Windows 95) file name.
Target File
(Read-only.) This contains the file name of the target of this file. You specified
this file when you created this shortcut. To create a shortcut to a different file,
delete this shortcut entry and create a new one. If you created a command line
shortcut, this field is replaced by the Command Line field.
Command Line
This appears only if you created a command line shortcut. It contains the
command line statement.
Dest. Directory
This lists all pre-defined directories and directories you’ve created. Select the
location for the shortcut on the destination computer, or click New Folder to
create a new directory.
Arguments
Enter command line arguments to append to the command line statement that
is executed to launch the target of this shortcut. You can enter property names
surrounded by brackets to specify standard directories. (Example: To specify a
file named Notes.txt in the Windows directory, enter
[WindowsFolder]Notes.txt.) For a list of predefined directories, see System
Folder Properties in the Windows Installer SDK Help.
Description
Enter a one-line description of the shortcut, which appears when an end user
right-clicks on a shortcut file in Windows Explorer and selects Properties.
Working Directory
Select the directory that should be current when the target of this shortcut is
launched.
Show Window
Select whether the target file opens in a normal, minimized, or maximized
window.
Advertised
Mark this to have the shortcut appear on the destination computer regardless of
whether its target is installed or advertised. When the end user opens an
advertised shortcut, installation of the target .EXE file is initiated. If you clear
this checkbox, the shortcut appears only if its target is installed, but not if its
target is advertised. You can select a new feature or icon only if this checkbox is
marked.
Feature
To associate this feature with a different shortcut, select the feature. Because
non-advertised shortcuts cannot be associated with a feature, this field is
enabled for advertised shortcuts only.
3. To select a new icon, click New Icon and specify the icon.
4. Click OK.
Name
Enter a name for the environment variable.
Value
Enter a value for the environment variable.
Note
To read the value of an existing environment variable into a property, use the
Set Property type of custom action to read it into a property. Enter
[%ENVIRONMENT_VARIABLE_NAME] in the Property Value field on the
Details tab of the Set Property dialog while making the action (brackets
required).
Operation
Specify how to handle the variable during installation and uninstallation.
Replacement
Specify how to handle an existing value for the variable.
3. Click OK.
The environment variable is added. To edit it, double-click its name. To delete it, use the
right-click menu.
Items that you add to a feature are installed on the destination computer only if
the feature is installed. Items that you add to a condition are installed only if
the feature is installed and the condition is true.
2. On the Extension Details tab, select the executable to use for the extension, type an
extension, and enter the program ID for the executable. For details, see
Determining Extension Settings on page 157.
3. (Optional.) On the Command Verbs tab, click Add, and on the Verb Details dialog
that appears, set the actions that will be available when the end user right-clicks an
executable with this extension in Windows Explorer. For details, see Adding
Command Verbs on page 158.
4. (Optional.) On the MIME Types tab, mark Show All and mark checkboxes to select
the MIME types to associate with this extension. For details, see Selecting MIME
Types on page 158.
5. Click OK.
The file association appears. To edit it, double-click its name. To delete it, use the right-
click menu.
In Setup Editor, a new branch of folders is created under the Advertising icon to show
the application folder, the Extensions folder, and the ProgId folder.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
3. Click Add at the right of the File Associations page and select Import.
4. Click Browse to select the executable to use for the extension. You can only select
executables that you’ve already added to the installation.
5. From Extension, select the extension to use. This list shows all available extensions
on your computer.
6. Click OK.
All relevant information for the extension you select is imported into the Extension
Details, Command Verbs, and MIME Types tabs. To edit those tabs, double-click the file
association name.
1. Click the Extension Details tab on the File Associations Details dialog. See Adding
File Associations on page 156.
Executable File
Specify the executable to use for the extension. You can only select an
executable that is in the installation.
Extension
Enter an extension. Do not include the period.
ProgID
Enter or select the program ID for the executable. This list contains the ProgIDs
defined in this installation and the ProgIDs detected for the executable you
specified above.
Description
Enter the type of file. The end user sees this description on the Properties dialog
for files of this type.
Icon
Click Change Icon and specify an icon. This icon will be displayed on files of this
type on the destination computer.
Note
The Description and Icon fields are associated with the ProgID, not the extension.
If no ProgID is specified, those fields are disabled.
3. Click OK.
1. Click the Command Verbs tab on the File Associations Details dialog. See Adding File
Associations on page 156.
Verb
Enter or select the action to be performed when the end user selects the
corresponding command from the right-click menu.
Command
Enter the command as it should appear on the right-click menu. This entry is
added to the text strings on the Languages page and can be localized. See
Translating an Installation on page 258.
Argument
Enter command line options that will be passed to the executable file when the
action is performed. The default (%1) is a Windows variable that holds the
pathname of the file that was opened.
4. Click OK.
1. Click the MIME Types tab on the File Associations Details dialog. See Adding File
Associations on page 156.
Show All
Mark this to display all available MIME types on your computer. To associate a
MIME type with an extension, click its checkbox. If you are an experienced
Windows Installer developer, you can add MIME types using the MIME table in
Setup Editor.
Show Associated
Mark this to display the MIME types currently associated with the selected file
extension. To disassociate a MIME type, clear its checkbox.
3. Click OK.
Services Page
Use the Services page to define applications to be installed as a service under Windows
NT, 2000, XP, or Server 2003. You also can start, stop, and delete services that are
installed on the destination computer. For information on coding an application to run as
a service, consult Microsoft developer documentation.
Application files that can be installed as a service are: .EXE, .VXD, .SYS, or .386.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
Items that you add to a feature are installed on the destination computer only if the
feature is installed. Items that you add to a condition are installed only if the feature
is installed and the condition is true.
3. Add the file that runs the service. Application files that can be installed as a service
are: .EXE, .VXD, .SYS, or .386.
Click Add at the right of the page and select Create Service.
The options you set on the Create Service Details dialog are dependent on how you
coded your service. Some of the options correspond to options in the Services
control panel (Windows NT 4.0) or the Services application (Windows 2000, XP, and
Server 2003). For details, see ServiceInstall Table in the Windows Installer SDK
Help.
Service Name
Enter the name of the service. This name is used internally by the service to
register itself properly in the registry, so this value must match the internal
name of the service that’s stored within the application file. You can see the
internal name in Windows Task Manager or the SCList Windows utility.
Display Name
The name that appears in the Services control panel on Windows NT 4.0 or the
Services application on Windows 2000, XP, and Server 2003.
Description
Enter a description for the service. This appears only in the Windows 2000
Services application.
Executable
Displays the file you selected on the Select File dialog, which runs the service.
Arguments
Enter any arguments to be passed to the service on the command line at
startup.
Dependencies
Enter the names of any other services that must be running before this service
can start.
Error Control
Specify what happens if an error is reported while starting the service.
Ignore Error
Logs the error in an error log and continues.
Normal Error
Displays a message to the end user and logs the error in an error log.
Critical Error
Reboots the system and sets it to the last known good menu.
Automatic
Mark this to have the service always start when the destination computer is
started.
Manual
Mark this to have the service enabled but not automatically started. If this
option is marked, the end user can start the process manually using the
Services control panel or Services application.
7. Click OK.
The service appears. To edit it, double-click its name. To delete it, use the right-click
menu.
To start, stop, and delete services on the destination computer, see Controlling Services
on the Destination Computer.
To add a service to the installation, see Adding a Service to the Destination Computer on
page 159.
If the service is not in this installation, select a feature with which to associate
the control service action.
Items that you add to a feature are installed on the destination computer only if
the feature is installed. Items that you add to a condition are installed only if
the feature is installed and the condition is true.
Click Add at the right of the page and select Service Control.
Service Name
Select a service contained in the currently-selected feature, or enter the name
of a service you expect to be installed on the destination computer. This name is
used internally by the service to register itself properly in the registry, so this
value must match the internal name of the service that’s stored within the
application file.
Arguments
Enter any arguments to be passed to the service on the command line at
startup.
Install Action
Mark the actions to perform on the service when your application is installed.
Uninstall Action
Mark the actions to perform on the service when your application is uninstalled.
3. Click OK.
The service control item appears. To edit it, double-click its name. To delete it, use the
right-click menu.
Note
To both stop and delete a service, do not mark both the Stop Service and Delete
Service checkboxes in the same control service action; instead, create two control
service actions. On the first control service action, mark Stop Service and Wait for
service action to complete before continuing. On the second control service action,
mark Delete Service. This ensures that the service is completely stopped before the
installation attempts to remove it.
From Current Feature, select a feature or condition. (Because any item you
add must be assigned to a specific feature, you cannot add an item when All
Features is selected.)
Items that you add to a feature are installed on the destination computer
only if the feature is installed. Items that you add to a condition are installed
only if the feature is installed and the condition is true.
Click Add at the right of the ODBC page and select Driver, Data Source, or
Translator.
The ODBC entry appears. To edit it, double-click its name. To delete it, use the right-
click menu.
Driver
Enter the driver name that will be used to access this data source. If you don’t
know the exact spelling of the driver name, click Import to import the data
source.
Source Attributes
Enter attributes for the data source, one per line, in keyword=value format.
Press Ctrl+Enter to move to the next line.
3. Click OK.
Driver Name
Enter a name for the driver, or click Import to import driver information from a
saved driver file. If you click Import, the Select ODBC Driver dialog appears,
which displays a list of ODBC drivers that are currently installed on your
computer.
Driver .DLL
Specify the path to the .DLL used for this driver.
Setup .DLL
Specify the path to the .DLL used to configure this driver.
Driver Attributes
Enter attributes for the driver, one per line, in keyword=value format. Press
Ctrl+Enter to move to the next line.
3. Click OK.
Description
Enter a description of the translator, or click Import to import an existing
translator. If you click Import, the Select ODBC Driver dialog appears, which
displays a list of ODBC translators that are currently installed on your computer.
Translator File
Specify the file that contains the translator.
Setup File
Specify the file that contains configuration data for the selected translator.
3. Click OK.
On the Firewall Exceptions page, you can specify application files and ports to be added
to the Windows Firewall exception list during installation. This adds custom actions to
the installation, which add the exceptions to the Windows Firewall exception list. When
your application is installed, it can accept incoming traffic and open required ports on
the destination computer without end user intervention. This is useful for games and
other similar applications.
Example: Your installation installs a multi-player network game, which requires multiple
users to communicate with each other over the Internet. On computers that use
Windows Firewall, end users are prompted the first time another player tries to
communicate with them. If you add the port that the game uses to the Windows Firewall
exception list, then the game communication can occur without prompting the end
users.
z When the destination computer is running Windows XP SP2, Windows Server 2003
SP1, or later, the exceptions are added to the Windows Firewall exceptions list.
z When the destination computer is running an operating system that does not have
Windows Firewall, the installation runs normally and the Windows Firewall
exceptions are ignored.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
Items that you add to a feature are installed on the destination computer only if the
feature is installed.
Application file. Do this to allow traffic to this specific file through any port. Go
to step 5.
Port. Do this to allow traffic from any application through this specific port. Go
to step 6.
The Application Selection dialog appears and displays files in the installation
with the following extensions: .EXE, .COM, or .ICD.
b. Select a file. A file can appear in the exception list only once.
The Friendly Name defaults to the file name. You can edit this information.
c. Click Finish.
6. To add a port:
A combination of port number and protocol type can appear in the exception list
only once.
e. Click Finish.
The exception appears. To edit it, double-click its name. To delete it, use the right-click
menu.
When you edit an application exception, you can only change the Friendly Name. When
you edit a port exception, you can change the Friendly Name, the Port Number, and
the protocol type.
When a file that is specified in an exception is deleted from the installation, the
exception entry and the associated custom actions are removed also.
The Target System and User Interface page groups in Installation Expert, along with the
Launch Conditions icon in Setup Editor > Product tab, let you determine how the
installation behaves on the destination computer.
Topics include:
z Setting Features for Installation Types (determining which features are installed
when the end user selects a specific installation type).
For information on selecting and editing the dialogs that appear during installation, see
Working With Dialogs on page 427.
2. Double-click a requirement.
3. From the drop-down list at the top of the dialog, select a requirement.
Requirements that begin with “All” or “Do not check” indicate that this requirement
is not checked. Any requirement you select includes not only the requirement but
also any greater value. Example: Selecting a Windows version of Windows 98 lets
an installation run on any computer with Windows 98 or any later versions of the
same operating system.
4. In Message Text, enter the error message that appears if the destination computer
doesn’t meet the system requirement. It should communicate to the user why the
installation cannot run.
5. Click OK.
Windows Version
The requirements you set for the Windows version apply only if the destination
computer is running one of the following operating systems:
Windows 95
Window 98
Windows Me
If the destination computer is running a version of Windows NT, the minimum system
requirements specified under the Windows NT Version item are checked instead.
Windows NT Version
The requirements you set for the Windows NT version apply only if the destination
computer is running one of the following operating systems:
Windows NT 4.0
Window 2000
Windows XP
Windows Server 2003
If the destination computer is running Windows 95, Windows 98, or Windows Me, the
minimum system requirements specified under the Windows Version item are checked
instead.
Screen Resolution
The minimum required screen resolution.
Screen Colors
The minimum required screen depth. 24 Million Colors corresponds to True Color in
the Display Control Panel.
IIS Version
This option is useful if you have set up this installation to configure a Microsoft Internet
Information Services (IIS) server. By default, this value is not checked. Also see About
Web Installations on page 222.
If you set an IIS Version, then an additional list of requirements appears, which are
settings available in IIS 4.0 and later. These requirements match those that are in
Internet Services Manager under the Web Service Extensions folder icon. You can
double-click any of these requirements to check its state as set on the destination IIS
Web server.
Also see:
To set basic requirements, use the System Requirements page; see Setting a
Requirement on the System Requirements Page on page 166. To create new launch
conditions and edit existing ones, use the Launch Conditions icon in Setup Editor >
Product tab.
Condition
Enter the new condition or click Build to create a condition in Condition Builder.
See Creating Conditions With Condition Builder on page 411.
Message Text
Enter the error message that appears if the destination computer doesn’t meet
the condition. It should communicate to the end user why the installation
cannot run.
3. Click OK.
The new condition appears in the list in the upper right pane.
Note
If the launch condition depends on a system search, move the AppSearch action so that
it precedes the LaunchCondtions action in the User Interface sequence. For silent
installations, also move the AppSearch action in the Execute Immediate sequence. See
About Installation Sequences on page 470.
z To find a previous version of your application that wasn’t installed using Windows
Installer technology.
z To find any files, directories, .INI files, registry entries, or components of a previous
version of your application. You can specify the items to search for and then code
the installation so the new version is placed in the same location as the previous
one, rather than in a default location.
z To look for a specific third-party application. Example: You might want to include a
feature in your application that is only installed if a certain application is already
installed on the destination computer.
At runtime, the installation searches for the items indicated on the System Search page
and places the results in properties you specify. There is no order to the search,
therefore you can’t make one entry depend on another.
See:
For information on searching for previous versions, see Searching for Existing
Applications, Files, Registry Entries, or .ini File Entries in the Windows Installer SDK
Help. You can get the product code GUID of the previous installation by filling in the
Action Property field on the Upgrade dialog. See Creating an Upgrade on page 311.
2. Click Add at the right of the page and select File or Directory.
Property
Specify a property name. It will hold the result of the search, which is a file
name or directory path. If you’ve already defined a new public property (all
uppercase) in the Properties icon on the Product tab, then you can select it from
the list; otherwise enter a new property name (all uppercase). If you enter a
new property name, and the search fails to find a match, the property value will
be null and will be false if used in a condition.
Operation
Select the type of entry for the property:
Search Directory
This is not available when you search all fixed drives for a file. Although you can
enter a specific path here, it is best to enter one of the predefined folder
properties that are listed in the Directory table of the Tables tab in Setup Editor.
Example: Entering [Windows] searches the default Windows directory,
regardless of its name or location.
Search Depth
Enter how many directories below the search directory to search. The default, 0,
searches only the top level of the directory specified in Search Directory. If
you are searching all fixed drives for a file, then 0 searches the root directories
only. Enter 1 to search both the top level and the top level’s child directories, 2
to search two levels of child directories, and so on.
File Name
Enter the name of the file.
Details
Click to specify more details about the file.
Because the file search stops with the first match, enter as much detail as possible
to ensure that the installation finds the correct file.
File Name
Enter the name of the installed file. This is the only required search criteria.
Min. Version
(Optional.) The file’s binary version resource must be equal to or greater than
this number. Leave both version fields blank to ignore the file version.
Max. Version
(Optional.) The file’s binary version resource must be equal to or less than this
number. Leave both version fields blank to ignore the file version.
Note
When using the version fields, make sure you consider the binary version
resource and not the string version resource. The Windows Properties dialog for
files displays only the string version, which can be different from the binary
version. Only the first 3 segments of a 4 segment version string are considered.
Example: For 1.0.2.3, only 1.0.2 is considered.
Min. Size
The file’s size must be equal or greater than this number. Leave the default
value of 0 to ignore the file size.
Max. Size
The file’s size must be equal or less than this number. Leave the default value of
0 to ignore the file size.
Languages
(Optional.) To search for a file with a particular language ID, enter the language
ID. To enter multiple languages, separate the language IDs with commas.
To test the search, add a text box on one of the dialogs in the installation. In the text
box’s Control Text field, enter the property name (surrounded by brackets) that you
assigned to this search. (Example: [MY_PROPERTY].) This causes the value of the
property to be displayed on the dialog. When you run the installation, the property you
specified will hold the results of the search. If it is empty, the search failed.
Note
When you use the System Search page to search for an .INI file, you can only search for
.INI files that are inside the Windows or the Winnt directory. Windows Installer does not
find .INI files that are located in other directories, even subdirectories within the
Windows directory.
SrcDir=E:\Application\
SrcFiles=E:\Application\Application.exe, E:\WiseUser\wiseuser.dll
z Item Field refers to the number of the item in a comma-delimited list. Example:
The Item Field for E:\WiseUser\wiseuser.dll in the section above is 2 because it is
the second item in the list.
2. Click Add at the right of the page and select INI File.
Property
Specify a property name. It will hold the result of the search, which is a file
name, directory path, or other value, depending on the operation performed by
the search. If you’ve already defined a new public property (all uppercase) in
the Properties icon on the Product tab, then you can select it from the list;
otherwise enter a new property name (all uppercase). If you enter a new
property name, and the search fails to find a match, the property value will be
null and will be false if used in a condition.
Operation
Select the type of entry for the property:
If you use this operation on .INI information that’s in the form of a file path,
or any other form, then this type of search fails. The search also fails if there
is more than one value listed for the item, separated by commas.
If you use this operation on .INI information that’s in the form of a directory
path, or any other form, then this type of search fails. The search also fails if
there is more than one value listed for the item, separated by commas.
Colors=red,blue,green
Item Field
This is enabled if you select Read raw value from INI file in the Operation
field. If the item you’re searching for contains several values, separated by
commas, enter the number of the value’s position in the list of values or enter 0
to get all values.
4. Click OK.
To test the search, add a text box on one of the dialogs in the installation. In the text
box’s Control Text field, enter the property name (surrounded by brackets) that you
assigned to this search. (Example: [MY_PROPERTY].) This causes the value of the
property to be displayed on the dialog. When you run the installation, the property you
specified will hold the results of the search. If it is empty, the search failed.
Property
Specify a property name. It will hold the result of the search, which is a file
name, directory path, or other value, depending on the operation performed by
the search. If you’ve already defined a new public property (all uppercase) in
the Properties icon on the Product tab, then you can select it from the list;
otherwise enter a new property name (all uppercase). If you enter a new
property name, and the search fails to find a match, the property value will be
null and will be false if used in a condition.
Operation
Select the type of entry for the property:
If you use this operation on registry information that’s not in the form of a
file path, the search fails.
dropped from the search result. A search of this type returns the directory
path only, minus the file name. Example: E:\Application\.
If you use this operation on registry information that’s not in the form of a
directory path, the search fails.
Root
Select the root folder that contains the registry value to search for.
Key
Enter an entire key path, separating key names with backslashes. Example:
Software\Application\Common.
Value Name
Enter the name of the registry value. To find the default registry value, leave
this blank.
4. Click OK.
To test the search, add a text box on one of the dialogs in the installation. In the text
box’s Control Text field, enter the property name (surrounded by brackets) that you
assigned to this search. (Example: [MY_PROPERTY].) This causes the value of the
property to be displayed on the dialog. When you run the installation, the property you
specified will hold the results of the search. If it is empty, the search failed.
You might use this search to find the installation directory of a component installed by a
different Windows Installer installation.
Example: Suppose you want to find the installation directory of version 1.0 of your
Sample1 application. You could use a file search to find the file, Sample1.exe, but it
might take a long time to search all drives. Instead, you could search for the component
ID of the component that contained Sample1.exe in the original installation. This type of
search is much faster.
In order to perform a component search, you must know the component’s ID. To obtain
this ID, you must have access to the .WSI file of the previous installation. You can find
the component’s GUID on the Component Details dialog; see Adding and Editing a
Component on page 392.
Property
Specify a property. It will hold the result of the search, which is a file name,
directory path, or other value, depending on the operation performed by the
search. If you’ve already defined a new public property (all uppercase) in the
Properties icon on the Product tab, then you can select it from the list;
otherwise enter a new property name (all uppercase). If you enter a new
property name, and the search fails to find a match, the property value will be
null and will be false if used in a condition.
Operation
Select the type of entry for the property:
Component ID
Enter the GUID for the component. See Adding and Editing a Component on
page 392 and About GUIDs on page 524.
4. Click OK.
To test the search, add a text box on one of the dialogs in the installation. In the text
box’s Control Text field, enter the property name (surrounded by brackets) that you
assigned to this search. (Example: [MY_PROPERTY].) This causes the value of the
property to be displayed on the dialog. When you run the installation, the property you
specified will hold the results of the search. If it is empty, the search failed.
Example: Suppose your application contains 3 features. You could set the following
defaults for the Installation Type dialog:
Tutorial
Samples
Because the Installation Types page simply sets the defaults, the end user can still
override these choices during installation by clicking Custom in the Installation Type
dialog, and then turning features on or off on the Select Feature dialog. To display the
Select Feature dialog to the end user during installation, mark its checkbox on the
Dialogs page.
On the Installation Types page, the upper left list box shows 3 installation types by
default, Typical, Complete, and Custom, which correspond to the 3 radio buttons
presented to the end user on the Installation Type dialog during installation. The right
list box shows the features in the installation. You can collapse or expand the features
and their child features using the right-click menu.
z Description text
This text appears next to the radio button on the Installation Type dialog. To change
the text for a specific installation type, select the installation type name in the upper
left list and change the text in the Description text box.
z Default features
To set which features are turned on by default during installation, select an
installation type name in the upper left list and mark the checkboxes of the features
in the list on the right.
Caution
If you are using the Installation Types page to manage the Installation Type dialog, do
not edit the Installation Type dialog. Doing so causes the Installation Types page not to
work properly.
The Select Installation Type and Select Features dialogs below illustrate how the
selections you make on the Installation Types page appear to the end user.
Selected by
default
Description
text
Access key
Default
features
You can create an installation that generates different installations for different releases
of your application. You do this by creating and customizing releases within the
installation. You can create releases that install different features, have different
properties, have different output formats, and generate a Web-based installation.
Note
You can only create releases in a project file (.WSI). In any other file, the pages in the
Release Definition page group are fully or partially disabled. An exception is the
Languages page. See Translating an Installation on page 258.
Topics include:
z About Releases.
z Setting Build Options for a Release (determining format of output files and language
options).
z Creating a Clean Build (creating a compilable copy that has minimal impact on a
build computer).
About Releases
Note
This page is fully enabled in a .WSI only. In an .MSI or .MST, you cannot add or delete.
The Releases page lets you define multiple releases for an installation, edit releases, and
delete releases you’ve created. If you haven’t created additional releases for the
installation, the Releases page lists only one release: Default.
Example:
You might want to have a standard and a demo edition for your application, and you
might want to release both editions on CD and as Internet downloads. In this case, you
would create 4 releases:
z Details
Edit a release.
z Add
Add a new release. See Creating a New Release.
z Delete
Delete a release. At least one release is required; if the installation only has one
release, you cannot delete it.
z Compile
Compile a specific release without compiling the entire installation. Select one or
more releases and click the Compile button at the right of the Releases page.
The Compile button at the bottom of the main window compiles the entire
installation. (In Visual Studio: use commands on the Build menu.) See Compiling An
Installation on page 88.
You can edit various aspects of each release on the other pages in the Release Definition
page group.
2. Click Add.
Release Name
Enter a unique name that describes the release. Example: Standard_CD-ROM or
Standard_Internet. This name appears on the Releases page.
Description
Enter information to distinguish this release from others. Examples: Demo,
Optimized for Internet Distribution. This description appears on the Releases
page.
Installation Theme
Select the theme for the installation dialogs for this release. The theme controls
the overall look of the dialogs by setting the dialogs’ top or side image and the
fonts of the dialog text. You can use different themes for different releases.
Example: Use a different theme for a demo release to clearly distinguish it from
your standard release. For details, see Changing the Theme of Dialogs on
page 431.
The theme of the Default release on the Releases page corresponds to the
Default Theme on the Dialogs page. Changing the theme on one page changes
it on the other. Renaming or deleting the Default release breaks this
relationship.
Compression Type
Select the amount of compression. This depends on the media you use to
distribute the release. Examples: For an Internet release, use maximum
compression for a faster download, but for a release on a CD, use no
compression. Higher compression slows the compile.
Release Type
Select Terminal Server Enabled if this release is intended to be installed in a
Microsoft Terminal Services or Citrix environment. This sets the installation to
be installed per-machine and prevents keypaths for components from being
assigned to per-user resources. This option might cause keypaths to be empty,
and might cause a one-time repair. Environment variables are duplicated,
creating a per-user set and a per-machine set, one of which is installed
depending on the value of ALLUSERS. Also see ALLUSERS Property in the
Windows Installer SDK Help. (Enterprise Edition only.)
4. To add or edit media settings, click Edit Media. The Media Details dialog appears.
See Setting Up Media for Distribution on page 201. The Edit Media button and the
Media section appear only when you first add a new release.
5. Click OK.
The release is added to the list on the Releases page. To edit a release, double-click its
name. The other pages in the Release Definition page group let you further customize
each release.
1. On the Releases page, create a release to contain the multiple languages. See
Creating a New Release on page 179.
Current Release
Select the release that you just created
.EXE Options
Select one of the following:
Single-file .EXE
When you select this, you must create a language transform for each
additional language. See Creating a Language Transform on page 260.
During compile, the transforms are packaged inside the .EXE along with the
.MSI.
Clear this to have the resulting installation verify if one of the languages in the
installation is on the destination computer. If so, the installation proceeds in the
destination computer’s language. If not, the end user is prompted to select a
language.
3. On the Languages page, select the languages you want to include in this release.
See Creating a Translated .MSI on page 259.
When the end user launches the installation .EXE, the installation either proceeds in the
destination computer’s language or prompts the end user to select a language. If you
created a single-file .EXE, the .MSI runs with the appropriate transform. If you created
an .EXE that launches an external .MSI, the appropriate language .MSI runs.
Customizing a Release
When you create a new release, it has the same properties, summary items, and
features list as the Default release. The Release Settings page lets you customize a
particular release by:
z Overriding the properties and summary items. These are set for the entire
installation in Setup Editor > Product tab.
z Selecting the features to include in the release. Features are set for the entire
installation in Installation Expert > Features page.
The tree structure on the Release Settings page displays features and their
hierarchical relationships. Use the right-click menu to collapse or expand all features
or child features of selected parents only.
You can share settings between releases, so you can efficiently create releases that
share all or most settings.
Example:
z The product’s summary informs the end user that this demo release doesn’t allow
saving files.
Note
This page is enabled in a .WSI only.
You can use the Release Settings page to override the value of an existing property or
add a new property for a specific release. Example: Change the ProductName property
to reflect that a particular release is a demo version rather than a full version.
Each release contains the properties listed under the Properties icon in Setup Editor >
Product tab. Only those properties you change or add for a specific release appear under
the Properties icon on the Release Settings page. Properties you add for a specific
release do not appear in Setup Editor. Deleting a property from the Release Settings
page removes the override for the specific release.
4. Click Add at the right of the Release Settings page. The Property Settings Override
dialog appears.
5. From Name, select an existing property or enter a name to create a new property.
6. In Value, enter an initial value for the property. During execution, the installation
might change this value.
7. Click OK.
The property appears in the list box. To edit it, double-click its name.
You can use the Release Settings page to override the value of an existing summary
item or edit customized summary items. Example: Change the Comment Summary item
to reflect that a particular release is a demo version rather than a full version.
End users can see the summary information by right-clicking the compiled .MSI or .EXE
in Windows Explorer and selecting Properties.
For information on summary items, see Summary Property Descriptions in the Windows
Installer SDK Help.
Each release contains the summary items listed under the Summary icon in Setup Editor
> Product tab. Only those summary items you change for a specific release appear
under the Summary icon on the Release Settings page. You cannot create new summary
items. Deleting a summary item from the Release Settings page removes the override
for the specific release.
4. Click Add at the right of the Release Settings page. The Summary Settings Override
dialog appears.
7. Click OK.
The summary item appears in the list box. To edit it, double-click its name.
Also see:
The Release Settings page lists all features in an installation. You can select the features
to include in a particular release. Example: Turn off a SpellCheck or a SaveAs feature for
a demo release.
4. To include a feature in this release, mark its checkbox. To exclude a feature, clear its
checkbox.
You can share settings from a release with other releases in the installation. After you
initially share settings, the settings for the releases are linked. This means that any
change you make to the release settings for any of the linked releases is applied to all
other linked releases. At any time, you can break the link.
3. Click Share at the right of the Release Settings page. The Share Release dialog
appears.
4. From Copy/Share Settings From, select the release that contains the settings to
copy.
5. Click OK.
The settings of the release in Copy/Share Settings From immediately replace the
settings of the release in Current Release. Any change you make to the release
settings of either of the linked releases is applied to the other release, until you break
the link.
3. Click Share at the right of the Release Settings page. The Share Release dialog
appears.
5. Click OK.
The link between the selected release and other releases is broken. The current settings
of the releases are not changed, but changing settings for one release no longer affects
the settings of the other release.
z Potential customers can use the demo version indefinitely, but they can’t save any
files.
Assumptions
z On the Features page, you have added a SaveAs feature with the appropriate
resources for the default release.
z The SaveAs feature includes resources that let end users save files.
4. Click Add at the right of the Release Settings page. The Property Settings Override
dialog appears.
7. Click OK.
9. Click Add at the right of the Release Settings page. The Summary Settings Override
dialog appears.
On the Build Options page, you can customize a release by selecting the format of
output files and language options.
Build Options
z Use short file names for files uncompressed outside of the install
Mark this to abbreviate file names to 8.3 format names. This is useful if you will
distribute your installation on CDs with the 8.3 format.
z .EXE Options
This determines what kind of files are output when you compile this release. If you
create an .EXE, you can install Windows Installer and .NET Framework runtimes and
run prerequisite files on the destination computer before the main installation. See
Adding Prerequisites to a Release on page 186. For WebDeploy to be enabled, you
must select one of the WebDeploy options. For details, see Creating a WebDeploy
Installation on page 198.
the preferred option if you place the installation on a CD, because the .MSI does
not need to be extracted to the hard drive.
WebDeploy .EXE
Create an .EXE that is optimized for direct downloading from the Internet. The
installation will compile to an .EXE that contains the download information, and
an .MSI file that might or might not be embedded in the .EXE. This sets the
Create a downloadable .EXE option on the WebDeploy page, and vice versa.
Caution
If you change the .EXE options after you edit the WiseScript on the Prerequisite
Pages, you will lose all the changes you made to the script.
z Password
Enter a password. The user installing the application is prompted to enter the
password to initiate the installation. This password is the same for all users. You can
protect only .EXEs with a password.
For this to work, the previous version must have been installed using Windows
Installer technology. If not, then use the System Search page to search for a
previous version.
Note
For best results, use the Upgrades page rather than this option to deal with previous
versions of your software.
Do not mark this checkbox if you are using the Upgrades page or patches to update
an application.
Clear this to have the resulting installation verify if one of the languages in the
installation is on the destination computer. If so, the installation proceeds in the
destination computer’s language. If not, the end user is prompted to select a
language.
z Add prerequisite files to run before the main installation. Prerequisite files are
usually .EXE or .MSI files, but there is no restriction on their type.
z Add the MSDE runtime to run before the main installation. This is a special file that
installs MSDE using specific command line options and settings. It is added as an
include script to the WiseScript that creates the installation .EXE.
If you specify a runtime that is not on your computer, the Download Redistributables
wizard appears during compile. Use the Wise Web Site option to download that runtime,
which should be pre-selected. See Downloading Redistributable Files on page 35.
Note
The options on the Prerequisites page are disabled if Do not create an .EXE file is
selected from .EXE Options on the Build Options page. See Setting Build Options for a
Release on page 185.
If you know that a particular operating system is not used on any destination
computers, select None for that operating system.
Select Latest to add the latest runtime that you have downloaded and that
works with that operating system.
Example: If the latest runtime that you have downloaded is 2.0 and you
select Latest (NT) and Latest (2000/XP/2003), then 2.0 is added to the
installation. If later you download 3.0, both 2.0 and 3.0 are added. Version
2.0 would be the latest runtime for NT and 3.0 would be the latest for 2000/
XP/2003.
Note
Prior to the release of Windows Installer 3.0, the .NET Framework included the
version of the Windows Installer runtime that it required. However, Microsoft
does not distribute Windows Installer 3.0 with the .NET Framework. If your
application requires Windows Installer 3.0, configure the installation to pre-
install it.
If the .NET Framework includes a Windows Installer version that is later than
the Windows Installer version you selected above, the later version is pre-
installed.
4. To delay the reboot to the end of the installation and minimize reboots for the end
user, mark Delay Windows Installer runtime reboot until after product
installation.
This is enabled only if one of the Windows Installer Runtime Version fields is set
to 2.0 or later, or if a .NET Framework that includes Windows Installer 2.0 or later is
selected. Normally, installing the Windows Installer runtime requires a reboot at
that point in the installation.
5. To run the prerequisite files before checking the launch conditions of the .MSI
installation, mark Don’t check the launch conditions of the .MSI installation
until after running the prerequisites.
By default, the .MSI launch conditions are checked after the installation of any
runtimes that you select on the Prerequisites page and before any prerequisite files
run. With this option you can delay checking the .MSI launch conditions until after
the prerequisite files run. Use this option when the .MSI launch conditions will fail if
the prerequisite files have not been run.
6. To add a prerequisite file, click Add at the right of the page and select Prerequisite.
7. Complete the Prerequisites Details dialog and click OK. See Adding a Prerequisite
File on page 189.
The prerequisite file is added to the Prerequisites page. To edit or delete it, use the
right-click menu.
8. To add the MSDE runtime prerequisite, click Add at the right of the page and select
Runtime.
9. Complete the Runtime Details dialog and click OK. See Adding the MSDE Runtime
Prerequisite on page 190.
The runtime is added to the Prerequisites page. To edit or delete it, use the right-
click menu.
10. If a prerequisite file or runtime requires a reboot, you might need to edit the
WiseScript to make the reboot run smoothly. We recommend adding 2 Pause actions
for 1000 milliseconds after a prerequisite or runtime that requires a reboot. This
works better than 1 Pause action for 2000 milliseconds. Adding the Pause actions
prevents the WiseScript from trying to launch the next prerequisite or runtime while
the computer is shutting down. See Editing the WiseScript That Creates the
Installation .EXE on page 191.
11. During installation, any runtimes you selected at the top of the Prerequisites page
run first, and then the prerequisite files and runtimes run in the order that they are
listed. To rearrange the order, select an item in the lower pane and click Move Up or
Move Down at the right of the page.
For each prerequisite file and runtime that you add, script is added to the WiseScript
that creates the installation’s .EXE. You can edit this script to enhance the functionality
of the prerequisites. See Editing the WiseScript That Creates the Installation .EXE on
page 191.
Note
The options on the Prerequisites page are disabled if Do not create an .EXE file is
selected from .EXE Options on the Build Options page. See Setting Build Options for a
Release on page 185.
3. To add a prerequisite file, click Add at the right of the page and select Prerequisite.
Note
If you compile an installation into an .EXE that launches an external .MSI, 3 files are
generated: an .EXE, an .MSI, and an .INI. If you add prerequisite files to the
installation, a subdirectory that is named after your installation file is also created.
When you distribute the installation, you must include this subdirectory along with
the 3 files that are generated or the installation will not run.
File Path
Specify the prerequisite file to be run before the main installation.
Command Line
Specify the command line options to apply to the prerequisite file at run time.
The Prerequisite Launch Conditions dialog appears. You can add launch
conditions for the destination computer’s operating system, display settings,
and NT administrator rights. The prerequisite file runs only if all conditions are
true. Conditions you add appear in the Condition section. If your prerequisite
file is an .MSI, you cannot add launch conditions, but you can view its launch
conditions on the Prerequisite Launch Conditions dialog.
To add a launch condition, select an option from both drop-down lists and
click Add. Repeat to add additional launch conditions.
The prerequisite file is added to the Prerequisites page. To edit or delete it, use the
right-click menu.
Also see:
The runtime is always included in the installation .EXE, even if .EXE that launches
external .MSI is selected on the Build Options page.
Before you can add the MSDE runtime to an installation, you must add the MSDE
installation files to your computer.
Note
The options on the Prerequisites page are disabled if Do not create an .EXE file is
selected from .EXE Options on the Build Options page. See Setting Build Options for a
Release on page 185.
2. Mark Other Vendors’ Web Sites and click Next. When all available redistributables
are retrieved, the Available Redistributable Files dialog appears.
3. In the list box, select the MSDE 2000 runtime (Microsoft SQL Server 2000 Desktop
Engine). Then click Download to launch your Internet browser, if necessary, and
connect to Microsoft’s Web site.
4. Follow the links and prompts on the Web site to download the MSDE .EXE file.
5. When the download is complete, return to the Available Redistributable Files dialog
and click Finish.
6. Find the .EXE file that you downloaded and double-click it to extract the MSDE
installation files to your computer.
4. To add the MSDE runtime, mark its checkbox and click OK.
MSDE Directory
Specify the directory to which you extracted the MSDE installation files.
Strong SA Password
Enter a strong password for the system administrator of this instance of MSDE.
A strong password is one that meets these requirements:
It may not contain your user name or any part of your full name.
MSDE Instance
Enter a name for this instance of MSDE, if required.
The runtime is added to the Prerequisites page. To edit or delete it, use the right-
click menu.
Also see:
If your default WiseScript editor is WiseScript Express, you cannot use this interface to
open WiseScripts that were created in another Wise product, because they might
contain actions that WiseScript Express does not support.
Caution
Make sure the .EXE options on the Build Options page are set correctly before you edit
the WiseScript. If you change the .EXE options after you edit the WiseScript, you will
lose all the changes you made to the script.
Note
After you edit the WiseScript, the ability to add or edit prerequisite files and
runtimes on the Prerequisites page is disabled. To enable them, click Reset Script at
the right of the page.
The Edit Script button is disabled if Do not create an .EXE file is selected from
.EXE Options on the Build Options page. See Setting Build Options for a Release on
page 185. It is also disabled until you add prerequisite files or runtimes.
If you have not previously edited the script, a warning message appears. Click Yes.
The installation is saved and compiled and the WiseScript that creates the
installation’s .EXE opens in your default WiseScript editor. See WiseScript Editing
Tools on page 473.
The name of the WiseScript file for the default release is the installation name with
the extension .WSE. The WiseScript files for additional releases are named for the
release.
Caution
Don’t change the name of the WiseScript file. It must have this name to create an
.EXE that includes your edits.
The next time you compile the installation, an .EXE is generated using the
WiseScript file that you edited.
This button is enabled only if you have used the Edit Script button.
2. Click Yes.
The changes you made to the WiseScript are deleted, and the ability to add and edit
prerequisite files on the Prerequisites page is enabled.
Also see:
Use the Clean Build page if you need to do the final build on a clean build computer. A
clean build environment helps avoid virus contamination. Also, moving a build to a clean
build computer will reveal whether some necessary files exist only on the developer’s
computer.
The clean build itself is a collection of files that are necessary to compile an installation
project. This includes a minimal copy of Wise for Windows Installer, an .INI file that
stores information normally stored in the registry, and all installation files. No changes
are made to the registry or system of the build computer during the build creation
process.
z Check the clean build into a source code control system (SCCS). Every time you
generate a clean build, any files in the installation that changed are checked into the
SCCS. This provides a history of versions of the installation and lets you recreate a
build at any stage in its development process.
z Save the clean build to any network directory. Every time you generate a clean
build, the necessary files are recopied to the directory, overwriting previous
versions. Do this if you do not need to recreate older builds.
Requirements
z The build computer must have Windows Installer installed in order to compile the
final build. Version 2.0 or later is preferred because some advanced features are not
supported in earlier versions.
z To use the source control option, you must have an SCCS installed on your local
computer. You cannot be running an SCCS from a network.
4. Mark Store clean build in source control. This is disabled if source control is not
enabled in options. (In Visual Studio: this is disabled if an SCCS is not installed
locally.
5. Click Browse under the Store clean build in source control option and specify
where in the SCCS to store the project. Dialogs from your SCCS lead you through
this process.
In the Wise editor: If you are using the Source Control menu for version control
on the entire installation, select a different folder in source control to store the
clean build.
In Visual Studio: If you are already storing the installation project in source
control, select a different folder in source control to store the clean build.
This completes the setup portion of the clean build process. Complete the following
steps when you are ready to copy the clean build to the clean build environment.
6. To make the final build, select File menu > Update Clean Build. (In Visual Studio:
Project menu > Update Clean Build.) This is disabled if no clean build options are set
for any release.
7. From your SCCS, copy or get the clean build folder to your clean build computer.
8. From the clean build folder on the clean build computer, double-click the file
Wisebuild.exe, which silently compiles the build.
The compiled files appear for each release whose Build checkbox is marked on the
Releases page. Two log files are created; one shows compile actions and the other
shows compile errors.
3. Mark Store clean build in directory. This lets you copy the clean build anywhere
on the network, to a disk or zip drive, or to any other directory accessible to your
computer. You can then copy it to a clean build computer.
4. Click Browse under the Store clean build in directory option and specify the
directory in which to store the clean build.
This completes the setup portion of the clean build process. Complete the following
steps when you are ready to copy the clean build to the clean build environment.
5. To make the final build, select File menu > Update Clean Build. (In Visual Studio:
Project menu > Update Clean Build.) This is disabled if no clean build options are set
for any release.
The new or updated files are copied to the directory you selected.
6. From the directory, copy the clean build folder to your clean build computer.
7. From the clean build folder on the clean build computer, double-click the file
Wisebuild.exe, which silently compiles the build.
The compiled files appear for each release whose Build checkbox is marked on the
Releases page. Two log files are created; one shows compile actions and the other
shows compile errors.
Note
This page is enabled in a .WSI only.
Examples:
z If you set the installation to pre-install the Windows Installer runtime, and the
destination computer already has that runtime installed, then the runtime file is not
downloaded.
z If the installation contains multiple features, only the features that the end user
selects during installation are downloaded and installed.
Without WebDeploy, you could create a single-file .EXE, upload it to an FTP server, and
let your end users download it by clicking on its link. The disadvantage of this is that a
single-file .EXE can be very large. The entire installation, including Windows Installer
runtimes, is downloaded whether or not it is needed on the destination computer. The
resulting download can take a long time and tie up bandwidth.
Note
You cannot use WebDeploy to run patches (.MSP) or transforms (.MST). To distribute
updates with WebDeploy, format the installation as an upgrade using the Upgrades
page.
You can use WebDeploy in several ways, depending on how you set the WebDeploy
options:
WiseScript runtimes that you add on the Prerequisites page are always included in the
.EXE.
This is the best method to use when distributing installations over the Internet because,
if a self-repair is needed, the .MSI is cached locally and no further downloads are ever
required.
WiseScript runtimes that you add on the Prerequisites page are always included in the
.EXE.
This method is best used over a corporate intranet. Because the .MSI is run directly from
the Web, if a self-repair or install-on-demand is needed, the end user must have
immediate access to the original Web location of the .MSI.
Create an .EXE that runs an external .MSI, and an external .INI that
contains download and installation information
Use this method to change the download information dynamically, perhaps as a result of
end user input. You compile to an .EXE and .INI and then distribute the .EXE on a CD or
other media along with an Autoplay program.
Example:
Suppose you want to let the end user select from multiple download sites. You write an
Autoplay program that presents download site options to the end user. When the end
user selects a site, the Autoplay program copies the .EXE and .INI to a temporary
directory, then edits the .INI file, adding the URL of the selected download site. The
Autoplay program then launches the .EXE, which connects to the appropriate Web site
based on the updated information in the .INI file, and runs the .MSI file it finds there.
Also see:
z For more efficient downloading, organize the installation into components. Only the
components that are needed for the installation are downloaded. See Working With
Components and Features on page 523.
z Make the installation download more efficiently. On the Installation Expert > Media
page, display the Media Details dialog and select One Cab per component in the
Cab Options field. See Adding a Media Item on page 202.
z It is a good idea to digitally sign installations that you plan to deploy over the Web.
To add an authenticode digital signature to your installation files, use the Digital
Signature page. This requires Windows Installer 2.0 or later. See Adding a Digital
Signature to Your Installation on page 219.
Note
This page is enabled in a .WSI only.
The WebDeploy™ page lets you enable an installation for distribution via the Web. You
do this by setting options for compiling the installation and for connecting to the Web
server that will contain the installation files. For suggestions on how to set WebDeploy
options to meet your requirements, see Creating Web-Based Installations With
WebDeploy on page 194. Also see Tips for Creating an Efficient WebDeploy Installation
on page 197.
3. Mark Create a Web-based installation. This enables the remaining options on the
page.
4. From .EXE Options, specify how the installation is created. This is linked to the
.EXE Options field on the Build Options page.
5. In the following fields, specify the URL to which you will upload various installation
files. This information is included in the installation and determines where the
installation looks for files to download. You must specify the full URL address,
pathname, and file name. Include a username and password if your Web server
requires them. Use the format:
http://username:password@www.address.com/file_name.msi
Click the Edit button next to each field to display a URL Settings dialog, which lets
you enter the elements of the file location separately and then builds the full path
from your entries.
Note
If you select the Create .EXE and .INI option, the password is stored in the .INI
file. If you are concerned about the password being visible, select the Create a
downloadable .EXE option instead, which stores the password in the .EXE.
Leave these fields blank to embed the .MSI in the .EXE if the Prerequisites page
is set to pre-install the Windows Installer runtime.
Leave these fields blank to embed the .MSI in the .EXE if the Prerequisites page
is set to pre-install the .NET Framework runtime.
Note
This page is enabled in a .WSI only.
z Any FTP client. Do this when the Windows Installer and .NET runtime installation
files will be stored in a different location than the application installation files.
Note
On each of the following pages, select a release.
Build Options page: In the .EXE Options field, select one of the WebDeploy
options.
WebDeploy page: Specify the same path in all the Download URL fields.
Package Distribution cannot upload to multiple locations.
2. Make sure that a directory exists on the Web server at the URL address you
specified on the WebDeploy page.
3. Run Package Distribution and mark the FTP Server option. In the FTP Upload
Directory field on the FTP Server dialog, make sure you enter the same directory
path specified in the Download URL fields on the WebDeploy page. For details, see
Copying an Installation to an FTP Server on page 285.
Package Distribution uploads all the files needed by the WebDeploy installation to a
single directory on your Web server.
Now you can distribute the installation .EXE. If you will distribute the .EXE from the Web
rather than on CD or other media, create a Web page with a link to the .EXE.
If you are distributing a single-feature .MSI over the Internet, the installation
should be compiled to an .EXE that contains the .MSI. Create a Web page
containing a link to the .EXE file, then upload the .EXE to the location of that
Web page.
Example:
UploadSample2.exe to http://www.Sample2.com/installations
UploadSample2.msi to http://www.Sample2.com/downloads
If you are distributing the installation via an Autoplay program, the installation
should be compiled to an .EXE that runs an external .INI and .MSI. Save the
Autoplay program and the .EXE and .INI files to a CD or other distribution
media. Then upload the .MSI and any external .CAB files to the URL address you
specified in the .MSI Download URL field on the WebDeploy page.
Example:
3. If the installation will pre-install any Windows Installer or .NET runtimes, use an FTP
client to upload the following files:
If you specified a 9x Download URL on the WebDeploy page, upload the file
InstMsi.exe to that Web address.
If you specified a NT Download URL on the WebDeploy page, upload the file
InstMsiW.exe to that Web address.
If you specified a .NET Runtime URL on the WebDeploy page, upload the .NET
Framework file dotnetfx.exe to that Web address. Likewise, if you specified a
.NET Update URL, upload the .NET Framework update file to that Web
address.
If you do not have a copy of the appropriate runtime file, use the Download
Redistributables wizard. See Downloading Redistributable Files on page 35.
4. Distribute the installation media or notify your end users of the Web link to the .EXE.
The Media page lets you prepare an installation for distribution. Here, you specify
compression, the media’s size, holding directories, and how features and components
are organized on the media. You set media options per release.
If the installation spans more than one media, you can determine which files are placed
on which disk, or you can have it done for you.
z Add destination directories. Destination directories are holding places for the
installation. They represent the disks, CDs, or server you use for distributing your
application. See Adding a Media Destination on page 204.
z Copy the contents from the destination directories onto the media you will use for
distribution.
Note
At least one media item is required. If the Media page contains only one item, you
cannot delete it.
You can add media items to apply different compression options to different files in
components or features.
Example:
Leave a Readme file and a tutorial uncompressed, compress application files inside the
.MSI file, and compress graphic files into external .CAB files. In this case, you would add
these media items:
z Uncompressed Readme
z Uncompressed Tutorial
3. Click Add at the right of the Media page. The Media Details dialog appears.
4. In Media Name, describe the media item you’re setting up. Examples: Compressed
Application Files or Uncompressed Tutorial. This name appears on the Media page.
The media name must be unique within a release.
When you select one of the above compression options, you must select one of the
Cab Options below.
If you select this option, you also might want to use short file names for
uncompressed files outside the installation. See the description of Use short
file names for files uncompressed outside of the install in Creating a New
Release on page 179.
6. In Cab Options, determine the makeup of your .CAB files. To minimize file size, use
fewer .CAB files; to minimize installation time, use more .CAB files. This is disabled
if you select Uncompressed external files from Compression Option above, or
if you are working in an .MSI.
The remaining options on the Media page are enabled in a .WSI only.
7. In the Custom Media Settings area, specify settings that are related to the size of
your media.
You can also use this option to have one distribution medium (example: a CD)
filled up before starting to place media items on a second or third distribution
medium. See Example: Spanning an Installation Across Media and Sharing
Media Size Information on page 206.
Cluster Size
Select the bytes per sector of the distribution media.
8. In the Media Destinations section, enter the directory where the installation is
stored before you copy it to the distribution media. Enter one destination for each
distribution medium. For details, see Adding a Media Destination on page 204.
The media item appears on the Media page, in the Media Name column. To edit it,
double-click its name.
A media destination is a holding directory for the installation. It has the same capacity
as indicated in the Max Media Size field in the Media Details dialog. During compile, all
files for your installation are placed in one or more destination directories, and you copy
them from there to your distribution media. Enter one destination for each distribution
media. If you don’t create media destinations, that is, destination directories, the files
are copied to the directory where the .WSI file is located.
Note
The .MSI file is always placed in the first directory in the list.
4. In the Media Destinations section, click Add. The Media Destination Details dialog
appears.
Destination Directory
Specify the holding directory in which the installation files are stored before
they’re placed on the selected media.
If you specify a maximum media size on the Media Details dialog and do not
specify destination directories, installation files are placed in folders with
generic names (Disk1, Disk2, and so on) in the directory that contains the
project file.
Volume Label
This entry appears in the Label field when you right-click the icon for a volume
in Windows Explorer and select Properties.
It is very important to change volume labels for your disks or CDs to match this
value. Failing to do so will prevent the installation from working properly.
Disk Name
Enter the disk name that should appear when the installation prompts the end
user to insert another disk or CD. Example: Disk2. This only pertains to
installations that require multiple distribution media.
6. Click OK.
During compile, the installation is broken up into the directories you specify. Then, you
must copy the contents of each directory to a disk or CD that has the same name that’s
in the Volume Label field.
You can specify the features and components to include in each media item.
z You want to include every remaining feature and component that is not included in a
previous media item.
In any other case, use the Include Items for Media dialog to select the features and
components to include in the current media item. During compile, an error message
notifies you if you have failed to include a feature that has files added to it.
Examples:
z Suppose the installation includes a graphic feature with sample images, and you
want to compress these images into an external .CAB file. In this case, you could
create a media item called Compressed graphic files. Then, from the list of features,
you would select the graphic feature for inclusion in this media item.
4. In the Include Features/Components section, click Add. The Include Items for
Media dialog appears.
6. In the list box, select one or more features or components and click OK.
You can share media settings from a release with other releases in the installation. After
you initially share settings, the settings for the releases are linked. This means that any
change you make to the media settings for any of the linked releases is applied to all
other linked releases. At any time, you can break the link.
3. Click Share at the right of the Media page. The Share Release dialog appears.
4. From Copy/Share Media Settings From, select the release that contains the
settings to copy.
5. Click OK.
The settings of the release in Copy/Share Media Settings From immediately replace
the settings of the release in Current Release. Any change you make to the media of
either of the linked releases is applied to the other release, until you break the link.
3. Click Share at the right of the Media page. The Share Release dialog appears.
5. Click OK.
The link between the selected release and other releases is broken. The current settings
of the releases are not changed, but changing settings for one release no longer affects
the settings of other release.
z The files for your application use 1.5 GB of uncompressed disk space.
z For each of the 2 CDs, you can safely assume a maximum size of 550 MB, which
means that you need to compress some, but not all of your files.
z Your application includes some features that are always installed on the destination
computer. These are the files you compress.
z The application also includes some features that the end user can either install or
run from the CD-ROM. These are the files you don’t compress.
z One media item for those features and components that are always installed,
compressed into one big .CAB file.
z A second media item for those files that can be run from the CD and that you
therefore don’t compress.
2. Click Add at the right of the Media page. The Media Details dialog appears.
Media Name
Enter a name for the first media item. Example: Compressed Files.
Compression Option
Select Compress files into external Cab files.
Cab Options
Select One Cab (including modules).
Cluster Size
Select 2048 Bytes.
4. In the Media Destinations section, click Add. The Media Destination Details dialog
appears.
Destination Directory
C:\My Installation\CD 1
This assumes that you have a directory named My Installation on your C drive.
Volume Label
CD One
It is very important to change volume labels for your disks or CDs to match this
value. Failing to do so will prevent the installation from working properly.
Disk Name
CD 1
6. Click OK.
7. In the Media Destinations section, click Add again. The Media Destination Details
dialog appears.
Destination Directory
C:\My Installation\CD 2
Volume Label
CD Two
Disk Name
CD 2
9. Click OK.
10. In the Include Features/Components list, click Add and select the features and
components to compress.
12. On the Media page, click Add. The Media Details dialog appears.
Media Name
Enter a name for the second media item. Example: Uncompressed Files.
Compression Option
Select Uncompressed external files.
After compile, the destination directory CD 1 contains the .CAB file and as many
uncompressed files as can fit on the CD. All remaining uncompressed files are in the
directory CD 2.
Wise for Windows Installer lets you set advanced installation options and create special
purpose installations such as installations for Web applications.
Topics include:
z MTS/COM+ Page.
Command Lines You Can Apply to Command Lines You Can Apply to
Installations at Runtime Wise for Windows Installer for
Compiling
Call MSIExec.EXE. Call WFWI.EXE.
Are applied to Windows Installer Are applied to Wise for Windows Installer
installations or patches at runtime. at runtime to compile an installation.
They let you specify UI, logging, Options let you control logging and UI, and
advertising, and repair options. They set default values for properties in the
also let you edit public properties, compiled installation.
apply transforms, and apply or remove
patches.
Command Lines You Can Apply to Command Lines You Can Apply to
Installations at Runtime Wise for Windows Installer for
Compiling
Are documented fully in Command Line Are documented in Wise product
Options and Standard Installer documentation. See Command Line
Command Line Options in the Windows Options For WFWI.EXE on page 217.
Installer SDK Help.
Can be built automatically with the Must be built manually.
Command Line page. See Creating a
Command Line To Apply to an
Installation on page 210. Also build
them manually; see Command-Line
Options in the Windows Installer SDK
Help.
Also see:
2. Click Add.
Note
Although you can enter a command line in the Command Line field, we
recommend that you use the options provided in this utility for an optimal, error-
free installation.
Name
Enter the name of the command line.
Shortcut File
Specify the full pathname of the shortcut file (.LNK) you are creating to execute
the command line. The default location is the Temp directory.
You also can create a batch file by changing the file extension to .BAT.
Install Mode
Select an install mode:
Install
Installs or configures the installation package. Select this option to remove
patches.
Advertised
Advertises the installation on the destination computer.
Repair
Repairs an application that is installed on the destination computer.
Network Install
Extracts the files in the installation package to a network location.
Uninstall
Uninstalls the installation package.
Update
Updates the installation package by applying patches.
4. Depending on the install mode you select, additional tabs appear on the Command
Line Details dialog. Following are the tabs that appear and how you can use them to
modify the command line:
UI Options
Make the installation run in silent mode and set the user interface level. See
Applying UI Options to an Installation on page 211.
Logging
Generate a log when the installation is run and select logging options. See
Applying Logging Options to an Installation on page 213.
Advertising
Advertise applications and apply a transform to the advertised package. See
Applying an Advertising Option to an Installation on page 214.
Repair
Repair installed files. See Applying a Repair Option to an Installation on
page 215.
Properties
Change the value of public properties. See Changing Public Properties in an
Installation on page 215.
Transforms
Apply transforms to the installation package using the TRANSFORMS property.
See Applying Transforms to an Installation on page 216.
Patches
Add or remove patches using the PATCH and MSIPATCHREMOVE properties. See
Applying or Removing Patches With a Command Line on page 216.
The command line is added to the Command Line page. To edit it, double-click its name.
To delete it, select it and click Delete.
You can set the UI options, which determine how much the end user interacts with the
installation. See User Interface Levels in the Windows Installer SDK Help. You can set UI
options for all versions of Windows Installer or for Windows Installer 3.0 only.
1. On the Command Line Details dialog, click the UI Options tab. See Creating a
Command Line To Apply to an Installation on page 210.
qn - No UI
Displays no user interface during the installation.
qb - Basic UI
Displays built-in modeless dialogs that show progress messages during the
installation.
Note
Modal dialogs require user input whereas modeless dialogs don’t.
qr - Reduced UI
Displays authored modeless dialog and built-in modal error-message boxes
during the installation.
qf - Full UI
Displays both modal and modeless dialogs that have been authored into the
internal user interface, and built-in modal error-message boxes during the
installation.
qn+ - No UI
Displays no user interface, except for a modal dialog at the end of the
installation.
qb+ - Basic UI
Displays built-in modeless dialogs that show progress messages during the
installation and a modal dialog at the end of the installation.
qb- - Basic UI
Displays built-in modeless dialogs that show progress messages and no modal
dialogs during the installation.
4. If you mark either the qb+ or qb- option, then the Hide the Cancel Button button
is enabled. Mark this to add the ! switch to the command line, which removes the
Cancel button from the installation dialogs.
5. To set options for Windows Installer 3.0 only, mark one of the following options in
the Windows Installer 3.0 only section. This overrides any options you mark in
the All Windows Installer versions section. (These options are enabled only if
Windows Installer 3.0 or later is installed on your computer.)
Quiet - No UI
Displays no user interface during the installation.
6. If you mark Quiet or Passive in the Windows Installer 3.0 only section, you can
also control how Windows Installer handles reboots.
No restart
Never restarts the computer after the installation.
Force restart
Always restarts the computer after the installation.
Prompt restart
(Passive only.) Displays a message that a restart is required to complete the
installation and asks the user if they want to restart the computer now.
7. Click OK.
1. Click the Logging tab on the Command Line Details dialog. See Creating a Command
Line To Apply to an Installation on page 210.
This enables the field to its right, which displays the default location for a log file
created during installation. The default location is the Temp directory.
4. To set logging options for all versions of Windows Installer, mark the appropriate
checkboxes in the All Windows Installer versions section:
v - Verbose output
Logs more detailed information about each event or error.
i - Status messages
w - Non-fatal warnings
a - Start up of actions
Logs actions as they are started.
r - Action-specific records
u - User requests
c - Initial UI parameters
Logs the initial user interface parameters.
o - Out-of-disk-space messages
p - Terminal properties
5. To set logging options for Windows Installer 3.0 or later, mark log - log all
information in the Windows Installer 3.0 or later section. This overrides any
options you mark in the All Windows Installer versions section.
Note
This option is enabled only if Windows Installer 3.0 or later is installed on your
computer. It will work on the destination computer only if it has Windows Installer
3.0 or later installed.
6. Click OK.
You can set advertising options that determine who sees the advertised application and
whether a transform is applied to it. For information on advertising options, see
Advertisement in the Windows Installer SDK Help.
1. Click the Advertising tab on the Command Line Details dialog. See Creating a
Command Line To Apply to an Installation on page 210.
Note
The Advertising tab appears only when Install Mode on the General tab of the
Command Line Details dialog is set to Advertised.
In the field below the checkbox, specify the transform file to include in the
installation.
3. Click OK.
1. Click the Repair tab on the Command Line Details dialog. See Creating a Command
Line To Apply to an Installation on page 210.
Note
The Repair tab appears only when Install Mode on the General tab of the
Command Line Details dialog is set to Repair.
3. Click OK.
1. Click the Properties tab on the Command Line Details dialog. See Creating a
Command Line To Apply to an Installation on page 210.
Note
The Properties tab appears only when Install Mode on the General tab of the
Command Line Details dialog is set to Install or Network Install.
2. Select a property in the left pane and click Add to copy it to the right pane.
4. Click OK.
1. Click the Transform tab on the Command Line Details dialog. See Creating a
Command Line To Apply to an Installation on page 210.
Note
The Transforms tab appears only when Install Mode on the General tab of the
Command Line Details dialog is set to Install.
4. Because Windows Installer applies transforms in the order specified, adjust the
order of the transforms as needed.
5. Click OK.
Prior to Windows Installer 3.0, you could only remove a patch by uninstalling the entire
application. Beginning with Windows Installer 3.0, you can remove a single patch or a
set of patches in any order without uninstalling the application. See Removing Patches
and Uninstallable Patches in the Windows Installer SDK Help.
1. On the General tab, select one of the following from Install Mode. See Creating a
Command Line To Apply to an Installation on page 210.
Install
Use this option to remove or apply patches. You can apply patches to an
installed package or to the package being installed by the command line
Update
Use this option to update installed applications.
3. Mark whether to add or remove patches. The option to remove patches is enabled
only if Windows Installer 3.0 or later is installed on your computer.
5. Repeat the preceding step to specify additional patches. (Windows Installer 3.0 or
later only.)
6. Windows Installer applies patches in the order listed. To rearrange the order, click
Move Up or Move Down. If you used patch sequencing with Windows Installer 3.0
when you created the patches, that sequencing would override the order you specify
here.
7. Click OK.
You can also launch Wise for Windows Installer (WfWI.exe) in the Visual MSIDiff mode
using the following command line: WFWI.EXE <base file> <compare file>. For
information on Visual MSIDiff, see Comparing Windows Installer Files on page 85.
Do not confuse this list of command line options with the command line options that you
can apply at runtime to an .MSI via the executable msiexec.exe. For a list of those
command line options, see Command Line Options in the Windows Installer SDK Help.
You can use the Command Line page to build command lines to apply to your .MSI. See
Creating a Command Line To Apply to an Installation on page 210.
If you set multiple properties, separate property value pairs with spaces. Enclose values
with double quotes.
Enter the following command line statement into a batch file or any other program that
has the ability to run command line statements, such as Scheduled Tasks in the Control
Panel:
where:
To define a digital signature, mark the Add a digital signature option on the Digital
Signature page and complete the page:
z Web URL
Enter your company’s Web site address.
z Descriptive Name
Enter the name of your application. This name is embedded in your Authenticode
certificate to let end users verify the name of the application they are installing.
z TimeStamp URL
Specify the URL you use for your timestamping service. Timestamping lets end
users distinguish between a certificate that’s expired but was valid when it was used
to sign the installation, and a certificate that was used to sign an installation while it
was expired. The timestamping service must be available to build the installation
but does not need to be available to the end user running the installation.
Note
The ability to add a digital signature to .MSI and external .CAB files is supported
only by Windows Installer 2.0 or later.
environment, you must also create a package definition file (.PDF or .SMS), which
contains information about the installation. You can create the package definition
file manually, or configure the installation to create it when compiled. For information
about SMS, visit the Microsoft Developer Network (msdn.microsoft.com).
The Microsoft SMS page specifies the information for the .MIF file and package definition
file. Alternatively, you can apply the /m command line option to msiexec.exe to create a
status.mif file. See Command Line Options in the Windows Installer SDK Help.
To have the installation create a status .MIF file and a package definition file, mark
Create Status MIF and complete the page.
z Serial Number
Enter the serial number of the application being installed.
You can also import an existing Microsoft SMS installation. See Convert SMS Installer or
WiseScript Installation on page 358.
2. In the Application Type field, select either .NET Application or Mixed (.NET and
Win32).
This designates the installation as .NET and determines how Wise for Windows
Installer handles COM interop registry entries. See Product Details Page on page 92.
3. Add assemblies and their dependency files to the installation, using the Files page.
For details, see Adding .NET Assemblies to the Installation on page 124.
Wise for Windows Installer finds all multifile assemblies and adds them
automatically. Depending on the Scan Dependencies option in Wise Options,
dependency assemblies might be added automatically, or you might be prompted to
add them. If the option to Never scan dependencies is selected, you must add
the dependencies.
5. Finish building the installation as usual, then compile and distribute it.
Also see:
This designates the installation as .NET and determines how Wise for Windows
Installer handles COM interop registry entries. See Product Details Page on page 92.
3. Add assemblies to the installation, using the Files or Web Files page.
For details, see Adding .NET Assemblies to the Installation on page 124. Be sure to
add all files in multifile assemblies.
a. Use a computer that has the .NET Framework installed and has the assemblies.
This typically is a development computer.
b. For each assembly, run the ildasm tool from the Visual Studio .NET command
prompt. When you run ildasm, you select an assembly and the program displays
the assembly’s attributes. Write down the assembly’s name, publicKeyToken,
and version, as well as any dependencies.
c. On the Files or Web Files page, add the dependency assemblies to the same
directory as the assembly that has the dependencies. Repeat for each assembly.
d. In the lower right pane of the Files or Web Files page, double-click an assembly
to display the File Details dialog. Click the Assembly tab. Click Add to add the
Name and Value of the assembly’s name, publicKeyToken, and version. Repeat
for each assembly. For details, see Editing Assembly Settings for Files on
page 133.
5. If the installation contains both .NET and Win32 components, register the .NET
components for COM interop.
a. Use a computer that has the .NET Framework installed and has the assemblies.
This typically is a development computer.
b. For each .NET assembly, run the Assembly Registration tool (regasm) from the
Visual Studio .NET command prompt. Run regasm with the argument /regfile
and specify a file name.
This command generates a .REG file containing the registry entries you need to
allow the .NET assembly to be called as a COM component. Search for
“Assembly Registration Tool (Regasm.exe)” in the MSDN Library
(msdn.microsoft.com/library/).
c. On the Registry page, import the .REG file you created for each assembly. See
Adding Registry Keys on page 144.
7. Finish building the installation as usual, then compile and distribute it.
Also see:
To learn about file-related functionality on the Web Files page, see Files or Web Files
Page on page 113 and its subtopics.
Note
If you cannot see the Web Files page in the list of pages in Installation Expert, select
Web Application or All from the Page Views drop-down list in the upper left corner.
Also see When to Use the File-Related Installation Expert Pages on page 115.
ASPNET Properties
The default ASP .NET users that are set by .NET installations are put into Windows
Installer properties: ASPNET_USER, ASPNET1.0_USER, and ASPNET1.1_USER. You can
use these for setting directory security. See Runtime Properties on page 424.
Directory Security
You can set NTFS directory security, which enhances Web site security. See Setting
Permissions for Files and Directories on page 132.
Wildcard Groupings
To make it easier to quickly add all files of specific types, such as all Web file types, you
can set up Wildcard groups in Options. Then, when you add the contents of a directory
on the Files or Web Files page, you can choose a wildcard group to filter on. See Setting
Wildcard Groups on page 54.
Instance Transforms
You can install more than one instance of a Web application to multiple virtual directories
using instance transforms; see Multiple Instance Installations on page 352.
sites only on server operating systems, which excludes Windows 2000 Professional and
Windows XP. To let end users install to workstation operating systems, you can allow a
Web site to be created as a virtual directory; see Install as Virtual Directory on
Workstation in Setting Installation Options for a Web Installation on page 229.
If you don’t see the Web Files page, select All from the Page Views drop-down list.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
3. If the Web installation requires a Web server restart, mark Restart IIS service
during installation. This checkbox does not appear when All Features is selected
above.
Description
Enter a description for the directory, which serves as an identifying name in
Internet Information Services.
Local Path
Specify the physical directory to which the Web site is mapped. You can browse
to any directory that has already been added to the installation. Example:
Change this to a directory under wwwroot to have this item reside under
wwwroot.
7. Click OK.
10. Click the Web Site UI tab. Use this tab to specify the installation options that will be
available to the end user at run time. For details, see Setting Installation Options for
a Web Installation on page 229.
11. Complete the remaining tabs on the details dialog. These tabs correspond to options
on the properties dialog in IIS, version 5.0. Use them to specify which options are
user-configurable at run time. For information on these tabs, see the IIS help. Also
see About the Web Site Details Dialog on page 232.
Note
Clicking OK on the details dialog regenerates the Web dialogs in the installation.
Click No to clear the Web Folder settings but leave the folders and files in the
installation and the lower-left pane.
If the Delete button is disabled, it means you have selected a normal folder instead
of a Web site. To delete a normal folder from the installation, use the Files page.
On the Files page or Visual Studio Solution page, you cannot delete a physical directory
that is linked to a Web site.
Settings on the details dialog that do not apply to virtual directories are disabled.
However, if you change this back to a Web site, those settings are retained. For
information on Web site settings, see Setting Installation Options for a Web Installation
on page 229 and About the Web Site Details Dialog on page 232.
If you don’t see the Web Files page, select All from the Page Views drop-down list.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
3. If the Web installation requires a Web server restart, mark Restart IIS service
during installation. This checkbox does not appear when All Features is selected
above.
Alias
Enter an alias for the directory. This typically appears in the URL to this Web
resource.
Local Path
Specify the physical directory to which the alias is mapped. You can browse to
any directory that has already been added to the installation and create an
additional directory (optional) by typing its name in this field.
7. Click OK.
The details dialog appears with several tabs. For a top-level virtual directory, the
Web Site, Web Site UI, and Home Directory tabs appear. For a child virtual directory,
the Virtual Directory and Virtual Directory UI tabs appear. The remaining tabs are
the same for both types of virtual directory.
Remove on Uninstall
(Top-level virtual directories only.) Mark this to have this virtual directory
removed (unregistered) from IIS during uninstall. This does not uninstall the
physical directory and files—the normal uninstall mechanism handles that.
10. To specify the installation options that will be available to the end user at run time,
do one of the following:
If this is a top-level virtual directory, click the Web Site UI tab. For details, see
Setting Installation Options for a Web Installation on page 229.
If this is a child virtual directory, click the Virtual Directory UI tab. For details,
see Setting Installation Options for a Child Virtual Directory on page 230.
11. Complete the remaining tabs on the details dialog. These tabs correspond to options
on the properties dialog in IIS, version 5.0. Use them to specify which options are
user-configurable at run time. For information on these tabs, see the IIS help. Also
see About the Web Site Details Dialog on page 232.
Note
Clicking OK on the details dialog regenerates the Web dialogs in the installation.
2. In the upper left list box, navigate to and select the directory on your computer.
The contents are added into the virtual directory. If you don’t first clear the Dest.
Directory field, then the directory is added as a Web folder.
1. On the Web Files page, in the lower left list box, select a parent node.
Alias
Enter an alias for the directory. This appears in the URL to this Web resource.
Local Path
Browse to the existing directory to be mapped to a virtual directory.
4. Click OK.
On the Files page or Visual Studio Solution page, you cannot delete a physical directory
that is linked to a virtual directory.
Settings on the details dialog that do not apply to Web sites are disabled. However, if
you change this back to a virtual directory, those settings are retained. For information
on virtual directory settings, see Setting Installation Options for a Web Installation on
page 229 and About the Web Site Details Dialog on page 232.
If you don’t see the Web Files page, select All from the Page Views drop-down list.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
3. In the lower left list box, select a Web site or virtual directory.
7. Complete the tabs on the details dialog. These tabs correspond to options on the
properties dialog in IIS, version 5.0. For information on these tabs, see the IIS help.
Also see About the Web Site Details Dialog on page 232.
You set options for each Web site or virtual directory you have added on the Web Files
page. Setting installation options adds Web (IIS) dialogs to the installation. If you omit
the procedure below, no Web dialogs appear to the end user, and the installation
attempts to apply the defaults for all items.
Caution
Do not edit the Web (IIS) dialogs, except to change their order (as a group) in the
installation sequence. Editing the Web dialogs might cause unexpected, undesirable
behavior, including damage to the installation. Also, any operation within this product
that affects the installation’s user interface will regenerate the Web dialogs, therefore,
any changes you make to them will be lost.
2. In the lower left list box, select a Web site or a top-level virtual directory and click
Details. If you don’t see the item you want, make sure you have the correct feature
selected in Current Feature.
4. To display installation dialogs to the end user at run time, mark Display Run-Time
UI. This adds Web dialogs to the installation.
If this is a top-level virtual directory, no other options are available. Skip the
remaining steps and click OK.
If this is a Web site, the remaining options on the tab are enabled when you mark
this checkbox.
Note
If the current installation was built in an older version of Wise for Windows Installer,
you are prompted to first convert the dialogs on the Dialogs page. Converting resets
navigation and conditions, so if you have customized the dialogs, back up this
installation before converting.
Virtual Directory
Mark this to let end users install Web resources to a virtual directory. If you
select only this option, then this Web site will be installed as a virtual directory.
These options are enabled if you mark New Web Site above. Mark the items that
the end user should be able to configure during installation. These items correspond
to options on the properties dialog in IIS. See About the Web Site Details Dialog on
page 232.
7. Click OK.
Note
Clicking OK on the details dialog regenerates the Web dialogs in the installation.
directory is directly under Destination Computer, then see Setting Installation Options
for a Web Installation on page 229.
You set options for each Web site or virtual directory you have added on the Web Files
page. Setting installation options adds Web (IIS) dialogs to the installation. If you omit
the procedure below, no Web dialogs appear to the end user, and the installation
attempts to apply the defaults for all items.
Caution
Do not edit the Web (IIS) dialogs, except to change their order (as a group) in the
installation sequence. Editing the Web dialogs might cause unexpected, undesirable
behavior, including damage to the installation. Also, any operation within this product
that affects the installation’s user interface will regenerate the Web dialogs, therefore,
any changes you make to them will be lost.
2. In the lower left list box, select a child virtual directory and click Details. If you don’t
see the item you want, make sure you have the correct feature selected in Current
Feature.
4. To display installation dialogs to the end user at run time, mark Display Run-Time
UI. This adds Web dialogs to the installation. When you mark this checkbox, the
remaining options on the tab are enabled.
Note
If the UI is disabled for the parent Web site, then Web dialogs are not generated for
this child virtual directory.
Note
If the current installation was built in an older version of Wise for Windows Installer,
you are prompted to first convert the dialogs on the Dialogs page. Converting resets
navigation and conditions, so if you have customized the dialogs, back up this
installation before converting.
6. Click OK.
Note
Clicking OK on the details dialog regenerates the Web dialogs in the installation.
z Web Site UI
(Web sites and top-level virtual directories.) Lets you specify the installation options
that will be available to the end user at run time. See Setting Installation Options for
a Web Installation on page 229.
z Virtual Directory UI
(Child virtual directories only.) Lets you specify the installation options that will be
available to the end user at run time. See Setting Installation Options for a Child
Virtual Directory on page 230.
Options in Wise for Windows Installer That are Different From IIS:
z On the Web Site tab, you can only specify one identity for a Web site (consisting of
an IP address, port, and host header), whereas in IIS you can specify multiple
identities.
z The Web Site tab lacks the Connections and Logging sections.
z The Home Directory and Virtual Directory tabs lack the options to specify where the
content should come from.
z The Directory Security tab lacks the IIS options for IP address and domain name
restrictions and Secure communications. The navigation of this tab is also different
from IIS.
z The HTTP Headers tab lacks the ability to edit content ratings.
This is accomplished by a Web settings XML file that is generated by the end user from a
special command line. The end user can edit this XML file to set the Web installation
options they want. When the end user runs the installation with another special
command line, the Web installation settings are obtained from the XML file.
The XML file can be created and used during the initial installation only. Using the
command lines during a reinstall or uninstall does not work. Instead, the .MSI runs as it
normally would for the reinstall or uninstall.
z The XML file is generated for a specific .MSI and should only be used with that .MSI.
z The XML file is generated for a specific version of Wise for Windows Installer and can
only be used with that version.
z The XML file contains the default Web site settings that you have set in the
installation.
z If the installation contains a Web site, the XML file cannot be generated on a
workstation.
z End users should limit their editing to the sections in the XML file that are
commented. These generally are settings that appear in the Web dialogs, that is,
settings that appear on the Installation Settings, Web Site UI, and Virtual Directory
tabs on the Web site details dialog. Editing non-commented settings can cause the
installation to fail or cause IIS to be configured improperly. We cannot provide
technical support for such problems.
The default Web site settings are written to the XML file specified in the command
line. The installation itself is not performed and a Setup Canceled dialog appears.
2. Edit the XML file to set the desired options and then save the changes.
Follow the guidelines at the beginning of the XML file. Only edit settings that are
commented.
3. On the destination computer, run the installation with the following command line:
The installation uses information in the XML file to configure the Web settings. Web
dialogs do not appear during installation.
On this page, you specify a connection string and SQL statements, which are executed
during installation. Thus you have the ability to do any configuration that is possible with
SQL statements. You can generate SQL statements in 3 ways:
z Specify a database to recreate, and the necessary SQL statements are generated
automatically.
See Tips on Using the SQL Server Scripts Page on page 235.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
Items that you add to a feature are installed on the destination computer only if the
feature is installed. Items that you add to a condition are installed only if the feature
is installed and the condition is true.
4. Click the Connection tab and specify a name for the SQL script and a connection
string that connects to the database the installation modifies.
5. Click the Statements tab and specify SQL statements to be executed on the
destination computer.
6. Click the Replacement tab and specify text strings to be found and replaced within
the SQL statements at install time.
The script is added to the list on the SQL Server Scripts page.
8. The SQL scripts are executed in the order they appear on the SQL Server Scripts
page. To rearrange the order, select a statement name and click Move Up or Move
Down.
For information on setting the required SQL Server version, see Setting a Requirement
on the System Requirements Page on page 166.
z Uninstall won’t roll back the changes performed by the SQL statements.
z Databases are connected to and configured through the ODBC driver on the
destination computer.
z The SQL scripts you specify are saved to a file with the same name as the script
name you specify, with the extension .SQL The file is added to the installation. This
file appears on the Files page under a Temp directory. During installation, this file is
installed, its statements are executed, and then it is deleted. Do not remove this file
from the installation.
z The SQL Server Scripts page does not provide error checking for valid SQL syntax or
debugging for failed statements. Make sure the SQL code you enter is well-tested
before deployment. If errors occur during installation, the end user will see SQL
error dialogs.
Note
These tips assume familiarity with SQL Server statement syntax and debugging.
Technical Support does not provide assistance with debugging SQL statements.
Also see Configuring a Microsoft SQL Server During Installation on page 234.
Name
A name for the SQL script is generated and displayed here. You can accept the
default or enter a more descriptive name. If you later change this field, the
script file is not renamed.
A file with this name and the extension .SQL is added to the installation.
Connection String
Enter a connection string that connects to a specific Microsoft SQL Server and
database. The default connection string works for most locally installed SQL
Server databases.
If you use the SQL Connection dialog in this installation, enter the Windows
Installer property WISE_SQL_CONN_STR enclosed in brackets. This property is
populated with a valid connection string when the end user completes the SQL
Connection dialog and clicks Next. See About the SQL Connection Dialog on
page 452.
If your application connects to more than one SQL Server during installation,
add a SQL Connection dialog for each additional server, edit the additional
dialogs, and use a different property for each connection string. See Editing
Additional SQL Connection Dialogs on page 454.
The database you specify here must be accessible through ODBC on the
destination computer. If you have a database registered in ODBC on your own
computer, you can click Browse to select it, and the connection string is
generated. For this to work, the destination computer must have access to the
same database.
3. Click OK.
Also see Tips on Using the SQL Server Scripts Page on page 235.
2. To import a file containing SQL statements, click Import SQL File and specify a .SQL
or .TXT file that contains SQL statements.
The statements appear on the Statements tab, where you can edit them. If you
later change the file on disk, you must re-import the file to include the changes in
the installation.
Connection String
Specify a connection string to the Microsoft SQL Server and database. It must
be accessible to your computer. If it is registered as an ODBC data source on
your computer, click Browse to select it, and the connection string is generated.
Database Name
Enter a name for the database to be created on the destination computer.
Import Views
Mark this to import the defined views of the database.
Import Procedures
Mark this to import the defined procedures of the database.
Import Tables
Mark this to import blank tables from the database. This does not import the
data (mark Import Data Rows to import data). You can import all tables, only
certain tables, or all tables except certain tables. For the last 2 options, enter a
list of table names delimited by commas.
5. Click OK.
Note
Error checking or debugging is not available for statements that you type or import.
Make sure the SQL code you enter is well-tested before deployment. If errors occur
during installation, the end user will see SQL error dialogs.
Also see Tips on Using the SQL Server Scripts Page on page 235.
1. Click the Replacement tab on the SQL Script Details dialog. See Configuring a
Microsoft SQL Server During Installation on page 234.
2. Click Add.
Text to Find
Enter regular text or formatted text, such as a bracketed property name. If you
enter formatted text, it is resolved before the find and replace takes place.
Example: If you enter [INSTALLDIR], the find and replace searches for the
value of INSTALLDIR.
Replace With
Enter regular text or formatted text, or select a current Windows Installer
property from the drop-down list. If you enter formatted text, items are
replaced with the value of the formatted text. This is useful for creating dynamic
installations. Example: Suppose you are creating a new database on the server.
Place an edit field on a dialog asking for the new database name. The answer is
stored in a property, which you could then use in this field, replacing the current
database name.
4. Click OK.
Note
Keep in mind that any matching string is replaced, so only replace strings you know to
be unique. Example: If you replace “Red” with “Blue,” a “PreparedStatement” object in a
SQL statement becomes “PrepaBlueStatement” and breaks the code.
Also see Tips on Using the SQL Server Scripts Page on page 235.
When an end user downloads your .NET application using no-touch deployment, they
need specific security settings to be able to run the application. You import these
security settings from your computer into the installation. When the application is
downloaded, the settings you imported into the installation change the client’s security
settings and enable the application to run.
To be able to import security settings using the .NET Framework Security page, you
must have the .NET Framework installed on your computer. You create and configure
.NET Framework security settings using the Microsoft .NET Framework Configuration
tool, which is in Administrative Tools in your computer’s Control Panel. The .NET
Framework security settings consist of a hierarchy of code groups. When you import
.NET Framework Security settings, you import one or more of these code groups.
Properties and
Code groups on values of the
your computer. code group last
selected in the
upper-left pane.
Properties and
Code groups you values of the
have imported code group last
from your selected in the
computer into lower-left pane.
the installation.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
Items that you add to a feature are installed on the destination computer only if the
feature is installed. Items that you add to a condition are installed only if the feature
is installed and the condition is true.
3. In the upper-left list box, navigate to and select the code group that contains the
security settings.
4. Click Add Code Group to add the code group to the installation.
The code group appears in bold type in the lower-left pane. If you import a child
code group, any parent code groups also appear but are not in bold type. These
parent code groups contain no security settings, but maintain the correct
hierarchical structure for the code groups.
To delete a .NET Framework security code group from the installation, select it in the
lower-left list box and click Delete. If the code group has parent code groups that are
not in bold type, they do not need to be deleted. They are removed when you exit the
.NET Framework Security page.
MTS/COM+ Page
¾ Professional and Enterprise Editions only.
Use the MTS/COM+ page to add MTS or COM+ application packages to an installation.
The MTS/COM+ page is intended for software developers who know the computer
names of the servers that contain MTS or COM+ server applications.
Both MTS (Microsoft Transaction Server) and COM+ are steps in the evolution of the
Component Object Model (COM) technology. MTS, which was developed first, is a
transaction processing system for developing, deploying, and managing server
applications. MTS Server is an add-on that runs on Windows NT 4.0.
COM+, the next generation of COM technology, is part of the operating system on
Windows 2000, XP, and Server 2003. It provides a standard that lets any two
components communicate with each other regardless of what computer each is running
on, the operating systems that are running, and the language in which the components
are written. COM+ ships with and requires Microsoft Windows 2000, XP, or Server 2003.
All computers can communicate via COM if they have support for DCOM (Distributed
Component Object Model) installed.
MTS or COM+ packages generally consist of server software and client software. When
you add an MTS or COM+ package to an installation, you must designate it as either a
server installation or a client installation. You cannot add both the server and client
installation for a given MTS or COM+ application to the same feature. If you need to
install both the server and client of the same application, either create two .MSI files, or
put the server installation in one feature, and the client installation in another feature. If
the MTS or COM+ application contains roles, those roles are not installed on destination
computers.
Note
(Optional) You can add the files that make up the MTS/COM+ application on the
Files page. This lets you place the files in any directory structure. Otherwise, the
files are placed in the Program Files\{GUID}\ directory. If you add the files yourself,
you must mark the Use Existing Source Paths checkbox later in this procedure.
3. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
Items that you add to a feature are installed on the destination computer only if the
feature is installed. Items that you add to a condition are installed only if the feature
is installed and the condition is true.
Application Name
Specify the MTS/COM+ application. You can only select from currently installed
applications.
GUID
(Read-only.) This contains the GUID of the MTS/COM+ application that you
select.
Installation Type
Select the installation type:
Client
Installs the client portion of the MTS/COM+ application. This installation type
requires a remote server name. In Remote Server Name, enter the name
of the computer on the network that will contain the MTS/COM+ server
application the client will connect to. If you design the installation so that the
server name is placed into a property dynamically during the installation
wizard dialogs, you can enter that property name here, surrounded by
brackets.
Server
Installs the server portion of the MTS/COM+ application.
5. Click OK.
Topics include:
z Palm OS Installations.
z Add support for multiple mobile device platforms and processors. Each time you
compile the .MSI, the necessary .CABs are recompiled and wrapped inside the .MSI.
When the .MSI runs on a desktop computer that has an attached mobile device, the
appropriate .CAB is extracted from the .MSI and installed onto the mobile device.
z Create a single .MSI installation that installs to the desktop computer and the
mobile device.
z Close the installation, re-open the installation, and continue editing mobile device
support from where you left off.
z You cannot close the .CAB, re-open the .CAB and continue editing where you left off.
When you create a new .CAB, you can compile the .CAB, but you cannot save the
settings that were used to create the .CAB.
z Once you exit the tool, you can re-open the .CAB, but you cannot edit the platform
or processor information for the .CAB or for any individual resource within the .CAB.
When you add support on the Mobile Devices page, the installation that you create is an
.MSI-based installation, which can only be installed on a desktop computer. However,
the .MSI-based installation installs files that support the mobile device software. Thus
any mobile device installation is a two-part process: the .MSI-based installation is
installed onto the desktop computer, and then the appropriate device installation is
installed.
The advantage of using an .MSI-based installation that also installs to mobile devices is
that the mobile device installation can be part of a larger installation that installs
software to the desktop computer. This lets you install your main application to a
desktop computer and simultaneously install support for any mobile device—Pocket PC,
Smartphone, Palm—that the user has. The ability to install to all platforms at once,
including Windows, simplifies the installation process for you and the end user.
In addition, if the installation supports the Pocket PC 2002 platform, you can
automatically install the .NET Compact Framework, a version of .NET designed for
mobile devices. If you don’t have the .NET Compact Framework runtime, and you
include it, the Download Redistributables wizard appears and prompts you to download
it.
Also see:
Mobile Devices Page Compared to Mobile Device Package Editor on page 242
Pocket PC and Smartphone Installations on page 244
How a Pocket PC or Smartphone Installation Works on page 245
Processor and Platform Support for Pocket PC on page 245
Creating a Pocket PC or Smartphone Installation on page 246
Compiling a Pocket PC or Smartphone Installation on page 246
Palm OS Installations on page 255
You can also use Mobile Device Package Editor to create new .CAB files, but we
recommend that you use the Mobile Devices page in Wise for Windows Installer instead.
The Mobile Device Package Editor provides limited functionality for creating new .CABs
with no ability to save. You can only define a .CAB or .CABs and immediately compile—
once you quit, the .CAB definition is lost and cannot be recompiled. To make changes at
that point, you must open each .CAB and edit it individually.
2. Use File > Open or File > New to open a .CAB and edit as described in:
Both Microsoft Pocket PC and Microsoft Smartphone 2002 are Windows CE-based
operating systems for mobile devices. Because these operating systems share some
underlying code, the process for creating a Pocket PC or Smartphone installation is very
similar with the exception of platform and processor support. The Pocket PC operating
system is compatible with many different platforms and processors, while Smartphone
only supports Smartphone devices. Therefore, the Pocket PC wizard contains options
and dialogs for specifying platform and processor support, while the Smartphone wizard
does not.
Pocket PC installations created with Wise for Windows Installer can be executed on
Windows CE 2.0 or later, and must be installed by the end user from Windows 95 or
later, or Windows NT 4.0 or later. All versions of Smartphone are supported. Installation
to Pocket PC removable storage cards is also supported.
2. Create the installation by using a wizard on the Mobile Devices page, during which
you add files, registry entries, shortcuts, and specify platform and application
information. All resources that are to be installed on the mobile device are
encapsulated on the Mobile Devices page. Items you enter on the Files, Registry,
and Shortcuts pages are installed on the desktop computer, not the mobile device.
3. Compile the installation. During compile, you might notice that a subdirectory is
created with the .MSI. The .CAB and .INI files are created in this directory, then
compiled into the .MSI.
5. The end user runs the .MSI-based installation, which installs to the desktop
computer. The .CAB and .INI files, which are necessary to install onto the mobile
device, are installed onto the desktop computer, along with any installation
resources that were specified on other pages in Installation Expert.
6. The mobile device installation is invoked and run by CEAppMgr.EXE (the Add/
Remove Programs dialog of ActiveSync). You can set this to happen immediately
after desktop computer installation, or create a shortcut on the desktop computer
that the end user can open to start installation. Otherwise, the end user is prompted
to install the next time the mobile device is connected to the desktop computer.
Uninstall of the mobile device application is controlled by the mobile device and
ActiveSync. Uninstalling the application from the desktop computer has no affect on the
application that is installed on the Pocket PC or Smartphone device.
Example: Suppose you support the Pocket PC 2000 and Handheld PC Pro platforms.
Then you add the file Application-P.EXE and specify that it is compatible only with Pocket
PC 2000. Then you add the file Application-H.EXE and specify that it is compatible only
with Handheld PC Pro. When you compile, Application-P.EXE is put in
Application.POCKETPC.CAB and Application-H.EXE is put in Application.HPC.CAB.
During installation onto the mobile device, the .CAB files can copy files, apply registry
settings, and run custom code located in the Setup.dll.
Note
Smartphone does not contain processor and platform support options because
Smartphone installations can be installed only to Smartphone platforms.
On the Mobile Devices page, click Add at the right of the page and select Pocket
PC or Smartphone. Use this method to add the mobile device installation to an
existing installation. (If the Mobile Devices page is not visible, select All from
the Page Views drop-down list in Installation Expert.)
Platform Support. (Pocket PC only) See Setting Platform Support for a Mobile
Device on page 247.
Desktop. See Setting Desktop Computer Details for a Mobile Device Installation
on page 254.
After you create a mobile device entry, you might notice changes throughout Installation
Expert, such as files added on the Files page, a shortcut on the Shortcuts page, and new
custom actions added to MSI Script. Do not make changes to these items because doing
so will cause the mobile device installation to fail.
During the creation of .CABs, one or more DOS windows appear briefly. These DOS
windows are for the Microsoft Cab Wizard. Separate .CABs are created for each platform
that has a specifically assigned resource.
If you specify platforms, but you do not assign any resources to the platform, a .CAB is
not created for the platform during compile. Resources must be specifically assigned to
the platform for a .CAB file to be created. Trying to compile an empty .CAB results in a
compile error.
Double-click a Mobile Device entry on the Mobile Device page and click the
Application Information tab.
Application Name
Enter the name of the application you are installing. This name appears in the
desktop computer’s mobile device software (the Add/Remove Programs dialog,
accessible from the Microsoft ActiveSync window).
Description
The end user sees this description in the Add/Remove Programs dialog before
installation.
Company Name
Enter the name of the company that developed the application. This further
describes the application to the end user during installation.
Double-click a Mobile Device entry on the Mobile Device page and click the
Platform Support tab.
Note
If you are using the Mobile Device Package Editor and you used File menu > Open to
open a .CAB, then platform and processor support options are disabled. You cannot
change platform and processor for an existing .CAB.
Example: Suppose you support the Pocket PC 2000 and Handheld PC Pro
platforms. Then you add the file Application-P.EXE and specify that it is
compatible only with Pocket PC 2000. Then you add the file Application-H.EXE
and specify that it is compatible only with Handheld PC Pro. When you compile,
Application-P.EXE is put in Application.POCKETPC.CAB and Application-H.EXE is
put in Application.HPC.CAB.
You can assign the platforms and processors you mark on this page to resources
such as shortcuts, registry entries, and shortcuts. After setting support, add
resources to each supported platform and processor.
Note
If you add platforms and processors but do not assign any resources to them, a
compile error occurs.
3. Click OK.
Note
When the installation .MSI is run on a desktop computer, the installation queries the
connected mobile device for its platform and processor. It runs the .CAB file that has
specific support for that system.
Double-click a Mobile Device entry on the Mobile Device page and click the
Platform Information tab.
Note
If you are using the Mobile Device Package Editor and you used File menu > Open to
open a .CAB, then platform and processor support options are disabled. You cannot
change platform and processor for an existing .CAB.
Setup.dll Path
(Optional.) You can include a separate Setup.dll for each platform that you
support. The Setup.dll is executed during installation. It lets you perform
custom operations during installation and removal of your application. For
information on how to create this file, refer to Microsoft’s Pocket PC or
Smartphone SDK documentation, or search for “Setup.dll” + “Windows CE” in
the MSDN Library (msdn.microsoft.com/library).
Double-click a Mobile Device entry on the Mobile Device page and click the Files
tab.
The upper 2 list boxes show the directories and files available on your computer. The
lower 2 list boxes represent the directory structure and files that will be installed
onto the mobile device. In the lower list boxes, add the directories and files to
create on the mobile device.
Note
This mobile device installation must contain files. Trying to compile an empty .CAB
results in a compile error.
2. Use the following buttons to set the files to be installed onto the mobile device
during installation and specify processor and platform support for each file.
Add Contents
Add the contents of the selected directory to the installation. This does not add
the directory itself, it only adds the contents. To add the directory, first create a
directory of the same name in the lower left list box, then add the contents to
that directory.
Add File
Add files to the directory selected in the lower left list box.
New Folder
Create directories that will be installed on the destination computer.
Delete Folder
Remove a directory from the installation. This doesn’t delete the folder from the
mobile device, it only removes it from this installation.
Delete File
Remove a file or operation from the installation. This doesn’t delete the file from
the mobile device, it only removes it from this installation.
Details
Select a file and click Details to set details about the file, including how to
handles errors, replacement options, shared .DLL count, self-registration, and
platform and processor support.
Double-click a Mobile Device entry on the Mobile Device page and click the Files
tab.
Source Pathname
This is the current path to the file on your hard drive. To replace this file, specify
a new file.
Self-Register File
Some files (examples: .OCXs and some .DLLs) support self-registration. Mark
this to have the file register itself in the registry of the mobile device.
Note
The options below are disabled if you opened an existing .CAB in Mobile Device
Package Editor. You can only specify processor and platform support when you
select File menu > New to start an installation.
Note
The options below are available for Pocket PC installations only.
Platform Supported
Select the platform with which this file is compatible. If you select a specific
platform, then this file is isolated into a .CAB file for that particular platform. If
you select All, the file is installed to all of the platforms you selected for
Platform Support.
Processor Supported
Select the processor with which this file is compatible. If you select a specific
processor, then this file is isolated into a .CAB file for that particular processor. If
you select All, the file is installed to all of the processors you selected for
Platform Support.
4. Click OK.
Double-click a Mobile Device entry on the Mobile Device page and click the
Registry tab.
The left list box shows keys and the right list box shows values.
Root
Select the parent key under which the new key will reside.
Key
Enter the name of the key to create or update. You can create multiple
hierarchical keys at once by separating them with backslashes, as in directory
path names. (Example: Protocol\StdFileEditing creates the StdFileEditing key
inside the Protocol key.) Any keys you specify that do not exist are created.
Value Name
Enter the name of a new named value.
Data Value
The data you enter should be valid data for the Data Type you select below.
Press Ctrl+Enter to insert a carriage return.
Data Type
Select the type of data contained in the named value. Available types are:
String
(REG_SZ prefix.) Identifies a value entry as an expandable string.
Multiple Strings
(REG_MULTI_SZ prefix.) Identifies a value entry as a multiple string. These
are multiple pieces of text, separated by carriage returns.
Binary/Hex
(REG_BINARY prefix.) List of numeric values separated by commas. Two
bytes per field. Do not use the “0x” hexadecimal prefix.
Double Word
(REG_DWORD prefix.) Identifies a value entry as a 4 byte (DWORD) entry.
This must be a valid DWORD value.
Note
The options below are disabled if you opened an existing .CAB in Mobile Device
Package Editor. You can only specify processor and platform support when you
select File menu > New to start an installation.
Note
The options below are available for Pocket PC installations only.
Platform Supported
Select the platform on which this registry entry should be installed. If you select
a specific platform, then this registry entry will be isolated into a .CAB file that is
meant only for that particular platform. If you select All, the registry entry will
be installed to all of the platforms you selected for Platform Support.
Processor Supported
Select the processor on which this registry entry should be installed. If you
select a specific processor, then this registry entry will be isolated into a .CAB
file that is meant only for that particular processor. If you select All, the registry
entry will be installed to all of the processors you selected for Platform Support.
4. Click OK.
After you add a new registry entry, you can edit it by selecting the key name from the
left list box and double-clicking the value in the right list box.
Double-click a Mobile Device entry on the Mobile Device page and click the
Shortcuts tab.
2. Click Add.
Source Pathname
Click Browse and specify the file from the mobile device installation for which
you want to create a shortcut. Only those files that you added to the mobile
device’s files are displayed.
Shortcut Name
Enter the name for the shortcut on the mobile device.
Shortcut Location
Select the directory for the shortcut on the mobile device. The drop-down list
contains the most common locations for shortcuts on mobile devices.
Note
The options below are available for Pocket PC installations only.
Platform Supported
This field is disabled and matches the target file’s platform.
Processor Supported
This field is disabled and matches the target file’s processor.
4. Click OK.
After you add a new shortcut, you can edit it by selecting the shortcut name and clicking
Details.
It is important to understand that with a mobile device installation, there are 2 separate
installations that take place; see How a Pocket PC or Smartphone Installation Works on
page 245.
Double-click a Mobile Device entry on the Mobile Device page and click the
Desktop Computer tab.
Prompt end user to install on mobile device during .MSI execution (runs
Application Manager)
If you mark this and the mobile device is connected during the .MSI installation,
then the end user is prompted to perform the mobile device installation
immediately following the .MSI installation.
If installation onto the mobile device will not take place immediately following the
.MSI installation, then use the fields below to create a shortcut on the desktop
computer. This shortcut initiates installation onto the mobile device by calling CE
Application Manager.
Shortcut Name
Enter a name for the shortcut, such as Install PocketWriter.
Shortcut Directory
Select a directory on the desktop computer in which to place the shortcut.
Typically, you would place it in the Windows Start menu. Select
Windows\Profiles\Start Menu\Programs\ to place the shortcut in the
common shortcut location.
Icon File
To use a custom icon, enter the path to the .ICO, .EXE, or .DLL file that contains
the icon.
Icon Index
Enter the resource number of the icon (in the .ICO, .EXE, or .DLL file specified
above) to use from the icon file above. This icon displays in the Shortcut
Directory you selected above.
Palm OS Installations
¾ Professional and Enterprise Editions only.
Use the Mobile Devices page to create an installation for devices running Palm OS.
If you add a Palm OS application to an installation and there are multiple Palm users on
the target computer, then an additional dialog appears during installation if the user
selects Custom on the Installation Type Dialog. This dialog, named Palm User
Information, lists the Palm users who regularly use this computer to perform a HotSync.
During installation, mark the checkboxes of those users who should have this software
installed into their Palm User directories. Software is only installed to the Palm User
directory if you mark the Install File to Palm User Folder During Installation
checkbox on the Palm File Details dialog, as outlined in the procedure below.
If this installation was created in an earlier version of Wise for Windows Installer, it
might not contain the Palm User Information dialog. To add this dialog, see Creating a
New Dialog on page 437. Without this dialog, the application is installed by default to all
Palm users if the Install File to Palm User Folder During Installation checkbox is
marked.
Uninstall of this application is controlled by the Palm device. Uninstalling the application
from the desktop computer has no affect on the application that is installed on the Palm
device.
On the Mobile Devices page, click Add at the right of the page and select Palm
OS. Use this method to add the mobile device installation to an existing
installation. (If the Mobile Devices page is not visible, select All from the Page
Views drop-down list in Installation Expert.)
From the New Installation File dialog, select the Palm Application template from
the Predefined Templates category. Use this method to add the mobile device
installation to a new installation.
The Application Information dialog appears.
Application Name
Enter the name of the application you are installing. This is used to display the
name of the mobile device entry on the Mobile Devices page.
Desktop Directory
Specify a directory on the desktop computer in which to store the files that you
plan to add to the Palm device. This is simply a holding area for the files to
enable their being copied to Palm-specific directories. The files in this directory
are uninstalled when the .MSI is uninstalled from the desktop computer.
Typically, this would be a directory under the Program Files directory.
3. Click Add, specify a file, and complete the Palm File Details dialog:
File Name
Specify the name for the file when it is installed onto the Palm device.
Source Pathname
This specifies the source path for the file you added.
Note
Files you install to the Add-on folder or Palm User folder are not uninstalled
when the .MSI is uninstalled. Only those files in the Desktop Directory are
uninstalled. End users can use the Palm software to perform uninstalls from
their device.
You can translate the default dialogs in an installation into any language. Wise for
Windows Installer contains 5 pre-translated languages in addition to English; the
optional Language Pack contains translations for 20 additional languages. You can add
any language that is not already pre-translated.
z Translate an installation into one or more languages. This translates the default text
in the installation’s user interface elements. It does not translate your application or
any user interface elements you customize in the installation.
z Define a new language, if the language you need is not one of the pre-translated
languages. See Defining and Translating Into Additional Languages on page 263.
z Export text strings to a file that you can send to a translator. Do this when you
define a new language, or when you add or change any user interface elements in
an installation.
z Import translated text strings from a file to the installation. See Importing All Text
Strings After Translation on page 266 and Importing All Text Strings With the New
Language Wizard on page 267.
z Translate customized user interface elements. See Translating Text Strings You’ve
Added or Changed on page 268.
z Keep track of changed, exported, and imported strings. See Keeping Track of
Changed Text Strings on page 278.
z When you mark the checkbox for a language, the Text Translated column displays
Yes to indicate that the installation contains a translation for that language. All
languages that show Yes in this column are listed on the Language menu.
z Compile to a language transform (.MST). The compile creates an .MSI for the
default language and a separate .MST for each language that is marked on the
Languages page. At installation, the appropriate .MST must be applied to the .MSI
to change the installation language. See Creating a Language Transform on
page 260.
A Share option makes it easy to translate several releases into the same language or set
of languages, with the same language settings. See Sharing Language Settings Between
Releases on page 261.
Note
The Languages page is disabled for transforms. Edit languages in the base .MSI.
If you have customized any of the user interface elements of this installation, you must
translate the changed text before translating the installation. See Translating Text
Strings You’ve Added or Changed on page 268.
If the language you need is not listed on the Languages page, you must define a new
language and translate its text strings. See Defining and Translating Into Additional
Languages on page 263.
Note
If the installation contains Web resources, adding or changing a language regenerates
the Web dialogs in the installation.
3. Mark the checkbox next to each language to translate this installation to.
Some .MSI files might not have languages listed on the Languages page. In that
case, you must use the .WSI that compiled the .MSI.
Note
If this installation was created in a previous version of Wise for Windows Installer,
but you did not update the path variables when you first opened the installation in
the newer version, you will receive an error when you mark a language checkbox. To
fix this, close the installation, reopen it, and click Yes in the prompt that asks you to
update variables.
Destination File
Specify the full pathname for the translated .MSI; be sure to include the .MSI
file extension.
If you leave this field blank, this language is always compiled to an .MSI whose
name is created by adding an underscore and the language name to the
installation file name. Example: If you mark the checkbox for German and the
installation file is named Sample, a file named Sample_German.msi is created
during compile.
Codepage, Language ID
Leave the defaults in these fields. You typically only change these fields when
you define a new language.
Note
Only one language per release can be the default release language. An error
message lets you know if you mark this checkbox for a second language.
6. Click OK.
7. If needed, complete the Language Details dialog for any other languages that are
marked.
Default text strings for the selected release are translated into the selected languages.
You can share these language settings with other releases in this installation. See
Sharing Language Settings Between Releases on page 261.
language and a separate .MST for each language that is marked on the Languages page.
During installation, the appropriate .MST must be applied to the .MSI to change the
installation language. See Applying a Transform to an Installation on page 351.
If you have customized any of the user interface elements of this installation, you must
translate the changed text before translating the installation. See Translating Text
Strings You’ve Added or Changed on page 268.
If the language you need is not listed on the Languages page, you must define a new
language and translate its text strings. See Defining and Translating Into Additional
Languages on page 263.
Note
If the installation contains Web resources, adding or changing a language regenerates
the Web dialogs in the installation.
3. Mark the checkbox next to each language to create a language transform for.
Some .MSI files might not have languages listed on the Languages page. In that
case, you must use the .WSI that compiled the .MSI.
5. In Destination File, specify the full pathname for the translated .MST; be sure to
include the .MST file extension.
6. Leave the defaults in Codepage and Language ID. You typically change these
fields only when you define a new language. The Default release language
checkbox is disabled when you specify an .MST as the destination file.
7. Click OK.
8. If needed, complete the Language Details dialog for any other languages you
marked.
Default text strings for the selected release are translated into the selected languages.
You can share these language settings with other releases in this installation. See
Sharing Language Settings Between Releases on page 261.
After you initially share language settings, the settings for the releases are linked. This
means that any change you make to the language settings for any of the linked releases
is applied to all other linked releases. At any time, you can break the link. Breaking the
link does not change the current settings for the releases.
4. Click Share at the right of the page. The Share Release dialog appears.
5. From Copy/Share Languages From, select the release that contains the settings
to copy.
6. Click OK.
The settings of the release in Copy/Share Languages From immediately replace the
settings of the release in Current Release. Any change you make to the language
settings of either of the linked releases is also applied to the other release, until you
break the link.
3. Click Share at the right of the page. The Share Release dialog appears.
5. Click OK.
The link between the selected release and other releases is broken. The current settings
of the releases are not changed, but changing settings for one release no longer affects
the settings of the other release.
You also can delete a language entirely from an installation. This means the language is
removed from the Languages page and its translated strings are deleted from the
installation. This is not recommended if you have added or changed text strings in a
language, because the customized strings are lost.
Note
If the installation contains Web resources, adding or changing a language regenerates
the Web dialogs in the installation.
The translated text strings for that language remain in the installation, but the
installation is not translated to that language during compile. To compile the installation
to that language again, simply mark its checkbox. In this way you can easily turn a
language off and on.
The language is removed from the Languages page in the installation. Text strings for
the deleted language are deleted from the installation, unless that language is selected
in another release. The language will still be available in other installations if it is one of
the pre-translated languages or if you added it to the installation template.
Caution
When you delete a language this way, all custom translated text strings in that language
are lost.
Add the language to the Languages page and import translated text strings. See
Importing All Text Strings With the New Language Wizard on page 267.
z To restore one of the pre-translated languages, select the appropriate resource file
from the Languages subdirectory of the Wise for Windows Installer application
directory. (In the Enterprise Edition, the Languages subdirectory is under the share
point directory.) To restore a language that you added and had translated, specify
the resource or text file containing the translated text strings.
Note
This process does not restore any custom translated text.
Example:
Suppose you want to translate an installation into Swiss French. However, that language
is not included in the standard product or the optional Language Pack. You can add
Swiss French to the Languages page and add Swiss French text strings to the
installation. Then, you can compile an installation that displays Swiss French on all
dialogs and error messages.
The new language and its translated strings are added to the current installation only. To
make the new language available for future installations, add it to an installation
template instead of to a specific installation. See Creating and Editing Installation
Templates on page 55.
2. Add the new language to the list on the Languages page by defining language
settings, then export the text strings in the installation to a resource or text file. See
Defining a New Language and Exporting All Text for Translation on page 265.
3. Have the text strings translated to the new language. The translator should
translate the strings in place in the same file, to ensure the returned file is
formatted identically.
Caution
If you export the strings to a text file, make sure that the first two fields in the text
file are not translated. These are the table and key names for the text strings and
must remain intact.
4. Import the translated resource or text file. See Importing All Text Strings After
Translation on page 266.
Now you can compile the installation to the new language. See Creating a Translated
.MSI on page 259 and Creating a Language Transform on page 260.
After the initial translation, whenever you add or change text strings, you must have
them translated if you want them in the new language. See Translating Text Strings
You’ve Added or Changed on page 268.
2. Complete the dialog. The information you need to enter depends on what you plan
to do; for details, see the topics listed in the next step. Then click Next.
Export
Export all text strings to a file for translation into this new language. This is the
option most typically used. For details, see Defining a New Language and
Exporting All Text for Translation on page 265.
Import
Import a file containing translated text strings for this language. Do this if you
already have translated text strings for this language. For details, see Importing
All Text Strings With the New Language Wizard on page 267.
None
Add a new language with text strings in the default language. Do this when you
want to add a new language to the Languages page now and translate the
strings later.
4. If you select None, click Finish to add the language to the Languages page and exit
the wizard. If you select Export or Import, click Next. Additional dialogs appear;
for details, see the topics listed in the preceding step.
The New Language wizard appears with the Specify Language Details dialog.
Language Name
Enter a name for the new language.
Destination File
(Optional.) Specify the full pathname for the translated installation file. You can
create an .MSI or a transform (.MST).
If you leave this field blank, this language is always compiled to an .MSI whose
name is created by adding an underscore and the language name to the
installation file name. Example: If the new language is named NewLanguage,
and the installation file is named Sample, the translated installation is compiled
to Sample_NewLanguage.msi.
Codepage
A code page ensures that the correct character set is used for the language you
are adding. In most cases, it is best to specify 0, which is a language-neutral
code page. If the language you are adding uses a multi-byte character set, then
select the appropriate code page from the drop-down list. See Setting the Code
Page of a Database in the Windows Installer SDK Help.
Language ID
Specify only one language ID for the language you are adding. Windows
Installer supports only one language in this field.
See Language IDs on page 279 or visit msdn.microsoft.com for a complete list
of language IDs.
Note
Only one language per release can be the default release language. An error
message lets you know if you mark this checkbox for a second language.
5. Click Next.
6. If you have not had the strings translated, mark Export and click Next.
Export As
Select a file type for the text strings:
Resource File
Exports the strings to a Visual C++ style resource file; this includes an .H
(header) file. With a resource editor, you or the translator can resize dialogs
appropriately for each language.
Text File
Exports the strings to a standard text file, in which they are separated by
tabs.
File Name
Specify the full pathname for the file to export text strings to.
8. Click Finish.
The text strings are exported to the file you specified, which you can send to a
translator. When you receive the translated file from the translator, you import the text
strings into the installation. See Importing All Text Strings After Translation.
This procedure assumes that you have already added the new language to the
Languages page, defined its settings, and exported text strings as described in Defining
a New Language and Exporting All Text for Translation on page 265. If you have not
defined language settings for the new language, you can use the New Language Wizard
to define the language settings and import the text strings at the same time. See
Importing All Text Strings With the New Language Wizard on page 267.
Note
In .TXT files, if tab characters for one or more text strings are added or deleted during
translation, the text strings cannot be imported. To determine whether there are any
text strings that are not imported and therefore not translated, go to the Language
Strings dialog and compare the entries in the Changed and Exported columns. They
should match. See Keeping Track of Changed Text Strings on page 278.
4. From Language, select the language for which you will replace all text strings.
6. In Translated Strings File, specify the name of the file that contains the
translated text strings for the new language.
7. Make sure the Do not compare with current strings option is marked. You only
need to compare strings when you import strings you add or change after you’ve
imported all strings.
8. Click OK.
The translated text strings are imported into the installation and you can translate the
installation to the new language. See Creating a Translated .MSI on page 259 and
Creating a Language Transform on page 260.
Note
A better way to make a new language available for multiple installations is to add it to an
installation template instead of to a specific installation. See Creating and Editing
Installation Templates on page 55.
You might also use this process to restore a language that you deleted from the
Languages page. You must have access to the original file that contains the translated
text strings. This process does not restore any custom translated text.
Typically, you do not have a translated text file at the time you define a new language.
Instead, you use the New Language wizard to define a new language and export text
strings to a file, you have the file translated, and you import the translated strings at a
later time. See Defining and Translating Into Additional Languages on page 263.
The New Language wizard appears with the Specify Language Details dialog.
Language Name
Enter a name for the new language.
Destination File
(Optional.) Specify the full pathname for the translated installation file. You can
create an .MSI or a transform (.MST).
If you leave this field blank, this language is always compiled to an .MSI whose
name is created by adding an underscore and the language name to the
installation file name. Example: If the new language is named NewLanguage,
and the installation file is named Sample, the translated installation is compiled
to Sample_NewLanguage.msi.
Codepage
A code page ensures that the correct character set is used for the language you
are adding. In most cases, it is best to specify 0, which is a language-neutral
code page. If the language you are adding uses a multi-byte character set, then
select the appropriate code page from the drop-down list. See Setting the Code
Page of a Database in the Windows Installer SDK Help.
Language ID
Specify only one language ID for the language you are adding. Windows
Installer supports only one language in this field.
See Language IDs on page 279 or visit msdn.microsoft.com for a complete list
of language IDs.
Note
Only one language per release can be the default release language. An error
message lets you know if you mark this checkbox for a second language.
5. Click Next.
7. In Translated Strings File, specify the file containing the translated strings.
8. Click Finish.
The translated text strings are imported into the installation and you can translate the
installation to the new language. See Creating a Translated .MSI on page 259 and
Creating a Language Transform on page 260.
error messages; disk prompts; text and controls on dialogs; descriptions or names for
launch conditions, features, or shortcuts; property values, file names, and directory
names.
You have several options for finding out which strings need to be translated and getting
the translated text into the installation:
z If you change multiple strings and need to send them to a translator, export only the
changed strings to a file. Send the file to a translator, then import the translated
strings back into the installation. See Translating Text Strings by Exporting to a File
on page 269.
z If you make just a few small changes and you know the translations, you can edit
the text directly. See Translating Text Directly Without Exporting It on page 272.
z If you are adding an entire new language, you can export all text strings in the
installation, have them translated, and then import the translated strings to the
installation. See Defining and Translating Into Additional Languages on page 263.
The translated text might require more space than the default language. (Example:
Most languages require more space than English.) Therefore, you might need to resize
dialog controls to accommodate text expansion. See Resizing Dialog Controls After
Translation on page 274.
Note
Dialog controls are shared across all languages, which means that a control you add to
one language is added to all other languages as well. Similarly, a control you delete in
one language is deleted in all other languages. However, you can add conditions to show
or hide certain controls in certain languages. For details, see Conditions for Controls on
Dialogs on page 408. Also see UserLanguageID Property in the Windows Installer SDK
Help.
Example:
Suppose an installation is in English and Spanish. You decide to add a new dialog to the
installation wizard. You add the dialog in the default language (in this case, English).
That way, the dialog is added to all languages in the installation (English and Spanish).
However, because the Spanish text for the new dialog does not exist, the new dialog
displays in English, even in the Spanish version of the installation. You must export all
the text on the new dialog to a file, have it translated to Spanish, and then import the
Spanish version of the text back into the installation.
If you are translating the entire installation to a new language, you can export,
translate, and import all text strings in the installation. See Defining and Translating
Into Additional Languages on page 263. If you make just a few small changes and you
know the translations, you can edit the text directly. See Changing Text in Installation
Expert and Setup Editor on page 273.
You can use the Language Strings dialog on the Languages page to keep track of
changed and exported text strings. See Keeping Track of Changed Text Strings on
page 278.
4. From Language, select the language to export text strings for. The drop-down list
shows those languages that have translated text strings in this installation; they are
indicated by a Yes in the Text Translated column on the Languages page.
6. From Export As, select a file type for the text strings:
Resource File
Exports the dialogs and strings to a Visual C++ style resource file; this includes
an .H (header) file. With a resource editor, you or the translator can resize
dialogs appropriately for each language.
Text File
Exports the strings to a standard text file, in which fields are separated by tabs.
Caution
Make sure that the first two fields in the text file are not translated. These are the
table and key names for the text strings and must remain intact.
7. In File Name, specify the full pathname for the file to export text strings to.
9. To include the installation’s file and directory names in the export file, mark Export
File and Directory Names.
The text strings are exported to the file you specified, which you can send to a
translator. When you receive the translated file from the translator, you import the text
strings into the installation. See Importing Selected Text Strings From a File.
6. In Translated Strings File, specify the name of the file that contains the
translated text strings.
7. If additional text changes might have been made since the text strings were
exported, you can compare the strings in the installation to the strings in the
original export file. If the strings don’t match, the corresponding translated strings
are not imported. To enable the compare:
b. In Original Strings File, specify the name of the file you exported for
translation.
8. Click OK.
If you chose to compare the text strings during the import, an error message informs
you when one or more text strings in the installation have been changed since the
export. In that case, the translated strings that correspond to the changed strings are
not imported. You should re-export the changed text strings for additional translation.
Note
In .TXT files, if tab characters for one or more text strings are added or deleted during
translation, the text strings cannot be imported. To find out if there are any text strings
that are not imported and therefore not translated, go to the Language Strings dialog
and compare the entries in the Changed and Exported columns. They should match. See
Keeping Track of Changed Text Strings on page 278.
Example:
Suppose you have translated an installation to German. Then you add a Cancel button to
an existing dialog. You already know the German translation for “Cancel” because other
dialogs contain a Cancel button. In this case, you don’t need to export, translate, and
import the changed string; you can change the text for the new Cancel button.
z Translate specific text in the Language Strings dialog. This lets you see at a glance
the translation status of text strings in the installation. See Translating Text on the
Language Strings Dialog.
z Change specific text in Installation Expert and Setup Editor. See Changing Text in
Installation Expert and Setup Editor on page 273.
Both of these procedures assume you already have the translation for the changed text.
If you are adding an entire new language, you can export, translate, and import all text
strings in the installation. See Defining and Translating Into Additional Languages on
page 263. If you change several strings and need to put them in a file for the translator,
you can export, translate, and import only the strings you changed. See Translating Text
Strings by Exporting to a File on page 269.
4. From Language, select a language. The Language Strings dialog shows the text
strings for that language.
5. In the Translated Text column, click the text to change and press Enter.
7. Press Enter.
You can observe the change in the corresponding table in the Tables tab in Setup Editor.
Similarly, you can change text in the Tables tab or the Dialogs tab, then observe the
change here in the Language Strings dialog. See Changing Text in Installation Expert
and Setup Editor.
2. Go to the table, dialog, or Installation Expert page that contains the text string, file
name, or directory name to edit.
3. Change the text. Note that the text is changed only for the language you’ve selected
from the Language menu.
You can observe the change in the Language Strings dialog. Similarly, you can change
translated text in the Language Strings dialog, then observe the change in Installation
Expert or Setup Editor. See Translating Text on the Language Strings Dialog on
page 272.
Tables and Columns That Contain Text Strings You Can Translate
You can edit the strings in Setup Editor > Tables tab, in other Setup Editor tabs, or in
Installation Expert.
To resize dialog controls across all languages, select the Default language.
For information on dialog controls, see Types of Dialog Controls on page 438.
Note
Dialog controls are shared across all languages, which means that a control you add to
one language is added to all other languages as well. Similarly, a control you delete in
one language is deleted in all other languages. However, you can add conditions to show
or hide certain controls in certain languages. For details, see Conditions for Controls on
Dialogs on page 408. Also see UserLanguageID Property in the Windows Installer SDK
Help.
Example:
Suppose you have translated an installation to German, and you want to resize buttons
and text boxes on a dialog to accommodate the longer German text. In Setup Editor,
click the Dialogs tab and display a dialog. Its text is in the default language. Now select
Language menu > German. The dialog is displayed in German, and you can resize dialog
controls as needed.
When you add or change text in the installation’s user interface elements, make sure
Language menu > Default is selected. That way, the items are added or changed for all
languages. If you change the user interface while a different language is selected, the
change is made for that language only.
The Language menu does not affect the basic information in the installation, such as
files added or dialogs selected. This means you cannot add files or select dialogs for a
certain language in this manner. Any file you add in Installation Expert or any dialog you
select in the Dialogs tab in one language is added and selected for all languages in the
overall installation. To add files or select dialogs for a certain language only, use features
and the Release Settings page. For details, see Customizing a Release on page 181.
The default language is initially English, however, you can change it. See Changing the
Default Language. You also can override the default language for a specific release by
designating a default release language. See About the Default Release Language on
page 277.
You can change the default language for new installations by creating a new installation
template. Although templates must be in .MSI format, you must start with a .WSI
because you cannot specify the default language in an .MSI.
4. Mark Create .WSI or .WSM project file that can be compiled into an .MSI or
.MSM and click OK.
5. In Installation Expert > Languages page, mark the checkbox next to the language
that should be the default.
8. Click Compile.
a. Navigate to the Templates subdirectory and enter a file name. The location of
the Templates subdirectory varies. See Where are Installation Resources
Stored? on page 28.
c. Click Save.
The .WSI is saved and then is compiled to an .MSI. Only .MSIs appear in the New
Installation File dialog as templates.
The New Installation File dialog appears and the file you just created appears in the
Custom Templates category. If the New Installation File dialog does not contain
the new template, check to make sure you saved the installation as an .MSI in the
Templates directory.
The Default language should be the only one listed on the Language menu.
In Installation Expert > Dialogs page, display any dialog. The dialog should
appear in the new default language rather than in English.
You can use this template to create installations in which the default language is the one
you selected.
4. In the Templates list, click the Windows Application Project icon and click Open.
5. In Installation Expert > Languages page, mark the checkbox next to the language
that should be the default.
8. Select File menu > Save As, name the file, and save it.
10. Copy the .MSI file to the Templates\File directory. The location of the Templates
directory varies. See Where are Installation Resources Stored? on page 28.
11. If you prefer to create a .WSI template, rename the file’s extension. If you have
added files to the template, use MSI to WSI Conversion to create the .WSI template.
2. Click Wise Setup and Deployment Projects in the Project Types list.
The file you just created appears in the Templates list. If the New Project dialog
does not contain the new template, check to make sure you saved it as a .WSI in
the Templates\Project directory.
4. In Solution Explorer, click the new project .WSI to open the installation in the Visual
Studio integrated editor.
The Default language should be the only one listed on the Language menu.
In Installation Expert > Dialogs page, display any dialog. The dialog should
appear in the new default language rather than in English.
You can use this template to create installations in which the default language is the one
you selected.
Example: Suppose you’re creating an installation named Sample and you only want to
create one .MSI, in German. Mark the Default release language checkbox on the
Language Details dialog for German. When you compile, Sample.msi will be in German.
If you don’t mark the checkbox, the compile will create two files: Sample.msi, which is
in the default language, and Sample_German.msi.
You can also use the default release language to change the language of a base .MSI,
against which you will apply other language transforms. Example: Suppose you create
an installation named Sample2. On the Languages page, you mark the checkbox for
German and, on the Language Details dialog for German, you mark the Default
release language checkbox. Then, back on the Languages page, you mark the
checkbox for Spanish. On the Language Details dialog for Spanish, you enter
Sample2_Spanish.mst as the Destination File. When you compile, the following files
result: Sample2.msi, which is in German, and Sample2_Spanish.mst, which is a Spanish
language transform.
The Default release language checkbox is on the Language Details dialog and the
Specify Language Details dialog of the New Language wizard. It appears in .WSI files
only.
Note
Only one language per release can be the default release language.
z Default Text
Lists all text strings in the default language.
z Table
Indicates the table in the database that contains the string.
z Key
Shows the key to the table.
z Column
Indicates which column of the table is translated.
z Changed
Yes indicates that a text string has been added or changed. See Keeping Track of
Changed Text Strings.
z Exported
Yes indicates that a text string has been exported. See Keeping Track of Changed
Text Strings.
Also see:
The same stages apply when you add or change files or directories, if you export file and
directory names for translation. If you do not export file and directory names, then the
entry in the Changed column remains Yes.
If the Changed column still reads Yes after you’ve imported text strings, one of 2 things
happened:
z Formatting for the corresponding text string in the resource or text file was
changed. (Example: This can happen if a tab in a text file was deleted or moved.)
Try to reformat the resource or text file and then import it again.
z When you imported, you chose to compare current strings with original strings, and
you’ve made changes to the strings in the interim. In this case, export changed text
strings again. Translate the strings that have changed, then import them.
French
German
Italian
Portuguese
Spanish
The optional Language Pack lets you select from these additional pre-translated
languages.
Chinese (PRC)
Chinese (Taiwan)
Czech
Danish
Dutch (Netherlands)
Finnish
French (Canadian)
Greek
Hungarian
Indonesian
Japanese
Korean
Norwegian
Polish
Portuguese (Brazil)
Russian
Spanish (Basque)
Spanish (Catalan)
Swedish
Turkish
If the language you need is not listed here, you can send the installation text strings to
a translator and then add the new language and the translated strings to the Languages
page. See Defining and Translating Into Additional Languages on page 263.
The default language for all installations is English, unless you change it. For details, see
Changing the Default Language on page 275.
Language IDs
Windows Installer uses language IDs to determine whether the destination computer
supports the language that is used for the installation dialogs. Example: If you create an
installation with the language ID for Greek, that installation only runs on a computer
with Greek fonts.
When you complete and compile an installation and are ready to deploy it, you can:
In the Enterprise Edition, you also can use Package Distribution to distribute to the share
point directory, so that the installation can be imported into the Software Manager
database.
Package Distribution
Use Package Distribution to deploy or share a package by:
You can run Package Distribution from Wise for Windows Installer or from Software
Manager. What’s the difference? Typically, when you run Package Distribution from Wise
for Windows Installer, you distribute a project file or the compiled installable file from its
source directory. When you distribute from Software Manager, you distribute installable
files only (examples: .MSI or .EXE files) from the Software Manager database.
Therefore, when you run Package Distribution from Software Manager, the option to
distribute to the share point directory is not available.
Distributing to the share point directory does not actually import the package into the
Software Manager database, but copies it to a directory in a format that can be imported
into the Software Manager database. You use Software Manager to import it from the
share point.
z All the installation’s source files are copied to the share point directory and the
source paths for those files are updated. See Where are Installation Resources
Stored? on page 28.
z If the Application Name and Package Name fields are not blank, the package’s
meta data is added to the Software Manager database, if it is not already there.
z You might want to copy the installation file to the Scripts subdirectory of the share
point directory, if the installation is not already located in the share point directory.
z This option is not available when you use Package Distribution from Software
Manager, because packages listed in Software Manager are already in the Software
Manager database.
2. If you are in a .WSI that contains multiple releases, a drop-down list appears. Select
a release.
5. Share Point (read-only) displays the share point directory to which the installation
will be copied. It defaults to the share point directory that is specified in Wise
Options.
Caution
(Wise Editor only.) If an installation file is located in the share point directory, Copy
Installation File To is cleared by default. If you mark it, then 2 copies of the
installation file will be in the share point directory, which can lead to confusion about
which file to edit.
Caution
(Visual Studio integrated editor only.) If you clear this checkbox, the source paths in
the project will be overwritten with the paths in the share point directory. If the
project is bound to other projects in the solution, these bindings will be broken.
In most cases, if the installation file is not already in the share point directory, it
is best to specify the Scripts\<application name>\<package name>
subdirectory of the share point directory, which is the default.
If you are distributing an .MSI or .WSI that is set to compile with external files,
specify either a subdirectory of Scripts or some other directory. This prevents
overwriting of any external files that might also be used by another installation.
To verify how the installation is set to compile, go to the Media page and look at
the Compression Option on the Media Details dialog.
Clear this if you don’t want to copy the installation file (recommended in the
Wise editor only).
7. Application Name and Package Name are pre-filled with data from the Product
Details page; the application and package names are used if defined; otherwise, the
product name and version are used. These names will be assigned to the installation
when it is imported into the Software Manager database.
If the package’s meta data is in the Software Manager database, don’t change these
names. If you change the names, you will have 2 packages in the database for the
same installation: a package with just meta data and the package you import. See
Adding Meta Data to the Software Manager Database on page 95.
8. Click Finish.
If a package with resources and the same package path is already in the Software
Manager database a warning message appears asking if you want to overwrite it.
Click Yes to re-import the package.
The installation or merge module is copied to the share point directory. From there, it
can be imported into the Software Manager database through Software Manager. See
Importing From the Share Point Directory in the Software Manager Help.
Note
To copy an installation and its .PDF or .SMS file, distribute the .WSI file unless one never
existed.
1. Click Distribute in the lower right of the window. (In Visual Studio: select Project
menu > Package Distribution.)
2. If you are in a .WSI that contains multiple releases, a drop-down list appears. Select
a release.
3. Mark Network.
Network Directory
Specify the directory to copy the package to. This can be a relative path or a
path variable.
6. Click Finish.
Package Distribution uses the FTP protocol to transfer the files to the server location you
specify. End users can download the files from the FTP server using an FTP client. If the
server is also configured to run a Web server, end users can download the files through
their Web browser (HTTP protocol) as well. Package Distribution does not support
passive FTP, which is required by some firewall and gateway configurations, and it
cannot FTP through a proxy server.
1. Click Distribute in the lower right of the window. (In Visual Studio: select Project
menu > Package Distribution.)
2. If you are in a .WSI that contains multiple releases, a drop-down list appears. Select
a release.
6. Click Next.
The package is uploaded to the FTP server. A dialog shows the status of the upload.
7. Click Finish.
Note
If this option does not work as you expect, open an FTP client, configure it with the
same information you entered in Package Distribution, and make sure it works.
(Windows contains a default FTP client.)
1. Click Distribute in the lower right of the window. (In Visual Studio: select Project
menu > Package Distribution.)
2. If you are in a .WSI that contains multiple releases, a drop-down list appears. Select
a release.
Network Directory
Specify the directory in which to place the administrative installation.
6. Click Finish.
1. Click Distribute in the lower right of the window. (In Visual Studio: select Project
menu > Package Distribution.)
2. If you are in a .WSI that contains multiple releases, a drop-down list appears. Select
a release.
5. If the Distribution Media Directories dialog appears, check the following lists to
verify that the installation files are in the proper directories before you distribute
them.
Volume Label
Displays the value you entered when you created this destination on the Media
Details dialog.
Directory
Displays the media destination you entered on the Media Details dialog. If you
moved the compiled files since compiling, edit this value to point to the new
location. Either click and type directly in the column, or select the row to edit
and browse to the new location of the files.
Destination Disk
Select the letter of the drive to which files will be copied. Only removable-media
drives connected to the computer are displayed.
Disk Label
Enter a name for the finished disk that will contain the installation.
Setup Filename
Enter the name for the final installation file. You do not need to enter an
extension. If you leave this blank, the final installation file is named the same as
the currently-open installation file.
8. Click Finish.
The installation is copied to the media. You are prompted to insert new media as
necessary.
If you are distributing a single file that is too large for the media specified, you are
prompted to insert a higher capacity media. If that is not possible, use the Media page
to span the installation across multiple media. See Setting Up Media for Distribution on
page 201.
WiseUpdate
¾ Professional and Enterprise Editions only.
WiseUpdate® offers an easy method for updating your application on your end users’
computers, ensuring that end users are always working with the most current version of
your application. Based on settings you specify on the WiseUpdate page, WiseUpdate
installs a small client application along with your application. You can place a shortcut to
this application in the end user’s Startup group so that it checks for updates when the
WiseUpdate, by itself, does not deploy the current version of your application; it simply
adds a Web-based update mechanism to your end users’ computers. The first time you
configure WiseUpdate, you enable that version to check for later versions over the
Internet. Once WiseUpdate is integrated into your application, it simplifies the upgrade
process for you and your end users for future updates to your application. For details,
see Configuring the WiseUpdate Page on page 290.
When WiseUpdate runs on the destination computer, the end user can change proxy
server information or the check interval by clicking the Advanced button on the first
dialog of the wizard.
Also see:
(HTTP)
3. Configure the WiseUpdate page. For details, see Configuring the WiseUpdate Page
on page 290.
4. When the installation is tested and ready for distribution, upload the installation
files, the Readme file, and the update file to a Web server in one of the following
ways:
Run Package Distribution using the FTP Server option. (See Uploading
WiseUpdate Files With Package Distribution on page 292.) Do not use Package
Distribution if your network setup requires that you use a proxy server to FTP
files or if you want to place files in different directories.
Use any FTP client. (See Uploading WiseUpdate Files With an FTP Client on
page 294.)
Caution
If you do not upload the files before deploying your application to end users, they
see an error when they attempt to check for upgrades.
5. Test the WiseUpdate process. For details, see Testing WiseUpdate on page 294.
b. Update the Version field on the Product Details page, otherwise the
maintenance mode will be entered.
After you upload the updated application, end users who have WiseUpdate will be
prompted to update their application over the Internet.
The first time you configure WiseUpdate, you enable that version to check for later
versions over the Internet. To enable the Internet updating capability, you must use
WiseUpdate for each successive version of your application.
Host Address
Enter the Web server address where you plan to store updated installation files.
(Example: www.company.com.) You can also enter the server’s IP address.
Note
The Web location you select should be accessible through both the FTP and the
HTTP protocols—Package Distribution uses FTP to transfer files to it, and end
users use HTTP (WiseUpdate Client) to read and download files from it. See
WiseUpdate Tips on page 296.
Host Username
If necessary, enter the username that’s required to connect to the host address.
Typically, Web servers don’t require user names and passwords. This is used for
basic HTTP authentication.
Host Password
If necessary, enter the password that’s required to connect to the host address.
Enter this only if the Host Username is entered above.
Host Directory
Enter the directory on the Web server where you plan to store updated
installation files, including the WiseUpdate update file. To put the files in the
root directory of the host, leave this blank.
If you are working in an update, the directory must be the same as in the
original version of the installation.
Update Filename
Enter a name for the WiseUpdate update file and use the extension .INI.
(Example: WiseUpdate.ini.) This file is created during compile. In subsequent
versions of this installation, the file name must be the same as in the original
version of the installation. See About the WiseUpdate Update File on page 292.
Product Version
Enter the current version of the installation. This version is stored with your
application on the destination computer and is compared to the version stored
in the update file on the Web server.
If you place the WiseUpdate shortcut in the StartUp group on the destination
computer, WiseUpdate Client runs when the destination computer is booted or
the end user logs on to Windows. If the check interval has been reached,
WiseUpdate Client runs normally, prompting the end user to check for updates.
If the check interval has not been reached, WiseUpdate Client runs silently and
quits.
If you do not mark this checkbox, then WiseUpdate Client will never be run on
the end user’s computer unless you code your application to run it. For details,
see Options for Running WiseUpdate Client on page 295.
The update file is in .INI format and contains information you enter on the WiseUpdate
page. It is formatted as follows:
[WiseUpdate]
Version=2.0
Size=1095391
Install=http://www.company.com/updates/Application.exe
ReadMe=http://www.company.com/updates/Readme.rtf
where:
z ReadMe is the URL to the installation’s Readme file. If there is no Readme file, the
Readme line is omitted.
After you complete the WiseUpdate page and are ready to distribute an installation, you
can use Package Distribution’s FTP Server option to upload installation files to a Web
server. The files you upload are:
z The WiseUpdate update file, which specifies the current version of the application,
the URL to the installation files, and the URL to the Readme. See About the
WiseUpdate Update File on page 292.
Because FTP and HTTP are different protocols controlled by different servers, the
connection information you entered on the WiseUpdate page might differ from the
information you enter in Package Distribution.
Package Distribution cannot FTP through a proxy server and it does not support placing
different files in different directories. If you need that capability, see Uploading
WiseUpdate Files With an FTP Client on page 294.
2. Click Distribute. (In Visual Studio: select Project menu > Package Distribution.)
ReadMe File
If you’re using WiseUpdate for the first time, you can leave this blank. However,
if you’ve used WiseUpdate before and are now uploading an update, specify a
Readme file in text or rich text format (.RTF), which will be displayed to the end
user before the upgrade. RTF files cannot contain embedded graphics.
Product Version
Enter the version to be stored in the update file. WiseUpdate Client compares
this version to the version on the destination computer to determine if an
update is needed. Usually, this should be the same as the Product Version
field on the WiseUpdate page and the Version field on the Product Details
page. You can force updates by entering a later version in this field.
Example: If the version deployed on the destination computer is 1.0.0, and you
enter 1.0.2 in this field, it will trigger the destination computer to be updated.
5. Click Next.
6. On the Upload Installation dialog, enter FTP information that points to the same
Web location you specified on the WiseUpdate page and click Next.
The installation files, the Readme you selected, and a WiseUpdate update file are
uploaded to the Web server you specified. If this is the first time you’ve used
WiseUpdate for this application, test the WiseUpdate process thoroughly to make sure
that no network-specific problems occur. See Testing WiseUpdate on page 294.
Use an FTP client to upload the following items to the Host Address and Host
Directory you specified on the WiseUpdate page:
z The WiseUpdate update file, which specifies the current version of the application,
the URL to the installation files, and the URL to the Readme. See About the
WiseUpdate Update File on page 292.
You can place the installation files and Readme at any Web location, provided their URLs
are recorded correctly in the WiseUpdate update file.
When you enter the URLs in the FTP client, make sure they match the case of the actual
path on the Web server. Some HTTP servers are case-sensitive and display errors if the
case does not match exactly.
Testing WiseUpdate
¾ Professional and Enterprise Editions only.
After you configure the WiseUpdate page and upload files to the FTP server, you should
test the WiseUpdate process.
1. Install the first version of your application on a testing computer (not your
development computer).
2. On the testing computer, open your application’s installation directory and double-
click the file WiseUpdt.exe. Normally, this file is run automatically at prescribed
intervals at startup, but for testing purposes, you run the .EXE directly.
3. Click Next.
WiseUpdate Client uses the HTTP connection information that you specified on the
WiseUpdate page to read the WiseUpdate update file on the Web server. If you are
running the same version of your application as that on the server, a message
notifies you that you are running the latest version.
If this test is not successful, see WiseUpdate Tips on page 296 and Troubleshooting
WiseUpdate on page 297.
If this test is successful, follow the next procedure to test what happens when the
version of your application on the Web server is later than the end user’s version.
If you are not using Package Distribution, manually edit the update file on the
Web server so that the version is later.
2. On the testing computer, open your application’s installation directory and double-
click the file WiseUpdt.exe. Then click Next.
Because the version on the Web server is now later than the version on the testing
computer, WiseUpdate Client displays the Readme file and then displays an option to
download and run the installation.
3. You can download and run the installation, but installation will fail unless the version
on the server is an upgrade or patch that updates the currently installed version. In
a real-life scenario, when you put updates on the server, they must be configured as
upgrades or patches.
4. Restore the correct version information to the server by doing one of the following:
If this test is not successful, see WiseUpdate Tips on page 296 and Troubleshooting
WiseUpdate on page 297.
If you see the Web page you entered in the Alternate Web Page field on the
WiseUpdate page, then there was a problem connecting to the host via HTTP, or the
necessary files were not found on the host.
z The installation adds a shortcut for WiseUpdate Client to the Startup group of the
Windows Start menu on the destination computer.
z When the destination computer is booted or the end user logs on to Windows,
WiseUpdate Client silently checks the time elapsed since it last ran. If the number of
days elapsed is greater than the check interval value, WiseUpdate Client prompts
the end user to check for updates.
z Code your application to open the file WiseUpdt.exe from the application directory,
in either of the following ways:
WiseUpdate Tips
¾ Professional and Enterprise Editions only.
Can WiseUpdate be used with WebDeploy?
Yes. Make sure that update installations you release are formatted as upgrades (use the
Upgrades page). You cannot use WebDeploy to run patch files (.MSP).
WebDeploy embeds connection information into the .EXE of the .MSI/.EXE pair, so that
the .EXE can launch the .MSI from a location on the Web. WiseUpdate provides for
regular checking for updates initiated by the application on the destination computer. If
you plan to put all compiled files in the same location on the Web, then specify the same
directory on both the WebDeploy and WiseUpdate pages.
Because the .EXE of an .MSI/.EXE pair might contain optional runtimes (examples:
Windows Installer or .NET runtimes), WiseUpdate always attempts to open the .EXE, not
the .MSI. Follow these guidelines:
z The .EXE of the .MSI/.EXE pair must be located somewhere on the Web and must be
accessible to WiseUpdate users. It cannot be distributed through e-mail or other
mechanisms.
z On the WiseUpdate page, the connection information you enter must point to the
location of the WiseUpdate update file on the Web server.
WiseUpdate Client that’s already on end user’s computers only knows to look at the Web
location you set when you originally configured it. Therefore, when you configure the
WiseUpdate page for subsequent versions of the same application, make sure that the
Host fields and the Update Filename field are the same as in the original version of
the installation.
Why are there 3 different fields that accept the product version?
During the WiseUpdate process, you encounter 3 different fields that require a product
version. How are these fields related?
z The Version field on the Product Details page sets the version for the application,
and is used by Windows Installer to determine whether updates and patches are
valid upgrades for the installed version.
z The Product Version field on the WiseUpdate page sets the version in the registry
of the destination computer, which WiseUpdate Client checks against the update file
on the FTP server.
z The Product Version field on the Upload WiseUpdate Information dialog of Package
Distribution sets the version stored in the update file on the FTP server.
Typically, all 3 of these fields should have the same version number, but you can change
the versions to force upgrades.
Troubleshooting WiseUpdate
¾ Professional and Enterprise Editions only.
If you encounter problems with WiseUpdate during testing or after deploying your
application, check the following suggestions.
z Use an FTP client to observe what files are the on the Web server and where they
are located. Open the WiseUpdate update file that is located on the Web server and
see if the referenced paths are valid.
z WiseUpdate Client uses HTTP to connect to the Web server specified on the
WiseUpdate page. Package Distribution’s FTP Server option uses the FTP protocol
to upload the installation .EXE, an optional Readme file, and a WiseUpdate update
file. Both operations access the same location on the same server. Therefore, both
protocols must have access to the directory, and the host must be able to process
both HTTP and FTP requests. Also, the Host Directory, the Host Username, and
the Host Password might be different for using the FTP protocol than for using the
HTTP protocol. This is because the Web server and the FTP server might have
different alias and user information, but point to the same directory.
z If end users cannot view the Readme file in WiseUpdate Client, make sure the
Readme file does not have embedded graphics, which are not supported.
Windows Installer provides 2 main methods for upgrading installations: patching and
upgrading. You can also have the end user upgrade by uninstalling and then reinstalling,
although this method is not recommended. You can create upgrades and patches for
installations using the UpgradeSync tool, Patch Creation tool, and the Upgrades page.
Topics include:
z Patches.
z Upgrades.
For information on upgrading, see the following topics in the Windows Installer SDK
Help.
Planning for the next software update should start when you ship the first version of
your application. To create an update, you must have access to previous versions of the
installation. Always archive the shipping installation in a place that is accessible. Even if
you compile and ship the installation as an .EXE, archive the .MSI, which is created
alongside the .EXE. If the installation included .CABs or other files, archive those also.
An update can be a patch, an upgrade, or a reinstall. You can create both a patch and an
upgrade of the same installation. If you do not create a patch or an upgrade, your
update is a reinstall by default. You can also use command line options to cause an
upgrade to completely or partially reinstall.
About Patches
z Can only update an existing application.
z Are small, containing only the changes between the original and updated
applications.
z Are created with the Patch Creation tool; see Creating a Patch File on page 304.
z Allow little flexibility in customizing an update. Example: You cannot change feature
states, leave certain features installed, or perform custom actions based on the
version of the installed application.
About Upgrades
z Used when you make major changes to an installation.
z After installing the new version, check for components of the previous version that
are no longer needed and remove them.
z Allow flexibility in customizing an update. Example: You can run custom actions and
specify features to leave on the destination computer based on what version is
already installed.
About Reinstalls
z Are required by default if you don’t provide for another method of updating, such as
a patch or upgrade. Reinstalls are forced by the operating system if the version and
the product code are the same.
z If the product code is changed, then the updated application can be installed
alongside the original application, or can inadvertently be installed over the original
application.
The update is so small that only the contents of a few files changed. No new
files or registry keys were added, and none were removed.
The update is so large that you want the old and new versions to be able to
coexist on the same computer.
If you make changes to the installation (Example: adding or removing files), you must
change the product version. If you do not change the product version and the end user
tries to reinstall, it can result in an invalid mix of old and new files. If the product version
is incremented, the installation displays a message stating that the application is already
installed and installation cannot continue. The end user must uninstall the application
and run the installation to install the new version. To avoid this, use patches or
upgrades.
Before deploying an updated installation, you must determine whether you need to
change the product code and the product version. Windows Installer uses the product
code and product version to determine how to handle an upgrade. Also, your company’s
support department might need to differentiate updates based on product version.
You change the product code and product version on the Product Details page. For
information on when to change them, see Patching and Upgrades in the Windows
Installer SDK Help. Also see Changing the Product Code in the Windows Installer SDK
Help.
Caution
If you are releasing a newer version of your application but are not using an upgrade or
patch, it is very important to enter a new version on the Product Details page. Not doing
so can cause the installation to open in maintenance mode instead of in normal
installation mode. This can result in an invalid installation that is a mixture of old and
new files, which can cause errors in your application. The only exception is if the
installation contains no new files, no deletion of files, and no other system changes,
which means that only the contents of files are changed.
UpgradeSync changes the current installation in preparation for creating either a patch
or upgrade. UpgradeSync compares the current installation to the previous version of
the installation and prepares the current installation for a patch or upgrade.
UpgradeSync
Using UpgradeSync is one of the steps in preparing software for updates; see Preparing
for Software Updates on page 298.
UpgradeSync compares the current package with the previous version of the package,
and does the following to prepare the current package for a patch or upgrade:
z Aligns component GUIDs. If GUIDs or key paths for the same component don’t
match between the new and old .MSI, the component could inadvertently get
deleted because Windows Installer does not recognize the components as being the
same. Aligning component GUIDs for matching components prevents upgrades from
deleting necessary files in the newer version.
z Detects errors that could cause problems with a patch or upgrade and, if possible,
fixes them.
Note
UpgradeSync does not create an upgrade or patch; it eliminates the most commonly
encountered problems that cause patches and upgrades to work incorrectly. Use
UpgradeSync before you create a patch or an upgrade. Use Patch Creation to create a
patch and the Upgrades page to create an upgrade.
For information on the different types of updates and when to change the ProductCode
and ProductVersion, see Patching and Upgrades in the Windows Installer SDK Help.
UpgradeSync changes your current installation according to Microsoft’s
recommendations, based on the type of upgrade you plan to make.
When you add new resources to an upgrade installation, you can use component rules to
ensure that the component GUIDs are aligned with those in previous installations. See
Using Component Rules to Align GUIDs in an Upgrade on page 59.
Also see:
Using UpgradeSync
1. Open the current version of the installation file (.WSI or .MSI).
2. Select Tools menu > UpgradeSync. (In Visual Studio: Project menu >
UpgradeSync.)
You must specify an .MSI here, even if you deployed the installation as a single-file
.EXE. The .MSI is created in the same directory as the .EXE during compile.
4. Click Next.
Small Update
Select this to ship this installation as a patch or reinstall. Small updates
generally contain minimal changes to the contents of files. This option changes
the package code.
Minor Upgrade
Select this to ship this installation as a patch or reinstall. Minor upgrades
generally contain changes such as new or removed features, files, or other
items. This option changes the package code and forces you to increment the
product version of the current installation if it is the same as the previous .MSI’s
product version.
Major Upgrade
Select this to ship the current installation as an upgrade. You usually ship an
installation as an upgrade when it contains comprehensive changes, but you
can create an upgrade for minimal changes. This option changes the package
code and product code, and forces you to increment the product version of the
current installation if it is the same as the previous .MSI’s product version.
Current Version
If you selected either the Minor or Major Upgrade options, and this is the same
as Previous Version, then you must increment it. If you do not increment it,
an error occurs when you click Next.
6. Click Next.
This dialog lists issues in the installation that might cause problems when creating
an upgrade or a patch. These errors are the most common causes of patch and
upgrade failures reported by Windows Installer users. Errors that can be fixed
automatically have a checkbox. The following types of error cannot be fixed
automatically and therefore have no checkboxes:
9. Click Finish.
The necessary changes are made to the installation. If you plan to create a patch or
upgrade, use Patch Creation or the Upgrades page. See Creating a Patch File on
page 304 or Creating an Upgrade on page 311.
Patches
Use Patch Creation to create a Windows Installer patch file (.MSP) that updates installed
versions of a Windows Installer-based application. A patch file can update one or several
previous versions. Unlike full installations, a patch installation contains only the
information necessary to update an installed version of the application.
Patch Creation uses 3 files from the Microsoft Windows Installer SDK: PATCHWIZ.DLL,
MSPATCHC.DLL, and MAKECAB.EXE. They are installed in the Wise for Windows Installer
application directory. You specify settings in Patch Creation, and it saves those settings
in a patch settings file (.PCP). Patch Creation then sends the patch settings file to
PATCHWIZ.DLL, which creates the patch file (.MSP).
z The package code must be different between the old installations and the new
installation. To see the package code, click the Summary icon in Setup Editor >
Product tab. Changing the Version field on the Product Details page causes the
package code to be updated, as does running UpgradeSync.
z The previous version or versions must have been installed using Windows Installer.
z To edit an existing patch, you need access to its patch settings file (.PCP).
z If you created any previous patches for an installation, you need access to the most
recent patch file (.MSP) to read its file sequence number and disk ID.
z You need access to the complete installation in .MSI format for every installation
that this patch will upgrade and for the latest version of your application. If the
installation includes external compressed or uncompressed files, you need them
also.
Note
If you compiled the installation as an .EXE, you need the .MSI for the installation
because Patch Creation does not operate on .EXE files. The .MSI is created in the
same directory as the .EXE during compile.
When you patch an assembly that is installed in the GAC, Windows Installer 3.0
identifies and finds the original file and applies a binary patch. This eliminates the need
for Windows Installer to access the original installation source in order to patch an
assembly installed in the GAC. See MsiPatchOldAssemblyName Table and
MsiPatchOldAssemblyFile Table in the Windows Installer SDK Help.
Also see:
Sequencing is supported for small update patches only. Sequenced patches can be
installed by Windows Installer 2.0, but the sequencing is ignored.
You add sequencing information to a patch during Patch Creation. You can add
sequencing to a patch you created previously. Step through Patch Creation, open an
existing patch file, enter sequencing information, and complete the wizard to recompile
the patch.
Patch Families
A patch family is a group of patches that update the same, similar, or related
functionality of the application and should be applied in a specific order relative to other
patches in the same family. Most patches belong to a single family, and most
applications are updated by a single family. However, a patch can belong to multiple
families if it applies to more than one application or includes multiple fixes.
Example: Suppose you have 2 applications that are sold separately, but are also sold
together as a suite. Patches A and C update only Application1 and belong to family 100.
Patch B updates only Application2 and belongs to family 200. Patch D updates both
applications and belongs to family 100 and family 200.
z Family 100: A, C, D
z Family 200: B, D
Also see:
1. Select Tools menu > Patch Creation. (In Visual Studio: Project menu > Patch
Creation.)
The Welcome dialog appears, listing the basic steps for creating a patch file. The
wizard guides you through each step.
2. Click Next.
4. Click Next.
The Specify Previous Versions dialog appears, where you select .MSI files of
previous versions that this patch updates, referred to as targets. When this patch is
run on a destination computer, it verifies that a valid target exists before
installation. You must add at least one previous version to this list.
6. Complete the dialog and click OK. See Specifying Previous Versions for Patches on
page 307.
Note
Microsoft’s Windows Installer engine is called to perform the administrative
installation. If the operation fails for any reason, the error message generated by
Windows Installer displays. To work around the error open the .MSI, set it to
generate uncompressed files, and recompile. Then specify the uncompressed
version on the Specify Previous Version dialog. To set an .MSI to generate
uncompressed files, go to the Media page, click Details at the right of the page, and
in Compression Option select Uncompressed external files.
9. When you finish, click Next on the Specify Previous Versions dialog.
Advanced
Click this to enter advanced settings. The Advanced Upgrade Version Details
dialog appears. Complete the dialog and click OK; see Advanced Upgrade
Version Details on page 308.
12. If you are prompted to run an administrative installation again, click Yes. If you are
prompted to update the package code, click Yes.
If Windows Installer 3.0 or later is installed on your computer, the Patch Sequencing
dialog appears. Complete the dialog and click OK; see Specifying the Patch
Sequence on page 309. Otherwise, the Compile Patch dialog appears.
Advanced Settings
Click Advanced to display the Advanced Patch Settings dialog. Complete the
dialog and click OK. See Specifying Advanced Patch Settings on page 309.
Patch Removal
(Windows Installer 3.0 or later only.) To make this patch removable through
Add/Remove Programs, click Allow Removal and complete the Patch Removal
Settings dialog. See Specifying Patch Removal Settings on page 310.
Note
Multi-patch Media Settings: During patch creation, entries are made in the Media
table of the patch installation. The following options populate the Media table. For
each subsequent patch, the file sequence start number and the disk ID start number
must be higher than the one in the previous .MSI or patch file. To enter these
numbers accurately, you must have access to the most recent patch file distributed
to end users.
Volume Label
Enter the name of the CD or other media on which this patch will ship. If the
application needs repair in the future, Windows Installer uses this label to tell
the end user what media to insert to perform the repair. If the patch is not
shipped on any media but is distributed over the Internet, this field is ignored.
Disk Prompt
Enter the prompt that the end user should see if this application needs to be
repaired. Example: Insert the disk labeled Application 2.0.
During patch creation, you might see a message stating that the versions between
the target image (previous version) and upgrade image (new version) do not match.
This is normal; click Yes if this message appears.
Note
If the date and time of a file in the upgrade is earlier than the date and time of the
matching file in the original installation, Patch Creation changes the date of the file
in the upgrade file to be later than that of the original installation.
The Compile Patch dialog notifies you when the patch creation is completed.
15. Click View Log to view a log file of all actions performed by Patchwiz.dll to create the
patch.
If the patch file could not be created, use the log file to determine the source of the
error.
Also see:
This dialog is not related to the System Search page in Installation Expert, which
lets you search for files, registry entries, and components, or search .INI files.
Match Language
Mark this to confirm that the language codes match between the target and
upgrade images.
Version To Check
Select what parts of the product version—the major, minor, or update version—
should be used in the version relationship comparison. Example: Suppose the
product version is 2.4.6801. The first segment is the major version; the second
segment is the minor version; and the third segment is the update version (also
called build version).
The version for each installation is in the Version field on the Product Details
page.
Version Relationship
Select a comparison that must be true in order for the patch to be installed.
Base Version is the version of the package you use to create the patch; this is
the version you specify in Previous MSI path. Installed Version is the version
of the package being upgraded. In most cases, you should select the
relationship Base Version must be = Installed Version. This means that the
previous version you used to create this patch must match the version installed
on the destination computer.
Patch GUID
Each patch file is assigned a GUID, independent of product codes and upgrade
codes. The installation uses this to track which patches have been applied to an
application. To change this value, click Generate or paste another valid GUID
into this field. See About GUIDs on page 524.
If any of these patches are found on the destination computer and are
registered with Windows Installer, they are unregistered and their patch
transforms are removed from the list of transforms associated with the
application. This lets you apply a patch to an original installation without having
applied any intermediate patches. Example: If this patch represents Service
Pack 2, setting this field lets end users upgrade to Service Pack 2 even if they
did not install Service Pack 1.
Patch Family
Specify the patch family that this patch belongs to.
To sequence this patch after a specific patch, click Browse and select a patch file
(.MSP). This populates the Patch Family and the Sequence Within Family
fields. Example: If you browse to a patch that is in Family01 and has a sequence
of 10, the current patch will be added to Family01 with a sequence of 20
(sequences are generated in increments of 10). If the selected patch belongs to
multiple families, the first family found is used.
Product Code
Typically, you should leave this field blank, which causes the patch to be applied
to all targets in the family. If you enter a product code GUID, then sequencing is
used only when the patch is applied to the installation defined by that GUID,
relative to other patches in the family.
4. On the Patch Sequencing dialog, add more sequencing information if needed. When
you finish, click Next to continue the Patch Creation wizard.
Also see:
Allow Product Codes to differ between the upgrade and prior versions
Mark this to upgrade a previous version even if it has a different product code.
This global setting overrides the validation settings you specified on the
Previous Version Details dialog.
Allow Version Number to differ between the upgrade and prior versions
Mark this to have the patch be able to upgrade a previous version if its version
number is different. This global setting overrides the validation settings you
specified on the Previous Version Details dialog. You should always leave this
checkbox marked.
1. On the Compile Patch dialog of Patch Creation, click Allow Removal to display the
Patch Removal Settings dialog. See Creating a Patch File on page 304.
When you make a patch removable, enter values for the following meta data,
which is used by Add/Remove programs. Only the Classification is required.
Description
Enter a brief description of the patch that will appear in Add/Remove programs.
DisplayName
Enter a name for the patch that will appear in Add/Remove Programs.
Classification
(Required.) Enter text to describe the category of updates that this patch
belongs to. The category descriptions are arbitrary. Examples: hot fix, security
rollup, update, critical update, service pack, update rollup, and so on.
ManufacturerName
Enter the manufacturer or publisher of the application.
TargetProductName
Enter the name of the application that this patch updates.
MoreInfoURL
Enter a URL where end users can get online support for the application.
Upgrades
Use the Upgrades page to create an installation that upgrades previous versions of an
application. During an upgrade, the installation searches the destination computer for
applications that can be upgraded, and upon detection, retrieves its version information
from the registry. The installation uses this information along with the criteria on the
Upgrades page to determine whether the installed application should be upgraded. Then
the installation silently uninstalls the previous version and installs the new version.
Note
Upgrading is only supported in Windows Installer runtime v1.1 or later.
z You need access to the .MSI of each version you are upgrading.
z If you do not have access to the .MSI files, you must have the upgrade code and
version information from the .MSI files. The upgrade code is stored in the
UpgradeCode property, which is in the Properties icon in Setup Editor > Product tab.
The version is located on the Product Details page.
z The product code of this installation should be different from the product codes of
the installations you will upgrade.
The upgrade code is the only information required for creating an upgrade. If no other
upgrade specifications are entered, it is used as the sole factor for determining whether
the upgrade takes place. You can see the upgrade code under the Properties icon in
Setup Editor > Product tab. It is in GUID format.
Creating an Upgrade
1. Select Installation Expert > Upgrades page.
2. Click Add at the right of the page and specify the .MSI or .WSI for the previous
version of the application.
If you see a warning to update the current installation’s product code, click Yes.
Upgrade Code
If you specified an .MSI or .WSI to upgrade, this is filled in with that .MSI’s
upgrade code. If you did not specify an .MSI, you must enter the upgrade code
of the installation you want to upgrade. See What is the Upgrade Code? on
page 311.
Minimum Version
Enter the minimum version that should be upgraded by this installation. The
version you enter here is not upgraded unless you mark the Include minimum
version in range checkbox.
Maximum Version
Enter the maximum version that should be upgraded by this installation. The
version you enter here is not upgraded unless you mark the Include
maximum version in range checkbox.
Languages
This determines if an application should be upgraded based on its language.
Enter a semicolon-delimited list of languages that should be upgraded by this
installation. If this is left blank, all languages are included. Example: To upgrade
only the American English version, enter 1033. See Language IDs on page 279.
Features to remove
If this is left blank, the upgrade removes all existing features from the installed
application, and then installs the features specified in the new installation. To
prevent the removal of a feature or features, you must specify the features you
want removed. Then the upgrade removes only the features you specify and
leaves any other features. The list of features should be comma-delimited. The
feature names must exactly match those in the previous version.
Action Property
Specify a property to run a particular custom action based on which product
version is already installed. During installation, if an application with the same
upgrade code is found on the destination computer, its product code is placed
into this property. You can set conditions on custom actions so that they
execute based on the contents of this property. If you choose to create a new
property, enter its name in all uppercase letters, and add it to the list of
restricted public properties, which is stored in the SecureCustomProperties
property. Only restricted public properties appear in this list.
4. Click OK.
You might find that you need to work with source paths during installation development.
Project files (.WSI) reference files you add to the installation by their source path. Each
time you compile, the files are copied from the source path to the .MSI.
Topics include:
z Using Source Control. (Not available in the Visual Studio integrated editor.)
In the Enterprise Edition, you can distribute an installation to the share point directory
so that it can be imported into the Software Manager database. When you distribute to
the share point, all the installation’s source files are copied to the share point and the
source paths for those files are updated in the installation. See Copying an Installation
to the Share Point Directory on page 282.
Source code control is the control, tracking, and recording of all changes made to a set
of source code files. Various commercial and open-source software applications, such as
Microsoft Visual SourceSafe, act as source code control systems (SCCS). All SCCS
applications have similar functionality: tracking who is working on what file; allowing for
retrieval of previous versions, backing out of changes, adding and removing files from
the SCCS; and recording the history of files. They might also provide functionality for
viewing the differences between versions of files.
Wise for Windows Installer integrates with leading SCCS applications to let you perform
source control tasks on an installation. Wise for Windows Installer determines the SCCS
that you are using and calls APIs that interact with it. The API functions display dialogs
and functionality directly from your SCCS. On the Source Control tab in Wise Options,
you enable source code control and set the global level of interaction between your
SCCS and Wise for Windows Installer. See Setting Source Control Options on page 51.
z Have an SCCS installed on your computer, have a valid account, and you might need
permissions to create new directories and add files. Because Wise for Windows
Installer works though your existing user account, the permissions you experience
in Wise for Windows Installer are the same as those you already have set in your
SCCS.
z Enable the Source Control menu by marking the Enable source control checkbox
in Wise Options. If you do not have an SCCS installed on your system, the Source
Control menu is hidden and the Source Control tab in Wise Options displays an
informational message.
Note
If your installation is already located in your source control system, you can connect to
the existing installation. Do a Get of all the installation files to your hard drive, then
follow the procedure in Adding an Installation to Source Control on page 315.
z Source control tasks that you perform on the current installation file are also
performed on its XML copy. This ensures that both versions remain synchronized.
(The XML copy does not appear on the SCCS dialogs.)
z When you show history, the XML file is used instead of the installation file.
z When you compare differences, the XML file is used instead of the installation file. In
Visual Studio integrated editor, you cannot perform comparisons with the XML file.
This is a Visual Studio limitation.
z If you are using the Visual Studio source code control, do not check out files outside
of the Visual Studio interface. If you do, the installation file and its XML copy will get
out of sync.
Also see:
To use source control, you must have a source code control system (SCCS) installed on
your computer. For information about source control, see Using Source Control on
page 314.
1. If the commands in the Source Control menu are disabled, do the following:
b. Mark Enable source control. This enables the Source Control menu.
Dialogs from your SCCS appear, in which you connect to your SCCS and select the
location where this installation should be stored. To get further help on any of these
options, see the help system for your SCCS. If this installation is already located in
your SCCS, you can connect to it by selecting its current location when prompted.
After the SCCS-related dialogs appear, the Add to Source Control dialog appears.
This dialog contains the files that you add on the Files, Web Files, or Visual Studio
Solution page and resource files from the Wise for Windows Installer directory that
are part of every new installation.
Note
If you are working in a .WSI, only the .WSI can be added to source control; there is
no way to add the corresponding compiled .MSI. The .WSI or .MSI you are working
in does not appear on the Add to Source Control dialog because it is added
automatically. Only files that are currently part of the installation appear. If you later
add more files, repeat this process to add those files to the SCCS.
3. On the Add to Source Control dialog, mark the checkboxes of the files to add to
source control and click OK. Comments, which are stored as an attribute of the file
in the SCCS, are optional. If necessary, scroll to the right to view the Type and File
Path columns.
The Copy Files to New Location dialog appears if any files are not in the directory
tree of the installation file. Because all files that you add to source control must be
in the same directory tree as the installation file, this dialog prompts you to move
the files to a new directory under the installation file directory.
4. Mark the checkboxes of the files to copy to the same directory tree as the
installation file. To change the new location, click Change Dir and select another
directory within the same directory tree.
The New Location column indicates the directory to which files will be copied. (Scroll
right to see the New Location column.) If you later edit a file, you must edit the file
that is copied to the new location, because that is the file that is compiled into the
installation.
Note
To avoid moving files, cancel this operation, remove this project from source control,
and move the installation file into the same directory tree as its source files.
5. Click OK.
After the installation is added to your SCCS, use the options in the Source Control menu
to coordinate file transactions between your computer and the SCCS. Whenever you add
files to the installation, repeat the process above to add them to your SCCS.
When you add files to an installation, you must also add them to your source code
control system (SCCS), even if you’ve previously added the installation to source
control. Example: Suppose you add an installation to source control, along with source
files A.dll, B.txt, and C.jpg. Later, you add the file D.gif to the installation. To get D.gif
into source control follow the procedure below.
The Add to Source Control dialog appears. This dialog shows files in the installation
that have not yet been added to source control.
2. Mark the checkboxes of the files in the installation to add to source control and click
OK. Comments, which are stored as an attribute of the file in the SCCS, are
optional.
The Copy Files to New Location dialog appears if any files are not in the directory
tree of the installation file. Because all files that you add to source control must be
in the same directory tree as the installation file, this dialog prompts you to move
the files to a new directory under the installation file directory.
3. Mark the checkboxes of the files to copy to the same directory tree as the
installation file. To change the new location, click Change Dir and select another
directory within the same directory tree.
The New Location column indicates the directory to which files will be copied. (Scroll
right to see the New Location column.) If you later edit a file, you must edit the file
that is copied to the new location, because that is the file that is compiled into the
installation.
Note
To avoid moving files, cancel this operation, remove this project from source control,
and move the installation file into the same directory tree as its source files.
4. Click OK.
After the installation is added to your SCCS, use the options in the Source Control menu
to coordinate file transactions between your computer and the SCCS. Whenever you add
files to the installation, repeat the process above to add them to your SCCS.
Also see:
If you check a file in, then attempt to work on it, you are prompted to save it with a new
name because the file is locked for changes unless it is checked out first.
The Check In dialog appears, listing all files that have previously been checked out.
Note
When you add an installation to source control, the installation file (.WSI or .MSI) is
added and is also checked out, so it might appear in this dialog even if you
previously did not check it out.
2. Mark the checkboxes of the files to check into source control and click OK.
Comments, which are stored as an attribute of the file in the SCCS, are optional.
Also see:
If you check a file in, then attempt to work on it, you are prompted to save it with a new
name because the file is locked for changes unless it is checked out first.
The Check Out dialog appears, listing all files that have previously been checked in.
Note
When you add an installation to source control, all files except the installation file
(.WSI or .MSI) are checked in, so they might appear in this dialog even if you
previously did not check them in.
2. Mark the checkboxes of the files to check out from source control and click OK.
Comments, which are stored as an attribute of the file in the SCCS, are optional.
Also see:
The Get Latest Version dialog appears, listing all files in the installation.
2. Mark the checkboxes of the files to get from source control and click OK. You cannot
select a new location to copy files you get; they replace the existing files at the
check in/check out location.
Also see:
2. Mark the checkboxes of the files to remove from source control and click OK.
Comments, which are stored as an attribute of the file in the SCCS, are optional.
Also see:
The Undo Check Out dialog appears, listing all files that have been checked out.
Note
When you add a installation to source control, the installation file (.WSI or .MSI) is
added and is also checked out, so it might appear in this dialog even if you
previously did not check it out.
2. Mark the checkboxes of the files for which to undo check out. This backs out your
changes to the file, and checks the file back into source control.
Also see:
You can view the history of an installation in terms of its check in/check out activity in
the SCCS. You can only view the history of the installation file (.WSI or .MSI), not the
other source files associated with the installation. If an XML copy of the installation
exists, the Show History command displays the history of the XML file instead of the
installation file. To view the history of files other than the installation file, use your SCCS
directly.
To view the history of the installation file, select Source Control menu > Show History.
Dialogs from your SCCS appear. For information on these dialogs, consult the
documentation for your SCCS. In Microsoft Visual SourceSafe, the History Options dialog
appears, followed by the History of ProjectFileName.wsi dialog.
Also see:
SCCS applications commonly have functionality to let you see the differences between
the installation located on your local computer and the installation in the SCCS.
To access this feature from Wise for Windows Installer, select Source Control menu >
Show Differences. Dialogs that are unique to your SCCS appear. For help using these
dialogs to show differences, consult the documentation for your SCCS.
Note
If you are using Microsoft Visual SourceSafe, the Difference Options dialog appears. You
might need to select the SourceSafe folder and the Windows folder to compare in the
Compare and To fields. Then click the Project button for differences.
To perform a compare using Visual MSIDiff instead, use the Compare to Latest menu
command. It performs a table-by-table, row-by-row comparison of the current
installation file to the installation file in your SCCS. See Comparing the Current
Installation to the Latest in Source Control.
Also see:
You can perform a table-by-table, row-by-row comparison of the database tables that
make up an installation file (.MSI or .WSI). The current installation file is compared to
the latest installation file that is checked into your SCCS.
You are taken to Setup Editor > Tables tab and the Visual MSIDiff Key dialog
appears, which describes icons that indicate changes. Changes are shown in the
tables and rows where they occur.
2. On the Visual MSIDiff Key dialog, take note of the symbols and colors that indicate
changes and click OK.
If the Visual MSIDiff Key dialog does not appear, you might have clicked its Do not
show this dialog again checkbox. You can reactivate this dialog on the Prompts
tab in Wise Options.
3. On the Tables tab, scroll through tables, looking for the symbols for changed tables.
Click changed tables to view differences in rows, which are indicated by symbols and
colors.
As you work in the installation file, the symbols indicating changed items are
updated dynamically.
4. To turn the compare off, which closes the comparison file and returns to the current
file, select Tools menu > Visual MSIDiff > End Current Compare. Closing the file also
ends the compare.
Another command in the Source Control menu, Show Differences, lets you use the
compare technology offered by your SCCS. See Showing the Differences Between
Installation Files on page 320.
Also see:
When you add a file to an installation, its source path is stored. During compile, the
source path information is used to find the file and compile it into the .MSI or .EXE. The
Path Variables page lets you define variables to replace commonly-used source paths.
However, it has no effect on files that are already part of the installation. For these files,
see Source Paths in an Installation on page 324. If you add a file, and its source path
matches one of the paths defined on the Path Variables page, the variable that
represents the path is stored instead of the hard-coded path.
Example: Suppose the source files for your test build are in C:\Application\Test, and the
source files for your production build are in C:\Application\Production. You could create
a user-defined path variable named Application_Files and set it to C:\Application\Test. If
you then add the test build source files, their source path would contain the variable
name. You could then change this path variable to C:\Application\Production for your
production build.
Note
Do not create more than one variable that refers to the same path, because only one of
them is used when you add files.
Turning substitution off does not remove the path variable from paths for files added
previously; it only affects paths for files added subsequently.
2. Click Add at the right of the page and select User-Defined Path Variable.
Variable Name
Enter any name, but do not use special characters or spaces. Because this is not
a Windows Installer property, you do not need to follow Windows Installer
property naming conventions. This variable is inserted into the pathnames of
files that are pulled from the directory that appears in Current Value.
Current Value
(Read-only) This displays what you enter in Defined Value.
Defined Value
Specify the directory to replace with a variable. When you add a file from this
directory, the variable name replaces the pathname.
4. Click OK.
2. Click Add at the right of the page and select Environment Path Variable.
Variable Name
Enter any name, but do not use special characters or spaces. Because this is not
a Windows Installer property, you do not need to follow Windows Installer
property naming conventions. This variable is inserted into the pathnames of
files that are pulled from the directory that appears in Current Value.
Current Value
(Read-only) This displays the current value of the environment variable you
select below.
Env. Variable
This list contains the environment variables that are currently defined on your
computer. Select an environment variable that contains a directory path.
4. Click OK.
When a registry path value is displayed on the Path Variables page, a double slash
precedes the value name. This is normal. (You might have to scroll to the right to see
this value in the Defined Value column.)
2. Click Add at the right of the page and select Registry Path Variable.
Current Value
(Read-only.) This shows the current data of the registry value specified below.
Reg. Key
Specify the complete key name of the registry value that contains a directory
path. The registry browser that appears shows only key names (folder icons).
You specify the value in Reg. Value below.
Reg. Value
Select the value to pull a directory name from. This list shows the values
contained in the key you selected above.
4. Click OK.
As you work on an installation, paths to files listed on the Files, Web Files, or Visual
Studio Solution page can become invalid if you:
z Move files that are part of the installation to a new directory on your computer or
network.
z Move the installation file itself from your computer to another computer.
z Rename a directory.
If paths are invalid, then during compile error messages appear in the Task List
concerning the files that could not be opened. Rather than adding the files again, you
can specify the new source directories for these files.
The Convert Source Paths dialog lets you change the directories that contain an
installation’s files. You can also change all the directories to either relative or UNC
(Uniform Naming Convention) paths. If you change directories to relative paths, then
the installation can be opened on any computer that has the same relative directory
structure. If you change the directories to UNC paths, you can leave the source files on a
server but open the installation from any computer on the local network.
Whether the path to a file is stored depends on what kind of file you’re working in. When
you add a file to an .WSI or .MSI, the path to the file is stored, and each time you
compile, the file is recompressed into the resulting .MSI. However, if you open an .MSI
that was compiled from a .WSI, it does not store paths to the files because the files are
encapsulated inside the .MSI. You cannot change the source paths of files encapsulated
inside an .MSI.
To see a file’s path, go to the Files, Web Files, or Visual Studio Solution page and double-
click a file in the lower right list box. The File Details dialog appears, which displays the
pathname for the file in the Source Pathname field. If this field only displays a file
name or is blank, then you are working in an .MSI that was compiled from a .WSI. If
files do not have paths, you can either double-click on each file and define a path, or
convert the .MSI to a .WSI by using MSI to WSI Conversion.
Also see:
1. Select Tools menu > Convert Source Paths. (In Visual Studio: Project menu >
Convert Source Paths.)
The Convert Source Paths dialog appears with a list of all the directories that are
referenced in the installation.
To change multiple directories, select a high-level directory so that you can change
all of its subdirectories.
Change to
Specify the new pathname.
Change Sub-Directories
Mark this to change the subdirectories of the current directory.
5. Click OK.
The Change Source Directories to column displays the new pathname. If you
marked Change Sub-Directories, all directories that start with the same name as
the one you changed are renamed.
7. To set the path type for files that you add to the installation later, make a selection
from Path Type on the Convert Source Paths dialog.
8. Click OK.
All parts of the installation that reference these directories are updated.
A relative pathname uses .\ in the path to indicate the current directory, and it uses ..\
to indicate one directory up. All paths are relative to where the .WSI or .MSI file is
located.
Example: If the path to the .WSI is C:\Development\Application.wsi, and you add the
file C:\Program Files\Application.ini, the relative pathname of Application.ini is
..\Program Files\Application.ini.
1. Select Tools menu > Convert Source Paths. (In Visual Studio: Project menu >
Convert Source Paths.)
Paths to files that are not on the same drive as the installation file are not
converted, because they cannot be written as relative paths. Predefined paths, such
as [ProgramFiles], cannot be changed to relative paths.
3. To convert all directories you add to the installation later to relative paths, select
Relative Paths from Path Type.
4. Click OK.
Example: If you add files to an installation from your Y:\ drive, which is mapped to a file
server, paths of files you add to the installation start with Y:\. If a co-worker opens and
compiles the installation on another computer that doesn’t have its Y:\ drive mapped to
the same file server, the compile fails because the installation cannot find the source
files on the Y:\ drive. However, if you first convert all network paths to UNC paths, co-
workers on the same network can open and compile the installation without
encountering errors. Instead of a path such as Y:\Application.ini, a file has a fully
qualified path such as \\Server\Development\Application\Application.ini.
1. Select Tools menu > Convert Source Paths. (In Visual Studio: Project menu >
Convert Source Paths.)
This button is only available if at least one of the paths in the installation is from a
mapped network drive.
The Change Source Directories to column displays the new pathnames. Only the
source paths that are from mapped drives are changed to UNC.
3. To convert all directories you add subsequently to UNC paths, select UNC Paths
from Path Type.
4. Click OK.
A one-time conversion of all the network paths in the installation is performed. Paths to
files that are on local drives are not converted. However, if the local drive is shared, it is
converted to the shared drive name.
Use the procedures below to change the source directory dynamically during compile.
2. In the right pane, select New > Property from the right-click menu.
Name
Enter a new property name.
Value
Enter the directory path that currently contains the source files.
Example: Enter SourceFiles in the Name field and enter C:\Development in the
Value field. The directory path you enter here can be changed by command line
options during compile.
Change to
Enter the name of the property, surrounded by square brackets. The property
name is case-sensitive. Example: [SourceFiles].
You can add other directories to the end of the property name to create other
locations. Example:
[SourceFiles]Libraries\Visual Basic
[SourceFiles]Libraries\C++
Change Sub-Directories
Mark this to change the subdirectories of the current directory.
5. Click OK.
The Change Source Directories to column displays the property name in brackets.
6. Click OK.
The command line options to compile and set the property value.
Example: "C:\Program Files\Wise for Windows Installer\WfWI.exe"
C:\Installers\Application.wsi /c /p SourceFiles="E:\Development\"
See About Command Lines on page 209 and Source Paths in an Installation on
page 324.
You can apply merge modules and transforms to installations you create in Wise for
Windows Installer. Both change the installation in some way. Merge modules are
databases that contain separate, self-contained software installations. You use them to
insert shared Windows Installer components and setup logic into an installation during
compile. Transforms are applied at runtime only, to customize the installation for a
particular group of end users.
Topics include:
z About Transforms.
Example: Suppose you have 5 applications that require a specifically configured version
of the Visual Basic runtime. You could create a merge module that installs and
configures the Visual Basic runtime. Then you add the merge module to each installation
that requires that particular Visual Basic runtime. This saves you from having to add the
necessary files, registry entries, and other components to every installation individually.
It also saves time if you update the merge module; instead of updating the 5
installations for all applications, you update only the merge module, then recompile the
5 installations.
When deploying software via a merge module, keep update considerations in mind.
Example: If you deploy MSDE via a merge module, end users cannot use Microsoft’s
MSDE security patches to update that installation of MSDE. Microsoft patches only
operate on software packages installed by .MSI. You would have to incorporate the
MSDE patch changes in an update to your own application and distribute it to your end
users. This could cause security and timing issues for your end users.
You can create merge modules and add them to installations. See Adding a Merge
Module to an Installation on page 345. You can also add predefined merge modules to
an installation, which install commonly-used software packages. For information on
obtaining predefined merge modules, see Downloading Redistributable Files on page 35.
Note
When you view MSI Script in a merge module, you’ll notice that you cannot select an
installation mode, that there are no actions in the right pane, and that there are no
sequence tabs at the bottom. This is because any custom action you add to a merge
module does not contain its own sequence tables and must be merged into the
CustomAction table and the sequence tables of the main installation. See All Custom
Actions on page 469 and Using the Custom Action Location Tab for Merge Modules on
page 516.
Configurable merge modules are supported only by Windows Installer 2.0 or later. See
Configurable Merge Modules in the Windows Installer SDK Help.
Also see:
You cannot add features to a merge module, therefore, the Features tab does not appear
in Setup Editor when you are in a merge module. Instead, the Module tab appears,
which contains information similar to that found on the Features tab. It lets you
manipulate the components, files, registry entries, and other items in the merge
module. Items you add to the merge module are listed under this tab. For information
about each icon, see Items You Can Add on the Features Tab on page 386.
The panes on the Module tab show only the items you’ve added, unless you select to
show empty folders and items from the right-click menu. The upper right pane shows
the contents of the item selected in the left pane. For an expanded view of a selected
item, double-click the item in the right pane.
Also see:
If there is no Module Details page, you are not in a merge module file.
Module Name
Enter a name that Windows Installer and Wise for Windows Installer can use
internally to identify the merge module.
Version
Enter the version of the module. Windows Installer and Wise for Windows
Installer use this number to check versions of dependency and exclusion merge
modules. You can use the format xxxxx.xxxxx.xxxxx.xxxxx, where x is a digit.
See Version in the Windows Installer SDK Help.
Language
Enter the language code for the merge module. English is 1033. Language
neutral (meaning the merge module works with all languages) is 0. See
Language IDs on page 279.
Module Type
Select the module type. This defaults to the Default Application Type that is
specified in Wise Options. See Setting .NET Assembly Options on page 40.
Note
The ability to create .NET installations is supported only by Windows Installer
2.0 or later.
.NET Application
A .NET merge module with only .NET elements.
When the .NET Application or Mixed option is selected, entries are created in
the MsiAssembly and MsiAssemblyName tables for each assembly you add to
the merge module. Also, the Global Assembly Cache appears on the Files page.
Also see Available Tabs and Pages in Merge Modules on page 330.
A dependency is a merge module that is required for the current merge module to work.
Dependencies can have their own dependencies, which means that the module you
designate as a dependency could itself have a dependency on another module, and so
on. Use dependencies to compartmentalize different components of software. When you
compile an installation that contains a merge module that has a dependency, both the
original merge module and all its dependencies are merged into the installation.
Example:
Suppose you have a merge module that consists of a library of database drivers, but for
those drivers to work, MDAC must also be installed. You designate the MDAC merge
module as a dependency to the database driver module. Then, whenever you add the
database driver module to an installation, Wise for Windows Installer attempts to add
the dependency merge module, MDAC.
Wise for Windows Installer looks for dependency merge modules in the default merge
module directory specified in Wise Options, and also looks at the list of previously added
merge modules. If Wise for Windows Installer does not find the dependent module in
either of these places, it prompts you to add the dependency merge module yourself.
2. Click Add at the right of the Dependencies page and specify one or more merge
modules.
If you select one merge module, the Dependency Module Details dialog appears.
If you select multiple merge modules, they’re listed on the Dependencies page.
Double-click a module name to open the Dependency Module Details dialog for a
specific merge module.
Fields are populated with information extracted from the merge module.
Module ID
To specify a different merge module, click Browse.
Language ID
To specify a different language for the dependent merge module, change
Language ID. (Example: Do this if the merge module you’ve selected includes
a complete language group but you want your merge module to be dependent
on only one language in this group.) To ignore any language considerations,
enter 0.
Version
To ignore any version considerations for the merge module upon which the new
merge module will be dependent, leave Version blank.
4. Click OK.
Note
The information on the Dependency Module Details dialog fills the
ModuleDependency table, which you can see in Setup Editor > Tables tab. See
ModuleDependency Table in the Windows Installer SDK Help.
Also see Available Tabs and Pages in Merge Modules on page 330.
Completing the Exclusions page enters the exclusion information in the ModuleExclusion
table in the Windows Installer database and triggers compile and verification error
messages if both merge modules are included in the same installation.
2. Click Add at the right of the Exclusions page and specify one or more merge
modules to exclude from the current merge module.
If you select one merge module, the Exclusion Module Details dialog appears.
If you select multiple merge modules, they’re listed on the Exclusions page. Double-
click a module name to open the Exclusion Module Details dialog for a specific
merge module.
Fields are filled in with information extracted from the merge module.
Module ID
To specify a different merge module, click Browse.
Language ID
To specify a different language for the merge module to be excluded, change
the number in Language ID. (Example: Do this if the merge module you’ve
selected includes a complete language group but you want to exclude one
language in this group only.) To ignore any language considerations, enter 0.
4. Click OK.
Note
The information on the Exclusion Module Details dialog fills the ModuleExclusion
table, which you can see in Setup Editor > Tables tab. See ModuleExclusion Table in
the Windows Installer SDK Help.
Also see Available Tabs and Pages in Merge Modules on page 330.
(Visual Studio integrated editor.) Follow this procedure to create a merge module that is
not associated with a Visual Studio .NET solution. Do this if you plan to create the merge
module and have it remain static. If it is part of a solution, it is continually rebuilt, so
creating it stand-alone makes it more stable.
To create a merge module that is part of a Visual Studio .NET solution, see Creating a
Merge Module Within a Solution on page 336.
The Target Platform section on the New Installation File dialog is available in the
Professional and Enterprise Editions only, and appears only if Select platform in
New Installation File dialog is selected in Wise Options. For information on target
platforms, see Specifying the Target Platform in an Installation on page 76.
A new merge module opens. In Installation Expert, 4 page groups appear, showing
the pages that apply to merge modules. Go to Assembling the merge module below.
For information on .MSM and .WSM files, see File Types on page 67.
5. Click Open.
The new merge module opens. In Installation Expert, 4 page groups appear,
showing the pages that apply to merge modules. Go to Assembling the merge
module below.
Note
The Files page includes an extra folder named Application. By default, files that you
add to this folder are copied to the default installation directory of the installation
into which the merge module is merged. Example: If you merge the merge module
into an installation that installs files to C:\Program Files\Product, all files you add to
the Application folder will also be installed to C:\Program Files\Product.
2. If you’re creating a configurable merge module, specify which items can be modified
when the module is merged into an installation. See Creating a Configurable Merge
Module on page 338.
Dependencies are other merge modules that must be included with this merge
module, and exclusions are other merge modules that cannot be included with this
merge module. See Setting Dependencies for a Merge Module on page 332 and
Setting Exclusions for a Merge Module on page 333.
4. Configure the summary information for the merge module, which is described in
General Information Page on page 98.
5. Configure the Module Details page, which contains the merge module name,
language, and version, and is described in Setting Merge Module Details on
page 331.
After you create the merge module, you can add it to a standard installation. See Adding
a Merge Module to an Installation on page 345.
Also see:
To create a merge module that is not integrated with a Visual Studio .NET solution, see
Creating a Merge Module As a New Installation on page 334.
3. In the Project Types list, select Wise Setup and Deployment Projects.
(Professional and Enterprise Editions.) Select the Setup Wizard icon to create a
new merge module and enter its project settings.
(Standard Edition.) Select the Merge Module icon to create a new merge module
with default settings, which you can change later.
5. In Name, enter a name for the merge module file. In Location, specify the
directory in which to save the merge module project.
7. Click OK.
If you selected the Windows Application icon, a merge module project is created in
the location you specified and is listed in Solution Explorer. Skip the next step.
If you selected the Setup Wizard icon, the Wise Setup Wizard appears.
b. On the wizards’ Project Type page, select the Merge Module option.
c. For information on other settings in this wizard, see Entering Project Settings on
page 77.
d. Click Finish.
A merge module project is created in the location you specified and is listed in
Solution Explorer.
The new merge module opens. In Installation Expert, 4 page groups appear,
showing the pages that apply to merge modules.
10. Assemble the merge module by adding files, registry entries and so on using the
pages under the Details page group. Because merge modules cannot have multiple
features, you don’t select a feature on these pages.
Note
The Files page includes an extra folder named Application. By default, files that you
add to this folder are copied to the default installation directory of the installation
into which the merge module is merged. Example: If you merge the merge module
into an installation that installs files to C:\Program Files\Product, all files you add to
the Application folder will also be installed to C:\Program Files\Product.
11. If you’re creating a configurable merge module, specify which items can be modified
when the module is merged into an installation. See Creating a Configurable Merge
Module on page 338.
12. Select the dependencies and exclusions for this merge module.
Dependencies are other merge modules that must be included with this merge
module, and exclusions are other merge modules that cannot be included with this
merge module. See Setting Dependencies for a Merge Module on page 332 and
Setting Exclusions for a Merge Module on page 333.
13. Configure the summary information for the merge module, which is described in
General Information Page on page 98.
14. Configure the Module Details page, which contains the merge module name,
language, and version, and is described in Setting Merge Module Details on
page 331.
After you create the merge module, you can add it to a standard installation. See Adding
a Merge Module to an Installation on page 345.
Also see Available Tabs and Pages in Merge Modules on page 330.
Note
All the components you plan to move to the new merge module must be in the same
feature. If they are not, create a feature temporarily and add the components to it in
Setup Editor > Features tab.
2. Select Tools menu > Move Components to Merge Module. (In Visual Studio: Project
menu > Move Components to Merge Module.)
You can also select Setup Editor > Features tab (in an installation) or Setup Editor >
Modules tab (in a merge module), right-click the feature containing the components
to move, and select Move Components to Merge Module.
Module Name
Enter a name that Windows Installer and Wise for Windows Installer can use
internally to identify the merge module.
Version
Enter the version of the module. Windows Installer and Wise for Windows
Installer use this number to check versions of dependency and exclusion merge
modules. You can use the format xxxxx.xxxxx.xxxxx.xxxxx, where x is a digit.
See Version in the Windows Installer SDK Help.
Language
Enter the language code for the merge module. English is 1033. Language
neutral (meaning the merge module works with all languages) is 0. See
Language IDs on page 279.
4. Click Next.
5. From Export from Feature, select the feature that contains the components to
move.
If you are moving components from a merge module, there are no features.
6. Mark the checkboxes of the components to move into the new merge module.
7. Click Finish.
The components you select are removed from this installation, compiled into the new
merge module, and re-inserted in the form of a merge module. The new merge module
is also available to other installations.
Also see:
This creates a substitution value, which consists of one or more values specified by
configuration items. When a configurable merge module is added to an installation, the
installation author can specify values for the substitution item based on the
configuration item settings. See Adding a Merge Module to an Installation on page 345.
Configurable merge modules are supported only by Windows Installer 2.0 or later.
For information on creating a standard merge module, see Creating a Merge Module As a
New Installation on page 334. (In Visual Studio: also see Creating a Merge Module
Within a Solution on page 336.)
3. From Table, select the table that contains the item to be configured when the
merge module is added to an installation.
Configurable Item
Select to add a configuration item to the selected substitution item. See Setting
Configuration Item Details on page 339.
Constant
Select to add a constant value in combination with configurable items. Example:
After adding a configuration item, select this option to add a pipe character (|)
before adding another configuration item.
6. Click OK.
The value you defined for the configurable item appears in the Value field, and the
item appears in the Configuration Items list box.
7. To add more values for the item, repeat the preceding 2 steps.
If you add multiple values, multiple rows appear in the list box and the values are
concatenated to create the entire substitution value. See Example: Configuring an
Item for a Merge Module on page 343.
8. Click OK.
Also see:
Name
Enter a name to represent the item in the Configuration Items list box on the
Module Substitution dialog.
Display Name
Enter the name that should appear on the Merge Module Configuration dialog
when the merge module is added to an installation.
Description
Describe what can be modified.
Type
Select the type of configurable data that is appropriate for the item you allow to
be substituted.
Arbitrary Text
The installation author can enter any text to replace the default value.
Example: Use this when you allow a file name to be modified. See Example:
Configuring an Item for a Merge Module on page 343.
Formatted Text
The installation author can enter any text in Windows Installer formatted
text format to replace the default value. Example: Use this when you allow a
registry value to be modified.
RTF Text
The installation author can enter any text in rich text format to replace the
default value. Example: Use this when you allow a different license
agreement to be selected.
For information on the format types like the ones listed above, see Text Format
Types in the Windows Installer SDK Help.
author could be for the file to be read-only; read-only and hidden; or read-
only, hidden, and vital.) For information on completing the additional fields
that display when this option is selected, see Specifying a Bitfield for
Substitution on page 342 and Bitfield Format Types in the Windows Installer
SDK Help.
Integer
The installation author can enter any integer to replace the default value.
Example: Use this to make the size of a control or a dialog configurable. See
Integer Format Types in the Windows Installer SDK Help.
Non-nullable
Mark this if a value is required for this configuration item.
Default Value
Enter the value that should appear on the Merge Module dialog when the
configurable merge module is added to an installation. This is the value that can
be changed.
3. Click OK.
1. Access the Configuration Item Details dialog from the Module Substitution dialog.
2. Complete the Configuration Item Details dialog. See Setting Configuration Item
Details on page 339.
4. Click Add.
Name
Enter text to describe the substitution value. The installation author sees this
value in the Value drop-down list on the Merge Module Configuration dialog.
Value
Enter the value to be substituted for the current value of the configuration item.
6. Click OK.
The Configuration Item Details dialog lists the text and value you defined.
8. Click OK.
The values you defined for the configurable item appear in the Value field, and the
items appear in the Configuration Items list box.
9. Click OK.
1. Access the Configuration Item Details dialog from the Module Substitution dialog.
See Creating a Configurable Merge Module on page 338.
2. Complete the Configuration Item Details dialog. See Setting Configuration Item
Details on page 339.
4. In Bitmask, enter the decimal value of the bit flag to set. To set multiple bit flags,
enter the sum of their decimal values.
Example: Suppose you want to let the installation author set the attributes of a file
to system and vital. The decimal value of the system attribute is 4. The decimal
value of the vital attribute is 512. You would add these values and enter a bitmask
of 516.
5. Click Add.
Name
Enter text to describe the substitution value. The installation author sees this
value in the Value drop-down list on the Merge Module Configuration dialog.
Value
Enter the value to be substituted for the current value of the configuration item.
7. Click OK.
The Configuration Item Details dialog lists the text and value you defined.
9. Click OK.
The values you defined for the configurable item appear in the Value field, and the
items appear in the Configuration Items list box.
1. Access the Configuration Item Details dialog from the Module Substitution dialog.
See Creating a Configurable Merge Module on page 338.
2. Complete the Configuration Item Details dialog. See Setting Configuration Item
Details on page 339.
4. Mark Delete Unreferenced Rows to have the row that is referenced by the default
value merged if the installation author selects the default value when adding the
merge module to an installation.
Example: Suppose the merge module includes a dialog with a graphic. You select
Binary (Bitmap) from Key Table and set the Default Value to the bitmap in the
merge module. If the installation author selects a different bitmap when adding the
merge module to an installation, then the default bitmap is no longer referenced. If
Delete Unreferenced Rows is marked, the default bitmap is not merged into the
installation.
5. From Key Table, select the type of table to make available for selection for this key.
6. Click OK.
The values you defined for the configurable item appear in the Value field, and the
items appear in the Configuration Item list box.
7. Click OK.
4. In the FileName column, click the cell that contains the ReleaseNotes file name. It
should look something like this:
RELEAS~1.TXT|ReleaseNotes.txt
Name
Enter “short name.”
Display Name
Enter “Short file name.”
Description
Enter “Choose whether to use a short or a long file name for this file.”
Type
Select Arbitrary Text.
Default Value
Enter “RELEAS~1.TXT.”
7. Click OK.
9. In Constant Substitution Value, enter the pipe character (|) and click OK.
On the Module Substitution dialog, the pipe character (|) appears in the
Configuration Items list box, below short_name.
Name
Enter “long name.”
Display Name
Enter “Long file name.”
Description
Enter “Choose whether to use a short or a long file name for this file.”
Type
Select Arbitrary Text.
Default Value
Enter “ReleaseNotes.txt.”
13. When you add this merge module to an installation, the configuration items will
appear in the order they are listed here. To rearrange the items click move up and
move down.
When you add this configurable merge module to an installation, the Merge Module
Configuration dialog displays the following:
z In the list box at the top: Short file name and Long file name.
z Description: Choose whether to use a short or a long file name for this file.
See:
When deploying software via a merge module, keep update considerations in mind.
Example: If you deploy MSDE via a merge module, end users cannot use Microsoft’s
MSDE security patches to update that installation of MSDE. Microsoft patches only
operate on software packages installed by Microsoft .MSIs. You would have to
incorporate the MSDE patch changes in an update to your own application and distribute
it to your end users. This could cause security and timing issues for your end users.
2. From Current Feature, select a feature or condition. (Because any item you add
must be assigned to a specific feature, you cannot add an item when All Features
is selected.)
Items that you add to a feature are installed on the destination computer only if the
feature is installed. Items that you add to a condition are installed only if the feature
is installed and the condition is true.
The Select Merge Module dialog appears and lists available merge modules in the
directories specified in Wise Options. See Setting Merge Module Directories on
page 48.
In the Enterprise Edition, the Select Merge Module dialog can also include merge
modules that are in the Software Manager database. You must have access to the
Software Manager database and the Read Merge Modules List From Software
Manager Database checkbox must be marked in Wise Options.
4. If the merge module you want is not in the list, do one of the following:
To add directories to search for merge modules, click Directories and the Merge
Modules tab from Wise Options appears. Click Add to add the directory that
contains the merge module. See Setting Merge Module Directories on page 48.
The merge modules in this directory are added to the list of available merge
modules.
Click Download to add merge modules from the Wise Web site, other vendors’
Web sites, or from the product CD. See Downloading Redistributable Files on
page 35. If you download the merge modules to a directory that is specified in
Wise Options, they are added to the list of available merge modules.
5. Select one or more merge modules from the list by marking the corresponding
checkboxes.
6. Click Next.
7. To change the destination for a merge module, select one or more merge modules
and click Change.
Select the destination directory for files in the merge module that are not installed
to a predefined directory. If there are no files in the merge module’s Application
directory and you want to leave this blank, select <none>.
9. If the installation contains only one feature and the merge module is not
configurable, the Merge Module File Directory dialog contains a Finish button. Click
Finish to complete this process.
10. If the installation contains multiple features, the Merge Module File Directory dialog
contains a Next button. Click Next to continue.
11. To add this merge module to other features besides the one you selected in the
Current Feature drop-down list, select them in the list box. You can select multiple
features.
If multiple features in the installation depend on this merge module, you should add
it to all of them. Only one copy of the merge module is installed on the destination
computer regardless of how many features include it.
12. If none of the merge modules you’re adding is configurable, the Merge Module
Features dialog contains a Finish button. Click Finish to complete the process.
13. If any of the merge modules you’re adding is configurable, the Merge Module
Features dialog contains a Next button. Click Next to continue. The Merge Module
Configuration dialog appears.
14. In the list box, select the name of the item to configure. If the Value drop-down list
appears, select a value. If a text field appears, its label indicates the type of data
you can enter. For a description of possible values, see Editing Merge Module Details
on page 347.
15. If you’re adding more than one configurable merge module, a Next button appears
at the bottom of the dialog. Click Next and repeat the preceding step.
The Next button changes to a Finish button when the Merge Module Configuration
dialog shows the last configurable merge module to be added.
The merge modules are added to this installation. If any of the merge modules contain
dependencies, Wise for Windows Installer attempts to add them by looking in the default
merge module directory. See Setting Dependencies for a Merge Module on page 332. If
a dependency merge module cannot be found, you are prompted to download it. During
compile, the merge modules are merged into the installation, so that the resulting .MSI
contains both the changes defined in the standard installation as well as the changes
defined in the merge modules. If your compile fails because of merge module errors, the
errors appear in the Task List.
To remove a merge module from an installation, select the merge module on the Merge
Modules page and click Delete. If the module is included with more than one feature, it
is only removed from the installation when you remove it from all features.
2. From Current Feature, select the feature or condition that contains the merge
module to edit.
The Merge Module Details dialog appears. It has 1 tab if you’ve double-clicked a
standard merge module and 2 tabs for a configurable merge module.
4. Click the Settings tab and change the dialog’s settings as needed:
Destination Directory
Select the destination directory for files in the merge module that are not
installed to a predefined directory. If there are no files in the merge module’s
Application directory and you want to leave this blank, select <none>.
Feature
If the installation contains multiple features, a list of features appears. To add
this merge module to other features, mark their checkboxes.
If multiple features in the installation depend on this merge module, you should
add it to all of them. Only one copy of the merge module is installed on the
destination computer regardless of how many features include it.
5. If the merge module is configurable, the Merge Module Details dialog has a
Configuration tab. To change configuration values:
If the Value drop-down list appears, select a value. It will be either a bitfield
value, a table, or text. If a text field appears its label indicates the type of data
you can enter:
Text Value
Enter any text.
RTF Value
Enter any text in rich text format.
For information on the format types listed above, see Text Format Types in the
Windows Installer SDK Help.
Integer Value
Enter any integer. See Integer Format Types in the Windows Installer SDK
Help.
For general information on configurable item types, see Semantic Types in the Windows
Installer SDK Help or see Creating a Configurable Merge Module on page 338.
Note
During compile, if the installation contains a merge module that cannot be located on
your system, you are prompted to download the merge module. This can happen if the
installation was created on a different computer or if you have moved your merge
modules directory.
About Transforms
A transform is a special kind of Windows Installer file (.MST) that customizes a Windows
Installer installation. You use it to change the installation in some way for a specific
group of end users. When you create a new transform, you must specify a standard
installation database (.MSI) on which to base the transform. Unlike merge modules,
which you can add to multiple installations, you create a transform to work only with a
specific installation.
Because it would be unwieldy to install all options for all groups of end users, you can
create one base .MSI, along with several transforms, each of which modifies the .MSI
database at installation to customize it for different groups.
Example: Suppose you are a system administrator who’s deploying a new version of
workgroup software. You can use transforms to customize the installation for the needs
of different departments. In each transform, you make changes to customize an
installation for a particular department. Then during installation, you make sure that the
appropriate transform is applied for each department.
z Creating a Transform Based on an Existing .MSI. This lets you change any aspect of
the installation.
z Creating a Language Transform on page 260. This lets you change the language on
the dialogs that appear during installation.
Transforms must be run from the command line. See Applying a Transform to an
Installation on page 351.
Note
The Languages pages is disabled for transforms. Edit languages in the base .MSI.
Also see:
Example: Suppose you want a transform that changes the application name, changes
what registry entries are installed, and changes what system requirements are
necessary to run the installation. Because these changes affect multiple areas of the
product, you use this method to create the transform.
1. (Visual Studio only.) If a solution is open in Visual Studio .NET, close it.
2. Select File menu > New. The New Installation File dialog appears. (In Visual Studio:
select File menu > New > File. The New File dialog appears.)
From the Categories list, select Other Templates. (In Visual Studio: select
Wise Files.)
In the Templates/Tools list, select the Transform icon, then click OK. (In
Visual Studio: in the Templates list, select Transform File, then click Open.)
The Open File dialog appears.
The transform opens with the exact settings of the installation on which it is based.
4. Make changes to the installation, such as adding files, or changing any other
settings.
Note
If you add files when editing a transform, a .CAB file is created along with the
transform. When you apply the transform, make sure the .CAB file, the original
.MSI, and the .MST are all in the same directory.
5. When you finish making changes, select File menu > Save.
The Save As dialog appears. (In Visual Studio: the Save File As dialog appears.)
The transform appears in the location you specified, with an .MST extension. For
information on applying a transform, see Applying a Transform to an Installation on
page 351.
In most cases, if you create the transform using Wise for Windows Installer, you can
leave the defaults on the Transform Details dialog. See
MsiCreateTransformSummaryInfo in the Windows Installer SDK Help.
z Base database
This is the .MSI on which this transform is based. Do not change this. If this
transform is applied to a database other than the one specified here, an error is
generated during installation.
z Validation
The following checkboxes and fields let you require certain conditions to be true for
the transform to be applied to the base .MSI.
Match Language
Mark this if the language of the transform must match the language of the base
.MSI.
Match Product
Mark this if the product code of the transform must match the product code of
the base .MSI.
Version Matching
The version of the installation (set on the Product Details page) is in the form
AA.BB.CCCC.DDDD, where AA represents the major version, BB represents the
minor version, CCCC represents the update version, and DDDD represents the
build version. Select an item in the list to have the version of the transform
checked against the version of the base .MSI. If the versions do not match, an
error is generated during installation.
Version Relationship
If you chose to check versions, specify what version relationship must be true in
order not to generate an error.
where Application.msi is the name of the .MSI, and TransformName.mst is the name of
the transform.
Because it is not practical to have end users type a line on the command line to run a
transform, we suggest you use one the following methods to run the transform:
z Write a batch file that runs the .MSI along with the appropriate transform.
z Output the installation as an .EXE that launches an .MSI, which lets you send
command line options to the .MSI. Do this on the Build Options page. See the
example below.
3. Select the Build Options page, select the new release from the Current Release
drop-down list, and select .EXE that launches external .MSI from the .EXE
Options drop-down list.
4. Compile the installation, which creates an .EXE, an .MSI, and an .INI file.
CmdLine=TRANSFORMS="TransformName.mst" /i
When you double-click the .EXE file, it reads the .INI file of the same name. (Example:
Application.EXE reads Application.INI.) When it runs the installation, it applies the
command line option specified in the CmdLine property and the transform is applied.
These command line options are passed to msiexec.exe, the Windows Installer
executable.
If you have multiple transforms, you can make multiple releases, and manually edit the
.INI file for each release.
Windows Installer permits one instance of a product code to be installed per machine
and one instance to be installed per user. To install multiple instances of a product
without creating a separate installation for each instance, you can create instance
transforms to change the product code for each instance. An instance transform changes
the product code of an installation or patch and can isolate its data so that multiple
instances of the application can be installed.
Example: A Web server administrator can install multiple instances of a web site
template on the same server to different virtual directories.
Guidelines
z Code the application so that it can locate resources based on the instance identifier.
To create the instance identifier, you define an instance property in the base
installation and have the instance transform set the property value.
z Each instance must have a unique product code and an instance identifier.
z To isolate resources for each instance, install them into a location that depends on
the instance identifier.
For additional guidelines, see Authoring Multiple Instances with Instance Transforms in
the Windows Installer SDK Help.
4. Product Name is pre-filled with the product name from the Product Details page. If
you change it here, it is changed on the Product Details page.
Product Code
Wise for Windows Installer generates a product code in the form of a GUID,
which ensures that no 2 applications ever have the same product code. To
change the product code, click Generate; typing or editing a GUID does not
generate a valid GUID.
Product Name
The base product name is incremented by 1 for each new instance transform.
You can change this but the name must be unique. The end user sees this name
during installation and in the Add/Remove Programs dialog.
File Name
The base product name is incremented by 1 for each new instance transform.
You can change this but the name must be unique. This becomes the name of
the transforms that is created. The transform is saved in the same directory as
the base installation file.
Example: Suppose you want to install test, beta, evaluation, and production
versions of your application on the same destination computer. To do this, code
your application to look for these instances. Add files to the installation. On the
Instance Transforms page, add instances for each version of your application
and define an instance property value for each (examples: 1, 2, 3, 4). Mark the
Change install directory to Instance Property Value checkbox for each
instance. When each instance transform is applied to the installation, files are
installed into INSTALLDIR, but the value of INSTALLDIR changes based on the
instance property value. (Examples: Program Files\Application1, Program
Files\Application2, and so on.) If you did not mark the Change install
directory to Instance Property Value checkbox, then files for each instance
would be installed on top of each other in the same directory as for the base
installation.
7. Click OK.
The instance transform is added to the list on the Instance Transforms page. To edit an
instance transform, double-click its name. The actual transform files (.MST) are created
during compile.
Note
Multiple instance installations are supported only by the versions of Windows Installer
released with Windows XP SP1 (2.0.2600.1106), Windows Server 2003 (2.0.3790.0), or
later.
Like other types of transforms, an instance transform must be applied to a base .MSI or
patch during installation using a command line option; it cannot be applied beforehand.
where Application.msi is the name of the .MSI, and Instance.mst is the name of the
transform.
For additional examples, see Installing Multiple Instances with Instance Transforms in
the Windows Installer SDK Help.
Wise for Windows Installer contains powerful tools that perform specialized functions.
You can start a tool, except for Setup Capture, by selecting its name from the Tools
menu. (In Visual Studio: Project menu.) Some tools are also available on the Tools
toolbar. To display the Tools toolbar, select View menu > Tools. (In Visual Studio: View
menu > Toolbars > Wise Wizards.)
You also can start some tools from the New Installation File dialog, which puts the
results from the tool into a new installation file. (In Visual Studio: New Project or New
File dialog.)
z Move Components to Merge Module. See Creating a Merge Module From Existing
Components on page 337.
z Software Manager, which provides the interface for working with packages in the
Software Manager database. See Software Manager Basics in the Software Manager
Help. (Enterprise Edition only.)
z WiseScript Express™, which lets you lets you write scripts that solve complex
problems outside the Windows Installer environment. Save the scripts as separate
.EXEs to be called from Call WiseScript custom actions in a Windows Installer
installation. See WiseScript Editing Tools on page 473.
Note
SetupCapture has been replaced by the expanded tools for converting and importing
non-Windows Installer projects that are listed above. These tools provide more accurate
installations than could be obtained by capturing the installations.
ApplicationWatch
ApplicationWatch monitors your system as you execute an application or run an
installation and helps you determine which .DLL, .OCX, and .EXE files were accessed. It
adds these files to the current Windows Installer installation. You can use this tool for
informational purposes or to facilitate the creation of a new installation.
Note
Application Watch cannot monitor 16-bit applications.
1. Exit all other applications so the files they access are not added to the installation.
2. Select Tools menu > ApplicationWatch. (In Visual Studio: Project menu >
Application Watch.)
Application Path
Specify the full pathname of the application executable to run.
Command Options
Enter any command line options that should be applied to the executable. Refer
to the source application’s documentation for applicable command line options.
5. In the source application, use all possible features except printing. If you are
watching an installation, run the installation through to completion.
6. Exit the application, return to the Run Application dialog, and click Finish.
If a file that is part of a merge module is added, the Files in Merge Modules dialog
appears. It prompts you to add the merge module and, if necessary, download it. See
Adding Merge Modules Instead of Files on page 120.
If a file that is used by a package in the Wise Software Repository is added, the Files in
Repository dialog appears and prompts you to add a version of the file that is in the
repository. See Adding Files From the Wise Software Repository on page 121.
(Enterprise Edition only.)
The files that were accessed by the source application are added to the Files page. If you
use this information as a starting point for developing a complete installation, you
should compile and test the installation thoroughly to make sure it operates correctly.
Caution
Some of the files that are listed on the Files page might be platform-specific or non-
distributable Windows system files. If you are not sure whether it is safe to deploy a file,
check with Microsoft developer documentation before deploying these files to end users.
Guidelines
z Because InstallShield Professional installations are based on a different technology
than Windows Installer, not all elements of the source installation are converted to
Windows Installer format:
The installation is built from the configuration files defined by the .IPR. Files,
registry keys, and shortcuts are converted. The Product Name, Product Version,
and Company Name properties are also converted. File source paths are
retained.
The .RUL file, which controls how the resources are installed, cannot be
converted. Add custom actions to the new package to replace any custom logic
that was previously stored in the .RUL file.
Only InstallShield projects that use English in their dialogs can be converted.
z All the files available to the original InstallShield installation must be available to the
converted Windows Installer package at the same locations.
z Resources are organized into features based on groups in the resource lists. To
retain the organization in the InstallShield project, components are organized into
separate features, with FileGroups as child features.
Select File menu > New. On the New Installation File dialog, select Conversion
Tools from the Categories list and double-click InstallShield Professional in the
Templates/Tools list. (In Visual Studio: Select File menu > New > File. On the
New File dialog, select Wise Files from the Categories list and double-click
Convert InstallShield Professional in the Templates list.) Use this method to
create an installation that contains only the information from the converted
installation.
Select Tools menu > Convert InstallShield® Professional. (In Visual Studio:
Project menu > Convert InstallShield® Professional.) Use this method to add
the converted installation’s information to the current installation file.
The Welcome dialog appears.
2. On the Welcome dialog, specify the full pathname of the project file (.IPR) to
convert.
The Conversion Progress dialog appears. The .IPR file is converted to Windows
Installer format.
4. To obtain a record of the conversion errors, click Save Errors or Print Errors.
5. Click Finish.
More errors might appear at this point, which have to do with saving in Windows
Installer format.
The installation that was created from the .IPR file opens. Pages in Installation
Expert (example: Files page) are populated based on the contents of the source
installation.
If a file that is part of a merge module is added, the Files in Merge Modules dialog
appears. It prompts you to add the merge module and, if necessary, download it. See
Adding Merge Modules Instead of Files on page 120.
If a file that is used by a package in the Wise Software Repository is added, the Files in
Repository dialog appears and prompts you to add a version of the file that is in the
repository. See Adding Files From the Wise Software Repository on page 121.
(Enterprise Edition only.)
z A .WSE file created in version 5.0 and later of Wise Installation System.
z An .EXE file created by one of the applications above. Do this when you do not have
the original installation file. The compiled .EXE file contains an embedded copy of
the installation script.
z Because WiseScripts and SMS Installer scripts are based on a non-Windows Installer
technology, not all elements of the script are converted to Windows Installer format:
Only the installation of files, registry changes, and other system changes are
converted.
Custom dialogs, custom logic, and other settings are not converted.
z All the files available to the original SMS installation must be available to the
converted Windows Installer package at the same locations.
z Components are converted to features, and Execute Program script actions are
converted to Execute Program custom actions.
z Some script actions can cause problems with the conversion process.
Select File menu > New. On the New Installation File dialog, select Conversion
Tools from the Categories list and double-click the SMS Installer or WiseScript
Installation icon in the Templates/Tools list. (In Visual Studio: Select File
menu > New > File. On the New Files dialog, select Wise Files from the
Categories list and double-click Convert SMS Installer or WiseScript
Installation in the Templates list.) Use this method to create an installation
that contains only the information from the converted installation.
Select Tools menu > Convert SMS Installer or WiseScript Installation. (In Visual
Studio: Project menu > Convert SMS Installer or WiseScript Installation.) Use
this method to add the converted installation’s information to the current
installation file.
The Welcome dialog appears.
Installation Script
Specify a .WSE, .EXE, or .IPF file to convert.
You cannot convert .EXE files that were not generated by the Wise Installation
System or SMS.
Extract Directory
If you are converting an .EXE file, specify a temporary directory to hold the files
extracted from the installation.
When the conversion is finished, the Conversion Complete dialog appears. It shows
the results of the conversion and lists any errors or problems that might have
occurred. (Example: If files referenced by the original script could not be found, an
error is displayed.) You can fix these problems in Wise for Windows Installer.
5. To obtain a record of the conversion errors, click Save Errors or Print Errors.
6. Click Finish.
More errors might appear at this point, which have to do with saving in Windows
Installer format.
If a file that is part of a merge module is added, the Files in Merge Modules dialog
appears. It prompts you to add the merge module and, if necessary, download it.
See Adding Merge Modules Instead of Files on page 120.
If a file that is used by a package in the Wise Software Repository is added, the Files
in Repository dialog appears and prompts you to add a version of the file that is in
the repository. See Adding Files From the Wise Software Repository on page 121.
(Enterprise Edition only.)
Pages in Installation Expert (example: Files page) are populated based on the
contents of the source installation. If you converted an .IPF or .WSE, files are
referenced from their original locations. If you converted an .EXE, files are stored in
and referenced from the directory you specified in Extract Directory above.
z These types of files are supported: .VBP, .VBPROJ, .CSPROJ, .VJSPROJ, or .SLN.
z When you import a solution, any project types other than those listed above are
skipped. If your VB, C#, or J# projects depend on files that are in projects that are
skipped, the installation might not work.
z For Visual Basic projects, the Visual Basic Import tool only supports file types of the
Standard EXE project type.
z For Visual Basic .NET, C#, or J# projects, if a project file has dependencies on other
projects, you cannot import just the project file. You must import the entire solution
that contains the project and its dependencies.
z There is no link between a project or solution and the installation you create for the
project or solution. If your solution or project is updated with new files, you must
make those changes in the installation manually. Use the Visual Studio integrated
editor to link a development project directly to an installation project.
z These tools are not designed to set up a remote automation or a DCOM™ server
automatically.
z This tool only supports projects of file type .VBP. Only the Standard EXE project type
is supported.
z You can only use the Import Visual Basic 5/6 Project tool on a stand-alone
installation project. See Creating a Stand-alone Installation on page 72 for details.
You cannot use it in a multi-project solution.
Select File menu > New. On the New Installation File dialog, select Import Tools
from the Categories list, and in the Templates/Tools list, double-click the
type of project to import. Use this method to create an installation that contains
only the information from the imported installation.
Select Tools menu > Import Tools and select the type of project to import. Use
this method to add the imported installation’s information to the current
installation file.
The Project or Solution File dialog appears.
2. In the Project or Solution File field, specify the path to the project or solution file,
and click Next.
The dialog that appears depends on what kind of file you import.
If you import a Visual Basic .NET, C#, or J# file, the Select Configuration dialog
appears, which shows the configurations stored in the solution or project. These
correspond to build configurations in your Microsoft development environment.
If you import a Visual Basic 5 or 6 file, the Select Visual Basic Directory dialog
appears.
4. If the Select Visual Basic Directory dialog appears, specify the directory on your
computer where Visual Basic is installed. The Visual Basic installation directory
contains the support files that must be included as part of the installation because
they are needed by the Visual Basic program.
5. Click Next.
During the scan, you might see an error about the project being out of date or
missing. You can attempt a rebuild of the project from this tool, or open the
development environment yourself and rebuild the project. Another error, Project
<Project Name> contains a reference to the project with GUID..., means that you
selected a project that has a reference to another project. In this case, the import
ends. You must select the solution (.SLN) file that contains both projects.
Next, the Dependency Files Not Found dialog appears if necessary, which lists
missing dependency (.DEP) files for Win32 target files. Dependency files list
referenced files. This dialog usually does not apply to .NET projects, which use
assembly manifests instead of dependency files, unless the .NET project depends on
a COM .DLL that has a dependency. If the dependency files cannot be read, then the
files they refer to cannot be added to the installation you are creating.
6. If any files in the Dependency Files Not Found dialog are crucial to this installation,
cancel the import process, locate the files, move them to the System or System32
directory, and then restart the import process.
7. Click Next.
The Files Not Found dialog appears if necessary, which lists the target files that were
not found during the scan.
8. If necessary, select a file and click Browse to locate missing files. Files might be
missing if the configuration of the solution that you selected has not been built.
Missing files will cause compile errors in the installation that results from this import
process.
9. Click Next.
The Installation Files dialog appears, which lists the files that were detected. These
are the files that will be added to the installation.
10. To make changes to the files that will be added to the installation, add or remove
files by clicking Add or Delete, and then click Next.
The Application Installation Information dialog appears. The items on this dialog set
fields in the installation.
Name
Enter a name for the installation. This overwrites the Name field on the Product
Details page. If you don’t want to overwrite the current installation name, leave
this blank.
Installation Directory
Enter the default installation directory where files from this import should be
placed. This determines the folder on the Files page of Installation Expert in
which all added files are placed.
If you imported a Visual Basic .NET, C#, or J# project and you cleared the
Automatically add Assembly Dependencies without prompting checkbox, the
Assembly Dependencies dialog appears. It prompts you to select which
dependencies to add to the installation. See Adding Assembly Dependencies on
page 119.
If a file that is part of a merge module is added, the Files in Merge Modules dialog
appears. It prompts you to add the merge module and, if necessary, download it. See
Adding Merge Modules Instead of Files on page 120.
If a file that is used by a package in the Wise Software Repository is added, the Files in
Repository dialog appears and prompts you to add a version of the file that is in the
repository. See Adding Files From the Wise Software Repository on page 121.
(Enterprise Edition only.)
The project is integrated into a Windows Installer installation file, which contains all the
information it needs to install the project. Options are pre-filled on the Files and Product
Details pages. As with any installation, you should compile and test the installation
thoroughly to ensure it operates correctly.
Select File menu > New > File and double-click Import Visual Basic. Use this
method to create an installation that contains only the information from the
converted installation.
Select Project menu > Import Visual Basic. This is available only if you have
opened a file and not a project. Use this method to add the imported
installation’s information to the current installation file.
The Project File dialog appears.
2. In VB Project File, specify the path to the project file and click Next.
3. Specify the directory on your computer where Visual Basic is installed. The Visual
Basic installation directory contains the support files that must be included as part
of the installation because they are needed by the Visual Basic program.
4. Click Next.
During the scan, you might see an error about the project being out of date or
missing. You can attempt a rebuild of the project from this tool, or open the
development environment yourself and rebuild the project. Another error, Project
<Project Name> contains a reference to the project with GUID..., means that you
selected a project that has a reference to another project. In this case, the import
ends. You must select the solution (.SLN) file that contains both projects.
Next, the Dependency Files Not Found dialog appears if necessary, which lists
missing dependency (.DEP) files for Win32 target files. Dependency files list
referenced files. This dialog usually does not apply to .NET projects, which use
assembly manifests instead of dependency files, unless the .NET project depends on
a COM .DLL that has a dependency. If the dependency files cannot be read, then the
files they refer to cannot be added to the installation you are creating.
5. If any files in the Dependency Files Not Found dialog are crucial to this installation,
cancel the import process, locate the files, move them to the System or System32
directory, and then restart the import process.
6. Click Next.
The Files Not Found dialog appears if necessary, which lists the target files that were
not found during the scan.
7. If necessary, select a file and click Browse to locate missing files. Files might be
missing if the configuration of the solution that you selected has not been built.
Missing files will cause compile errors in the installation that results from this import
process.
8. Click Next.
The Installation Files dialog appears, which lists the files that were detected. These
are the files that will be added to the installation.
9. To make changes to the files that will be added to the installation, add or remove
files by clicking Add or Delete, and then click Next.
The Application Installation Information dialog appears. The items on this dialog set
fields in the installation.
Name
Enter a name for the installation. This overwrites the Name field on the Product
Details page. If you don’t want to overwrite the current installation name, leave
this blank.
Installation Directory
Enter the default installation directory where files from this import should be
placed. This determines the folder on the Files page of Installation Expert in
which all added files are placed.
If a file that is part of a merge module is added, the Files in Merge Modules dialog
appears. It prompts you to add the merge module and, if necessary, download it. See
Adding Merge Modules Instead of Files on page 120.
If a file that is used by a package in the Wise Software Repository is added, the Files in
Repository dialog appears and prompts you to add a version of the file that is in the
repository. See Adding Files From the Wise Software Repository on page 121.
(Enterprise Edition only.)
The project is integrated into a Windows Installer installation file, which contains all the
information it needs to install the project. Options are pre-filled on the Files and Product
Details pages. As with any installation, you should compile and test the installation
thoroughly to ensure it operates correctly.
If you have an installation .MSI, you can open and edit it in Wise for Windows Installer.
However, to take advantage of some Wise for Windows Installer features, you can
convert the .MSI to a project file.
See:
A .WSI file records the files and merge modules that should be compiled into the .MSI by
storing source paths. (You can see a source path in Wise for Windows Installer by
double-clicking a file on the Files or Web Files page.) When you open a .WSI and
compile, Wise for Windows Installer reads the source paths, and then compiles them
into the .MSI.
Running MSI to WSI Conversion involves redefining source paths, either by extracting
files and merge modules from the .MSI itself, or by redefining the source paths to point
to files and merge modules that already exist on your computer.
2. Open an .MSI.
3. In New Source Directory, specify the directory to which all files and merge
modules in the .MSI will be extracted. In the converted .WSI file, all source paths
will point to the files and merge modules located in this directory. You can override
this directory for individual files and merge modules later in this wizard.
If the .MSI contains any merge modules, the Merge Module Sources dialog appears;
otherwise, the File Sources dialog appears.
4. On the Merge Module Sources dialog, you can change the default for extracting
merge modules, which is to extract them from the .MSI into the default source
directory you specified on the Welcome dialog. To accept the default, click Next. To
change the default, see Specifying Merge Module Source Directories on page 366.
5. On the File Sources dialog, you can change the default for extracting files, which is
to extract them from the .MSI into the default source directory you specified on the
Welcome dialog. To accept the default, click Next. To change the default, see
Specifying File Source Directories on page 367.
6. In New .WSI File, specify the path of the new .WSI to create. Do not select a
directory that already contains an .MSI of the same name, because when you
compile this .WSI file, it overwrites any .MSI of the same name that resides in the
same directory.
7. Click Finish.
If any source files or associated .CAB files are not in the location specified in the
.MSI, they are listed on the Files Not Found dialog and source paths are not created
for those files. You must find them and add them to the new .WSI.
The new .WSI is created at the location you specified, the current .MSI is closed,
and the new .WSI is opened. (In Visual Studio: the new .WSI is added to the current
solution as a new project.) Compile and test this installation thoroughly before
deploying.
You can override the default source directory in the following ways:
z Reset to Default
After changing the source path through any of the above methods, you can reset a
merge module to its default, which is to extract to the default source directory.
3. Select a directory and click OK. The merge modules you selected will be extracted to
this directory instead of the default source directory.
If multiple merge modules are selected, the Select Directory dialog appears. If one
merge module is selected, the Choose Replacement Merge Module dialog appears.
On the Select Directory dialog, select the directory that contains replacement
merge modules for all the merge modules you have selected and click OK.
Merge modules are matched by GUID, a unique identifier attached to Windows
Installer files, rather than by name. If the search is unsuccessful, a dialog lists
the merge modules that were not found.
On the Choose Replacement Merge Module dialog, specify the merge module to
replace the selected merge module. You must specify a merge module whose
GUID matches the GUID of the original merge module; otherwise an error
occurs.
The Source column on the Merge Module Sources dialog changes to Local to indicate
that a local merge module will be used instead of the merge module in the .MSI.
You can override the default source directory in the following ways:
z Reset to Default
After changing the source path through any of the above methods, you can reset a
file to its default, which is to extract to the default source directory.
3. Select a directory and click OK. The selected files will be extracted to this directory
instead of the default source directory.
3. Specify a file to replace the selected file. The Source column on the File Sources
dialog changes to Local to indicate that a local file will be used instead of the file in
the .MSI.
Note
For the following 2 options, the Destination Path column is appended to whatever
directory you select. Example: Suppose you are repackaging Application.msi, and
you have it installed in C:\Program Files\Application, you would select the C:\ drive,
then select Selected Directory Contains Destination Directory Structure and
click OK. If you selected the Application directory itself, it would result in searching
C:\Program Files\Application\Program Files\Application because the Destination
Path column on the File Sources dialog is appended to the end of the directory you
select.
installed, or you might just have a directory that contains the same directory
structure as that of the installed application.
Using this option, the Duplicate Files Details dialog might appear if the
installation you are converting contains instances of duplicate files. An
installation can contain multiple copies of a file and the copies can be set to
install to the same directory. Example: Suppose the installation Application.msi
contains both a Windows NT version and a Windows 98 version of the file
pshop.dll. Only one file gets installed, depending on the operating system the
installation runs on. In an installation with duplicate files, MSI to WSI
Conversion cannot change the paths to point to your local computer, because
your local computer only contains one copy of the file. For these files, either
leave them set to the default, which will extract all copies of the file from the
.MSI, or individually replace them with the appropriate files from your
computer.
Files are matched by name. The first found instance is used. The Source column on
the File Sources dialog changes to Local to indicate that local files will be used
instead of files from the .MSI. If the search is unsuccessful, a dialog lists the files.
Package Validation
Package Validation checks a Windows Installer package for errors based on rules in one
or more validation modules. It validates package files (.MSI and .WSI), merge modules
(.MSM and .WSM), and transforms (.MST). For details, see Validating a Package.
z If you correct validation errors in an .MSI or .MSM, errors are not corrected in any
corresponding .WSI or .WSM.
z When you specify a transform, Package Validation checks both the transform and
the original .MSI.
z You can select which validation rules to use during the validation test.
z You can create new validation modules and new validation rules. (Enterprise Edition
only.)
Note
Package Validation ignores issues pertaining to the group box “enabled” attribute, which
Microsoft’s validation module falsely reports as an error.
Validating a Package
Use Package Validation to verify an installation package using predefined or customized
validation modules.
1. Open the installation file (.MSI or .WSI), merge module (.MSM or .WSM), or
transform (.MST) to test.
2. Select Tools menu > Package Validation. (In Visual Studio: Project menu > Package
Validation.)
3. To view the description of a validation module, select the module in the list.
Note
The tests in Application Specification Logo are a subset of the tests in Internal
Consistency, therefore, running both tests at the same time might result in duplicate
errors.
5. If this installation contains multiple releases, the Release drop-down list appears
below the list of validation modules. Select the release to test.
When the validation is complete, the View / Correct dialog appears. It lists validation
issues that represent areas where the package might not comply with the
specifications in the validation modules you selected. The icon to the left of each
issue indicates the issue type.
If the issue was found by a Microsoft validation module, see ICE Reference in the
Windows Installer SDK Help for details.
9. If the Correct button is enabled when you select an issue, click it to correct the
issue.
Caution
If you correct a .WSI or .WSM, it is recompiled to an .MSI or .MSM at the end of
validation. If you correct an .MSI or .MSM, errors are not corrected in any
corresponding .WSI or .WSM.
10. If the Correct button is not enabled when you select an issue, the issue cannot be
corrected within Package Validation. Make any necessary changes to the installation
package in Wise for Windows Installer.
Note
The Correct button is not enabled when an issue is found by a custom action rule.
Depending on how the custom action is written, the problem might be fixed
automatically when it’s found, or you might need to fix the problem manually.
11. To add issues to the Task List and fix them manually, mark Add to Task List.
When you click Finish, the issues appear in the Task List. See Using the Task List on
page 26.
12. To obtain a record of the issues, click Save to File or Print All.
In the Professional and Enterprise Editions, you can customize validation modules by
selecting which validation rules to use during the validation test. See Selecting
Validation Rules to Use on page 373.
In the Enterprise Edition, you also can create new validation modules and new validation
rules. Do this if you prefer not to modify a predefined validation module, or to define a
validation module that contains only your custom rules.
See:
1. Start Package Validation as described in Validating a Package on page 370 and click
Customize on the Welcome dialog.
The Customized Validation Rules dialog appears. Validation Files lists the
predefined validation modules and any validation modules you’ve added. When you
select a validation module, its rules appear in Validation Rules.
3. Enter a unique name and description to identify the validation module in the
Welcome dialog of Package Validation.
If this is a new file and you do not specify its location, it is created in the Validation
subdirectory of your share point directory.
5. If the .CUB file you specify is intended to validate merge modules only, mark Only
display this file for Merge Modules.
6. Click OK.
On the Customized Validation Rules dialog, the validation module you specified
appears in Validation Files.
7. To add a rule to the validation module, click Add to the right of the Validation
Rules list. To add a rule that:
Calls a custom action, see Adding a Rule That Calls a Custom Action on
page 374.
Consists of a series of conditions and actions, see Adding a Validation Rule Set
on page 376.
8. To enable or disable the rules to use during validation, see Selecting Validation Rules
to Use on page 373.
9. To delete a validation module or rule, select it and click the Delete button to its
right.
Deleting a validation module from Package Validation does not delete the .CUB file
from the computer.
Also see:
Example:
Note
When customizing a predefined validation module, customize a copy of the .CUB file to
retain the original file.
1. Start Package Validation as described in Validating a Package on page 370 and click
Customize on the Welcome dialog.
The Customized Validation Rules dialog appears. Validation Files lists the
predefined validation modules and any validation modules you’ve added. When you
select a validation module, its rules appear in Validation Rules.
If the validation module is not listed, see Adding a Validation Module to Package
Validation on page 372.
4. (Enterprise Edition only.) To add a rule to the validation module, click Add to the
right of the Validation Rules list. To add a rule that:
Calls a custom action, see Adding a Rule That Calls a Custom Action on
page 374.
Consists of a series of conditions and actions, see Adding a Validation Rule Set
on page 376.
Also see:
Note
You cannot add rules to predefined validation modules.
Example: Suppose you want to check packages for hard-coded references to C:\ or D:\
and replace those references with the directory property INSTALLDIR. To do this, write a
VBScript to find and replace the references and then display a message. In Package
Validation, you specify a new or existing .CUB file and add a rule that calls the VBScript.
When you run Package Validation with the new rule enabled, the VBScript performs the
find and replace operations.
When a validation test finds an error based on a custom action rule, the Correct button
on the View / Correct dialog is not enabled; the error is fixed based on functions in the
custom action. Errors found by a custom action rule are displayed on the View / Correct
dialog only if the custom action contains a message string. For information on
formatting message strings, see ICE Message Guidelines in the Windows Installer SDK
Help.
For information on creating a custom action to perform validation checks, see Internal
Consistency Evaluators - ICEs and Building An ICE in the Windows Installer SDK Help.
Also see:
2. Start Package Validation as described in Validating a Package on page 370 and click
Customize on the Welcome dialog.
The Customized Validation Rules dialog appears. Validation Files lists the
predefined validation modules and any validation modules you’ve added. When you
select a validation module, its rules appear in Validation Rules.
Note
You cannot add rules to predefined validation modules.
If the validation module is not listed, see Adding a Validation Module to Package
Validation on page 372.
4. Click Add to the right of the Validation Rules list and select DLL Rule, EXE Rule, or
VBScript Rule.
5. Enter a unique name and description to identify this rule when it appears in the
Validation Rules list.
6. If the custom action file is in the File drop-down list, select it.
The files listed are those contained in the validation module you are editing.
7. If the custom action file is not in the File drop-down list, do one of the following:
For .DLL and .EXE files, click New and specify the .DLL or .EXE file.
For a VBScript file, click Options, select New, and specify the VBScript file. To
edit the VBScript, click Options, select Edit, and modify the VBScript in the
Macro Editor.
8. (.DLL and VBScript only.) If the Function field appears, enter the name of the
function in the .DLL or VBScript that performs the validation.
9. (.EXE only.) If the Parameters field appears, enter any command line options that
are needed to run the .EXE.
10. Click OK
The Customized Validation Rules dialog reappears, and the new rule is displayed at
the end of the Validation Rules list with its checkbox marked.
11. To add more rules to this validation module, either repeat this procedure or see
Adding a Validation Rule Set on page 376.
Also see:
Note
You cannot add rules to predefined validation modules.
Example:
Suppose you want to determine if your packages contain any version of report.dll earlier
than 2.0.0 and if so, replace it with version 2.0.0 of report.dll. The rule set you create
for this check would contain the following conditions and actions:
The underlined values in the conditions and actions might be truncated on the screen.
When you include the action to display text, errors found by a custom rule set are
displayed on the View / Correct dialog. The error text is displayed with the question
mark icon ( ) and the Correct button is enabled. Click Correct to perform the actions in
the rule set.
Also see:
1. Start Package Validation as described in Validating a Package on page 370 and click
Customize on the Welcome dialog.
The Customized Validation Rules dialog appears. Validation Files lists the
predefined validation modules and any validation modules you’ve added. When you
select a validation module, its rules appear in Validation Rules.
Note
You cannot add rules to predefined validation modules.
If the validation module is not listed, see Adding a Validation Module to Package
Validation on page 372.
3. Click Add to the right of the Validation Rules list and select Rule Set.
4. Enter a unique rule set name and description to identify this rule set in the
Validation Rules list.
5. Click Add.
The Validation Rules wizard starts and the Name dialog appears.
Rule name
Enter a unique name for this rule.
Type
Select whether an issue that breaks this rule will be displayed as an error or
warning on the View / Correct dialog.
7. In Which condition(s) do you want to check, mark conditions in the order they
should be checked.
8. If a condition contains underlined text, click the underlined text to open the Rule
Details dialog and specify its value.
you would click the word any and enter a specific file name.
10. In Which action(s) do you want to perform, mark the action or actions to
perform if the conditions for this rule are met. Mark them in the order they should
be performed. Actions that are incompatible with the conditions you selected are
disabled.
Note
To display a message in Package Validation’s View / Correct dialog, include the
action Display text [text] in View/Correct dialog. Replace [text] with your message.
11. If an action contains underlined text, click the underlined text to open the Rule
Details dialog and specify its value.
you would click the word none and enter specific text.
The Validation Rules dialog reappears. The rule list displays the rule, and the Rule
description list displays its conditions and actions.
13. To add additional rules, click Add to restart the Validation Rules wizard.
To edit a rule, select it in the rules list and click Details. This restarts the
Validation Rules wizard, in which you can change the rule name or any
conditions or actions.
To rearrange the order of the rules, select a rule in the rules list and click Move
Up or Move Down.
To change the value in a condition or action, click its underlined text in the Rule
description list and enter new text on the Rule Details dialog.
15. When you finish adding and editing rules, click OK on the Validation Rules dialog.
The Customized Validation Rules dialog reappears, and the new rule set is displayed
at the end of the Validation Rules list with its checkbox marked.
16. To add more rules to this validation module, either repeat this procedure or see
Adding a Rule That Calls a Custom Action on page 374.
Also see:
z Component design
Checks that the proper files have been placed into each component and that the
same file has not been placed into multiple components.
z Uninstall support
Checks that the package does not reference non-Windows Installer uninstall
utilities.
Also see:
z Adding, removing, or replacing merge modules that are part of .MSI or .WSI
packages in the Software Manager database.
Because Wise Task Manager manages these operations, the user who runs them can
proceed with other tasks in Wise Package Studio while these operations are processed.
When a user runs one of the managed operations listed above, Wise Task Manager
queues them and executes them in the order in which they are received. An operation is
performed after any other operations that are in the queue for that computer.
z Cancel the tasks of managed operations. You can cancel only the tasks of operations
that you run.
Its status.
z A Warning status means the task completed, but an error message was written to
the task’s log file.
Details on the progress of the task appear at the bottom of the Wise Task
Manager dialog unless you select another task.
3. To change the tasks that appear, click Options on the Wise Task Manager dialog. By
default, Wise Task Manager displays only the tasks belonging to operations you run
that do not have a status of Completed.
b. Click OK.
You can cancel only tasks belonging to operations you ran that have a status of
Waiting or Executing. If you cancel one task in an operation, then all the tasks of the
operation are canceled.
Setup Editor is a powerful view of the installation, and using its advanced features
requires proficiency in the Windows Installer development environment or in software
development in general. While Installation Expert lets you create basic Windows
Installer installations and provides an easy-to-use, task-oriented user interface to set
the most common installation tasks, Setup Editor lets you create fully customized,
interactive installations.
Topics include:
z Product Tab.
z Features Tab.
z Components Tab.
z Tables Tab.
Setup Editor also contains the Dialogs Tab, which is discussed in Using the Dialogs Tab
on page 433, and the Module Tab, which is discussed in Available Tabs and Pages in
Merge Modules on page 330.
Note
This documentation does not discuss Windows Installer tables, functions, or properties.
Before you edit raw table data, read the Windows Installer SDK help for that table. On
the Tables tab, click a table and press F1.
The lower right pane contains context-sensitive help. To hide the help, select
View menu and clear Help Pane. (Not available in the Visual Studio integrated
editor.)
Note
Check the right-click menu frequently when you are working in Setup Editor. It provides
access to most of the tasks that you can accomplish in Setup Editor.
z Features
Add, edit, and delete features. Assign components to features; add and remove
components to and from features; and arrange the features of the installation. See
Features Tab on page 385.
z Dialogs
Select and customize dialogs the installation uses. See Using the Dialogs Tab on
page 433.
z Tables
Edit tables in the .MSI database. You can access most of the data in these tables
through Installation Expert pages or other tabs of Setup Editor. Deleting, adding, or
editing table data directly is not recommended unless you are an experienced
Windows Installer developer with a clear understanding of Windows Installer
database technology. See Tables Tab on page 397.
z Components
Add, edit, and delete individual components of the installation. Each component is
one action the installation performs. Example: installing a file, changing the registry,
and so on. See Components Tab on page 390.
z Module
This tab appears only when you are in a merge module file. Add, edit, and delete the
components, files, registry entries, and other installation modifications contained in
the merge module. See Available Tabs and Pages in Merge Modules on page 330.
Product Tab
On the Product tab in Setup Editor, you set and edit the following information for an
installation:
Summary
Use the Summary icon to set the value of a summary item. End users can see the
summary information by right-clicking the compiled .MSI or .EXE in Windows Explorer
and selecting Properties.
Properties
Use the Properties icon to add, edit, and delete properties in an installation. Properties
are variables that are initialized by the installation and are used by Windows Installer.
The property values can change during runtime. Some of the properties that appear are
required Windows Installer properties, so use caution in editing or deleting them.
See:
Launch Conditions
Use the Launch Conditions icon to create new launch conditions and edit existing launch
conditions. Launch conditions are system requirements that must be met on the
destination computer for the installation to proceed. See Setting a Requirement by
Creating a Launch Condition on page 168.
For information on summary items, see Summary Property Descriptions in the Windows
Installer SDK Help.
You can use the Release Settings page to override the value of an existing summary
item or edit customized summary items. See Customizing Summary Items for a Release
on page 182.
To view all available summary items, click the Summary icon in the left pane on the
Product tab. A list of summary items appears in the upper right pane, and you can edit
an item by changing its value. You cannot create or delete summary items, because they
are defined by Windows Installer.
The following summary items are named differently in the Windows Installer SDK Help:
2. In the upper right pane, double-click a summary item. The Summary Details dialog
appears.
In a transform, some summary items are not editable because they keep the value
of the base .MSI.
4. Click OK.
You also can edit several of the summary items in Installation Expert > General
Information page. See General Information Page on page 98.
Features Tab
The Features tab lets you manipulate an installation’s features and all corresponding
items. It displays a tree structure that lists all components, merge modules, files,
registry entries, and other installation items associated with each feature.
For information on what features are and how they are used, see Working With
Components and Features on page 523.
Features you add in Installation Expert are displayed on this tab. However, the features’
conditions are not displayed in Setup Editor.
By default, the Features tab displays only items that are in the installation. Example: If
the installation contains a file, a Files icon appears. If you have not added any items to
the installation, only the Features and Complete icons appear. (Complete is the default
feature that is included in new installations.)
z To display a feature’s contents, click the feature in the left pane. The contents
appear in the upper right pane.
z To display all items in a feature, click the feature’s Combined icon. All items appear
in the upper right pane.
z To display all items in a feature grouped by type, expand the feature’s Combined
icon and click the type icon.
z To customize how items appear in the features tree, right-click in the left pane and
select Customize View. In the Customize View dialog that appears, mark the
checkboxes of the items to display, and rearrange items by clicking Move Up or
Move Down.
z Right-click the feature name. Select New and the item to add.
z Expand the feature and expand the Combined folder. If necessary, show empty
folders. Right-click the icon for a particular item and select New.
If an icon does not appear, right-click and use the Customize View dialog to show
the icon.
z Duplicate file entry. See Creating Duplicate File Entries on page 389
z File association. See Advertising Icon on page 388 and Adding File Associations on
page 156.
z INI file. See Creating and Editing .INI Files on page 151.
z ODBC source, driver, or translator. See Adding an ODBC Item on page 162.
z Service control. See Controlling Services on the Destination Computer on page 161.
z Remove Registry operation. See Removing Registry Entries From the Destination
Computer on page 145.
z Remove Files operation. See Removing a File From the Destination Computer on
page 127.
z Move Files operation. See Copying and Moving Files on the Destination Computer on
page 128.
z Copy Files operation. See Copying and Moving Files on the Destination Computer on
page 128.
You also can view merge modules included in specific features. See Modules Icon on
page 388.
z Add new components and edit the details of existing ones. See Adding and Editing a
Component on page 392.
The Components icon on the Features tab shows items in each component. To access
installation items organized by component, use the Components tab. See Components
Tab on page 390.
The Assign Components to Feature dialog appears. The dialog lists all components in
the installation, except those already assigned to the currently selected feature.
3. Click OK.
You can add the same component to more than one feature; the component is in the
installation only once. Example: If your application includes a grammar check feature
and a spell check feature that both depend on the same file, you might want to assign
that file’s component to both features. That way the file is available even if only one of
the features is installed on the destination computer.
To unassign a component:
1. In Setup Editor > Features tab, expand the folder for the feature that contains the
component to unassign.
2. Click the Components icon. All components for the feature appear in the upper right
pane.
Components that are not assigned to any feature are not installed on the destination
computer.
2. Click the Components icon. All components for the feature appear in the upper right
pane.
3. In the upper right pane, click a component and drag it to a different feature in the
left pane.
Modules Icon
The Modules icon displays merge modules included in specific features. However, you
cannot add merge modules here. To add or edit merge modules in an installation, use
Installation Expert > Merge Modules page. See Adding a Merge Module to an Installation
on page 345 and Editing Merge Module Details on page 347.
The merge modules in the selected feature appear in the upper right pane.
If the Advertising icon does not appear, right-click and select Hide Empty Folders/
Items.
Also see:
Advertising Icon
The Advertising icon contains information that Windows Installer uses when publishing
and assigning applications to the destination computer. The Advertising icon:
z Shows the entry points that are installed if you are using advertising to make
applications available to end users.
z Lets you edit and create new file associations. See Adding File Associations on
page 156.
Note
The Advertising icon might contain other advertising items besides file extensions
but you can add extensions only.
If the Advertising icon does not appear, right-click and select Hide Empty Folders/
Items.
The AppID or ProgID dialog appears, which displays information from the AppID or
ProgID table.
3. You can edit the entries in the Value column. See AppID Table or ProgID Table in the
Windows Installer SDK Help.
Caution
Editing table data directly is not recommended unless you are an experienced Windows
Installer developer with a clear understanding of Windows Installer database technology.
You can also create directories on the Files, Web Files, or Visual Studio Solution pages in
Installation Expert, where you can also use wildcards to add files to directories
automatically. See Editing Settings for Automatic Updating on page 125.
To add permissions to the directory you create, see Setting Permissions for Files and
Directories on page 132.
3. At the end of the existing path, type \ followed by the name of the new directory.
Example: To create a folder named Sample in the Program Files directory, the
Directory field should contain Program Files\Sample.
4. Click OK.
Also see:
You can create a duplicate file entry only for files that are already in the installation.
Note
Duplicate files are not created for .NET assemblies added to both the application
directory and the Global Assembly Cache. Instead, they are treated as separate
components.
Existing File
Specify the pathname for the file to be duplicated.
Dest. Directory
Specify the directory on the destination computer in which the duplicate file
should be installed. To add a subdirectory to the directory you selected, click
New Folder and enter a folder name.
4. Click OK.
If you added the duplicate file to a different feature and a different directory than the
original file, then a new component is created for the duplicate file.
You cannot have 2 components install the same file to the same destination directory. If
the file is already set to be installed to the same directory by a component assigned to
another feature, you are prompted to create a component assignment to the current
feature. If you do this, then any future changes to the component will affect all features
to which it is assigned.
To edit a duplicate file entry, double-click its name. To delete it, right-click its name and
select Delete.
Components Tab
The Components tab lets you manipulate an installation’s components. It displays a tree
structure that lists all files, registry entries, and other installation items contained in
each component. It also indicates any component errors.
Installation Expert automatically creates the appropriate components for each item you
add and organizes them according to a component rule set you select. Example: You can
always create a new component for each new file added to the installation, or you can
group related resources, such as help files, into one component. See Component Rules
on page 57.
By default, the Components tab displays only items that are in the installation. Example:
If the installation contains a file, a Files icon appears. If you have not added any items to
the installation, only the Components icon appears.
z To display a component’s contents, click the component in the left pane. The
contents appear in the upper right pane. You also can expand the component so
that its contents appear in the components tree.
z To customize the icons that appear in the components tree, right-click in the left
pane and select Customize View. In the Customize View dialog that appears, mark
the checkboxes of the items to display, and rearrange items by clicking Move Up or
Move Down.
Drag an item from the upper right pane to a different component on the left
pane.
In the left pane, drag an entire component item group from one component to
another.
z Right-click the component name. Select New and the item to add.
z Expand the component. If necessary, show empty folders. Right-click the icon for a
particular item and select New.
If an icon does not appear, right-click and use the Customize View dialog to show
the icon.
z Duplicate file entry. See Creating Duplicate File Entries on page 389
z File association. See Advertising Icon on page 388 and Adding File Associations on
page 156.
z INI file. See Creating and Editing .INI Files on page 151.
z ODBC source, driver, or translator. See Adding an ODBC Item on page 162.
z Service control. See Controlling Services on the Destination Computer on page 161.
z Remove Registry operation. See Removing Registry Entries From the Destination
Computer on page 145.
z Remove Files operation. See Removing a File From the Destination Computer on
page 127.
z Move Files operation. See Copying and Moving Files on the Destination Computer on
page 128.
z Copy Files operation. See Copying and Moving Files on the Destination Computer on
page 128.
Also see:
Component Errors
As you work on the Components tab, Setup Editor continually monitors components for
common errors. When it detects an error, it changes the color of the component’s icon to
red.
z The component has more than one executable (.EXE, .DLL, .OCX).
z A shortcut is assigned to the component, but the key path for the shortcut is not a
file.
z Registry keys are created in HKEY_CURRENT_USER, but the key path is not for a
registry key in HKEY_CURRENT_USER.
Installation Expert automatically creates the appropriate components for each item you
add to an installation. However, you can add and edit components yourself in Setup
Editor > Components tab.
z To edit multiple components, first select the Components icon in the upper left pane.
In the upper-right pane, select components, right-click, and select Details. On the
Multi-Component Details dialog, you can edit a subset of the fields found in the
Component Details dialog.
Component
Enter a name for the new component. Components generated by Installation
Expert have automatically generated names that usually reflect the first file
added to a particular directory.
Directory
Enter the directory on the destination computer where the files in this
component will be installed. To create a new folder, click New.
GUID
(Optional.) To replace the automatically-generated GUID (globally unique
identifier) for this component with a new one, click Generate.
Condition
Enter the condition required to install this component. To always have the
component installed, leave this blank. To enter a condition that must evaluate to
true before the component can be installed, click Build. The Condition Builder
appears. See Creating Conditions With Condition Builder on page 411.
For some conditions, you might need to add a special merge module that
addresses a limitation of Windows Installer. See Using Conditions With Features
on page 108.
Run Location
Select the location from which the component should run:
Run Locally
The component is installed and runs from the destination computer’s hard
drive. This setting overrides the corresponding feature’s attribute.
Key Path
Select the item Windows Installer should use as a key path. The drop-down list
shows files, registry entries, or ODBC data sources that are included in the
component, depending on your selection in the Key Path Type field. See About
the Key Path on page 396.
64-bit component
(64-bit installations only.) Mark this to designate the component as a 64-bit
component. The target directory and the component must both be either 32-bit
or 64-bit. If one is 32-bit and the other is 64-bit, a warning message appears,
giving you the option to change the target directory to match the component.
Example: If this checkbox is marked and the Directory is Program Files (x86),
you are prompted to change this target directory to its 64-bit counterpart,
Program Files.
If you clear this checkbox, then the file is not self-registered; instead,
registration information is scanned from its type library and added to the
installation. Registering the file enables its advertising information to be drawn
into the installation—if the file is not registered, then this advertising
information might not be present on the current computer, which means it
cannot be automatically added. See How Self-Registration Information is
Captured on page 139.
Example: If the programmer who creates the key file for this component is not
the author of the installation, the programmer can place all required information
into a .REG file and give this file to the installation author for inclusion into the
component. You can use WiseComCapture.exe to create this .REG file. See
Using WiseComCapture.exe on page 140.
If the installation has only one feature, the component is added to that feature. If
the installation has more than one feature, the Select Feature(s) to Assign
Component to dialog appears.
4. Mark one or more checkboxes for the features to assign the new component to and
click OK.
On the Components tab, you can move items from one component to another. The
procedure below works for all types of items, and also warns you when a key path must
be changed. For files and registry entries, you can drag between components, but you
are not warned if a key path is changed.
1. In Setup Editor > Components tab, navigate to an item so that it appears in the
upper right pane.
2. In the upper right pane, select one or more items, right-click, and select Move.
Note
If an item you select is the component’s key path, a message informs you that the
item will become the destination component’s key path, even if that component
already has a key path. To reset the destination component’s key path, click Yes. To
cancel the move, click No. You can reset key paths manually by right-clicking an
item and selecting Set as Key.
4. Click OK.
If the component icon is colored red after you move an item to it, the change you made
causes an error. Right-click the component and select Show Errors to see a description
of the problem.
Setup Editor indicates key paths by placing a yellow key icon over the item’s icon.
OR
z Select the item as key path on the Component Details dialog. See Adding and
Editing a Component on page 392.
Only Windows 98 Second Edition (SE), Me, 2000, XP, and Server 2003 support isolated
components. Therefore, you should add the .DLL to the System32 directory, as you
normally would. Then, create an isolated component that moves the .DLL to your
application’s directory if the destination computer runs one of the above operating
systems.
Note
Before you isolate a .DLL with an executable, make sure that you’ve added all files to
the installation, especially .EXE and .DLL files.
The Isolated Component Details dialog appears, where you select a file for isolation
from the feature that contains the component.
If the key path for the current component is not an .EXE, the drop-down list
shows all .EXEs in the containing feature that are key paths of .DLL files.
If the key path for the current component is an .EXE, the drop-down list shows
all files from the containing feature that are key paths other than the current
component.
3. Click OK.
The isolated component entry appears in the upper right pane. To edit it, double-click its
name. To delete it, right-click its name and select Delete.
1. In Setup Editor > Components tab, right-click a component and select New >
Published Component.
Publish GUID
(Optional.) To replace the automatically-generated GUID (globally unique
identifier) for this component with a new one, click Generate.
Feature
Select the feature to have published.
Component
Select the component to have published.
Qualifier
Enter a text string to distinguish multiple forms of the same component.
Application Data
Enter a text string that describes the qualified component, that is, the
combination of component and qualifier. This string can be displayed to the end
user.
4. Click OK.
The published component entry appears in the upper right pane. To edit it, double-click
its name. To delete it, right-click its name and select Delete.
Tables Tab
The Tables tab lists every table in the Windows Installer database. Most of this data is
accessible in Installation Expert or in the other tabs of Setup Editor. The Tables tab lets
you edit existing table data, add new data, add new tables, and delete tables.
In addition to standard Windows Installer tables, the Tables tab also lists Wise tables,
which are described in About Wise Tables on page 403.
z To add a table to store data that is non-Windows Installer standard. Example: If you
create a custom action that stores data, you must create a new table in which to
store it. Or you might write a .DLL that reads the new table and performs certain
actions.
z To edit the data created in Installation Expert or on the other tabs of Setup Editor.
Caution
Deleting, adding, or editing table data directly is not recommended unless you are an
experienced Windows Installer developer with a clear understanding of Windows
Installer database technology. Editing table data might cause unexpected, undesirable
behavior, including damage to the installation. We cannot provide technical support for
problems arising from table editing.
Column
information
List of tables in
the Windows
Installer
database. Table contents.
By default, the left pane of the Tables tab lists all the tables in the Windows Installer
database, even those that don’t contain data.
z To hide empty tables, right-click in the left pane and select Show Empty Tables. To
redisplay the empty tables, right-click and select Show Empty Tables again.
z To display a table’s contents, click its name in the left pane. The table’s contents
appear in the upper right pane, arranged in columns by field. The column width and
sort order are retained when you leave the Tables tab.
The top heading row of the table displays field names. Key fields are indicated by a
key symbol. By convention, database columns that are external keys take the name
of the primary key column with an added underscore character. Example: An
external key to the File column of the File table is always named File_.
z An optional, second heading row shows the field’s data type, string length if
applicable, and whether the field can be null. To display or hide the second heading
row, right-click the table and select Column Info.
z Initially, tables are not sorted. To sort a table, click the heading for the column to
sort.
z You can select rows in tables, then copy and paste them into any program that
supports SYLK format, such as Excel. You also can paste the rows into a text editor,
where they appear as comma-delimited text.
See:
1. In Setup Editor > Tables tab, right-click and select Create Table.
Field Name
Enter the name of the field.
Data Type
Specify whether this field is a long integer, short integer, or string.
String Length
If this field is a string, enter the length of the string in this field. The default is
255 characters; a length of 0 indicates no length limit.
Nullable
Mark this to indicate that this field can be null.
Primary Key
Mark this to indicate that this field is a primary key in this table. A table can
have more than one primary field.
Localizable
Mark this to indicate that this field should be translatable. If you distribute this
installation in another language, the data in this field will be translated.
Value Set
Enter a list of acceptable values for this field, separated by semicolons.
Key Table
Select the table to which this column is linked. Example: The SelfReg table has
a column File_ that is linked to the File table.
Key Column
Select the column in the linked table. Example: The SelfReg table File_ column
is linked to the File column in the File table.
Category
Select the type of information stored in this column.
Description
Enter a short text description of the information stored in this column.
Also see:
2. In the upper right pane, right-click the row above which the new row should appear
and select New Row.
4. Click in each field to select it for entry. (If you click away from the row, you might
have to triple-click to access a field.)
Caution
Deleting, adding, or editing table data directly is not recommended unless you are an
experienced Windows Installer developer with a clear understanding of Windows
Installer database technology. Editing table data might cause unexpected, undesirable
behavior, including damage to the installation. We cannot provide technical support for
problems arising from table editing.
If a field is already active, press Tab to move from left to right or Shift+Tab to
move from right to left within the table.
Some table columns have drop-down lists that you can use for editing. Example: The
drop-down list for the Feature_Parent column in the Feature table lets you select a new
parent for the current feature. Drop-down lists for columns that contain formatted data
type show the properties from the Property table. You can either select from the list or
enter a new property.
To delete a table:
1. In Setup Editor > Tables tab, in the left pane, right-click a table and select Delete
Table.
If you later add an item that requires the deleted table, Wise for Windows Installer
automatically recreates the table.
Example: The product name changes and you need to find and replace it everywhere it
occurs.
Also see:
A validation error occurs when the data in a field does not comply with the requirements
assigned to the field. Examples: null fields in columns that are not nullable, foreign key
mismatches, and strings that are too long for the field.
Alternatively, when a project is complete and all changes are saved, you can run the
Package Validation tool to check the entire package against a set of rules, such as the
Windows Installer SDK Internal Consistency rules.
The installation is searched for tables that contain errors. Any table that contains an
error is shown in red in the left pane and the error becomes a task in the Task List.
You can use the Task List to review the errors (see Using the Task List on page 26) or
you can click a red table name and use the Find Error menu item to find the row that
contains the error. See the following procedure.
2. In the Direction section, mark either Up or Down to specify the search direction.
If the database contains one or more validation errors, the first one is highlighted in
red in the upper right pane.
When validation is complete, the View / Correct dialog appears. It lists validation
issues that represent areas where the package might not comply with the
specifications in the validation modules you selected. The icon to the left of each
issue indicates the issue type. When you close Package Validation, validation errors
that were not corrected are added to the Task List.
Also see:
The Binary table also contains binary data. To edit binary data in the Binary table, use
the Resources page. See Managing Binary Resources on page 109.
Caution
Deleting, adding, or editing table data directly is not recommended unless you are an
experienced Windows Installer developer with a clear understanding of Windows
Installer database technology. Editing table data might cause unexpected, undesirable
behavior, including damage to the installation. We cannot provide technical support for
problems arising from table editing.
The table’s data appears in the upper right pane. You can change the data in the
Name fields as you would in any other table.
2. In the Data column, click a binary field (displayed as {binary data}) and press F2 or
Enter.
If you are reading from an external file, specify the full pathname of a file to
read.
If you are writing to a file, enter the full pathname of the file. By default, this
file is exported to the directory where the Windows Installer database file is
stored. To export to a different directory, specify a full path, such as
C:\TEMP\FILENAME.
5. Click OK.
Caution
Deleting, adding, or editing table data directly is not recommended unless you are an
experienced Windows Installer developer with a clear understanding of Windows
Installer database technology. Editing table data might cause unexpected, undesirable
behavior, including damage to the installation. We cannot provide technical support for
problems arising from table editing.
z WiseLangString. Contains all strings for all languages currently defined in the
installation.
z WiseLanguage. Contains a list of all languages defined for the installation, along
with the corresponding releases.
z WiseMetaDataCache. Contains user-defined meta data after values for the meta
data are entered on the Product Details page.
z WiseSequence. Contains the remarks used in MSI Script as well as any empty If/
End If blocks.
z WiseSourcePath. Contains a list of all source paths for all files that are in the
installation.
z WiseStreamFiles. Contains a list of all source path names for custom actions and
graphics that are in the installation.
z WiseVDAttributes. Stores the Web Dialogs settings for the virtual directories on
the Web Files page.
z WiseVirtualDirectory. Stores the settings you chose for virtual directories and
Web folders you created on the Web Files page.
z WiseWebSiteAttributes. Stores the Web Dialogs settings for Web sites you
created on the Web Files page.
z WiseWebSites. Stores the settings you chose for Web sites you created on the
Web Files page.
z WiseWildcard. Contains an entry for each time you add a wildcard in Installation
Expert > Files page and mark the Update installation as files are added or
removed from source directory checkbox.
z WiseWildcardFile. Contains a list of files that were originally added via a wildcard,
and were later deleted because they no longer exist. File information is stored so
that if and when a file is re-added, crucial information about the file is retained.
Conditions and properties are integral parts of any complex installation. To do advanced
customization of an installation, you’ll probably need to use conditions and properties.
Topics include:
z Conditions.
z Properties.
Conditions
Conditions are like expressions: they evaluate to a true or false value. You associate
conditions with different elements of an installation such as features, components,
actions, dialogs, and dialog controls to determine whether something happens or not.
Based on whether the condition is true or not, you can determine whether to:
When you create a new installation, conditions are already created throughout the
installation where appropriate.
You often use properties inside conditions. Properties are named values that are any of
the following:
z Defined by Windows Installer, by you in the installation file, or by the end user
during installation.
Also see:
Launch Conditions
Launch conditions are system requirements that must be met for the installation to
proceed. You set launch conditions in the Launch Conditions icon in Setup Editor >
Product tab. When you set system requirements on the System Requirements page,
they are added to the Launch Conditions icon.
This condition specifies that the screen resolution must be 800 x 600 in order for the
installation to proceed.
ScreenX and ScreenY are Windows Installer properties that are set according to the
screen resolution on the destination computer. See ScreenX Property and ScreenY
Property in the Windows Installer SDK Help.
Example: If you double-click the Next button on the License Dialog in Setup Editor >
Dialogs tab, then on the Conditions tab on the Properties dialog you see 3 conditions
attached to the Next button. These conditions determine the state of the Next
button. They are all based on the value of a property named Accept. The Accept
property is set to “Yes” when the end user clicks the I accept the license
agreement radio button. As soon as Accept equals “Yes”, the Next button becomes
enabled and set to the default control. (To see how the Accept property is set,
double-click the radio buttons on the License Dialog, then look at the Items tab on
the Properties dialog.)
Example: Click the Installation Type Dialog in Setup Editor > Dialogs tab. Double-
click the Next button and click the Events tab on the Properties dialog. Depending
on what the property InstallMode is set to, different dialogs appear, as specified in
the NewDialog events. If the end user selects the Custom radio button, InstallMode
is set to Custom, and the Select Feature Dialog appears. If the end user does not
select the Custom radio button, the Start Installation Dialog appears. The value of
the InstallMode property is determined by the end user’s radio button choice.
If you add conditions to the Features page, and add items to the conditions using the
Current Feature drop-down list at the top of Installation Expert pages, then some of
the components on the Components tab will have conditions set.
Note
If you add a component condition that checks the installed state of a component or
feature, add the merge module CondFix.msm to the installation. This merge module
fixes a Windows Installer limitation; see WiseFixConditions on page 411.
Condition Guidelines
Before creating conditions, become familiar with the following Windows Installer
guidelines for creating conditions.
The name of the property. This is case-sensitive. You do not need to enclose the
property name in square brackets. See Using Properties in Conditional
Statements in the Windows Installer SDK Help.
Any integer between -32,767 and 32,767. You cannot use floating point values.
Environment variable. Precede the variable name with a percent symbol (%).
z When adding conditions to the Launch Conditions icon, you can add conditions that
check properties or environment variables, but you cannot add conditions that check
the installed state of a component or feature.
z You might need to include the merge module CondFix.msm, that fixes certain
Windows Installer limitations related to component conditions. See
WiseFixConditions on page 411.
z Property names and values, by default, are case-sensitive. To make them case-
insensitive, precede the operator with ~= instead of =.
Example: If you enter the condition REMOVE=ALL but the value of the REMOVE
property is currently “All” (with upper- and lowercase), the condition is false. To
write the condition so that it is case-insensitive, type the condition as follows:
REMOVE~=”All”
z Non-existent property values are treated as empty strings and evaluate to false.
z Operators and precedence are the same as in the BASIC and SQL languages, but
you can override precedence with parentheses.
z Arithmetic operators and floating point numeric values are not supported.
For details, see Conditional Statement Syntax in the Windows Installer SDK Help.
Examples of Conditions
You can build conditions using property names, environment variables, and feature and
component states. Conditions can contain both Windows Installer properties and
properties that you create. A complete list of Windows Installer properties is available in
Property Reference in the Windows Installer SDK Help.
WiseFixConditions
Wise for Windows Installer contains a special merge module, WiseFixConditions
(CondFix.msm), that fixes certain Windows Installer limitations:
z You add a component condition that checks the installed state of a component or
feature.
The Wise for Windows Installer installation places CondFix.msm in the default merge
modules directory, or you can download it with the Download Redistributables wizard.
See Downloading Redistributable Files on page 35. This merge module appears on the
Select Merge Module dialog when you add a merge module on the Merge Modules page.
If you don’t see it, you’ve marked the Do not show merge modules from the
Default Merge Module Directory checkbox in Wise Options. See Setting Merge
Module Directories on page 48.
Scrolling text
box. Enter or
build conditions
here.
Operator
buttons
Mark Ignore Case
to make conditions
case-insensitive.
This inserts a ~
when you click a
comparative
operator button.
Lists
Operator Buttons
Most of the operator buttons in the middle of the dialog, starting with the = button, are
described in Conditional Statement Syntax in the Windows Installer SDK Help. They
include logical, comparative, string, and bitwise operators.
z Use the () buttons to enclose parts of the condition, which changes the order of
precedence.
Lists
z Fields
Select the kind of item the condition checks. You can check the installed state for
features and components, and you can check the value of properties and
environment variables.
z Values
If you selected Environment Variable or Property in the Fields list, double-click the
name of an environment variable or a property to insert it into a condition. See
Checking the Value of a Property on page 412 or Checking the Value of an
Environment Variable on page 413.
Note
The following 2 lists let you check the current or future installed state of a feature or
component. The procedures for using these are described in Checking If and How a
Feature or Component is Currently Installed on page 414 and Checking If and How a
Feature or Component Will Be Installed by This Installation on page 414.
z State
Use this list only to check the installed state of a component or feature. Action
refers to what occurs during installation, and Installed refers to the current state of
the destination computer.
z Install/Action state
Use this list only to check the installed state of a component or feature. Absent
means the feature or component is not installed, Advertised means it is
advertised, Local means it is installed on the local hard drive, and Source means it
is installed to run from the installation source.
Also see:
The Values list displays a list of properties and directories that are initialized by this
installation. More properties appear than in other lists of properties, such as the
Properties icon in Setup Editor > Product tab. It includes Windows Installer
properties that are set at runtime based on system configuration, such as ScreenX
and ScreenY. For information on Windows Installer properties, see Property
Reference in the Windows Installer SDK Help.
If the property you want does not appear in this list, enter the property name in the
condition list box at the top of the Condition Builder dialog.
5. Click in the condition list box after the equals sign and enter a value.
6. Click OK.
Note
This procedure lets you check the value of an environment variable. To read the value of
an environment variable into a property, use the Set Property type of custom action.
Enter [%ENVIRONMENT_VARIABLE_NAME] in the Property Value field on the Custom
Action Target dialog while making the action (brackets required).
1. Access the Condition Builder dialog. See Creating Conditions With Condition Builder
on page 411.
The Values list displays the environment variables that currently exist on your
computer. If the environment variable you want is not in the list, enter its name in
the condition list box at the top of the Condition Builder dialog. For information on
available environment variables, consult Microsoft Windows developer
documentation.
5. Click in the condition list box after the equals sign and enter a value.
6. Click OK.
Note
You cannot add this type of condition to the Launch Conditions icon in Setup Editor >
Product tab. Also, when you add this type of condition, add the merge module
CondFix.msm to the installation. This merge module fixes a Windows Installer limitation.
For details, see WiseFixConditions on page 411.
1. Access the Condition Builder dialog. See Creating Conditions With Condition Builder
on page 411.
6. In the Install/Action state list, double-click one of the following to check the
current installation state of the feature or condition:
Absent
Not installed.
Advertised
Installed in an advertised state.
Local
Installed locally.
Source
Installed to run from installation source.
When you finish, a condition appears in the condition list box. Based on the choices
you make, the appropriate Windows Installer codes are inserted. Example:
!Complete = 3
7. Click OK.
Note
You cannot add this type of condition to the Launch Conditions icon in Setup Editor >
Product tab. Also, when you add this type of condition, add the merge module
CondFix.msm to the installation. This merge module fixes a Windows Installer limitation.
For details, see WiseFixConditions on page 411.
1. Access the Condition Builder dialog. See Creating Conditions With Condition Builder
on page 411.
6. In the Install/Action state list, double-click one of the following to check the
action state of the feature or condition:
Absent
Will not be installed by this installation.
Advertised
Will be installed in an advertised state.
Local
Will be installed locally by this installation.
Source
Will be installed to run from installation source by this installation.
When you finish, a condition appears in the condition list box. Based on the choices
you make, the appropriate Windows Installer codes are inserted. Example:
&Complete = 3
7. Click OK.
Properties
Properties are variables used by Windows Installer during installation. You often use
properties inside conditions. You can hard-code the value of a property, but you can also
make properties more flexible by manipulating them during runtime based on user
input, system configuration, or other situations.
Properties are set by the following methods and in the following order:
Because each method of setting properties can be overridden by the methods that come
after it, property values might change during installation. In the Professional and
Enterprise Editions, you can see the value of properties during installation in the
Properties pane of Debugger for Windows Installer, which appears when you click the
Debug button. (In Visual Studio: select Debug menu > Start.)
Properties that are authored into the installation database’s Property table, which
appear in the Properties icon in Setup Editor > Product tab, represent initial values of
properties. Changing the Properties table after installation begins has no effect on the
values of properties that are stored in memory. During installation, properties can be
changed only by actions that are running in immediate execution mode. User interface
actions are in immediate execution mode, and you can set your custom actions to run in
immediate execution mode.
Also see:
Example: In Setup Editor > Dialogs tab, the Installation Type Dialog has a set of radio
buttons. The radio buttons are associated with a property named InstallMode, and based
on the value of InstallMode, the Next button displays a different dialog. Double-click the
radio buttons and the Next button, to view their Properties dialogs. See About Dialog
Controls on page 438.
In conditions
You can use properties inside conditions. You do not need to enclose the property name
in brackets. Conditions determine whether something happens or not.
Example: In Setup Editor > Dialogs tab, right-click a dialog name, and select Details.
The Dialog Details dialog appears with [ProductName] [_WiseDialogSuffix] in the Dialog
Title.
1. In Setup Editor > Product tab, right-click the Properties icon and select New >
Property.
Name
Enter a name for the property. Properties can contain only letters, numbers,
underscores, and periods and must begin with a letter or underscore.
A public property name consists of all uppercase letters. The value of public
properties can be passed from the UI Sequence to the Execute Sequence. In
most cases, barring security issues, you should designate properties as public
properties. See Public Properties in the Windows Installer SDK Help. A private
property name includes lowercase letters. See Private Properties in the
Windows Installer SDK Help.
Value
Enter an initial value for the property.
Note
You cannot enter other properties to set the value of a new property because
text you enter is interpreted literally. This is not true for some specific Windows
Installer properties, such as DiskPrompt and PrimaryFolder. To set a property to
the value or values of other properties, use the Set Property custom action. See
Set Property on page 514.
Hidden property
Mark this to designate this property as hidden. This Windows Installer 2.0
feature prevents the property’s value from being written to the installation log
file. Use this for properties that contain information, such as serial numbers or
passwords, that you don’t want end users to see.
Windows Installer SDK Help. This is disabled if you entered any lowercase
letters in the name.
3. Click OK.
You can also create a new property from any dialog in the product that has a Property
drop-down list with a New button next to it.
To edit a property, double-click its name under the Properties icon in Setup Editor >
Product tab.
Caution
You can edit and delete properties, but many of the properties you see in the Properties
icon are Windows Installer properties. You should be proficient in the Windows Installer
development environment before you edit or delete Windows Installer properties. If you
change the name of a property, make sure you update any dialog controls or conditions
that reference the property name.
Build Properties
Properties defined by settings in an installation at build time are listed below. Some of
them, such as INSTALLLEVEL, can be changed at runtime from the command line or
during the Action Sequence. You can also create new properties for your own use. See
Creating a New Property on page 417.
On the Build Options page, you can configure an installation to create an .EXE that
launches an .MSI. Then the installation includes an .INI file that contains settings
necessary for the installation to run. Some of the build properties below determine the
default value of some of the properties in the .INI file. In that case, the property
description includes the name of the corresponding property in the .INI file.
If an installation creates an .EXE that launches an .MSI, this property sets the
default value for the ProductCode property in the .INI file that’s generated.
See INI File Properties on page 422.
ProductID Contains the full product ID after the end user’s entry has been validated.
ProductLanguage Indicates the language for this product. See Language IDs on page 279.
ProductName Contains the name of the product, which is set on the Product Details page.
ProductVersion Contains the product version number, which is set on the Product Details
page.
If an installation creates an .EXE that launches an .MSI, this property sets the
default value for the ProductVersion property in the INI file that’s generated.
See INI File Properties on page 422.
ReinstallFileOlderVersion Indicates the action to take when an older version of a file being installed
already exists. The default value of “o” means overwrite. This sets an option
in the ReinstallMode dialog.
ReinstallFileVersion Indicates the action to take when the same version of a file being installed
already exists. The default value of “o” means overwrite. This sets an option
on the ReinstallMode dialog.
ReinstallRepair Indicates the action to take when reinstalling or repairing a file. The default
value of “r” means repair. This sets an option on the ReinstallMode dialog.
SecureCustomProperties Contains a semicolon-delimited list of properties that are restricted public
properties.
UpgradeCode Contains the product code for a related group of products, one of which might
be an upgrade for another.
WiseCRLF Contains a carriage return/line feed. Use in editable text boxes to insert lines,
or in property definitions.
WiseInitAdminError Contains the text of the error message that appears if the Windows Installer
runtime needs to be installed but the current user does not have
administrator privileges, which are necessary to install it.
If an installation creates an .EXE that launches an .MSI, this property sets the
default value for the AdminError property in the .INI file that’s generated.
See INI File Properties on page 422.
If an installation creates an .EXE that launches an .MSI, this property sets the
default value for the CmdLine property in the .INI file that’s generated. See
INI File Properties on page 422.
WiseInitExistError Contains the error that is displayed if a previous version of the installation is
already installed on the destination computer.
If an installation creates an .EXE that launches an .MSI, this property sets the
default value for the ExistError property in the .INI file that’s generated. See
INI File Properties on page 422.
WiseInitLangDefault Contains the default language for the installation, which initially is English. It
can also contain the language ID, separated from the language name by a
comma. (Example: English, 1033). If the language of the destination
computer matches this ID, the installation runs without applying any
language transforms.
If an installation creates an .EXE that launches an .MSI, this property sets the
default value for the WiseInitLangDefault property in the .INI file that’s
generated. See INI File Properties on page 422.
WiseInitPrefix Contains the text that’s displayed before the “Wise Installation” text in the
installation’s initialization window. The initialization window is the small
window that appears before the installation wizard dialogs appear.
If an installation creates an .EXE that launches an .MSI, this property sets the
default value for the WiseInitPrefix property in the .INI file that’s generated.
See INI File Properties on page 422.
WiseInitProductName Contains the text displayed in the title bar of the installation’s initialization
window. The initialization window is the small window that appears before the
installation wizard dialogs appear. This value overrides the value stored in the
ProductName property for the initialization window, to provide a shorter
name that fits in the window. This property is absent unless you create it.
If an installation creates an .EXE that launches an .MSI, this property sets the
default value for the ProductName property in the .INI file that’s generated.
See INI File Properties on page 422.
WiseInitProgressText Enter the text that should display while the hourglass is being displayed
during installation.
WiseInitSpaceError Contains the error text that is displayed if the destination computer does not
have enough free disk space to copy the .MSI database to its local disk drive.
If an installation creates an .EXE that launches an .MSI, this property sets the
default value for the SpaceError property in the .INI file that’s generated. See
INI File Properties on page 422.
If an installation creates an .EXE that launches an .MSI, this property sets the
default value for the WiseInitSuffix property in the .INI file that’s generated.
See INI File Properties on page 422.
WiseMaskedProperties Contains Windows Installer properties that can be set by the end user during
installation, and whose value will be masked.
WISEWEBSITES properties Caution
Do not edit any properties whose name begins with WISEWEBSITES. They
are set when you add Web resources to an installation and generate Web
dialogs. Changing these properties can result in unexpected behavior. Also,
when the Web dialogs are regenerated, any changes you make to these
properties will be lost.
Also see:
Some of the properties in the .INI file get their default values from the build properties
listed in Build Properties on page 418. See individual descriptions below to determine
which build property the .INI property takes its default from, if any.
Runtime Properties
The properties listed in Build Properties on page 418 represent properties that are
initialized by the installation. All build properties are also runtime properties. Windows
Installer sets additional properties at runtime that contain useful information you can
use in an installation. For definitions of all the properties Windows Installer sets at
runtime, see Property Reference in the Windows Installer SDK Help.
In Web Installations
(Professional and Enterprise Editions only.) When you add Web resources in Installation
Expert > Web Files page, certain properties are set by a custom action.
The following properties are provided so that you can grant the ASPNet account
permission to directories; see Setting Permissions for Files and Directories on page 132.
The following properties are provided so that you can perform operations based on how
and where the Web site or virtual directory is installed. (Example: Use these properties
to create shortcuts to a Web site or virtual directory.) In the following property names,
<VIRTDIR> and <WEBSITE> are populated from the PropertyRoot column of the
WiseVirtualDirectory table for the given Web site or virtual directory.
[<WEBSITE>_BEGINURL]file_name.html
<WEBSITE>_HOMEDIR Contains the physical home directory of the web site or virtual directory.
<WEBSITE>_INSTTYPE Contains the installation type of the web site or virtual directory (NEW, EXIST,
or VIRDIR).
<WEBSITE>_URL Contains the URL of the web site or virtual directory.
You can select, edit, and rearrange dialogs that appear to the end user during
installation. This lets you determine the level of control the end user has over the
installation. You also can select the theme that controls the overall look of the
installation dialogs.
For most installations, the Dialogs page provides all the options that are needed for
selecting and editing dialogs. The Dialogs tab in Setup Editor contains advanced tools for
editing the appearance as well as the behavior and logic of installation dialogs.
Topics include:
z About Dialogs.
z About Billboards.
About Dialogs
You can access dialogs from:
Script, if you double-click the script line for Welcome_Dialog, the first dialog of the
Welcome Dialog Wizard displays on the Dialogs tab.
The Dialogs tab shows all dialogs that are part of an .MSI. Any of these dialogs can
appear in different situations:
Install Dialogs
The Install Dialogs appear during a normal installation, if no command line options are
used to run an advertisement, administrative, or silent installation.
Maintenance Dialogs
The Maintenance Dialogs appear when the installation is run in maintenance mode, that
is, when it is run after the application is installed. Maintenance mode lets the end user
change, repair, or uninstall the application.
Admin Dialogs
The Admin Dialogs appear during an administration installation. An administrative
installation copies a source image of the application to a network, for later installation by
end users.
To run an administrative installation, use the command line option /a. See About
Installation Modes on page 468.
Also see:
z If you add them with the New Dialog Wizard (Creating a New Dialog on page 437).
z If you add certain features to your installation, corresponding dialogs are added.
Example: IIS dialogs are added if you add Web resources to the Web Files page.
z If you create an installation based on a certain template in the New Installation File
dialog. Example: The Server Application template contains the SQL Connection
Dialog.
z License Dialog
See Importing Text into License and Readme Dialogs on page 433.
z Readme Dialog
See Importing Text into License and Readme Dialogs on page 433.
z IIS Dialogs
Several dialogs that begin with “IIS” are added if you install Web files. See About
Web Installations on page 222.
Caution
Do not edit the Web (IIS) dialogs, except to change their order (as a group) in the
installation sequence. Editing the Web dialogs might cause unexpected, undesirable
behavior, including damage to the installation. Also, any operation within this
product that affects the installation’s user interface will regenerate the Web dialogs,
therefore, any changes you make to them will be lost.
Also see:
Caution
Do not edit the Web (IIS) dialogs, except to change their order (as a group) in the
installation sequence. Editing the Web dialogs might cause unexpected, undesirable
behavior, including damage to the installation. Also, any operation within this product
that affects the installation’s user interface will regenerate the Web dialogs, therefore,
any changes you make to them will be lost.
The Convert button converts the button navigation to a more flexible and robust system,
which facilitates changing the order of dialogs. However, converting may cause problems
with legacy installations if you have extensively customized the dialogs and their
settings. Make a backup of the installation before converting if such customization
exists. Click Convert and the dialogs are instantly converted to the new system with no
undo. At that point, new options appear on the Dialogs page.
Caution
If this installation contains Web resources, then the list of dialogs might include Web
(IIS) dialogs. Only enable or disable the Web dialogs as a group. Enabling individual Web
dialogs can prevent the installation from working properly.
To view a dialog:
Click the dialog name in the Dialogs list.
Caution
If this installation contains Web resources, then the list of dialogs might include Web
(IIS) dialogs. The Web dialogs must always remain in their original order, so they should
only be moved as a group. See Changing the Order of Web Dialogs on page 433.
z Use a silent installation. See User Interface Levels in the Windows Installer SDK
Help.
z In Setup Editor > Dialogs tab, clear the checkbox next to Welcome Dialog
Wizard.
Caution
Changing themes might delete dialog customizations in installations created in previous
versions of this Wise product. To preserve dialog customizations, leave None selected in
Default Theme.
Select No Graphics to omit top or side images from dialogs. Use this option to
minimize the size of an installation that is always run silently.
If an installation was imported or converted from a non-Wise product, the ability to edit
the themes is limited and varies depending on the product.
3. Specify a theme:
To edit an existing theme, click the theme name in the list on the left.
To create a new theme, click New and enter the theme’s name in Name.
To create a new theme based on an existing theme, click a theme in the list,
click Copy, and enter the new theme’s name in Name.
When you create a new theme, the images you specify are copied to a new
subdirectory in the Themes directory. The location of the Themes directory varies.
See Where are Installation Resources Stored? on page 28.
Theme images you create must be in .BMP format. To quickly create theme images,
copy and edit a set of predefined images. These images are in the subdirectories of
the Themes directory.
5. To remove an image from a theme, click the Remove button to the right of the
image.
6. To edit a theme’s fonts, click the Set Font button to the right of the font to change
and select a new font from the Font dialog. Select a font that will be on the
destination computer. If the font you select is not on the destination computer, the
font is set to a recognized system font.
The selected font appears on the Edit Themes dialog next to the Set Font button.
The Title Font settings control the font for the title of all dialogs that have a top
image. (Example: the title “License Agreement” on the License Dialog.) The
Title Font settings do not control the font for the title of the Welcome Dialog or
any other dialogs that have a side image.
The Main Font settings control the font for the rest of the text on the dialogs.
You cannot edit the font of individual sections of a dialog from the Edit Themes
dialog.
If you create a new theme and do not set the fonts for that theme, it uses the
default font settings in the Properties table.
To edit the font of the Welcome dialog title or of any individual sections of dialog
text, use Setup Editor > Dialogs tab. See Basic Control Settings on page 440.
If you change one or more themes on the Edit Themes dialog, and then click OK, all the
changes are saved, but if you click Cancel, all the changes are canceled.
3. Click Import Text and select an .RTF or .TXT file. (This button is available only when
you select the License or Readme dialogs.)
The text is imported into the dialog but any embedded graphics are removed.
Note
If you encounter error messages or formatting problems when you import the file, open
it in Wordpad, save it as .RTF, and re-import it. Some computers cannot import files with
formats other than .RTF. Also, only the standard .RTF settings are supported for the
License and Readme dialogs.
If the Web Dialogs button does not appear, either this installation does not contain
Web resources, or the user interface has been disabled for those Web resources.
3. In the list of dialogs, WEB DIALOGS represents the entire group of Web-related
dialogs, which must be moved as a group. Use the Move Up and Move Down buttons
to move the group of Web dialogs.
Caution
Do not edit the Web (IIS) dialogs, except to change their order (as a group) in the
installation sequence. Editing the Web dialogs might cause unexpected, undesirable
behavior, including damage to the installation. Also, any operation within this product
that affects the installation’s user interface will regenerate the Web dialogs, therefore,
any changes you make to them will be lost.
The Dialogs tab contains a Layout menu, a right-click menu, and a toolbar that let you
add new controls to dialogs, edit existing controls, and organize dialog content.
z To expand or collapse a selected dialog set’s children, use the right-click menu.
z If the toolbar is not visible, select View menu > Controls. (In Visual Studio: View
menu > Toolbox.)
Caution
Do not edit the Web (IIS) dialogs, except to change their order (as a group) in the
installation sequence. Editing the Web dialogs might cause unexpected, undesirable
behavior, including damage to the installation. Also, any operation within this product
that affects the installation’s user interface will regenerate the Web dialogs, therefore,
any changes you make to them will be lost.
Caution
If this installation contains Web resources, then it might contain Web (IIS) dialogs. Only
enable or disable the Web dialogs as a group. Enabling individual Web dialogs can
prevent the installation from working properly.
Caution
If you are using the Installation Types page to manage the Installation Types dialog, you
cannot change any details on the Installation Types dialog. Doing so causes the
Installation Types page not to work properly.
Caution
If this installation contains Web resources, then it might contain Web (IIS) dialogs. The
Web dialogs must always remain in their original order, so they should only be moved as
a group. See Changing the Order of Web Dialogs on page 433.
z Use a silent installation. See User Interface Levels in the Windows Installer SDK
Help.
z In Setup Editor > Dialogs tab, clear the checkbox next to Welcome Dialog
Wizard.
Because of limitations with Windows Installer, do not place dialog controls on top of
graphics. Although you can place objects on top of one another, controls that are placed
on top of graphics often do not appear at runtime.
Caution
Do not edit the Web (IIS) dialogs, except to change their order (as a group) in the
installation sequence. Editing the Web dialogs might cause unexpected, undesirable
behavior, including damage to the installation. Also, any operation within this product
that affects the installation’s user interface will regenerate the Web dialogs, therefore,
any changes you make to them will be lost.
1. In Setup Editor > Dialogs tab, select a dialog in the left pane.
2. Select Layout menu > Add, and then select the type of control to insert. If the
controls in the Add menu are disabled, click the dialog to make it active, and try
adding the control again.
(In Visual Studio: select View menu > Toolbox, and on the toolbox, double-click the
type of control to insert.)
Depending on the type of control you select, a Properties dialog appears so you can
configure the control’s properties, position, and attributes. For information on each
tab of the Properties dialog, see:
When you finish adding and configuring controls, use other commands on the Layout
menu to help organize and arrange them. (In Visual Studio: use commands on the
Format menu.)
z Setup Editor > Dialogs tab: Right-click the name of a dialog in the left pane, and
select Details.
z Installation Expert > Dialogs page: Select the dialog and click the Details button.
Caution
If you are using the Installation Types page to manage the Installation Types dialog, do
not change any details on the Installation Type dialog. Doing so causes the Installation
Types page not to work properly.
Caution
Do not edit the Web (IIS) dialogs, except to change their order (as a group) in the
installation sequence. Editing the Web dialogs might cause unexpected, undesirable
behavior, including damage to the installation. Also, any operation within this product
that affects the installation’s user interface will regenerate the Web dialogs, therefore,
any changes you make to them will be lost.
z Dialog Title
Enter the title of the dialog. You can include an installation property in the title by
enclosing it in square brackets. Example: [ProductName] inserts the name of the
product at runtime.
z X and Y Centering
Enter X and Y values from 1 to 100 to indicate where on the screen the dialog
should be centered. Values of 50 in both fields mean that the dialog should be
exactly centered on the screen. If the Y Centering value is set to 33, the center of
the dialog will be 1/3 of the way from the top of the screen.
z Visible
Mark this to make the dialog visible.
z Minimize Button
Mark this to add a minimize button.
z Error Dialog
Mark this if the dialog is an error dialog. The property named ErrorDialog
determines which specific dialog is called if errors occur during installation. The
dialog must contain a text control named ErrorText to receive the contents of the
error message. An installation can contain only one error dialog.
z Modal
Mark this if the dialog should be modal, which means the dialog is the front window
of the installation until the end user clicks OK or Cancel. The end user cannot access
other windows or dialogs of the installation until the modal dialog is dismissed.
z Keep Modeless
Mark this if non-modal dialogs that are displayed when this dialog appears should
remain on the screen.
Note
If you get details for the Custom Property Dialog, an Edit button appears on the Dialog
Details dialog. This lets you change the Windows Installer properties for the Custom
Property Dialog.
Select Setup Editor > Dialogs tab. In the left pane, right-click where the new
dialog should appear, and select New > Dialog.
OR
Note
The dialog templates that appear are in Wise Standard.msi, which is stored in
\Templates\Dialogs. The location of the Templates directory varies. See Where are
Installation Resources Stored? on page 28. To make additional dialogs available in
each new installation, open Wise Standard.msi and add the dialogs to the All Dialogs
branch on the Dialogs tab.
3. Edit any values by clicking the item in the Type column and then clicking Edit.
This dialog lets you change any properties the new dialog inherits from the
template. Example: Each dialog must have a unique name. The wizard assigns a
unique name to the new dialog by appending a number to the template’s name, but
you might want a more descriptive name.
If you added the Custom Property dialog, the Select Custom Properties dialog
appears, where you can select properties that can be set by the end user during
installation. See Adding the Custom Property Dialog on page 455.
The Select Installation Placement dialog appears, which differs slightly based on
what version of Wise for Windows Installer the current installation was created in.
Read about the Convert button in Using the Dialogs Page on page 430.
If Move Up and Move Down buttons appear, use them to move the new dialog
within the list.
If they do not appear, then you must select a dialog in both the After and
Before columns. The new dialog will appear after the dialog you select in After,
and before the dialog you select in Before.
See:
Dialog controls often have an associated property. The result from the dialog control is
put into the property. To have a dialog control be deselected by default, associate the
control with a property whose value is not defined (null).
Example:
Suppose you create a checkbox, and you want the checkbox to be initially cleared. In
the Properties dialog for the checkbox, click the New button next to the Property field,
create a new property named CHECKBOX1, and leave its value blank. Although this
results in error messages during compile (which you can safely ignore), it ensures that
the checkbox is initially cleared when initially cleared when it appears to the end user.
(Delete the property from the Properties icon on the Product tab to eliminate error
messages.) To test whether the end user marked the checkbox, you use a condition that
consists of the property’s name, that is, CHECKBOX1. If the checkbox was not marked,
the value of the property remains null, and therefore CHECKBOX1 is false. If the
checkbox was marked, its value is now non-null, and therefore CHECKBOX1 is true.
z Combobox. A combination edit field and drop-down list control that lets the end
user select a predefined value or enter a value.
z Directory Combobox. Displays a combination directory list and path edit field to
let the end user specify a directory.
z Directory Listbox. Displays the folders below the main part of the current path.
This is intended to be used with the path edit control.
z Listbox. Displays a single column of values without icons. The end user can select
one value from the list.
z Listview. Displays a single column of values with an icon next to each. The end
user can select one value from the list.
z Masked Edit Field. A text edit field with a mask that creates a template for end
user data entry, specifying default values for some positions and specifying the
proper type of character (numeric or alpha) for others. You can enter certain
characters in the Control Text field of the Masked Edit control to constrain which
characters can be used at each character position of the control. See MaskedEdit
Control in the Windows Installer SDK Help.
z Path Edit. A single line input field that accepts only a valid pathname. This is
intended to be used in conjunction with the directory list box or directory combobox
controls.
z Radio Button. A group of mutually exclusive options with a separate radio button
for each option.
z Text. Static text field for displaying messages. The end user cannot change text in
this type of field. You can enter a property name surrounded by brackets in this type
of control to display a property’s current value.
z Volume Cost Listbox. A static text control that shows information about the disk
space requirements of different volumes (referred to as “cost” in Windows Installer
terminology) for the currently selected features.
z Volume Combobox. Lets the end user select a volume for installation.
1. In Setup Editor > Dialogs tab, select a dialog in the left pane.
2. Double-click a control.
A multi-tabbed Properties dialog appears. The tabs that appear vary depending on
the type of control. See:
To see the results of these settings, compile and run the installation.
The settings available on this tab vary depending on the type of control.
z Property
The name of the property associated with this control. The property determines the
initial state of the control, and holds the result from the control after end user input.
This property can determine the initial state of the control. Example: If a checkbox
is associated with a property whose value is not defined (null), the checkbox is
initially cleared when it appears to the end user. After the end user has interacted
with a control by marking it, entering text into it, or selecting an option, the result of
the user input is stored in this property.
You can create a new property. For details, see Creating a New Property on
page 417.
Note
(Windows 9x installations only.) If you create a component condition based on a
property that is set during the UI Sequence, add the merge module CondFix.msm to
the installation. This merge module fixes a Windows Installer limitation. For details,
see WiseFixConditions on page 411.
z Control Text
The text in the control. For bitmap and icon controls, this stores the key in the
binary table in which the bitmap or icon is stored. Click Import to import text from
an existing text file (.TXT or .RTF).
Note
If you encounter error messages or formatting problems when you import the file,
open it in Wordpad, save it as .RTF, and re-import it. Some computers cannot import
files with formats other than .RTF.
z Max Characters
(This replaces the Control Text field for an edit field control.) Enter the maximum
number of characters the end user can enter.
z Default
Mark this to activate this control when the user presses Enter while on this dialog.
Example: If you mark this checkbox for an OK button on a dialog, then when the
user presses Enter, the event associated with the OK button is activated.
z Cancel
Mark this to activate this control when the user presses Esc while on this dialog.
Example: If you mark this checkbox for a Cancel button on a dialog, then when the
user presses Esc, the event associated with the Cancel button is activated.
z Font Property
(Not available for a scrollable text control.) Select the property that defines a font.
In most cases, select _WiseDialogFontDefault to match the default text of other
text on dialogs. To define a new font style, add a new row to the TextStyle table in
Setup Editor > Tables tab. Then create a new property, and enter the new text
style’s name, surrounded by curly brackets, as the property value.
z Control Font
You can click Set Font and select a font for the control. The Font Property field, if
set, overrides this field.
X Position, Y Position
The location of the control within the dialog. The upper left corner is represented by
X,Y values of 0,0. You also can drag the control to position it on the dialog.
z Width, Height
The size of the control in installation units, which are equal to 1/12 the height of the
system font on the destination computer.
General Attributes
z Visible
Makes the control visible.
z Sunken
Makes the control beveled to appear pushed into the dialog.
z Enabled
Enables the control, that is, display it in a state the end user recognizes as clickable.
z Indirect
If you mark this, the information for the control is not stored directly in the property
for the control. Instead, the value of the control’s property is used as the real
property name to store the information in.
Example: Suppose a dialog has 3 radio buttons and a checkbox. The radio buttons
set the property RADIO to FIRST, SECOND, or THIRD. The checkbox also uses the
property RADIO but has the Indirect checkbox marked. The property FIRST,
SECOND, or THIRD is set to the checkbox state based on the setting of the radio
button.
z Integer
Restricts end users to entering only integers in this control.
z Right-To-Left Reading
Indicates that the text in this control is in a language that is read right to left.
z Has Border
Displays a group box frame around the radio buttons in a radio button control.
z Check Value
If the end user marks the control, the value of the property in the Property field is
set to this value.
Control Attributes
z Transparent
Makes the background of the control transparent.
z Format Size
Attempts to format displayed text as a number representing a count of bytes. The
control’s text must be set to a number in units of 512 bytes. KB, MB, or GB is added
to the end of the text depending on how large the number is.
z No Prefix
Displays any & characters in the control’s text. Otherwise, & characters do not
appear and cause the next character to be underscored.
z Users Language
Makes the text control use fonts created in the end user's default UI codepage. If
this is cleared, the fonts are created in the database’s codepage.
z No Word Wrap
Text is not wrapped to fit the control area. Instead, it is clipped at the right edge of
the control.
z Multiline
Lets an edit field control accept multiple lines of text. If this is cleared, it accepts
only a single line.
z Image Handle
Obtains the image from a handle rather than from the Binary table.
z Icon Control
Replaces the control’s text with an icon. The control’s text is used as a key to the
Binary table to point to the icon data.
z Pushbutton
(Checkboxes and radio button groups only.) Draws the control as if it were a
pushbutton, although its behavior is not changed.
z Fixed Size
Prevents the image associated with the control from being scaled to fit the control
size. Instead, the image is cropped or centered in the control.
z Password
Makes an edit control display asterisks instead of the characters that the end user
types. This is typical of controls that require entry of a password.
z Bitmap
Replaces the control’s text with a bitmap. The control’s text is used as a key to the
Binary table to point to the bitmap data.
z Icon Size
Determines how icons are displayed in the control. Select a size, or select First
Icon to set scaling according to the first icon.
z Sorted
By default, the items in the control are sorted alphabetically before they are
displayed. Mark this to sort the items in the order they appear on the Items tab of
the Properties dialog.
z Droplist
Makes the control display a drop-down list rather than a multi-line selection list.
z Windows 95 Style
Displays the control using a Windows 95 appearance.
Use events to control the display of other dialogs, and to control the way Windows
Installer displays dialogs. When an event is generated (either by a dialog control or by
Windows Installer) it is published. The published event is sent to Windows Installer and
to all dialogs controls that have subscribed to it.
Publish Events
The top section of the Events tab lists the events published by the control.
z To rearrange the order in which the events are sent, click Move Up or Move Down.
When you click Add or Details, the Publish Event Details dialog appears, where you set
the following options:
z Event
Select the event to be published. See the following in the Windows Installer SDK
Help:
z Argument
Enter the argument for the event. If no value is passed for that argument, the event
is ignored. See Control Events in the Windows Installer SDK Help; click an event
name to see valid arguments.
z Condition
If you enter a condition for the event, the event occurs only if the condition is true.
If there is no condition, the event always occurs. For details, see Conditions on
page 407.
Subscribe to Events
The bottom section of the Events tab lists the events accepted by the control.
When you click Add or Details, the Subscribe Event Details dialog appears, where you
set the following options:
z Event
Select the event to be subscribed to. See the following in the Windows Installer SDK
Help:
z Attributes
Select an attribute that should be set for the control when the subscribing control
receives the ControlEvent. For information on valid attributes, see Control Attributes
in the Windows Installer SDK Help.
z Tooltip
A 1 or 2 word phrase that appears when the end user points to the control and
pauses. This is used only by screen reading programs.
When you click Add or Details, the Control Condition Details dialog appears, where you
set the following options:
z Action
The action to take when the condition is true.
z Condition
If you enter a condition for the event, the event occurs only if the condition is true.
If there is no condition, the event always occurs. For details, see Conditions on
page 407.
z Graphic Name
The drop-down list displays graphics stored in the Binary table. Select a graphic or
click Set to import a new graphic. Graphics must be in .BMP format.
z Information
Displays information about the graphic, including the number of colors in its palette,
its width and height, and its size.
z Preview
Displays the image. If necessary, the image is scaled down to fit in the preview
area.
All controls that share the same property name also share the same list of items.
Example: Suppose you make a radio button control, associate the property ITEM_LIST
with it, and add 3 items to it. Then on another dialog, you make a listview control and
associate ITEM_LIST with it. If you look at the Items tab for the listview control, it
contains the same items as for the radio button.
z To rearrange the order in which the items are displayed, click Move Up or Move
Down. To change the order in which the items appear on the dialog, double-click
each item and set its Y coordinate.
When you click Add or Details, a details dialog appears, where you can specify the text
that appears in the control.
The settings available on this tab vary depending on the type of control.
z Text
The text of the button or list item.
z Value
The value returned to the control’s property when the item is selected.
z Icon Name
Select an icon from the list or click Set and select an icon file on your hard drive.
The icon you set appears next to this item in the list control. This option does not
appear for all types of controls.
z Font Property
Select the property that defines a font. In most cases, select
_WiseDialogFontDefault to match the default text of other text on dialogs. To
define a new font style, add a new row to the TextStyle table in Setup Editor >
Tables tab. Then create a new property, and enter the new text style’s name,
surrounded by curly brackets, as the property value.
z Control Font
You can click Set Font and select a font for the control. The Font Property field, if
set, overrides this field.
z X Position, Y Position
The location of the item within the control. The upper left corner is represented by
X,Y values of 0,0. To rearrange items within the control (example: to reorder the
items for radio buttons), change the Y position.
z Width, Height
The size of the control in installation units, which are equal to 1/12 the height of the
system font on the destination computer.
Because of limitations with Windows Installer, do not place dialog controls on top of
graphics. Although you can place objects on top of one another, controls that are placed
on top of graphics often do not appear at runtime.
Caution
Do not edit the Web (IIS) dialogs, except to change their order (as a group) in the
installation sequence. Editing the Web dialogs might cause unexpected, undesirable
behavior, including damage to the installation. Also, any operation within this product
that affects the installation’s user interface will regenerate the Web dialogs, therefore,
any changes you make to them will be lost.
1. In Setup Editor > Dialogs tab, select a dialog in the left pane.
The last control you select is the master control that the other controls will be
aligned with.
3. Select Layout menu > Align > Lefts/Rights/Tops/Bottoms, depending on which edge
of the controls should align. (In Visual Studio: Format menu > Align > Lefts/Rights/
Tops/Bottoms)
1. In Setup Editor > Dialogs tab, select a dialog in the left pane.
3. Select Layout menu > Center in Form > and then select one of the following. (In
Visual Studio: Format menu > Center in Form.)
Vertically. Center within the top and bottom edges of the dialog.
Horizontally. Center within the left and right edges of the dialog.
1. In Setup Editor > Dialogs tab, select a dialog in the left pane.
The last control you select is the master control that the other controls will be sized
to.
3. Select Layout menu > Make Same Size and then select one of the following. (In
Visual Studio: Format menu > Make Same Size.)
Width.
Height.
Both.
1. In Setup Editor > Dialogs tab, select a dialog in the left pane.
3. Select Layout menu and then select one of the following. (In Visual Studio: Format
menu.)
1. In Setup Editor > Dialogs tab, select a dialog in the left pane.
3. Select Layout menu > Set Tab Order. (In Visual Studio: View menu > Tab Order.)
This is disabled unless you set the focus on the dialog first.
A black box appears for each control. The numbers on the boxes indicate the tab
order.
4. To set the new tab order for the dialog, click the controls in order. Each control turns
blue as its new tab order is assigned.
If the first several items have the correct tab order, and you want to begin
renumbering the tab order at a later number, hold down the Ctrl key and click the
control after which you want to renumber. Example: If controls 1 through 7 have the
correct tab order, and you want to start renumbering from 8, press Ctrl and click
control 7. Then continue setting tab order starting from control 8.
5. (Visual Studio integrated editor only.) Before working in another project in the
solution, save the installation to set the tab order.
About Billboards
Billboards consist of a series of text and images that are dynamically displayed on a
dialog during installation. Typically, billboards highlight features of the program being
installed, promote related products, or encourage product registration.
A billboard is associated with an action, and is displayed while that action is performed
during installation. A billboard consists of:
z The billboard. The billboard defines the area of the dialog where a sequence of text
and images is displayed. The billboard is like a screen on which bitmaps, icons, or
text controls are projected.
z The billboard control. The billboard control is associated with a feature and an
installation action. It also defines how many bitmaps, icons or text controls are
displayed, and in what order. You create one billboard control for each bitmap, icon,
or text control.
z The dialog is displayed to the end user while the installation is performing an action.
z You associate the billboard with an action that takes some time to perform. If the
action is completed in a fraction of a second, the end user will not see the billboard.
A billboard typically consists of several bitmaps, icons or text controls. If you want to
display only one control, add it to the dialog directly instead of within a billboard.
Windows Installer does not support the display of billboards outside of installation
dialogs.
2. In the left pane, select the Progress Dialog under Install Dialogs.
3. Click the small outline and resize and move it to accommodate the content items
you plan to add. You can adjust it later.
Note
Although a default billboard area is already created, you also can create your own.
Right-click the dialog and select Add > Billboard. On the Properties dialog that
appears, click the Events tab. Make sure the Subscribe to Event list contains an
entry where Event is set to SetProgress and Attribute is set to Progress.
Name
Enter a descriptive name for this control.
Feature
Select a feature from the list. This control’s content item only appears during
installation if this feature is installed.
Action
Select an action from the list. We strongly recommended that you leave the
default, InstallFiles, because usually only this action takes time to complete.
The control’s content items are displayed while this action is performed
during installation.
Display After
If this is the first control, select <display first>. Otherwise, select the
control that this one should appear after.
c. Click OK.
d. Repeat this step to add as many controls as you have content items.
The controls you create do not appear on the dialog. You can only see their content
items, which you add in the next step.
Right-click the dialog, select Billboards > Add Control, and select Bitmap, Icon,
or Text.
A properties dialog appears. The tabs that appear vary depending on the type of
control.
For bitmaps or icons, click the Graphic tab and select a graphic or click Set to
import a new graphic. Graphics must be in .BMP format. See Setting the
Graphic for a Control on page 444.
For text controls, enter text in the Control Text field. See Basic Control
Settings on page 440.
Make sure each content item is within the outline that represents the billboard
area.
If you add large content items, you can resize the Progress Dialog itself to
accommodate them. Also, you might need to resize bitmap items for them to
display correctly.
6. To preview the billboard, select each billboard in order from the Billboard submenu
of the right-click menu.
Note
Billboards do not appear when you test the installation. This is because files are not
installed during a test, so the InstallFiles event is never triggered. To view the billboards,
you must run the installation. See Running An Installation on page 90.
Often, server software must be configured after installation to run under a particular
user with certain permissions. To help with this process, you can add the Logon
z Let the end user create a new NT user account during installation, if the end user
has the privileges to do so.
z Let the end user specify an existing NT user account during installation.
Although this dialog captures the logon information, it does not use it in any way or
apply it to your executables or services. You must do that yourself by using the
properties elsewhere in the installation.
Example: To have a service run under the specified user account, you can enter the
property names MYUSERNAME and MYPASSWORD, enclosed in brackets, in the Service
Details dialog (Installation Expert > Services page). You also can use these properties as
the account to run a Web application (Web Files page).
(In the Wise editor) To create a new installation that contains the
Logon Information dialog:
1. Select File menu > New.
4. In Setup Editor > Dialogs tab, select the Logon Information Dialog and edit the
dialog text as needed to communicate its purpose to the end user installing your
application.
3. In the Templates list, select Server Application Project and click Open.
4. In Setup Editor > Dialogs tab, select the Logon Information Dialog and edit the
dialog text as needed to communicate its purpose to the end user installing your
application.
2. Right-click on a dialog under the Welcome Dialog Wizard and select New > Dialog.
3. On the Select Dialog Type dialog, select Logon Information and click Next.
4. Step through the wizard to create a new dialog; see Creating a New Dialog on
page 437.
5. Edit the dialog text as needed to communicate the purpose of the user account to
the end user installing your application.
z If the end user chooses to create a new user, the end user must have user creation
privileges on the server or domain.
z If the end user creates a user with this dialog, then cancels the installation, the
created user still exists and is not deleted.
z During installation, the end user cannot progress through the installation until a
valid NT account is entered on this dialog. There is no mechanism for the end user
to skip this part of the installation.
z Do not use this dialog to capture logon information to be used in a SQL Server
connection string on the SQL Server Scripts page; Microsoft’s SQL Server logon
mechanism prevents this from working.
Also see:
z Let the end user select a SQL Server name and security credentials to generate a
valid SQL Server connection string.
When the end user completes the SQL Connection dialog and clicks Next, the installation
creates and tests the connection string. If the connection string is not valid, an error
message appears.
Note
The SQL Connection dialog only validates the connection string; it cannot verify that the
user has permission to execute all SQL statements in a SQL script.
z The ODBC SQL Server driver must be on the destination computer for this dialog to
work. Use the Prerequisites page to pre-install MDAC, which includes the ODBC SQL
Server driver. See Adding Prerequisites to a Release on page 186.
z The Browse button appears on the SQL Connection dialog only if SQL Client Tools
(osql.exe) is installed on the destination computer. When the end user clicks the
Browse button, a drop-down list appears with the SQL Servers on their network. If
the Browse button does not appear, the end user must enter the SQL Server name.
Also see Adding the SQL Connection Dialog to an Installation on page 453.
(In the Wise editor) To create a new installation that contains the SQL
Connection dialog:
1. Select File menu > New.
4. In Setup Editor > Dialogs tab, select SQL Connection Dialog and edit the dialog text
as needed to communicate its purpose to the end user who installs your application.
4. In Setup Editor > Dialogs tab, select SQL Connection Dialog and edit the dialog text
as needed to communicate its purpose to the end user who installs your application.
3. Step through the wizard to create a new dialog; see Creating a New Dialog on
page 437.
4. Edit the dialog text as needed to communicate its purpose to the end user who
installs your application.
1. Start the New Dialog Wizard to add an additional SQL Connection dialog. See Adding
the SQL Connection Dialog to an Installation on page 453.
2. On the Dialog Properties dialog of the New Dialog Wizard, edit the dialog’s default
control properties.
From: To:
WiseSqlServerName WiseSqlServerName1
WiseSqlAuth WiseSqlAuth1
WiseSqlUser WiseSqlUser1
WiseSqlPass WiseSqlPass1
4. In Setup Editor > Dialogs tab, select SQL Connection Dialog1 in the left pane.
5. In the right pane, edit the Argument of the [WiseSqlParam] event for the Browse
and Next buttons using the new control properties and a new property for the
connection string. See Setting an Event on a Control on page 443.
Example: Edit the Argument of the [WiseSqlParam] event for the Browse and Next
buttons as follows:
From: To:
WiseSqlServerName|WiseSqlAuth|WiseSqlUser|WiseSq WiseSqlServerName1|WiseSqlAuth1|WiseSqlUser1|Wis
lPass|WISE_SQL_CONN_STR eSqlPass1|WISE_SQL_CONN_STR1
6. Use the new property for the connection string in the SQL script that executes the
connection with the additional SQL Server. See Setting SQL Connection Strings on
page 235.
This dialog does not appear in any installation by default, and must be added via the
New Dialog Wizard.
Caution
Do not add more than one Custom Property dialog to a single installation; only one per
installation is supported. If an installation contains multiple Custom Property dialogs,
then multiple, identical dialogs appear to the end user at run time.
2. Click Add.
The New Dialog Wizard appears, which is fully documented in Creating a New Dialog
on page 437.
3. In the list of dialogs, select Custom Property Dialog and click Next.
4. Leave the defaults on the Dialog Properties dialog and click Next.
The Select Custom Properties dialog appears, where you can either choose existing
Windows Installer properties or create new properties.
Existing Properties
To add an existing property, select it from this list and click Add. To create a new
property, select <New Property> from this list, and define the new property as
described in Creating a New Property on page 417.
Property Description
For each property you added in End User-Configurable Properties, select the
property name and add a description here to help the end user understand how
to set the property. This is limited to about 275 characters, because of the size
of the field that appears on the Custom Property Dialog.
The Custom Property Dialog now appears in the list of dialogs on the Dialogs page.
When you run this installation, the Custom Property Dialog appears.
3. Click Details.
The Edit Custom Properties dialog appears, where you can change the properties.
Caution
You should be familiar with macros and comfortable with Visual Basic to use this feature.
For information on Visual Basic, visit msdn.microsoft.com/vbasic/.
Note
You can use Wise Automation with Visual Studio or other scripting environments.
Topics include:
Each new file you start in Wise for Windows Installer has Macros.wbs attached. When
you open the Macro dialog, you can attach a different macro file.
z Event macros that run when you fire the corresponding event.
If your .WBS files include event macros, you might encounter a situation in which you
want to create a new project that doesn’t run these macros. Example: You might have a
macro that runs on the New event and adds a specific set of files to a specific set of
directories every time you start a new project. To start a new project that does not
include these files and directories, you can create a new .WBS file that doesn’t contain
any macros. Then, attach this macro file to your project.
The Macro Editor doesn’t let you save a .WBS file under a different name. To rename a
macro file, change the file name in Windows Explorer.
Also see:
To create a macro:
1. Do one of the following:
Macro Is Run
Select:
Event Name
For a manually-run macro, enter a name for the new macro. Do not include
spaces in the name. For an event macro, select an event.
Pathname
When you create a new macro, it is added to the macro file displayed. To add
the new macro to a different .WBS file, browse to the file’s location. To create a
new .WBS file, click New and specify the file.
3. Click Create.
The Macro Editor window appears. See About the Macro Editor Window on
page 460.
6. To create another macro, select Script menu > Add New Macro, enter a name for the
macro on the dialog that appears, write the macro, and save it.
To edit a macro:
1. Do one of the following:
If the macro is in a file other than the one shown in Pathname, browse to the file’s
location.
4. Click Edit.
The Macro Editor window appears. See About the Macro Editor Window on
page 460.
If the macro is in a file other than the one shown in Pathname, browse to the file’s
location.
4. Click Run.
Also see:
The Macro Editor window with all its functions is very similar to the Microsoft Visual Basic
window.
Buttons
These are unique to the Macro Editor or are in some way different from those in Visual
Basic:
Options Opens the Script Editor Options dialog, where you set
and change the appearance of a script.
Object View Shows all macros you’ve written for a particular object.
Full Module View Shows all macros you’ve defined for both WfWI events
and general functions.
z List Functions
Displays a global list of Wise and Visual Basic functions. For help on Visual Basic
functions, visit msdn.microsoft.com/vbasic/. For help on Wise functions, see the
Wise Automation Reference, which is in the Help directory under the Wise product
application directory.
z Check Syntax
Checks the macro for the correct syntax.
z Revert to Saved
Reverts the current macro to the last saved version, to undo any changes you’ve
made since you last saved.
There are 2 drop-down lists along the top of the script box. The drop-down list on the
left lets you select the type of macro: (General) for manually run macros, and
WFWIEvents for event macros. The drop-down list on the right lets you select
corresponding macros.
Topics include:
z Evaluating Conditions.
The debugger does not fix problems in the installation. Once you’ve used the debugger
to test the installation, use Wise for Windows Installer to make the appropriate changes
in the .MSI, .WSI, or .MST file. You cannot edit the installation within the debugger; you
can only change temporary values to see how they affect the installation. See Working
With Temporary Tables and Columns on page 465.
Also see:
z Actions
Lists the actions in the installation. These correspond to the actions in the Normal
Installation mode of MSI Script. Dialog actions can change depending on whether
you are installing or uninstalling your application.
z Table List
Lists all the tables in the installation in a window named _Tables. To open a table,
double-click its row in the Table List. Move from one open table to another by
clicking the corresponding tab at the bottom of this window. You can edit temporary
table fields only. See Working With Temporary Tables and Columns on page 465.
z Log
Displays a record of the actions that are processed during the installation. This
installation log is generated by Windows Installer and is displayed for informational
purposes only.
z Properties
Displays the properties of the action selected in the Actions pane. It shows current
values of the action’s condition, condition state, sequence, and type. You cannot
change any of the properties in this pane.
z Condition Evaluator
Lets you test conditions without adding them to the installation. When you enter
conditions and run the installation, the Condition Evaluator displays the conditions’
values. See Evaluating Conditions on page 465.
You can customize the debugger window by rearranging the panes. Any changes you
make to the panes are retained the next time you launch the debugger program. Use
the right-click menu in the Actions, Properties, Condition Evaluator, and Log panes for
these additional options:
z Allow Docking
Dock a pane when you drag it near an edge of the screen. When this option is not
marked, the pane does not dock regardless of where you drag it. You can also
prevent docking by pressing Ctrl while dragging.
z Hide
Remove the selected pane from the screen. To restore the pane, select it in the View
menu.
1. In Wise for Windows Installer, open the .WSI, .MSI, or .MST to debug.
2. Click the Debug button. (In Visual Studio: In Solution Explorer, right-click the
installation project icon and select Set as Startup Project. Then select Debug menu
> Start.)
The installation is saved and compiled if you have made changes since the last
compile. You are prompted to select an .MSI if you defined more than one release.
The debugger window opens.
Use Step Into if the installation contains one or more custom actions that call
VBScript, and you have the VBScript Debugger or Visual Studio with InterDev
installed. This opens the VBScript Debugger or Visual Studio and lets you debug
the VBScript. When you are finished, you can return to the installation in the
Debugger for Windows Installer.
Step Over runs VBScript actions but does not open the VBScript Debugger.
5. To stop the installation, select Debug menu > Stop Debugging or click Cancel in the
installation’s user interface.
To set a breakpoint:
Click the action at which you want to set a breakpoint, then press F9.
To clear a breakpoint:
Click an action with a breakpoint and press F9.
Evaluating Conditions
¾ Professional and Enterprise Editions only.
To display the Condition Evaluator pane, select View menu > Condition Evaluator.
This pane lets you test conditions without having to add them to the installation. You
enter the condition or conditions in the Condition Evaluator, and then run the installation
in the debugger. The Condition Evaluator returns the values, either TRUE or FALSE, for
the conditions you entered.
To enter a condition, click in the Condition column of the Condition Evaluator pane, then
enter the condition. Conditions you enter are saved from session to session. To delete a
condition, click its Condition column and press Delete.
To change a temporary field’s value, triple-click in its column and type the new value.
Changing temporary values does not affect the installation file; it just provides a way to
try different values. When you decide what changes need to be made, update the
installation in Wise for Windows Installer.
When you change a setting in an installation dialog, the corresponding property value in
the _Property table changes. As you step through the installation, you’ll notice that
certain tables and fields display in red. This means they have changed since the last step
or, if you are not stepping over, since the beginning of the installation or the last
breakpoint.
MSI Script™ provides a powerful yet easy-to-use environment for editing Windows
Installer installation sequences, even if you are not familiar with the underlying Windows
Installer technology. A sequence is a set of actions that are performed during a
particular type of installation.
Topics include:
z Editing Sequences.
Installation
Mode
Restricted Areas
Actions
Sequences
z Installation Mode
Installation modes represent the different ways an installation can be run. Choose
whether to work on a normal installation, an advertisement installation, or an
administrative installation. See About Installation Modes on page 468.
z Actions
You can select from standard actions, which are built-in Windows Installer functions,
or custom actions, which you configure yourself. To learn about an action, double-
click it and press F1.
z Restricted Areas
If you select an action that has restrictions on its placement, the restricted area is
shaded.
z Sequences
Below the sequence area are tabs that let you switch between sequences. Each
installation mode is comprised of sequences, which, in the Windows Installer
database, correspond to sequence tables.
The existing action sequences are sufficient for most installations. If you need
specialized functionality not offered by Windows Installer, you can add custom actions to
an installation. With custom actions, you can call .EXEs, .DLLs, WiseScripts, JScripts,
and VBScripts. You can set installation properties and directories and call nested .MSI
files. You can also perform many other functions such as launching a Web page or
downloading a file from a Web site. See Custom Action Reference on page 489.
Also see:
Normal Installation
Select this installation mode to edit the sequences that are run during a normal
installation. This is the most common type of installation.
If the application is not already installed when an end user double-clicks the installation
.MSI, the standard installation wizard appears (Install Dialogs), which installs the
product. If the application is already installed when an end user double-clicks the
installation .MSI or if the end user selects it from the Add/Remove control panel, the
installation runs in maintenance mode (Maintenance Dialogs), which provides options to
modify, repair, or uninstall an application. For information on dialog groupings, see
About Dialogs on page 427.
Administrative Installation
Select this installation mode to edit the sequences that are run during an administrative
installation.
To run an administrative installation, use the command line option /a. (Example:
msiexec /a “C:\Pathname\Sample.msi”.) An administrative installation uses the Admin
Dialogs. For information on dialog groupings, see About Dialogs on page 427.
Also see:
Advertisement Installation
Select this installation mode to edit the sequences that are run during an advertisement
installation.
To run an advertisement installation, use the command line option /j. Example: msiexec
/j “C:\Pathname\Sample.msi”.
If the action does not have these tabs, then you cannot add it outside a sequence.
6. Click OK.
If the action does not have these tabs, then you cannot add it to multiple
sequences.
This tab provides another way to perform tasks that you normally perform in the
User Interface, Execute Immediate, or Execute Deferred sequences. See Using the
Custom Action Location Tab on page 515.
The action is added to the sequence, below the action you selected.
If you are in a merge module, the layout of the Location tab is different. See Using
the Custom Action Location Tab for Merge Modules on page 516.
9. Click OK.
The Execute sequence installs the application and makes changes to the system. During
installation, Windows Installer first goes through each action in the Execute sequence
and builds an internal installation script to follow. You cannot see or access this internal
script. This first pass is referred to as immediate mode and is represented by the
Execute Immediate tab. After it creates the internal installation script, it runs the script
it created, performing the actions that change the system. The second pass is referred
to as deferred mode, and encompasses all the actions between InstallInitialize and
InstallFinalize. It is represented by the Execute Deferred tab. This makes it easier to
specify in which mode to run an action. For information on where to place a custom
action, see Guidelines for Custom Action Location on page 478.
When Windows Installer generates the installation script, it generates a rollback script
that will undo the actions of the installation script. The rollback script is executed if the
installation is canceled or is unsuccessful, and is also run in deferred mode. Although
you cannot view or edit the rollback script, you can specify that custom actions you add
be added to it; use the In-Script Options field on the Properties tab of the custom
action details dialog.
On Windows NT, 2000, XP, and Server 2003, Windows Installer runs as a service, which
is registered in the Services control panel. When an .MSI is launched, it is run by the
service. The Windows Installer service can run with elevated privileges based on
policies, and the Windows Installer database runs with the current user’s privileges.
When you add custom actions, you can specify whether they should be run with elevated
privileges (system context) or with user privileges (user context). Set privileges to user
context or system context in the In-Script Options field on the Properties tab of the
custom action details dialog. On Windows 95 and Windows 98, Windows Installer runs
as an executable. Because there are no levels of privileges on Windows 95 and Windows
98 (everyone has full privileges), setting privileges has no effect.
For information on Windows Installer sequence tables, see Using a Sequence Table in
the Windows Installer SDK Help.
Note
You cannot replace text using this feature, but you can replace text in Setup Editor >
Tables tab. See Searching for Table Data on page 401.
Also see:
Editing Sequences
Use the commands on the Edit menu, the right-click menu, or the tools on the toolbar to
edit an MSI Script™ sequence. You can edit only one action at a time, but you can cut,
copy, or paste several actions at a time. To edit an action, select its installation mode,
click its sequence tab, and select the action from the Installation Sequence pane.
See:
z Remarks (green)
Remark statements document the script. Remarks that explain how the script works
are already added to new scripts you create. Removing these remarks has no
adverse affect.
Display Dialog actions are not displayed on either the Standard or Custom tab. To add a
dialog, use Setup Editor > Dialogs tab. After you add a dialog, it appears in MSI Script
as an action.
Note
You cannot edit Windows Installer standard actions, which are displayed in gray, and you
should not move or delete them.
You can also copy and paste actions to other locations in the installation sequence.
However, each time you copy and paste an action, an entirely new copy of the action is
stored in the installation. To avoid this duplication, see Adding a Custom Action to
Multiple Sequences on page 469.
Also see:
z To comment out an action, select the line or lines in the sequence that you want to
disable and select Edit menu > Comment. (In Visual Studio: Edit menu > Advanced
> Comment Selection.)
The commented lines appear in green.
z To reactivate commented lines, select them again and select Comment a second
time. (In Visual Studio: Edit menu > Advanced > Uncomment Selection.)
Note
If the main Windows Installer installation is run silently, a called WiseScript is called
silently.
z WiseScript Express
Included in Wise for Windows Installer and Wise Package Studio - Standard Edition.
z WiseScript Editor
Included in Wise Package Studio - Professional Edition.
z If you have Wise for Windows Installer, it launches Wise Installation System, if
available. If it is not available, it launches WiseScript Express.
z If you have Wise Package Studio - Standard Edition, it launches Wise Installation
System, if available. If Wise Installation System is not available, it launches
WiseScript Express.
Do the following:
Get Windows Installer Property script action to get the property named
APPLICATION_PATH into a temporary variable.
Parse String script action on the temporary variable to put the file name into
another temporary variable.
Set Windows Installer Property script action to put the file name back into the
Windows Installer property APPLICATION_PATH.
2. In Installation Expert, use the System Search page to get a registry entry that
consists of a full pathname. Put the pathname into a property named
APPLICATION_PATH.
3. In MSI Script, add a custom action to Run a WiseScript from Installation and specify
the WiseScript you wrote.
4. When an end user runs the Windows Installer installation, it calls the WiseScript,
which parses the pathname. When the Windows Installer installation continues
running, APPLICATION_PATH contains Application.exe.
The sample WiseScript looks like this (the script lines are numbered for clarity):
Example: Your application comes in 2 editions: Regular and Super. Serial numbers for
the Regular edition begin with the letter R, and serial numbers for the Super edition
begin with S. The serial number the end user enters during installation determines the
license file that gets installed, which determines which features are turned on. You set
up the installation to have the license files installed by the WiseScript instead of the .MSI
so that the license files are embedded in the WiseScript .EXE and cannot be opened.
Do the following:
Get Windows Installer Property script action to get the property named
SERIALNUM into a temporary variable named SERIALNUMBER.
Set Variable script action, with the Evaluate Expression operation, to place the
first character of the serial number in a variable named EDITION.
If Statements and Install File(s) script actions to install the appropriate license
file based on the value of the EDITION variable.
2. In MSI Script, add a custom action to Run a WiseScript from Installation and specify
the WiseScript you wrote.
3. During the Windows Installer installation, the WiseScript runs, gets the first
character of the serial number, and installs the appropriate license file.
The sample WiseScript looks like this (the script lines are numbered for clarity):
z In the .MSI, during an uninstall, use a custom action to call the Unwise32.exe that is
in the WiseScript.
Example: You have an .MSI named Core and a WiseScript named CorePlus. CorePlus
includes an Install File(s) script action that installs a file named A.dll. You want to make
sure that A.dll gets uninstalled when Core is uninstalled.
Leave Command Line blank. On the Properties tab, leave the defaults.
The above script lines install CorePlus, which in this example is A.dll. In the
following script lines, you make provisions for the uninstall.
The MSI script looks like this (the script lines are numbered for clarity):
Variable to MAINDIR
3. Add an Open/Close INSTALL.LOG script action with Open new installation log
marked and the log file path specified as %MAINDIR%\install.log.
Unwise32.exe is located within the WiseScript Express directory under the Wise for
Windows Installer directory.
Add any other necessary script actions. (Example: You could edit registry entries, check
if a certain file or directory exists, or rename a file or directory.) For this example, the
CorePlus script installs only A.dll. For troubleshooting purposes, you might also want to
add a Display Message script action that shows the value of %MAINDIR%. This lets you
know when the WiseScript runs, and also gives you debugging abilities.
The sample WiseScript looks like this (the script lines are numbered for clarity):
Caution
Although you can change the order and conditions for standard actions and dialogs, we
recommend that you do not change these settings unless you are proficient in the
Windows Installer development environment. Many actions have restrictions that
determine where they must appear in the sequence. See Actions with Sequencing
Restrictions in the Windows Installer SDK Help for more details.
z If the custom action uses information that’s gathered during the User Interface
sequence, place it after the actions that gather the information you need.
z If the installation is run silently, items in the User Interface sequence do not
execute.
Correct Sequence
Restricted Areas
z If an action has restrictions on its placement in the sequence, the restricted areas
are shaded in the Installation Sequence list when you select the action in the
Actions list. Place the action in a non-restricted area. Restrictions are defined by
Windows Installer functionality. Example: You can’t run an action that depends on
an installed file if the file is not yet installed.
z If you use the Move Up and Move Down commands on a custom action that has
restricted placement, keep in mind that the restricted areas will not be shaded.
Before moving an action, select the action in the Actions list to view its restricted
areas.
Formatted Text
z If you use formatted text in a custom action, such as a bracketed property name,
the custom action must be placed after the CostFinalize action in the User Interface
sequence. This is a Windows Installer requirement.
z If you use formatted text in a custom action, do not put the custom action in the
Execute Deferred sequence. Formatted text strings do not convert in the Execute
Deferred sequence. The exceptions to this rule are the CustomActionData and
ProductCode properties. See Formatted and Obtaining Context Information for
Deferred Execution Custom Actions in the Windows Installer SDK Help.
Example: If you add a custom action that opens a Readme file and set the action’s
condition to NOT Installed, then the Readme opens during initial installation, but does
not open during maintenance installations (reinstall, modify, and repair operations).
Limitations
Nested installations are supported according to the Windows Installer specification.
While nested installations may sometimes be necessary, we do not recommend using
them because of the restrictions on their use. See a list of restrictions at the end of
Nested Installation Actions in the Windows Installer SDK help.
Usage
According to the Windows Installer SDK, Install MSI custom actions should be placed
between InstallInitialize and InstallFinalize of the main installation’s action sequence.
Install MSI custom actions must be set to run synchronously.
Example: Suppose your main installation, Main.MSI, has a button on a dialog that, if
clicked, installs Second.MSI. You can use an Install MSI custom action to run the second
.MSI. Then you can use another Install MSI custom action to provide for uninstallation if
the main installation is uninstalled.
Note
Getting a nested installation to install is straightforward, but getting it to uninstall
properly when the calling application is uninstalled requires that you add 2 custom
actions. Set the first custom action to call the nested installation, and set its condition to
NOT Installed (Custom Action Location dialog). Set the second custom action to call the
nested installation also, set its Property Settings field to REMOVE=ALL (Custom Action
Target dialog), and set its condition to REMOVE~=”All”.
With this type of custom action, you can call only Windows Installer installations. To call
an installation that was created with the Wise Installation System or WiseScript Editor,
use a Run WiseScript custom action. See WiseScript Editing Tools on page 473. To call
an installation that was created with any other installation technology, use an Execute
Program custom action type.
z It can be stored within the main installation file. See Install MSI From Installation on
page 505.
z It can be distributed along with the main installation file. See Install MSI From
Relative Path on page 506.
The return values for nested installation actions are the same as for other custom
actions. See Custom Action Return Values in the Windows Installer SDK Help.
You can call scripts using custom actions, but you must author the JScript or VBScript.
The built-in Macro Editor is not meant to author JScripts and VBScripts that you call from
custom actions. For help authoring the script, see the following topics in the Windows
Installer SDK Help:
Scripts
Obtaining Context Information for Deferred Execution Custom Actions
Downloading an Installation From the Internet
Return Values of JScript and VBScript Custom Actions
How do I access the current installer session from inside a custom action?
To write your .DLL function according to Windows Installer guidelines, see the following
topics in the Windows Installer SDK Help:
Dynamic-Link Libraries
How do I access the current installer session from inside a custom action?
Custom Action Type 1
Custom Action Type 17
In the User Interface or Execute Immediate sequences, you can send Windows Installer
properties to the .DLL function as parameters. The property’s current value is passed to
the function, and, if the function changes that value, the new value is put into the
corresponding property.
In the Execute Deferred sequence, the number of properties you can access is limited.
You can only access UserSID, CustomActionData, and ProductCode. CustomActionData
is filled with the property value of any Windows Installer property that has the same
name as the Custom Action. See Obtaining Context Information for Deferred Execution
Custom Actions in the Windows Installer SDK Help.
z You authored the .DLL and have its source code on your computer.
z You are using one of the Call Custom DLL custom action types.
To enable debugging, use Setup Editor > Product tab to set the property named
_WiseDebugMode to 1. Then test or run the installation. Microsoft Visual Studio opens
and attaches to the installation process, and a breakpoint is invoked near the start of
your .DLL. You need to step a few times to get out of Windows Installer compiled code
and into your .DLL code.
Note
The debugging method described above only works with the Call Custom DLL custom
action types. It does not work with the Call DLL custom action types.
3. Create a new custom action and configure it normally, but mark No Sequence on
the Location tab.
4. In Setup Editor > Dialogs tab, right-click a dialog and select Add > Button.
Make sure the button is not on top of a graphic. You can add other controls besides
buttons.
5. On the Control tab of the button’s Properties dialog, enter the label for the button in
the Control Text list box.
6. On the Events tab, in the Publish Events group box, click Add and complete the
dialog:
Event
Select DoAction.
Argument
Enter the name of the custom action. The name is case-sensitive.
When the installation is run, the button you added appears on a dialog. When the end
user clicks the button, the custom action you specified is run.
z Loads all the information out of the tables and configures the properties
needed to properly display the Web dialogs based on the destination
computer.
z Populates the list of existing Web sites that appears in the Web dialogs
when installing to an existing site.
z PrimaryVolumePath
z PrimaryVolumeSpaceAvailable
z PrimaryVolumeSpaceRequired
z PrimaryVolumeSpaceRemaining
DiagnosticCheckDotNet Determines if .NET is required by this installation.
The test first ensures that there is a .NET assembly in the package. It then
retrieves from the registry the versions of .NET that are installed. If a
version of .NET is installed, it returns success and lists the versions installed.
If no version is installed the test fails. This check is inserted after the launch
condition check.
DiagnosticCheckExecuteLocally Evaluates type 34 or type 50 custom actions, which launch a file that is
expected to exist on the destination computer. Once the test obtains the
application path and ensures that it is valid, it calls the load library to ensure
the application can be loaded and returns success if the application
succeeded, failure if not.
DiagnosticCheckInUseFiles Tells the user how many files in the preflight installation are in use. The
message it returns is: Checked x files (OCX, EXE, and DLL files only), y are
in use.
First, the test ensures that the connection can be opened to the specified
URL; then, the content is downloaded. The test then translates the result
into text.
DiagnosticManagedFileCheck Ensures that files that have been distributed throughout the environment are
known and tested. This test ensures that a given computer is in a well
known, managed state and that testing and conflict management operations
are not invalid in the production environment.
DiagnosticMarkBeginRun Indicates the beginning of the preflight test. Also determines if the
application that the preflight package is testing is already installed.
DiagnosticMarkEndRun Indicates the end of the preflight test and that the .MSI was fully processed.
Preflight Analysis uses the DiagnosticMarkEndRun test to determine if a run
is incomplete.
DiagnosticOpenDocExtCheck During Preflight Instrumentation, builds a list of document extensions from
the OpenDocument custom action and saves the list in the WiseExtDiag
table. On the destination computer, checks the registry for support for each
extension.
This test tries to open the registry key associated with the extension. If it
successfully opens the key, then an association exists. Otherwise, no
association exists.
DiagnosticPayloadInstalled Determines which files can be installed based on Windows installer file
versioning rules. The message it returns is: There are x files in this
installation, y files will be installed.
z Does the custom action require elevated privileges? If so, try running it in the
Execute Deferred sequence. On the custom action’s Properties tab, set the In-
Script Options drop-down to Deferred Execution - System Context.
z Make sure the custom action name is unique. To quickly survey your custom
actions, select All Custom Actions from Installation Mode.
z Does the custom action reference a Windows Installer property, such as REMOVE?
Windows Installer standard actions set Windows Installer properties. It could be that
the property your custom action is referring to is not set yet. Use the debugger to
discover whether the property is set at the point where you expect it to be set. Keep
moving the custom action down in the sequence until it works.
While Windows Installer provides standard actions that perform most functionality you
need in an installation, occasionally you might need additional functionality not available
in standard actions. In that case, Windows Installer supports a variety of custom
actions, which let you call code from other development environments, display a
message, download a file from a Web site, launch a Web page, post information over the
Internet to your organization’s server, run another installation, set directories, set a
feature state, set properties, and more. These custom actions let you add extensive
functionality to an installation without having to write the code yourself.
This section outlines each custom action and gives hints on using it effectively. For
technical details on custom actions, see Custom Actions in the Windows Installer SDK
Help. For help using the interface, see Using MSI Script on page 466.
Tips
z You can send a variable parameter list to the .DLL.
A tutorial demonstrates this custom action in the Wise for Windows Installer Getting
Started Guide.
Note
Before being passed to Windows Installer, calls you make with Call Custom DLL actions
are passed through a .DLL that facilitates the passing of parameters.
Usage
Double-click the custom action and complete the Details tab:
z DLL File
Specify a .DLL file that exists on the destination computer to call during installation.
Type the path to the .DLL as it will be on the destination computer, but use a
Windows Installer directory property (enclosed in brackets) to specify the beginning
of the path. You can use a predefined directory property, or a property representing
a directory you created in this installation. To see directories defined in this
installation, go to Setup Editor > Tables tab and click the Directories table.
[SystemFolder]user32.dll
z Function Name
Type the name of the function within the .DLL file to call.
z Parameter List
In the parameter list, specify the parameters to send to the .DLL.
z Returned Property
Type or select a property name. The return value of the function call will be put into
this property.
Also see:
Tips
z You can send a variable parameter list to the .DLL.
z Manage the .DLL on the Resources page, which reflects the Binary table.
Note
Before being passed to Windows Installer, calls you make with Call Custom DLL actions
are passed through a .DLL that facilitates the passing of parameters.
Usage
Double-click the custom action and complete the Details tab:
z DLL File
Specify a .DLL from your hard drive or local network to call during installation.
z Function Name
Type the name of the function within the .DLL file to call.
z Parameter List
In the parameter list, specify the parameters to send to the .DLL.
z Returned Property
Type or select a property name. The return value of the function call will be put into
this property.
Also see:
Tips
z You can send a variable parameter list to the .DLL.
z Before you add this custom action, add the file to be called to the Files page in
Installation Expert.
z Shaded areas of MSI Script indicate restricted placement for this custom action;
because this custom action calls an installed file, it must run after files are installed.
Note
Before being passed to Windows Installer, calls you make with Call Custom DLL actions
are passed through a .DLL that facilitates the passing of parameters.
Usage
Double-click the custom action and complete the Details tab:
z DLL File
Specify a .DLL file to call during installation. It must have already been added to this
installation.
z Function Name
Type the name of the function within the .DLL file to call.
z Parameter List
In the parameter list, specify the parameters to send to the .DLL.
z Returned Property
Type or select a property name. The return value of the function call will be put into
this property.
Also see:
In the Execute Immediate or User Interface sequences only, you can send Windows
Installer properties to the .DLL function as parameters. The property’s current value is
passed to the function and, if the function changes that value, the property is updated
back in the installation. To send a property, set Value Source to Property and type or
select the property name in Property Name.
z Parameter Type
This lists standard data types and two Windows Installer-specific items. Check the
.DLL function for its required parameter data types. The option MsiHandle to
Install gives you the handle hInstall, which is a handle to the running installation;
the option MsiHandle to Database gives you the handle hDatabase, which is a
handle to the running database. Some Windows Installer function calls and
database calls require these handles as parameters.
z Value Source
A parameter’s value can be set from a Windows Installer property, a constant, or a
constant with a NULL value. When you select a value source, the appropriate field
below becomes enabled.
z Property Name
If you selected Property in Value Source, enter or select a Windows Installer
property here to send as a parameter. This only works in the Execute Immediate or
User Interface sequences.
z Constant Value
If you selected Constant with NULL value, the value of NULL is passed
regardless of the parameter type, so Not applicable is displayed for the
parameter type.
Tips
z Manage the .DLL on the Resources page, which reflects the Binary table.
z You cannot send a variable parameter list to the .DLL. You can send only the handle
to the installation, which means the .DLL must be written specifically for Windows
Installer. To avoid these restrictions, use a “Call Custom DLL...” action instead.
Usage
Double-click the custom action and complete the Details tab:
z DLL File
Specify a .DLL from your hard drive or local network to call during installation.
z Function Name
Type the name of the function within the .DLL file to call.
Also see:
Tips
z You cannot send a variable parameter list to the .DLL. You can send only the handle
to the installation, which means the .DLL must be written specifically for Windows
Installer. To avoid these restrictions, use a “Call Custom DLL...” action instead.
z Before you add this custom action, add the file to be called to the Files page in
Installation Expert.
z Shaded areas of MSI Script indicate restricted placement for this custom action;
because this custom action calls an installed file, it must run after files are installed.
Usage
Double-click the custom action and complete the Details tab:
z DLL File
Specify a .DLL file to call during installation. It must have already been added to this
installation.
z Function Name
Type the name of the function within the .DLL file to call.
Also see:
Tips
z The script is limited to 255 characters; use other JScript custom actions for longer
scripts.
Usage
Double-click the custom action and complete the Details tab:
z Type or paste the script text. Code elements, such as function names, declarations,
and values, are color-coded. You can use bracketed property names, table keys,
environment variable references, and other special substrings. See Formatted in the
Windows Installer SDK Help.
Also see:
Tips
z Manage the file on the Resources page, which reflects the Binary table.
Usage
Double-click the custom action and complete the Details tab:
z Script File
Specify a script file from your hard drive or local network to call during installation.
Also see:
Tips
z Before you add this custom action, add the file to be called to the Files page in
Installation Expert.
z Shaded areas of MSI Script indicate restricted placement for this custom action;
because this custom action calls an installed file, it must run after files are installed.
Usage
Double-click the custom action and complete the Details tab:
z Script File
Specify a script file to call during installation. It must have already been added to
this installation via the Files page.
Also see:
Tips
z The script is limited to 32 Kb, which is the size limit for Windows Installer properties.
Usage
Double-click the custom action and complete the Details tab:
z Property
Specify a property that stores the script, either by selecting a property or typing a
new property name. Elsewhere in the installation, you must provide a mechanism
for populating this property with the script text.
Also see:
Tips
z The script is limited to 255 characters; use other VBScript custom actions for longer
scripts.
Usage
Double-click the custom action and complete the Details tab:
z Type or paste the script text. Code elements, such as function names, declarations,
and values, are color-coded. You can use bracketed property names, table keys,
environment variable references, and other special substrings. See Formatted in the
Windows Installer SDK Help.
Also see:
Tips
z Manage the file on the Resources page, which reflects the Binary table.
Usage
Double-click the custom action and complete the Details tab:
z Script File
Specify a script file from your hard drive or local network to call during installation.
Also see:
Tips
z Before you add this custom action, add the file to be called to the Files page in
Installation Expert.
z Shaded areas of MSI Script indicate restricted placement for this custom action;
because this custom action calls an installed file, it must run after files are installed.
Usage
Double-click the custom action and complete the Details tab:
z Script File
Specify a script file to call during installation. It must have already been added to
this installation via the Files page.
Also see:
Tips
z The script is limited to 32 Kb, which is the size limit for Windows Installer properties.
z To use this option, you must also provide some mechanism for populating the
property with the script text.
Usage
Double-click the custom action and complete the Details tab:
z Property
Specify a property that stores the script, either by selecting a property or typing a
new property name. Elsewhere in the installation, populate this property with the
script text.
Also see:
Display Message
This custom action displays a message to the end user. You can also use it for debugging
by displaying the value of properties while the installation runs.
Tips
z If this custom action is within a condition, the message is displayed only when the
specified condition is met.
Example: You could display a message if end users marked a checkbox on a dialog.
You would associate the checkbox with a property and then set up a condition to
check if the property was true. For information on conditional blocks, see If
Statement on page 504.
z You can use formatted text strings, such as bracketed property names, in Message
Title or Message Text. However, formatted text strings only work in the Execute
Immediate or User Interface sequences. See Guidelines for Custom Action Location
on page 478 and Formatted in the Windows Installer SDK Help.
Usage
Double-click the custom action and complete the dialog:
z Message Title
Enter text to be displayed in the title bar of the message dialog.
z Message Text
Enter the text to be displayed in the message dialog. Press Ctrl+Enter to add line
breaks in the displayed text.
z Message Icon
Select an appropriate icon for your message dialog.
Also see:
Tips
z If you place this action in the User Interface or Execute Immediate sequences, you
can use formatted text strings, such as [INSTALLDIR], in the Source URL and
Destination Directory fields. See Formatted in the Windows Installer SDK Help.
z If you place this action in the User Interface or Execute Immediate sequences, you
cannot display progress bar text.
z If you place this action in the Execute Deferred sequence, you must hard-code the
destination and source paths.
z Downloaded files are not uninstalled when the product is uninstalled because
Windows Installer only uninstalls files installed with standard actions, not custom
actions.
Usage
Double-click the custom action and complete the dialog:
z Source URL
Enter the URL of the file to download, including the name of the file.
Example: http://www.site.com/readme.pdf.
z Destination Directory
Specify the file path, including file name, on the destination computer where the file
should be downloaded. Example: [INSTALLDIR]readme.pdf.
z Error Handling
Determine how errors in the download operation are handled.
Ignore Errors
The installation continues regardless of errors.
Abort Installation
The installation stops if the download operation cannot be completed.
Also see:
End Statement
The End Statement action marks the end of an If action, which specifies conditions to
attach to an action or a set of actions. The End Statement action takes no parameters,
and double-clicking it in the Actions list immediately inserts it into the script above the
selected script line.
Usage
Double-click the custom action and complete the Details tab:
z Working Directory
Using a non-bracketed Windows Installer directory property (Example:
INSTALLDIR), specify the working directory of the .EXE file to call. When the .EXE
file is run on the destination computer, its current working directory is set to the
directory you specify here. This must be set to a directory that can be specified with
a Windows Installer directory property, which are listed when you click Browse.
(Optional) To pass command line options to the .EXE file, enter them after the name
of the .EXE file. The command line options are executed in relation to the working
directory. Example: If you type INSTALLDIR in Working Directory, and type
NOTEPAD.EXE README.TXT in this field, the README.TXT file that is in INSTALLDIR
is opened.
Also see:
Usage
Double-click the custom action and complete the Details tab:
z Executable File
Specify an .EXE file from your computer or local network. The .EXE file will be stored
in the Binary table of the installation.
z Command Line
(Optional) Enter any command line options to pass to the .EXE file.
Also see:
Tips
z Before you add this custom action, add the file to be called to the Files page in
Installation Expert.
z Shaded areas of MSI Script indicate restricted placement for this custom action;
because this custom action calls an installed file, it must run after files are installed.
Usage
Double-click the custom action and complete the Details tab:
z Executable File
Specify the .EXE file to run. It must have already been added to this installation.
z Command Line
(Optional) Enter command line options to pass to the .EXE file.
On the Properties tab, In-Script Options is disabled for this custom action.
Also see:
To use this option, you must provide a mechanism for setting a property with the value
of the .EXE path. Example: You could use the Set Property custom action and set a path
based on the operating system. Or you could use the System Search page to set a
property to the path of a found file.
Usage
Double-click the custom action and complete the Details tab:
z Property
Specify a property that will store the path and name of the .EXE. Select a property
or type a new property name.
z Command Line
(Optional) Enter command line options to pass to the .EXE file.
Also see:
If Statement
Use If Statements to set conditions on actions. An If Statement marks the beginning of
a If block, which is a conditional block of actions. The If block must be concluded by an
End Statement. If the condition specified in the If Statement is true, the actions inside
the If block are executed; if false, the actions are not executed. You can nest If
Statements to create complex conditions.
The condition you enter in the Condition field is subject to Windows Installer guidelines
for creating conditions. See Conditional Statement Syntax in the Windows Installer SDK
Help. To use the Condition Builder to create a syntactically correct Windows Installer
condition, click Build. See Creating Conditions With Condition Builder on page 411.
Also see:
Tips
z The installation being called must already be advertised or installed on the
destination computer.
z On the Properties tab, In-Script Options is disabled for this custom action and
Processing only allows synchronous execution.
z For best results, place this custom action in the Execute Immediate sequence after
the InstallFinalize action.
Usage
Double-click the custom action and complete the Details tab:
z Product Code
Either enter or copy and paste the product code of the nested installation. The
product code is stored in a property named ProductCode. To find the product code of
the nested .MSI, view its Product Code field on the Product Details page.
z Property Settings
Enter properties to set for the nested installation. You can set Windows Installer
properties or private properties. Example: To set the main installation directory for
the nested installation to be the same as for the current installation:
INSTALLDIR="[INSTALLDIR]"
If the directory represented by the property might contain spaces, as is typical with
the installation directory, enclose the property in quotes as shown above.
ADVERTISE=ALL
REMOVE=ALL
For a list of properties, see Property Reference in the Windows Installer SDK Help.
Also see:
Tips
z Manage the .MSI on the Resources page, which reflects the Binary table.
z On the Properties tab, In-Script Options is disabled for this custom action and
Processing only allows synchronous execution.
z For best results, place this custom action in the Execute Immediate sequence after
the InstallFinalize action.
Usage
Double-click the custom action and complete the Details tab:
z Installation to Run
Specify the .MSI to run from your computer or local network. The installation must
be in .MSI format, and must not include external compressed or uncompressed files.
z Property Settings
Enter properties to set for the nested installation. You can set Windows Installer
properties or private properties. Example: To set the main installation directory for
the nested installation to be the same as for the current installation:
INSTALLDIR="[INSTALLDIR]"
If the directory represented by the property might contain spaces, as is typical with
the installation directory, enclose the property in quotes as shown above.
ADVERTISE=ALL
REMOVE=ALL
For a list of properties, see Property Reference in the Windows Installer SDK Help.
Also see:
This custom action assumes that both the main installation file and the nested
installation file are stored on the same installation media. Example: You could place the
main and nested installations on a CD. The path to the nested installation must be
specified using a relative path from the main installation.
Tips
z This custom action is not available in an Administrative Installation.
z On the Properties tab, In-Script Options is disabled for this custom action and
Processing only allows synchronous execution.
z For best results, place this custom action in the Execute Immediate sequence after
the InstallFinalize action.
Usage
Double-click the custom action and complete the Details tab:
z Installation to Run
Enter the relative pathname of the .MSI to run. Example: If this installation is
located at the top level of a CD (F:\), and the nested installation is at
F:\SubInstall\second.msi, enter the following:
SubInstall\second.msi
z Property Settings
Enter properties to set for the nested installation. You can set Windows Installer
properties or private properties. Example: To set the main installation directory for
the nested installation to be the same as for the current installation:
INSTALLDIR="[INSTALLDIR]"
If the directory represented by the property might contain spaces, as is typical with
the installation directory, enclose the property in quotes as shown above.
ADVERTISE=ALL
REMOVE=ALL
For a list of properties, see Property Reference in the Windows Installer SDK Help.
Also see:
In Web Page URL on the Launch Web Page dialog, designate the URL to launch during
installation. The URL must be complete. Example: http://www.wise.com.
Also see:
Tips
z Before you add this custom action, add the file to be called to the Files page in
Installation Expert.
z Shaded areas of MSI Script indicate restricted placement for this custom action;
because this custom action calls an installed file, it must run after files are installed.
Pause Installation
This custom action temporarily stops a sequence from executing. After the specified
number of seconds, the sequence continues running.
Usage
Double-click the custom action and complete the dialog:
z Seconds to Pause
Number of seconds for the sequence to pause.
Tips
z You must have an ASP or CGI program set up to accept data from HTTP POST
operations.
z The computer running the installation must have a valid Internet connection (such
as dial-up networking).
z If you place this action in the User Interface or Execute Immediate sequences, you
can use formatted text strings, such as [PROPERTY], in the Destination URL and
Text to Post fields. However, because of Windows Installer limitations, if you place
it in the Execute Deferred sequence, you must hard-code the destination and source
paths. See Guidelines for Custom Action Location on page 478 and Formatted in the
Windows Installer SDK Help.
z Because of Windows Installer limitations, to display progress bar text to the user,
you must place the action in the Execute Deferred sequence.
z To give end users control over whether to post data to your HTTP server, put this
custom action in a conditional block. Set the conditional block so that it only posts
data if the end user has agreed to this posting. Example: Add a checkbox the user
marks to accept posting of data. Associate the checkbox with a property and set up
the conditional block to run if the property is true. For information on conditional
blocks, see If Statement on page 504.
Usage
Double-click the custom action and complete the dialog:
z Destination URL
The URL of the CGI program or ASP page that will accept the posted data.
z Text to Post
The text to post should be one or more lines in the format field=data, where field is
the name of the field expected by the Web application, and data is the data to
populate the field. If a line does not appear to contain a field name followed by =, it
is assumed to be a continuation of the previous line, and the data on the 2 lines is
concatenated and sent with a single field identifier. For information on using
formatted text, see the tips above .
z Error Handling
Determines how errors in the posting operation are handled.
Ignore Errors
The script continues regardless of any errors.
Abort Installation
The installation stops if the posting operation cannot be completed.
Also see:
Remark
The Remark action lets you put comments in sequences to document what is happening
in the script.
In Remark, type the comment. To place a blank line in the sequence, add a Remark
action, but leave Remark blank.
If you use both WiseScript and Windows Installer technology, you can integrate them
with this custom action. Use this to leverage past WiseScripts or to gain access to
unique WiseScript technology.
Tips
z In the WiseScript, use special script actions—Get Windows Installer Property, Set
Windows Installer Property, and Evaluate Windows Installer Condition—to
communicate between the Windows Installer installation and the WiseScript. For
details, see documentation for your WiseScript editing tool.
z Access your WiseScript editing tool by selecting Tools menu > WiseScript. (In Visual
Studio: Project menu > WiseScript.)
z If the WiseScript being called uses a Set Windows Installer Property action, place
this custom action in the User Interface or Execute Immediate sequence.
Usage
Double-click the custom action and complete the Details tab:
z Options button
This is disabled for this custom action.
z Command Line
(Optional) Enter the command line options to send to the .EXE. Example: Enter /s to
make the WiseScript run silently. The documentation for your WiseScript editing tool
lists valid command line options.
Also see:
If you use both WiseScript and Windows Installer technology, you can integrate them
with this custom action. Use this to leverage past WiseScripts or to gain access to
unique WiseScript technology.
Tips
z In the WiseScript, use special script actions—Get Windows Installer Property, Set
Windows Installer Property, and Evaluate Windows Installer Condition—to
communicate between the Windows Installer installation and the WiseScript. For
details, see documentation for your WiseScript editing tool.
z Access your WiseScript editing tool by selecting Tools menu > WiseScript. (In Visual
Studio: Project menu > WiseScript.)
z If the WiseScript being called uses a Set Windows Installer Property action, place
this custom action in the User Interface or Execute Immediate sequence.
z Manage the file you specify on the Resources page, which reflects the Binary table.
Usage
Double-click the custom action and complete the Details tab:
z Options button
z Command Line
(Optional) Enter the command line options to send to the .EXE. Example: Enter /s to
make the WiseScript run silently. The documentation for your WiseScript editing tool
lists valid command line options.
Also see:
If you use both WiseScript and Windows Installer technology, you can integrate them
with this custom action. Use this to leverage past WiseScripts or to gain access to
unique WiseScript technology.
Tips
z In the WiseScript, use special script actions—Get Windows Installer Property, Set
Windows Installer Property, and Evaluate Windows Installer Condition—to
communicate between the Windows Installer installation and the WiseScript. For
details, see documentation for your WiseScript editing tool.
z Access your WiseScript editing tool by selecting Tools menu > WiseScript. (In Visual
Studio: Project menu > WiseScript.)
z If the WiseScript being called uses a Set Windows Installer Property action, place
this custom action in the User Interface or Execute Immediate sequence.
z Before you add this custom action, add the file to be called to the Files page in
Installation Expert.
z Shaded areas of MSI Script indicate restricted placement for this custom action;
because this custom action calls an installed file, it must run after files are installed.
Usage
Double-click the custom action and complete the Details tab:
z Options button
z Command Line
(Optional) Enter the command line options to send to the .EXE. Example: Enter /s to
make the WiseScript run silently. The documentation for your WiseScript editing tool
lists valid command line options.
Also see:
Set Directory
This custom action sets a new value for a directory property. Example: Set a new value
for a directory based on end user input during installation. A tutorial demonstrates this
custom action in the Wise for Windows Installer Getting Started Guide.
Tips
z For best results, place this action in the User Interface or Execute Immediate
sequence.
z On the Properties tab, the In-Script Options and Processing drop-down lists are
disabled for this custom action.
Usage
Double-click the custom action and complete the Details tab:
z Directory
Specify the directory to change the value of. It must be a directory you’ve added to
this installation or a predefined Windows system directory, which appears when you
browse. Do not enclose the directory property with brackets.
z Directory Value
Enter the new path of the directory. You can use property and directory names by
enclosing them in brackets. Example: To indicate a directory named Data in the
installation directory, enter:
[INSTALLDIR]Data
Also see:
On the Set Feature State dialog, select the feature from Feature, then mark an
installation state option for that feature.
Tips
z This custom action has restrictions on its placement, indicated by shaded areas in
the Installation Sequence.
z If you set a feature to run from source and the files are compressed, Windows
Installer sets the feature to run from the local drive.
z For information on how Windows Installer sets feature states when features share
components, see MsiSetFeatureState in the Windows Installer SDK Help.
Also see:
Set Property
This custom action sets a Windows Installer property. This custom action is useful for
setting a property based on end user input or on system configuration.
Tips
z For best results, place this action in the User Interface or Execute Immediate
sequence.
z On the Properties tab, the In-Script Options and Processing drop-down lists are
disabled for this custom action.
Usage
Double-click the custom action and complete the Details tab:
z Property
Select a property from the list, or enter a new property name. Do not enclose this
property name with brackets.
z Property Value
Enter the value to set the property to. Because this value is of the data type
Formatted, you can use property and directory names by enclosing them in
brackets. For information on formatted text strings, see Formatted in the Windows
Installer SDK Help.
Also see:
Terminate Installation
This custom action terminates the installation and displays a message explaining the
termination. Typically, you would place this custom action within a conditional block; see
If Statement on page 504.
Tips
z This custom action has restrictions on its placement, indicated by shaded areas in
the Installation Sequence.
Usage
Double-click the custom action and complete the Details tab:
z Termination Message
Enter a message to explain to the end user why the installation terminated. Use
plain text, formatted text strings, or enter an integer that is indexed to an entry in
the error table.
Also see:
Note
The Location tab is an alternate way to perform tasks that you normally perform in the
User Interface, Execute Immediate, or Execute Deferred sequences. You can move and
copy custom actions by using editing functions in these sequences. The main use for this
tab is to click the No Sequence option, which causes this action to not run unless an
event invokes it.
z No Sequence
Omits the custom action from all sequences, and stores it in the CustomAction
table. If you mark this, the custom action is only invoked if you set an event to run
the custom action. See Launching a Custom Action from a Dialog on page 483.
z Sequence
Select a sequence to which to add this custom action. The options here correspond
to the sequences available with each of the 3 installation modes.
Click Add to add the custom action to the sequence below the action you
selected.
Click Move Up and Move Down to specify where in the sequence the custom
action is stored.
z Condition
For this action to run only if a certain condition is true, enter a condition. In the User
Interface, Execute Immediate, and Execute Deferred sequences, the condition you
enter is displayed as an If Statement preceding the custom action. To use the
Condition Builder to create a syntactically correct Windows Installer condition, click
Build. See Creating Conditions With Condition Builder on page 411.
Note
When you add a custom action to a merge module, you’ll notice that the Custom
Action Name field automatically contains the GUID of the merge module. You should
leave the GUID as part of the custom action name to ensure adherence to Windows
Installer guidelines for naming custom actions in merge modules.
Because a merge module is merged into a standard installation, you must specify where
the custom action should be merged into the action sequence of the standard
installation. To specify where this custom action is merged into the main action
sequence, set the following options:
z No Sequence
Clear this to add this action to an action sequence. If the action is not in an action
sequence, it is never executed.
z Sequence
Select a sequence to which to add this custom action. The options here correspond
to the sequences available with each of the three installation modes of a standard
installation (.WSI or .MSI file).
z Reference Action
This drop-down list contains all the standard Windows Installer actions from the
sequence that you selected in the Sequence drop-down list. This custom action,
when merged into a standard installation, will be placed relative to the action you
select in this list.
z Sequence Number
If the reference action you select above is not found, this custom action will be
placed using this sequence number. In most cases, you can ignore this field. You can
view sequence numbers for a particular sequence by viewing the sequence in the
Tables tab in Setup Editor.
In the Placement section, mark an option to specify where to place this action:
Before Action
Click this option to place this action before the Reference Action you selected
above.
After Action
Click this option to place this action after the Reference Action you selected
above.
z Condition
If you want this action to run only if a certain condition is true, enter a condition. In
the User Interface, Execute Immediate, and Execute Deferred sequences, the
condition you enter is displayed as an If Statement preceding the custom action. To
use the Condition Builder to create a syntactically correct Windows Installer
condition, click Build. See Creating Conditions With Condition Builder on page 411.
In-Script Options
This determines when the custom action is executed. When Windows Installer runs the
installation, it first reads the action sequences and creates its own internal installation
script to follow, then later it executes that script. You can have the custom action
executed immediately when Windows Installer first encounters it, or later during
execution of the internal script. See Custom Action In-Script Execution Options in the
Windows Installer SDK Help.
Note
The In-Script Options drop-down list is disabled if this custom action is located in the
User Interface or Execute Immediate sequences because both these sequences already
run in immediate execution mode, making this drop-down list redundant. It is disabled
for Set Property and Set Directory because they must be run in immediate execution
mode in order to work.
z Immediate Execution
If you place an action in the User Interface or Execute Immediate sequence, this is
set to Immediate Execution and is disabled, because those two sequences always
run in immediate execution. This action will be executed during Windows Installer’s
first pass through the installation database, before the internal script is generated
and executed. Actions in immediate execution mode can change properties; actions
in any type of deferred mode cannot. Actions in immediate execution mode always
run under User Context, which means that they run with the same privilege level as
the currently logged-in user. If the custom action needs to be run under a higher
privilege level, place it in the Execute Deferred sequence and set this field to
Deferred Execution - System Context.
Note
The following four options all apply to deferred custom actions, and are available
only if the custom action is placed in the Execute Deferred sequence. Otherwise the
drop-down list is disabled.
z Rollback only
Select this if the action should be executed later, during installation of the rollback
script, which is invoked if the end user cancels the installation or if the installation is
unsuccessful. Use rollback actions to undo previous custom actions that made
changes to the system. Rollback actions run in deferred execution mode and cannot
run asynchronously. See Rollback Custom Actions in the Windows Installer SDK
Help.
z Commit only
Select this if the action should be executed later, during installation of the commit
script, which is invoked upon successful completion of the installation script.
Commit actions run in deferred execution mode. See Commit Custom Actions in the
Windows Installer SDK Help.
Note
User context and system context are relevant only on locked-down Windows NT,
2000, XP, and Server 2003 computers. Actions run in system context are run with
elevated privileges by the Windows Installer service. Actions run in user context are
run with the current user’s privileges.
Processing
The main installation thread can control the custom action thread in different ways.
Options in this drop-down list determine how the custom action thread is controlled. See
Custom Action Return Processing Options and Synchronous and Asynchronous Custom
Actions in the Windows Installer SDK Help.
The Processing options are not available if the custom action type is Set Property or Set
Directory and are limited to synchronous for Install MSI custom actions.
z Synchronous
Run the custom action synchronously to the main installation thread. Windows
Installer waits for the custom action to complete before continuing the main
installation. The exit code of the custom action must be 0 to indicate success. Use
this method for Windows Installer to wait for the success of the action before
continuing.
z Asynch, No wait
Run the custom action asynchronously to the main installation thread. This means
that Windows Installer runs the custom action simultaneously with the main
installation. Windows Installer does not wait for completion of the custom action and
does not check the exit code. This option is not supported for Install MSI custom
actions. This option is not supported for Install MSI custom actions or if you selected
Rollback Only in the In-Script Options list above.
Scheduling Options
If you add the custom action to both the UI Sequence and the Execute Sequence, but
you want to limit the number of times it actually runs, select an option here. See Custom
Action Execution Scheduling Options in the Windows Installer SDK Help.
z Always Execute
Select this to have the action execute in all sequences that you added it to.
Wise products integrate closely with Microsoft Windows technologies. The installations
you create are in Microsoft Windows Installer format and are run on the destination
computer by the Windows Installer engine.
Wise for Windows Installer is an authoring environment for Microsoft’s Windows Installer
service. It also supports Microsoft’s .NET Framework. Although a comprehensive
discussion of Windows Installer and .NET is not possible here, it is important that you
understand some basic concepts about Windows Installer and .NET, and how Wise for
Windows Installer supports them.
Topics include:
Microsoft Windows Installer has its own help system, which contains detailed
information on every aspect of Windows Installer. Access the Windows Installer SDK
Help by selecting Help menu > Windows Installer SDK Help. (In Visual Studio: Help
menu > Wise Help > Windows Installer Help.)
Wise for Windows Installer is an installation authoring application for creating Windows
Installer database files. When you build an installation in Wise for Windows Installer,
you populate tables within a Windows Installer database file. The Wise for Windows
Installer user interface exposes the functionality offered by Windows Installer.
If you output an.MSI file compressed in an .EXE file, Windows Installer uncompresses a
copy of the .MSI into \Program Files\Common Files\Wise Installation Wizard\ on the
destination computer. These .MSI files do not have to be left on the destination
computer, but if they are, the end user does not need the source media to repair or
reinstall an installation.
What is advertisement?
Advertisement is a way to deploy applications in large organizations. It is available with
Windows Installer, but only for supported platforms. (See Platform Support of
Advertisement in the Windows Installer SDK Help.) During installation development, you
can set features or entire applications to be advertised. End users invoke advertised
items by launching a shortcut, opening a file with an advertised file extension, or by
accessing any other entry point.
Example: You could add a menu option for a spell checker, but design the installation so
that the files necessary for the spell checker are not installed by default. When the end
user selects the spell checker menu option, your code can use Windows Installer
functions to install the necessary files on demand.
While Wise for Windows Installer can help you bundle an application into an installation
package, it cannot help you design, develop, and code an application to use Microsoft
Windows Installer APIs. Use the Windows Installer Software Development Kit (SDK)
online help, which is installed with Wise for Windows Installer, as a reference for coding
Windows Installer functionality into an application.
For information on how Windows Installer handles components and features, see the
following topics in the Windows Installer SDK Help:
About GUIDs
GUID stands for globally unique identifier. It is a data type comprised of a text string
that represents a Class identifier (ID).
Examples:
z When you create an upgrade, you enter the upgrade codes, which are GUIDS, for
the versions of the application that can be upgraded. Then during installation,
Windows Installer searches the destination computer for these upgrade codes to
determine whether an upgrade should occur.
z Each component of an application has an assigned GUID. You can use the System
Search page to quickly search for components on the destination computer to
determine if a previous version exists.
Caution
Do not attempt to create a GUID by typing random hex characters.
Wise for Windows Installer simplifies the process of creating installations for .NET
applications, automating the process by extracting most of the installation details from
your assemblies.
Also see:
Code that runs outside the runtime and does not contain metadata is called unmanaged
code. Examples of unmanaged code are COM components, ActiveX interfaces, and
Win32 API functions. Unmanaged code executes in the common language runtime
environment with minimal services.
The common language runtime supports COM interoperability (interop). For backward
compatibility, COM interop provides access to existing COM components without
requiring you to modify the original components. COM interop also enables your COM
clients to access managed code as easily as they access other COM objects. This is
accomplished by adding information to the system registry so .NET components are
called as though they were COM components. At runtime, the common language
runtime marshals data between COM objects and managed objects as needed.
What is an assembly?
An assembly is the primary building block of a .NET application. An assembly contains its
own naming, binding, versioning, deployment, and configuration information. It consists
of 2 elements: a manifest, which is the meta data that describes information about the
assembly and any resources it depends on; and a set of instructions in the form of
Microsoft Intermediate Language (MSIL) code that is executed when the assembly is
referenced.
You can group assembly elements into a single file assembly, which incorporates the
manifest into a portable executable (PE) file, which can be an .EXE or .DLL, with the
source code. You also can create a multifile assembly consisting of modules of compiled
code, resources, or other files required by the application. In a multifile assembly, the
manifest can be a standalone file or it can be incorporated into one of the PE files in the
assembly.
When you add a .NET assembly to an installation, Wise for Windows Installer creates
entries in the MsiAssembly and MsiAssemblyName tables.
z Side-by-side
To safely share COM or Win32 assemblies among multiple applications and to
minimize .DLL conflicts, use side-by-side assembly sharing. Instead of having a
single version of an assembly that assumes backward compatibility with all
applications, side-by-side assembly sharing enables multiple versions of a COM or
Win32 assembly to run simultaneously on the destination computer. Side-by-side
assembly sharing is available only on Windows XP or later. See Side-by-Side
Assemblies in the Windows Installer SDK Help.
z Private assembly
To reserve a Win32 assembly for the exclusive use of one application, install it in a
directory that is private to the application, typically the application directory. This is
called a private assembly. The dependency of the application on the private
assembly is specified in an application manifest file. On operating systems earlier
than Windows XP, a copy of the private assembly and a .local file is installed into a
private directory for the exclusive use of the application. A version of the assembly
is also globally registered on the system and made available for any application that
binds to it. The global version of the assembly can be the version installed with the
application or an earlier version.
.NET applications that use shared assemblies, or that have a mix of managed and
unmanaged code, cannot be installed via XCOPY. You should use the Windows Installer
service for installations that do any of the following:
z Require security
z Create a shortcut
By creating a Windows Installer installation for your .NET applications, you can take
advantage of the services Windows Installer provides: installation, repair, and removal
of assemblies; roll back; install-on-demand; patching; and advertisement.
If the .NET Framework is installed on your computer, Wise for Windows Installer can
automate the process as follows:
z Find all files in multifile assemblies and add them to the installation.
z Determine attributes for registering the assembly files and add them to the
MsiAssemblyName table.
Also see:
You can build .NET installations without having Windows XP or later on your computer.
However, in order to take advantage of side-by-side assembly sharing, the destination
computer must have Windows XP or later installed. To use the Global Assembly Cache,
the destination computer must have the .NET Framework installed.
Before you begin to create an installation for your .NET application, do the following:
1. Gather all your assemblies, both Win32 and .NET, and their manifests into a
common location.
You can install assemblies into the Global Assembly Cache, the WinSxS directory, or
a private directory. For information on how each of these directories is used, see
Adding .NET Assemblies to the Installation on page 124.
3. For assemblies that are to be installed into the Global Assembly Cache or WinSxS,
generate publicKeyTokens and sign the assemblies.
Also see:
breakpoint check tables for errors 402 Common Files folder 522
clearing 464 checkbox common language runtime 525
setting in debugger 464 dialog control 438 Also see .NET Framework
setting items 445 comparison
build
Also see compile checking for updates 17 of Windows Installer files 85
automating 218 checking in files 317 to source control 320
clean 193 checking out files 318 compatibility with Windows Installer
sharing settings 183 version 98
checksum, validating 131
Build column 180 compile
Citrix
build error automating 218
compatibility 180
See compile validation 379 change source directory 327
changes not saved 90
Build Options page 185 clean build
error 26
button in directory 194
errors after import 362, 364
dialog control 438 in source control 193 file path errors 89, 324
resizing for language 274 Clean Build page 193 how to 88
cluster size 203 log file 218
C mobile device 246
CmdLine 423
C# quick 40, 88
code group, importing for .NET 238
importing 361 release 179, 180
project types 360 code page 265, 268
silent 218
tips for import 360 code signing with multiple processors 44
C++ symbol file directory 308, 308 See digital signature Complete feature 100
CAB colors in sequence 471 Complete installation type 175
adding files 250 column information 398 component error
creating CAB files 202 COM interoperability (interop) adding to Task List 26
file details 251 about 525
Component Object Model 240
names for mobile device 247 registering .NET assembly 95,
platform version 249 component rules
222, 332
register DLL 251 about 57
COM+ 240 action 58, 62
registry 252
combobox dialog control 438 adding 61
shortcut 254
command line aligning GUIDs 59
Call Custom DLL
creating 210 Also see rule set or component
from destination 489
command line options, installation condition 58, 62
from installation 490
about 209 deleting 61
from installed file 491
advertising 214 editing 61
tips 481
creating 210 how applied 58
Call DLL in upgrade 59
general options 210
from installation 492 Microsoft Best Practices 63
installation log 213
from installed file 493 modifying 61
logging 213
tips 481 One File Per Component 64
patch, applying 216
Call JScript patch, removing 216 predefined 63, 64
from embedded code 494 public property, changing 215 selecting 58
from installation 495 repair 215 sharing 50, 57
from installed file 495 running 90, 210 ComponentRules.ini 50
from property 496 testing 89 components
tips 481 transform, applying 216 64-bit 394
Call VBScript UI options 212 adding 393
from embedded code 497 command line options, WfWI.exe assigning to feature 387, 395
from installation 497 about 209 checking if installed 414, 414
from installed file 498 compiling with 328 condition not working 411
from property 499 create log file 218 conditions, adding 409, 409
tips 481 example 218, 328 creating 57, 523
Cancel button, hiding in install 212 list of 217 defined 523